| durin42 |
| hg-reviewers |
We'll be introducing more types as part of wire protocol version 2.
These types are shared between the command handling code (in
wireproto.py) and the protocol/transport code in wireprotoserver.py.
So they need to go in a new module to prevent a cycle.
The types are aliased into the wireproto module, so API compatibility
is preserved.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
In D2088#36287, @durin42 wrote:I wonder if these should move to being attrs-generated at some point.
Probably. I'm half considering blowing up all these types because they are... not well-defined and behavior is overloaded. I'll definitely be creating new types for version 2 of the wire protocol. I'm waiting on that code to come into existence before touching these types because I'm not yet sure how everything will pan out.
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/wireproto.py (61 lines) | |||
| M | mercurial/wireprotoserver.py (21 lines) | |||
| A | M | mercurial/wireprototypes.py (61 lines) |
| error, | error, | ||||
| exchange, | exchange, | ||||
| peer, | peer, | ||||
| pushkey as pushkeymod, | pushkey as pushkeymod, | ||||
| pycompat, | pycompat, | ||||
| repository, | repository, | ||||
| streamclone, | streamclone, | ||||
| util, | util, | ||||
| wireprototypes, | |||||
| ) | ) | ||||
| urlerr = util.urlerr | urlerr = util.urlerr | ||||
| urlreq = util.urlreq | urlreq = util.urlreq | ||||
| ooberror = wireprototypes.ooberror | |||||
| pushres = wireprototypes.pushres | |||||
| pusherr = wireprototypes.pusherr | |||||
| streamres = wireprototypes.streamres | |||||
| streamres_legacy = wireprototypes.streamreslegacy | |||||
| bundle2requiredmain = _('incompatible Mercurial client; bundle2 required') | bundle2requiredmain = _('incompatible Mercurial client; bundle2 required') | ||||
| bundle2requiredhint = _('see https://www.mercurial-scm.org/wiki/' | bundle2requiredhint = _('see https://www.mercurial-scm.org/wiki/' | ||||
| 'IncompatibleClient') | 'IncompatibleClient') | ||||
| bundle2required = '%s\n(%s)\n' % (bundle2requiredmain, bundle2requiredhint) | bundle2required = '%s\n(%s)\n' % (bundle2requiredmain, bundle2requiredhint) | ||||
| class remoteiterbatcher(peer.iterbatcher): | class remoteiterbatcher(peer.iterbatcher): | ||||
| def __init__(self, remote): | def __init__(self, remote): | ||||
| super(remoteiterbatcher, self).__init__() | super(remoteiterbatcher, self).__init__() | ||||
| def _abort(self, exception): | def _abort(self, exception): | ||||
| """clearly abort the wire protocol connection and raise the exception | """clearly abort the wire protocol connection and raise the exception | ||||
| """ | """ | ||||
| raise NotImplementedError() | raise NotImplementedError() | ||||
| # server side | # server side | ||||
| # wire protocol command can either return a string or one of these classes. | # wire protocol command can either return a string or one of these classes. | ||||
| class streamres(object): | |||||
| """wireproto reply: binary stream | |||||
| The call was successful and the result is a stream. | |||||
| Accepts a generator containing chunks of data to be sent to the client. | |||||
| ``prefer_uncompressed`` indicates that the data is expected to be | |||||
| uncompressable and that the stream should therefore use the ``none`` | |||||
| engine. | |||||
| """ | |||||
| def __init__(self, gen=None, prefer_uncompressed=False): | |||||
| self.gen = gen | |||||
| self.prefer_uncompressed = prefer_uncompressed | |||||
| class streamres_legacy(object): | |||||
| """wireproto reply: uncompressed binary stream | |||||
| The call was successful and the result is a stream. | |||||
| Accepts a generator containing chunks of data to be sent to the client. | |||||
| Like ``streamres``, but sends an uncompressed data for "version 1" clients | |||||
| using the application/mercurial-0.1 media type. | |||||
| """ | |||||
| def __init__(self, gen=None): | |||||
| self.gen = gen | |||||
| class pushres(object): | |||||
| """wireproto reply: success with simple integer return | |||||
| The call was successful and returned an integer contained in `self.res`. | |||||
| """ | |||||
| def __init__(self, res, output): | |||||
| self.res = res | |||||
| self.output = output | |||||
| class pusherr(object): | |||||
| """wireproto reply: failure | |||||
| The call failed. The `self.res` attribute contains the error message. | |||||
| """ | |||||
| def __init__(self, res, output): | |||||
| self.res = res | |||||
| self.output = output | |||||
| class ooberror(object): | |||||
| """wireproto reply: failure of a batch of operation | |||||
| Something failed during a batch call. The error message is stored in | |||||
| `self.message`. | |||||
| """ | |||||
| def __init__(self, message): | |||||
| self.message = message | |||||
| def getdispatchrepo(repo, proto, command): | def getdispatchrepo(repo, proto, command): | ||||
| """Obtain the repo used for processing wire protocol commands. | """Obtain the repo used for processing wire protocol commands. | ||||
| The intent of this function is to serve as a monkeypatch point for | The intent of this function is to serve as a monkeypatch point for | ||||
| extensions that need commands to operate on different repo views under | extensions that need commands to operate on different repo views under | ||||
| specialized circumstances. | specialized circumstances. | ||||
| """ | """ | ||||
| from .i18n import _ | from .i18n import _ | ||||
| from . import ( | from . import ( | ||||
| encoding, | encoding, | ||||
| error, | error, | ||||
| hook, | hook, | ||||
| pycompat, | pycompat, | ||||
| util, | util, | ||||
| wireproto, | wireproto, | ||||
| wireprototypes, | |||||
| ) | ) | ||||
| stringio = util.stringio | stringio = util.stringio | ||||
| urlerr = util.urlerr | urlerr = util.urlerr | ||||
| urlreq = util.urlreq | urlreq = util.urlreq | ||||
| HTTP_OK = 200 | HTTP_OK = 200 | ||||
| req.respond(HTTP_OK, HGERRTYPE, | req.respond(HTTP_OK, HGERRTYPE, | ||||
| body=_('requested wire protocol command is not available ' | body=_('requested wire protocol command is not available ' | ||||
| 'over HTTP')) | 'over HTTP')) | ||||
| return [] | return [] | ||||
| if isinstance(rsp, bytes): | if isinstance(rsp, bytes): | ||||
| req.respond(HTTP_OK, HGTYPE, body=rsp) | req.respond(HTTP_OK, HGTYPE, body=rsp) | ||||
| return [] | return [] | ||||
| elif isinstance(rsp, wireproto.streamres_legacy): | elif isinstance(rsp, wireprototypes.streamreslegacy): | ||||
| gen = rsp.gen | gen = rsp.gen | ||||
| req.respond(HTTP_OK, HGTYPE) | req.respond(HTTP_OK, HGTYPE) | ||||
| return gen | return gen | ||||
| elif isinstance(rsp, wireproto.streamres): | elif isinstance(rsp, wireprototypes.streamres): | ||||
| gen = rsp.gen | gen = rsp.gen | ||||
| # This code for compression should not be streamres specific. It | # This code for compression should not be streamres specific. It | ||||
| # is here because we only compress streamres at the moment. | # is here because we only compress streamres at the moment. | ||||
| mediatype, engine, engineopts = _httpresponsetype( | mediatype, engine, engineopts = _httpresponsetype( | ||||
| repo.ui, req, rsp.prefer_uncompressed) | repo.ui, req, rsp.prefer_uncompressed) | ||||
| gen = engine.compressstream(gen, engineopts) | gen = engine.compressstream(gen, engineopts) | ||||
| if mediatype == HGTYPE2: | if mediatype == HGTYPE2: | ||||
| gen = genversion2(gen, engine, engineopts) | gen = genversion2(gen, engine, engineopts) | ||||
| req.respond(HTTP_OK, mediatype) | req.respond(HTTP_OK, mediatype) | ||||
| return gen | return gen | ||||
| elif isinstance(rsp, wireproto.pushres): | elif isinstance(rsp, wireprototypes.pushres): | ||||
| rsp = '%d\n%s' % (rsp.res, rsp.output) | rsp = '%d\n%s' % (rsp.res, rsp.output) | ||||
| req.respond(HTTP_OK, HGTYPE, body=rsp) | req.respond(HTTP_OK, HGTYPE, body=rsp) | ||||
| return [] | return [] | ||||
| elif isinstance(rsp, wireproto.pusherr): | elif isinstance(rsp, wireprototypes.pusherr): | ||||
| # This is the httplib workaround documented in _handlehttperror(). | # This is the httplib workaround documented in _handlehttperror(). | ||||
| req.drain() | req.drain() | ||||
| rsp = '0\n%s\n' % rsp.res | rsp = '0\n%s\n' % rsp.res | ||||
| req.respond(HTTP_OK, HGTYPE, body=rsp) | req.respond(HTTP_OK, HGTYPE, body=rsp) | ||||
| return [] | return [] | ||||
| elif isinstance(rsp, wireproto.ooberror): | elif isinstance(rsp, wireprototypes.ooberror): | ||||
| rsp = rsp.message | rsp = rsp.message | ||||
| req.respond(HTTP_OK, HGERRTYPE, body=rsp) | req.respond(HTTP_OK, HGERRTYPE, body=rsp) | ||||
| return [] | return [] | ||||
| raise error.ProgrammingError('hgweb.protocol internal failure', rsp) | raise error.ProgrammingError('hgweb.protocol internal failure', rsp) | ||||
| def _handlehttperror(e, req, cmd): | def _handlehttperror(e, req, cmd): | ||||
| """Called when an ErrorResponse is raised during HTTP request processing.""" | """Called when an ErrorResponse is raised during HTTP request processing.""" | ||||
| def serve_one(self): | def serve_one(self): | ||||
| cmd = self._fin.readline()[:-1] | cmd = self._fin.readline()[:-1] | ||||
| if cmd and wireproto.commands.commandavailable(cmd, self._proto): | if cmd and wireproto.commands.commandavailable(cmd, self._proto): | ||||
| rsp = wireproto.dispatch(self._repo, self._proto, cmd) | rsp = wireproto.dispatch(self._repo, self._proto, cmd) | ||||
| if isinstance(rsp, bytes): | if isinstance(rsp, bytes): | ||||
| _sshv1respondbytes(self._fout, rsp) | _sshv1respondbytes(self._fout, rsp) | ||||
| elif isinstance(rsp, wireproto.streamres): | elif isinstance(rsp, wireprototypes.streamres): | ||||
| _sshv1respondstream(self._fout, rsp) | _sshv1respondstream(self._fout, rsp) | ||||
| elif isinstance(rsp, wireproto.streamres_legacy): | elif isinstance(rsp, wireprototypes.streamreslegacy): | ||||
| _sshv1respondstream(self._fout, rsp) | _sshv1respondstream(self._fout, rsp) | ||||
| elif isinstance(rsp, wireproto.pushres): | elif isinstance(rsp, wireprototypes.pushres): | ||||
| _sshv1respondbytes(self._fout, b'') | _sshv1respondbytes(self._fout, b'') | ||||
| _sshv1respondbytes(self._fout, bytes(rsp.res)) | _sshv1respondbytes(self._fout, bytes(rsp.res)) | ||||
| elif isinstance(rsp, wireproto.pusherr): | elif isinstance(rsp, wireprototypes.pusherr): | ||||
| _sshv1respondbytes(self._fout, rsp.res) | _sshv1respondbytes(self._fout, rsp.res) | ||||
| elif isinstance(rsp, wireproto.ooberror): | elif isinstance(rsp, wireprototypes.ooberror): | ||||
| _sshv1respondooberror(self._fout, self._ui.ferr, rsp.message) | _sshv1respondooberror(self._fout, self._ui.ferr, rsp.message) | ||||
| else: | else: | ||||
| raise error.ProgrammingError('unhandled response type from ' | raise error.ProgrammingError('unhandled response type from ' | ||||
| 'wire protocol command: %s' % rsp) | 'wire protocol command: %s' % rsp) | ||||
| elif cmd: | elif cmd: | ||||
| _sshv1respondbytes(self._fout, b'') | _sshv1respondbytes(self._fout, b'') | ||||
| return cmd != '' | return cmd != '' | ||||
| # Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com> | |||||
| # | |||||
| # This software may be used and distributed according to the terms of the | |||||
| # GNU General Public License version 2 or any later version. | |||||
| from __future__ import absolute_import | |||||
| class ooberror(object): | |||||
| """wireproto reply: failure of a batch of operation | |||||
| Something failed during a batch call. The error message is stored in | |||||
| `self.message`. | |||||
| """ | |||||
| def __init__(self, message): | |||||
| self.message = message | |||||
| class pushres(object): | |||||
| """wireproto reply: success with simple integer return | |||||
| The call was successful and returned an integer contained in `self.res`. | |||||
| """ | |||||
| def __init__(self, res, output): | |||||
| self.res = res | |||||
| self.output = output | |||||
| class pusherr(object): | |||||
| """wireproto reply: failure | |||||
| The call failed. The `self.res` attribute contains the error message. | |||||
| """ | |||||
| def __init__(self, res, output): | |||||
| self.res = res | |||||
| self.output = output | |||||
| class streamres(object): | |||||
| """wireproto reply: binary stream | |||||
| The call was successful and the result is a stream. | |||||
| Accepts a generator containing chunks of data to be sent to the client. | |||||
| ``prefer_uncompressed`` indicates that the data is expected to be | |||||
| uncompressable and that the stream should therefore use the ``none`` | |||||
| engine. | |||||
| """ | |||||
| def __init__(self, gen=None, prefer_uncompressed=False): | |||||
| self.gen = gen | |||||
| self.prefer_uncompressed = prefer_uncompressed | |||||
| class streamreslegacy(object): | |||||
| """wireproto reply: uncompressed binary stream | |||||
| The call was successful and the result is a stream. | |||||
| Accepts a generator containing chunks of data to be sent to the client. | |||||
| Like ``streamres``, but sends an uncompressed data for "version 1" clients | |||||
| using the application/mercurial-0.1 media type. | |||||
| """ | |||||
| def __init__(self, gen=None): | |||||
| self.gen = gen | |||||