| durin42 |
| hg-reviewers |
This was the final piece of version 2 referenced in wireproto. The
break between server implementations is now much cleaner.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/wireproto.py (4 lines) | |||
| M | mercurial/wireprotov2server.py (19 lines) |
| if gd: | if gd: | ||||
| v = ui.configbool('server', 'bundle1gd') | v = ui.configbool('server', 'bundle1gd') | ||||
| if v is not None: | if v is not None: | ||||
| return v | return v | ||||
| return ui.configbool('server', 'bundle1') | return ui.configbool('server', 'bundle1') | ||||
| # For version 1 transports. | |||||
| commands = wireprototypes.commanddict() | commands = wireprototypes.commanddict() | ||||
| # For version 2 transports. | |||||
| commandsv2 = wireprototypes.commanddict() | |||||
| def wireprotocommand(name, args=None, permission='push'): | def wireprotocommand(name, args=None, permission='push'): | ||||
| """Decorator to declare a wire protocol command. | """Decorator to declare a wire protocol command. | ||||
| ``name`` is the name of the wire protocol command being provided. | ``name`` is the name of the wire protocol command being provided. | ||||
| ``args`` defines the named arguments accepted by the command. It is | ``args`` defines the named arguments accepted by the command. It is | ||||
| a space-delimited list of argument names. ``*`` denotes a special value | a space-delimited list of argument names. ``*`` denotes a special value | ||||
| that says to accept all named arguments. | that says to accept all named arguments. | ||||
| interface as zi, | interface as zi, | ||||
| ) | ) | ||||
| from . import ( | from . import ( | ||||
| encoding, | encoding, | ||||
| error, | error, | ||||
| pycompat, | pycompat, | ||||
| streamclone, | streamclone, | ||||
| util, | util, | ||||
| wireproto, | |||||
| wireprotoframing, | wireprotoframing, | ||||
| wireprototypes, | wireprototypes, | ||||
| ) | ) | ||||
| FRAMINGTYPE = b'application/mercurial-exp-framing-0005' | FRAMINGTYPE = b'application/mercurial-exp-framing-0005' | ||||
| HTTP_WIREPROTO_V2 = wireprototypes.HTTP_WIREPROTO_V2 | HTTP_WIREPROTO_V2 = wireprototypes.HTTP_WIREPROTO_V2 | ||||
| COMMANDS = wireprototypes.commanddict() | |||||
| def handlehttpv2request(rctx, req, res, checkperm, urlparts): | def handlehttpv2request(rctx, req, res, checkperm, urlparts): | ||||
| from .hgweb import common as hgwebcommon | from .hgweb import common as hgwebcommon | ||||
| # URL space looks like: <permissions>/<command>, where <permission> can | # URL space looks like: <permissions>/<command>, where <permission> can | ||||
| # be ``ro`` or ``rw`` to signal read-only or read-write, respectively. | # be ``ro`` or ``rw`` to signal read-only or read-write, respectively. | ||||
| # Root URL does nothing meaningful... yet. | # Root URL does nothing meaningful... yet. | ||||
| if not urlparts: | if not urlparts: | ||||
| _processhttpv2reflectrequest(rctx.repo.ui, rctx.repo, req, res) | _processhttpv2reflectrequest(rctx.repo.ui, rctx.repo, req, res) | ||||
| return | return | ||||
| # Extra commands that we handle that aren't really wire protocol | # Extra commands that we handle that aren't really wire protocol | ||||
| # commands. Think extra hard before making this hackery available to | # commands. Think extra hard before making this hackery available to | ||||
| # extension. | # extension. | ||||
| extracommands = {'multirequest'} | extracommands = {'multirequest'} | ||||
| if command not in wireproto.commandsv2 and command not in extracommands: | if command not in COMMANDS and command not in extracommands: | ||||
| res.status = b'404 Not Found' | res.status = b'404 Not Found' | ||||
| res.headers[b'Content-Type'] = b'text/plain' | res.headers[b'Content-Type'] = b'text/plain' | ||||
| res.setbodybytes(_('unknown wire protocol command: %s\n') % command) | res.setbodybytes(_('unknown wire protocol command: %s\n') % command) | ||||
| return | return | ||||
| repo = rctx.repo | repo = rctx.repo | ||||
| ui = repo.ui | ui = repo.ui | ||||
| proto = httpv2protocolhandler(req, ui) | proto = httpv2protocolhandler(req, ui) | ||||
| if (not wireproto.commandsv2.commandavailable(command, proto) | if (not COMMANDS.commandavailable(command, proto) | ||||
| and command not in extracommands): | and command not in extracommands): | ||||
| res.status = b'404 Not Found' | res.status = b'404 Not Found' | ||||
| res.headers[b'Content-Type'] = b'text/plain' | res.headers[b'Content-Type'] = b'text/plain' | ||||
| res.setbodybytes(_('invalid wire protocol command: %s') % command) | res.setbodybytes(_('invalid wire protocol command: %s') % command) | ||||
| return | return | ||||
| # TODO consider cases where proxies may add additional Accept headers. | # TODO consider cases where proxies may add additional Accept headers. | ||||
| if req.headers.get(b'Accept') != FRAMINGTYPE: | if req.headers.get(b'Accept') != FRAMINGTYPE: | ||||
| # execute multiple commands. We double check permissions of each command | # execute multiple commands. We double check permissions of each command | ||||
| # as it is invoked to ensure there is no privilege escalation. | # as it is invoked to ensure there is no privilege escalation. | ||||
| # TODO consider allowing multiple commands to regular command URLs | # TODO consider allowing multiple commands to regular command URLs | ||||
| # iff each command is the same. | # iff each command is the same. | ||||
| proto = httpv2protocolhandler(req, ui, args=command['args']) | proto = httpv2protocolhandler(req, ui, args=command['args']) | ||||
| if reqcommand == b'multirequest': | if reqcommand == b'multirequest': | ||||
| if not wireproto.commandsv2.commandavailable(command['command'], proto): | if not COMMANDS.commandavailable(command['command'], proto): | ||||
| # TODO proper error mechanism | # TODO proper error mechanism | ||||
| res.status = b'200 OK' | res.status = b'200 OK' | ||||
| res.headers[b'Content-Type'] = b'text/plain' | res.headers[b'Content-Type'] = b'text/plain' | ||||
| res.setbodybytes(_('wire protocol command not available: %s') % | res.setbodybytes(_('wire protocol command not available: %s') % | ||||
| command['command']) | command['command']) | ||||
| return True | return True | ||||
| # TODO don't use assert here, since it may be elided by -O. | # TODO don't use assert here, since it may be elided by -O. | ||||
| assert authedperm in (b'ro', b'rw') | assert authedperm in (b'ro', b'rw') | ||||
| wirecommand = wireproto.commandsv2[command['command']] | wirecommand = COMMANDS[command['command']] | ||||
| assert wirecommand.permission in ('push', 'pull') | assert wirecommand.permission in ('push', 'pull') | ||||
| if authedperm == b'ro' and wirecommand.permission != 'pull': | if authedperm == b'ro' and wirecommand.permission != 'pull': | ||||
| # TODO proper error mechanism | # TODO proper error mechanism | ||||
| res.status = b'403 Forbidden' | res.status = b'403 Forbidden' | ||||
| res.headers[b'Content-Type'] = b'text/plain' | res.headers[b'Content-Type'] = b'text/plain' | ||||
| res.setbodybytes(_('insufficient permissions to execute ' | res.setbodybytes(_('insufficient permissions to execute ' | ||||
| 'command: %s') % command['command']) | 'command: %s') % command['command']) | ||||
| action) | action) | ||||
| def getdispatchrepo(repo, proto, command): | def getdispatchrepo(repo, proto, command): | ||||
| return repo.filtered('served') | return repo.filtered('served') | ||||
| def dispatch(repo, proto, command): | def dispatch(repo, proto, command): | ||||
| repo = getdispatchrepo(repo, proto, command) | repo = getdispatchrepo(repo, proto, command) | ||||
| func, spec = wireproto.commandsv2[command] | func, spec = COMMANDS[command] | ||||
| args = proto.getargs(spec) | args = proto.getargs(spec) | ||||
| return func(repo, proto, **args) | return func(repo, proto, **args) | ||||
| @zi.implementer(wireprototypes.baseprotocolhandler) | @zi.implementer(wireprototypes.baseprotocolhandler) | ||||
| class httpv2protocolhandler(object): | class httpv2protocolhandler(object): | ||||
| def __init__(self, req, ui, args=None): | def __init__(self, req, ui, args=None): | ||||
| self._req = req | self._req = req | ||||
| }) | }) | ||||
| caps = { | caps = { | ||||
| 'commands': {}, | 'commands': {}, | ||||
| 'compression': compression, | 'compression': compression, | ||||
| 'framingmediatypes': [FRAMINGTYPE], | 'framingmediatypes': [FRAMINGTYPE], | ||||
| } | } | ||||
| for command, entry in wireproto.commandsv2.items(): | for command, entry in COMMANDS.items(): | ||||
| caps['commands'][command] = { | caps['commands'][command] = { | ||||
| 'args': entry.args, | 'args': entry.args, | ||||
| 'permissions': [entry.permission], | 'permissions': [entry.permission], | ||||
| } | } | ||||
| if streamclone.allowservergeneration(repo): | if streamclone.allowservergeneration(repo): | ||||
| caps['rawrepoformats'] = sorted(repo.requirements & | caps['rawrepoformats'] = sorted(repo.requirements & | ||||
| repo.supportedformats) | repo.supportedformats) | ||||
| if args is None: | if args is None: | ||||
| args = {} | args = {} | ||||
| if not isinstance(args, dict): | if not isinstance(args, dict): | ||||
| raise error.ProgrammingError('arguments for version 2 commands ' | raise error.ProgrammingError('arguments for version 2 commands ' | ||||
| 'must be declared as dicts') | 'must be declared as dicts') | ||||
| def register(func): | def register(func): | ||||
| if name in wireproto.commandsv2: | if name in COMMANDS: | ||||
| raise error.ProgrammingError('%s command already registered ' | raise error.ProgrammingError('%s command already registered ' | ||||
| 'for version 2' % name) | 'for version 2' % name) | ||||
| wireproto.commandsv2[name] = wireprototypes.commandentry( | COMMANDS[name] = wireprototypes.commandentry( | ||||
| func, args=args, transports=transports, permission=permission) | func, args=args, transports=transports, permission=permission) | ||||
| return func | return func | ||||
| return register | return register | ||||
| @wireprotocommand('branchmap', permission='pull') | @wireprotocommand('branchmap', permission='pull') | ||||
| def branchmapv2(repo, proto): | def branchmapv2(repo, proto): | ||||