| yuja |
| hg-reviewers |
This is needed to prevent a cycle in an upcoming commit.
| Lint Skipped |
| Unit Tests Skipped |
| # Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net> | # Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net> | ||||
| # Copyright 2005-2007 Matt Mackall <mpm@selenic.com> | # Copyright 2005-2007 Matt Mackall <mpm@selenic.com> | ||||
| # | # | ||||
| # This software may be used and distributed according to the terms of the | # This software may be used and distributed according to the terms of the | ||||
| # GNU General Public License version 2 or any later version. | # GNU General Public License version 2 or any later version. | ||||
| from __future__ import absolute_import | from __future__ import absolute_import | ||||
| import abc | |||||
| import contextlib | import contextlib | ||||
| import struct | import struct | ||||
| import sys | import sys | ||||
| from .i18n import _ | from .i18n import _ | ||||
| from . import ( | from . import ( | ||||
| encoding, | encoding, | ||||
| error, | error, | ||||
| HGERRTYPE = 'application/hg-error' | HGERRTYPE = 'application/hg-error' | ||||
| # Names of the SSH protocol implementations. | # Names of the SSH protocol implementations. | ||||
| SSHV1 = 'ssh-v1' | SSHV1 = 'ssh-v1' | ||||
| # This is advertised over the wire. Incremental the counter at the end | # This is advertised over the wire. Incremental the counter at the end | ||||
| # to reflect BC breakages. | # to reflect BC breakages. | ||||
| SSHV2 = 'exp-ssh-v2-0001' | SSHV2 = 'exp-ssh-v2-0001' | ||||
| class baseprotocolhandler(object): | |||||
| """Abstract base class for wire protocol handlers. | |||||
| A wire protocol handler serves as an interface between protocol command | |||||
| handlers and the wire protocol transport layer. Protocol handlers provide | |||||
| methods to read command arguments, redirect stdio for the duration of | |||||
| the request, handle response types, etc. | |||||
| """ | |||||
| __metaclass__ = abc.ABCMeta | |||||
| @abc.abstractproperty | |||||
| def name(self): | |||||
| """The name of the protocol implementation. | |||||
| Used for uniquely identifying the transport type. | |||||
| """ | |||||
| @abc.abstractmethod | |||||
| def getargs(self, args): | |||||
| """return the value for arguments in <args> | |||||
| returns a list of values (same order as <args>)""" | |||||
| @abc.abstractmethod | |||||
| def forwardpayload(self, fp): | |||||
| """Read the raw payload and forward to a file. | |||||
| The payload is read in full before the function returns. | |||||
| """ | |||||
| @abc.abstractmethod | |||||
| def mayberedirectstdio(self): | |||||
| """Context manager to possibly redirect stdio. | |||||
| The context manager yields a file-object like object that receives | |||||
| stdout and stderr output when the context manager is active. Or it | |||||
| yields ``None`` if no I/O redirection occurs. | |||||
| The intent of this context manager is to capture stdio output | |||||
| so it may be sent in the response. Some transports support streaming | |||||
| stdio to the client in real time. For these transports, stdio output | |||||
| won't be captured. | |||||
| """ | |||||
| @abc.abstractmethod | |||||
| def client(self): | |||||
| """Returns a string representation of this client (as bytes).""" | |||||
| def decodevaluefromheaders(req, headerprefix): | def decodevaluefromheaders(req, headerprefix): | ||||
| """Decode a long value from multiple HTTP request headers. | """Decode a long value from multiple HTTP request headers. | ||||
| Returns the value as a bytes, not a str. | Returns the value as a bytes, not a str. | ||||
| """ | """ | ||||
| chunks = [] | chunks = [] | ||||
| i = 1 | i = 1 | ||||
| prefix = headerprefix.upper().replace(r'-', r'_') | prefix = headerprefix.upper().replace(r'-', r'_') | ||||
| while True: | while True: | ||||
| v = req.env.get(r'HTTP_%s_%d' % (prefix, i)) | v = req.env.get(r'HTTP_%s_%d' % (prefix, i)) | ||||
| if v is None: | if v is None: | ||||
| break | break | ||||
| chunks.append(pycompat.bytesurl(v)) | chunks.append(pycompat.bytesurl(v)) | ||||
| i += 1 | i += 1 | ||||
| return ''.join(chunks) | return ''.join(chunks) | ||||
| class httpv1protocolhandler(baseprotocolhandler): | class httpv1protocolhandler(wireprototypes.baseprotocolhandler): | ||||
| def __init__(self, req, ui): | def __init__(self, req, ui): | ||||
| self._req = req | self._req = req | ||||
| self._ui = ui | self._ui = ui | ||||
| @property | @property | ||||
| def name(self): | def name(self): | ||||
| return 'http-v1' | return 'http-v1' | ||||
| fout.flush() | fout.flush() | ||||
| def _sshv1respondooberror(fout, ferr, rsp): | def _sshv1respondooberror(fout, ferr, rsp): | ||||
| ferr.write(b'%s\n-\n' % rsp) | ferr.write(b'%s\n-\n' % rsp) | ||||
| ferr.flush() | ferr.flush() | ||||
| fout.write(b'\n') | fout.write(b'\n') | ||||
| fout.flush() | fout.flush() | ||||
| class sshv1protocolhandler(baseprotocolhandler): | class sshv1protocolhandler(wireprototypes.baseprotocolhandler): | ||||
| """Handler for requests services via version 1 of SSH protocol.""" | """Handler for requests services via version 1 of SSH protocol.""" | ||||
| def __init__(self, ui, fin, fout): | def __init__(self, ui, fin, fout): | ||||
| self._ui = ui | self._ui = ui | ||||
| self._fin = fin | self._fin = fin | ||||
| self._fout = fout | self._fout = fout | ||||
| @property | @property | ||||
| def name(self): | def name(self): | ||||
| # Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com> | # Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com> | ||||
| # | # | ||||
| # This software may be used and distributed according to the terms of the | # This software may be used and distributed according to the terms of the | ||||
| # GNU General Public License version 2 or any later version. | # GNU General Public License version 2 or any later version. | ||||
| from __future__ import absolute_import | from __future__ import absolute_import | ||||
| import abc | |||||
| class bytesresponse(object): | class bytesresponse(object): | ||||
| """A wire protocol response consisting of raw bytes.""" | """A wire protocol response consisting of raw bytes.""" | ||||
| def __init__(self, data): | def __init__(self, data): | ||||
| self.data = data | self.data = data | ||||
| class ooberror(object): | class ooberror(object): | ||||
| """wireproto reply: failure of a batch of operation | """wireproto reply: failure of a batch of operation | ||||
| Accepts a generator containing chunks of data to be sent to the client. | Accepts a generator containing chunks of data to be sent to the client. | ||||
| Like ``streamres``, but sends an uncompressed data for "version 1" clients | Like ``streamres``, but sends an uncompressed data for "version 1" clients | ||||
| using the application/mercurial-0.1 media type. | using the application/mercurial-0.1 media type. | ||||
| """ | """ | ||||
| def __init__(self, gen=None): | def __init__(self, gen=None): | ||||
| self.gen = gen | self.gen = gen | ||||
| class baseprotocolhandler(object): | |||||
| """Abstract base class for wire protocol handlers. | |||||
| A wire protocol handler serves as an interface between protocol command | |||||
| handlers and the wire protocol transport layer. Protocol handlers provide | |||||
| methods to read command arguments, redirect stdio for the duration of | |||||
| the request, handle response types, etc. | |||||
| """ | |||||
| __metaclass__ = abc.ABCMeta | |||||
| @abc.abstractproperty | |||||
| def name(self): | |||||
| """The name of the protocol implementation. | |||||
| Used for uniquely identifying the transport type. | |||||
| """ | |||||
| @abc.abstractmethod | |||||
| def getargs(self, args): | |||||
| """return the value for arguments in <args> | |||||
| returns a list of values (same order as <args>)""" | |||||
| @abc.abstractmethod | |||||
| def forwardpayload(self, fp): | |||||
| """Read the raw payload and forward to a file. | |||||
| The payload is read in full before the function returns. | |||||
| """ | |||||
| @abc.abstractmethod | |||||
| def mayberedirectstdio(self): | |||||
| """Context manager to possibly redirect stdio. | |||||
| The context manager yields a file-object like object that receives | |||||
| stdout and stderr output when the context manager is active. Or it | |||||
| yields ``None`` if no I/O redirection occurs. | |||||
| The intent of this context manager is to capture stdio output | |||||
| so it may be sent in the response. Some transports support streaming | |||||
| stdio to the client in real time. For these transports, stdio output | |||||
| won't be captured. | |||||
| """ | |||||
| @abc.abstractmethod | |||||
| def client(self): | |||||
| """Returns a string representation of this client (as bytes).""" | |||||