| durin42 |
| hg-reviewers |
These are shared across wire protocol implementations. wireprototypes
is our module for common code.
| Lint Skipped |
| Unit Tests Skipped |
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/wireproto.py (87 lines) | |||
| M | mercurial/wireprototypes.py (78 lines) | |||
| M | mercurial/wireprotov2server.py (2 lines) |
| if not compengines: | if not compengines: | ||||
| raise error.Abort(_('%s config option does not specify any known ' | raise error.Abort(_('%s config option does not specify any known ' | ||||
| 'compression engines') % config, | 'compression engines') % config, | ||||
| hint=_('usable compression engines: %s') % | hint=_('usable compression engines: %s') % | ||||
| ', '.sorted(validnames)) | ', '.sorted(validnames)) | ||||
| return compengines | return compengines | ||||
| class commandentry(object): | |||||
| """Represents a declared wire protocol command.""" | |||||
| def __init__(self, func, args='', transports=None, | |||||
| permission='push'): | |||||
| self.func = func | |||||
| self.args = args | |||||
| self.transports = transports or set() | |||||
| self.permission = permission | |||||
| def _merge(self, func, args): | |||||
| """Merge this instance with an incoming 2-tuple. | |||||
| This is called when a caller using the old 2-tuple API attempts | |||||
| to replace an instance. The incoming values are merged with | |||||
| data not captured by the 2-tuple and a new instance containing | |||||
| the union of the two objects is returned. | |||||
| """ | |||||
| return commandentry(func, args=args, transports=set(self.transports), | |||||
| permission=self.permission) | |||||
| # Old code treats instances as 2-tuples. So expose that interface. | |||||
| def __iter__(self): | |||||
| yield self.func | |||||
| yield self.args | |||||
| def __getitem__(self, i): | |||||
| if i == 0: | |||||
| return self.func | |||||
| elif i == 1: | |||||
| return self.args | |||||
| else: | |||||
| raise IndexError('can only access elements 0 and 1') | |||||
| class commanddict(dict): | |||||
| """Container for registered wire protocol commands. | |||||
| It behaves like a dict. But __setitem__ is overwritten to allow silent | |||||
| coercion of values from 2-tuples for API compatibility. | |||||
| """ | |||||
| def __setitem__(self, k, v): | |||||
| if isinstance(v, commandentry): | |||||
| pass | |||||
| # Cast 2-tuples to commandentry instances. | |||||
| elif isinstance(v, tuple): | |||||
| if len(v) != 2: | |||||
| raise ValueError('command tuples must have exactly 2 elements') | |||||
| # It is common for extensions to wrap wire protocol commands via | |||||
| # e.g. ``wireproto.commands[x] = (newfn, args)``. Because callers | |||||
| # doing this aren't aware of the new API that uses objects to store | |||||
| # command entries, we automatically merge old state with new. | |||||
| if k in self: | |||||
| v = self[k]._merge(v[0], v[1]) | |||||
| else: | |||||
| # Use default values from @wireprotocommand. | |||||
| v = commandentry(v[0], args=v[1], | |||||
| transports=set(wireprototypes.TRANSPORTS), | |||||
| permission='push') | |||||
| else: | |||||
| raise ValueError('command entries must be commandentry instances ' | |||||
| 'or 2-tuples') | |||||
| return super(commanddict, self).__setitem__(k, v) | |||||
| def commandavailable(self, command, proto): | |||||
| """Determine if a command is available for the requested protocol.""" | |||||
| assert proto.name in wireprototypes.TRANSPORTS | |||||
| entry = self.get(command) | |||||
| if not entry: | |||||
| return False | |||||
| if proto.name not in entry.transports: | |||||
| return False | |||||
| return True | |||||
| # For version 1 transports. | # For version 1 transports. | ||||
| commands = commanddict() | commands = wireprototypes.commanddict() | ||||
| # For version 2 transports. | # For version 2 transports. | ||||
| commandsv2 = commanddict() | 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 | ||||
| if not isinstance(args, bytes): | if not isinstance(args, bytes): | ||||
| raise error.ProgrammingError('arguments for version 1 commands ' | raise error.ProgrammingError('arguments for version 1 commands ' | ||||
| 'must be declared as bytes') | 'must be declared as bytes') | ||||
| def register(func): | def register(func): | ||||
| if name in commands: | if name in commands: | ||||
| raise error.ProgrammingError('%s command already registered ' | raise error.ProgrammingError('%s command already registered ' | ||||
| 'for version 1' % name) | 'for version 1' % name) | ||||
| commands[name] = commandentry(func, args=args, | commands[name] = wireprototypes.commandentry( | ||||
| transports=transports, | func, args=args, transports=transports, permission=permission) | ||||
| permission=permission) | |||||
| return func | return func | ||||
| return register | return register | ||||
| # TODO define a more appropriate permissions type to use for this. | # TODO define a more appropriate permissions type to use for this. | ||||
| @wireprotocommand('batch', 'cmds *', permission='pull') | @wireprotocommand('batch', 'cmds *', permission='pull') | ||||
| def batch(repo, proto, cmds, others): | def batch(repo, proto, cmds, others): | ||||
| unescapearg = wireprototypes.unescapebatcharg | unescapearg = wireprototypes.unescapebatcharg | ||||
| def checkperm(perm): | def checkperm(perm): | ||||
| """Validate that the client has permissions to perform a request. | """Validate that the client has permissions to perform a request. | ||||
| The argument is the permission required to proceed. If the client | The argument is the permission required to proceed. If the client | ||||
| doesn't have that permission, the exception should raise or abort | doesn't have that permission, the exception should raise or abort | ||||
| in a protocol specific manner. | in a protocol specific manner. | ||||
| """ | """ | ||||
| class commandentry(object): | |||||
| """Represents a declared wire protocol command.""" | |||||
| def __init__(self, func, args='', transports=None, | |||||
| permission='push'): | |||||
| self.func = func | |||||
| self.args = args | |||||
| self.transports = transports or set() | |||||
| self.permission = permission | |||||
| def _merge(self, func, args): | |||||
| """Merge this instance with an incoming 2-tuple. | |||||
| This is called when a caller using the old 2-tuple API attempts | |||||
| to replace an instance. The incoming values are merged with | |||||
| data not captured by the 2-tuple and a new instance containing | |||||
| the union of the two objects is returned. | |||||
| """ | |||||
| return commandentry(func, args=args, transports=set(self.transports), | |||||
| permission=self.permission) | |||||
| # Old code treats instances as 2-tuples. So expose that interface. | |||||
| def __iter__(self): | |||||
| yield self.func | |||||
| yield self.args | |||||
| def __getitem__(self, i): | |||||
| if i == 0: | |||||
| return self.func | |||||
| elif i == 1: | |||||
| return self.args | |||||
| else: | |||||
| raise IndexError('can only access elements 0 and 1') | |||||
| class commanddict(dict): | |||||
| """Container for registered wire protocol commands. | |||||
| It behaves like a dict. But __setitem__ is overwritten to allow silent | |||||
| coercion of values from 2-tuples for API compatibility. | |||||
| """ | |||||
| def __setitem__(self, k, v): | |||||
| if isinstance(v, commandentry): | |||||
| pass | |||||
| # Cast 2-tuples to commandentry instances. | |||||
| elif isinstance(v, tuple): | |||||
| if len(v) != 2: | |||||
| raise ValueError('command tuples must have exactly 2 elements') | |||||
| # It is common for extensions to wrap wire protocol commands via | |||||
| # e.g. ``wireproto.commands[x] = (newfn, args)``. Because callers | |||||
| # doing this aren't aware of the new API that uses objects to store | |||||
| # command entries, we automatically merge old state with new. | |||||
| if k in self: | |||||
| v = self[k]._merge(v[0], v[1]) | |||||
| else: | |||||
| # Use default values from @wireprotocommand. | |||||
| v = commandentry(v[0], args=v[1], | |||||
| transports=set(TRANSPORTS), | |||||
| permission='push') | |||||
| else: | |||||
| raise ValueError('command entries must be commandentry instances ' | |||||
| 'or 2-tuples') | |||||
| return super(commanddict, self).__setitem__(k, v) | |||||
| def commandavailable(self, command, proto): | |||||
| """Determine if a command is available for the requested protocol.""" | |||||
| assert proto.name in TRANSPORTS | |||||
| entry = self.get(command) | |||||
| if not entry: | |||||
| return False | |||||
| if proto.name not in entry.transports: | |||||
| return False | |||||
| return True | |||||
| 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 wireproto.commandsv2: | ||||
| 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] = wireproto.commandentry( | wireproto.commandsv2[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): | ||||