mercurial-scm/hg-stable: mercurial/wireprotoserver.py annotate

annotate mercurial/wireprotoserver.py @ 37049:1cfef5693203

wireproto: support /api/* URL space for exposing APIs I will soon be introducing a new version of the HTTP wire protocol. One of the things I want to change with it is the URL routing. I want to rely on URL paths to define endpoints rather than the "cmd" query string argument. That should be pretty straightforward. I was thinking about what URL space to reserve for the new protocol. We /could/ put everything at a top-level path. e.g. /wireproto/* or /http-v2-wireproto/*. However, these constrain us a bit because they assume there will only be 1 API: version 2 of the HTTP wire protocol. I think there is room to grow multiple APIs. For example, there may someday be a proper JSON API to query or even manipulate the repository. And I don't think we should have to create a new top-level URL space for each API nor should we attempt to shoehorn each future API into the same shared URL space: that would just be too chaotic. This commits reserves the /api/* URL space for all our future API needs. Essentially, all requests to /api/* get routed to a new WSGI handler. By default, it 404's the entire URL space unless the "api server" feature is enabled. When enabled, requests to "/api" list available APIs. URLs of the form /api/<name>/* are reserved for a particular named API. Behavior within each API is left up to that API. So, we can grow new APIs easily without worrying about URL space conflicts. APIs can be registered by adding entries to a global dict. This allows extensions to provide their own APIs should they choose to do so. This is probably a premature feature. But IMO the code is easier to read if we're not dealing with API-specific behavior like config option querying inline. To prove it works, we implement a very basic API for version 2 of the HTTP wire protocol. It does nothing of value except facilitate testing of the /api/* URL space. We currently emit plain text responses for all /api/* endpoints. There's definitely room to look at Accept and other request headers to vary the response format. But we have to start somewhere. Differential Revision: https://phab.mercurial-scm.org/D2834

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Tue, 13 Mar 2018 16:53:21 -0700
parents	02bea04b4c54
children	fddcb51b5084

rev	line source
5598 d534ba1c4eb4 separate the wire protocol commands from the user interface commands Dirkjan Ochtman <dirkjan@ochtman.nl> parents: diff changeset	1 # Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net>
d534ba1c4eb4 separate the wire protocol commands from the user interface commands Dirkjan Ochtman <dirkjan@ochtman.nl> parents: diff changeset	2 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
d534ba1c4eb4 separate the wire protocol commands from the user interface commands Dirkjan Ochtman <dirkjan@ochtman.nl> parents: diff changeset	3 #
8225 46293a0c7e9f updated license to be explicit about GPL version 2 Martin Geisler <mg@lazybytes.net> parents: 8109 diff changeset	4 # This software may be used and distributed according to the terms of the
10263 25e572394f5c Update license to GPLv2+ Matt Mackall <mpm@selenic.com> parents: 9713 diff changeset	5 # GNU General Public License version 2 or any later version.
5598 d534ba1c4eb4 separate the wire protocol commands from the user interface commands Dirkjan Ochtman <dirkjan@ochtman.nl> parents: diff changeset	6
27046 37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 20903 diff changeset	7 from __future__ import absolute_import
37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 20903 diff changeset	8
36104 2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	9 import contextlib
30764 e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	10 import struct
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	11 import sys
36552 e7411fb7ba7f wireprotoserver: ability to run an SSH server until an event is set Gregory Szorc <gregory.szorc@gmail.com> parents: 36403 diff changeset	12 import threading
27046 37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 20903 diff changeset	13
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	14 from .i18n import _
35896 ef3a24a023ec wireprotoserver: rename hgweb.protocol to wireprotoserver (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35750 diff changeset	15 from . import (
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	16 encoding,
34509 e21f274cccea hgweb: in protocol adapter, avoid control reaching end of non-void function Augie Fackler <augie@google.com> parents: 33842 diff changeset	17 error,
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	18 hook,
34742 5a9cad0dfddb hgweb: when unpacking args from request form, convert to bytes Augie Fackler <augie@google.com> parents: 34740 diff changeset	19 pycompat,
27046 37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 20903 diff changeset	20 util,
37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 20903 diff changeset	21 wireproto,
36111 cd6ab329c5c7 wireprototypes: move wire protocol response types to new module Gregory Szorc <gregory.szorc@gmail.com> parents: 36110 diff changeset	22 wireprototypes,
27046 37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 20903 diff changeset	23 )
35896 ef3a24a023ec wireprotoserver: rename hgweb.protocol to wireprotoserver (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35750 diff changeset	24
28861 86db5cb55d46 pycompat: switch to util.stringio for py3 compat timeless <timeless@mozdev.org> parents: 28530 diff changeset	25 stringio = util.stringio
5963 5be210afe1b8 hgweb: explicitly check if requested command exists Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 5915 diff changeset	26
28883 032c4c2f802a pycompat: switch to util.urlreq/util.urlerr for py3 compat timeless <timeless@mozdev.org> parents: 28861 diff changeset	27 urlerr = util.urlerr
032c4c2f802a pycompat: switch to util.urlreq/util.urlerr for py3 compat timeless <timeless@mozdev.org> parents: 28861 diff changeset	28 urlreq = util.urlreq
032c4c2f802a pycompat: switch to util.urlreq/util.urlerr for py3 compat timeless <timeless@mozdev.org> parents: 28861 diff changeset	29
35898 1b76a9e0a9de wireprotoserver: don't import symbol from hgweb.common Gregory Szorc <gregory.szorc@gmail.com> parents: 35897 diff changeset	30 HTTP_OK = 200
1b76a9e0a9de wireprotoserver: don't import symbol from hgweb.common Gregory Szorc <gregory.szorc@gmail.com> parents: 35897 diff changeset	31
5993 948a41e77902 hgweb: explicit response status Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 5963 diff changeset	32 HGTYPE = 'application/mercurial-0.1'
30764 e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	33 HGTYPE2 = 'application/mercurial-0.2'
15017 f4522df38c65 wireproto: add out-of-band error class to allow remote repo to report errors Andrew Pritchard <andrewp@fogcreek.com> parents: 14614 diff changeset	34 HGERRTYPE = 'application/hg-error'
11595 368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	35
37049 1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	36 HTTPV2 = wireprototypes.HTTPV2
36565 3cd245945ef3 wireprotoserver: move SSHV1 and SSHV2 constants to wireprototypes Gregory Szorc <gregory.szorc@gmail.com> parents: 36555 diff changeset	37 SSHV1 = wireprototypes.SSHV1
3cd245945ef3 wireprotoserver: move SSHV1 and SSHV2 constants to wireprototypes Gregory Szorc <gregory.szorc@gmail.com> parents: 36555 diff changeset	38 SSHV2 = wireprototypes.SSHV2
36015 48a3a9283f09 sshpeer: initial definition and implementation of new SSH protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 35940 diff changeset	39
36852 14f70c44af6c wireprotoserver: access headers through parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36821 diff changeset	40 def decodevaluefromheaders(req, headerprefix):
34744 0a2ef612ad50 hgweb: fix decodevaluefromheaders to always return a bytes value Augie Fackler <augie@google.com> parents: 34743 diff changeset	41 """Decode a long value from multiple HTTP request headers.
0a2ef612ad50 hgweb: fix decodevaluefromheaders to always return a bytes value Augie Fackler <augie@google.com> parents: 34743 diff changeset	42
0a2ef612ad50 hgweb: fix decodevaluefromheaders to always return a bytes value Augie Fackler <augie@google.com> parents: 34743 diff changeset	43 Returns the value as a bytes, not a str.
0a2ef612ad50 hgweb: fix decodevaluefromheaders to always return a bytes value Augie Fackler <augie@google.com> parents: 34743 diff changeset	44 """
30759 3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	45 chunks = []
3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	46 i = 1
3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	47 while True:
36852 14f70c44af6c wireprotoserver: access headers through parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36821 diff changeset	48 v = req.headers.get(b'%s-%d' % (headerprefix, i))
30759 3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	49 if v is None:
3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	50 break
34744 0a2ef612ad50 hgweb: fix decodevaluefromheaders to always return a bytes value Augie Fackler <augie@google.com> parents: 34743 diff changeset	51 chunks.append(pycompat.bytesurl(v))
30759 3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	52 i += 1
3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	53
3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	54 return ''.join(chunks)
3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	55
36402 0c231df1ffdc wireprototypes: move baseprotocolhandler from wireprotoserver Gregory Szorc <gregory.szorc@gmail.com> parents: 36313 diff changeset	56 class httpv1protocolhandler(wireprototypes.baseprotocolhandler):
36873 a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36868 diff changeset	57 def __init__(self, req, ui, checkperm):
36852 14f70c44af6c wireprotoserver: access headers through parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36821 diff changeset	58 self._req = req
35906 d747cf39cf70 wireprotoserver: make attributes private Gregory Szorc <gregory.szorc@gmail.com> parents: 35905 diff changeset	59 self._ui = ui
36809 66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	60 self._checkperm = checkperm
35913 29759c46aa1a wireprotoserver: make name part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 35912 diff changeset	61
29759c46aa1a wireprotoserver: make name part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 35912 diff changeset	62 @property
29759c46aa1a wireprotoserver: make name part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 35912 diff changeset	63 def name(self):
36261 2e07dc514073 wireprotoserver: add version to HTTP protocol name (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36260 diff changeset	64 return 'http-v1'
30567 b3a9ef3d30e8 protocol: declare transport protocol name Gregory Szorc <gregory.szorc@gmail.com> parents: 30475 diff changeset	65
11595 368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	66 def getargs(self, args):
14093 ce99d887585f httprepo: long arguments support (issue2126) Steven Brown <StevenGBrown@gmail.com> parents: 13721 diff changeset	67 knownargs = self._args()
11595 368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	68 data = {}
368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	69 keys = args.split()
368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	70 for k in keys:
368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	71 if k == '*':
368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	72 star = {}
14093 ce99d887585f httprepo: long arguments support (issue2126) Steven Brown <StevenGBrown@gmail.com> parents: 13721 diff changeset	73 for key in knownargs.keys():
13721 3458c15ab2f0 wireproto: fix handling of '' args for HTTP and SSH Peter Arrenbrecht <peter.arrenbrecht@gmail.com>* parents: 12704 diff changeset	74 if key != 'cmd' and key not in keys:
14093 ce99d887585f httprepo: long arguments support (issue2126) Steven Brown <StevenGBrown@gmail.com> parents: 13721 diff changeset	75 star[key] = knownargs[key][0]
11595 368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	76 data['*'] = star
368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	77 else:
14093 ce99d887585f httprepo: long arguments support (issue2126) Steven Brown <StevenGBrown@gmail.com> parents: 13721 diff changeset	78 data[k] = knownargs[k][0]
11595 368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	79 return [data[k] for k in keys]
35903 49426bb4476c wireprotoserver: add some blank lines between methods Gregory Szorc <gregory.szorc@gmail.com> parents: 35900 diff changeset	80
14093 ce99d887585f httprepo: long arguments support (issue2126) Steven Brown <StevenGBrown@gmail.com> parents: 13721 diff changeset	81 def _args(self):
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	82 args = self._req.qsparams.asdictoflists()
36852 14f70c44af6c wireprotoserver: access headers through parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36821 diff changeset	83 postlen = int(self._req.headers.get(b'X-HgArgs-Post', 0))
28530 fd2acc5046f6 http: support sending hgargs via POST body instead of in GET or headers Augie Fackler <augie@google.com> parents: 27046 diff changeset	84 if postlen:
36115 a3d42d1865f1 wireprotoserver: define and use parse_qs from urllib Gregory Szorc <gregory.szorc@gmail.com> parents: 36113 diff changeset	85 args.update(urlreq.parseqs(
36863 da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36861 diff changeset	86 self._req.bodyfh.read(postlen), keep_blank_values=True))
28530 fd2acc5046f6 http: support sending hgargs via POST body instead of in GET or headers Augie Fackler <augie@google.com> parents: 27046 diff changeset	87 return args
30759 3f5f0c98cd18 httppeer: extract code for HTTP header spanning Gregory Szorc <gregory.szorc@gmail.com> parents: 30567 diff changeset	88
36852 14f70c44af6c wireprotoserver: access headers through parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36821 diff changeset	89 argvalue = decodevaluefromheaders(self._req, b'X-HgArg')
36115 a3d42d1865f1 wireprotoserver: define and use parse_qs from urllib Gregory Szorc <gregory.szorc@gmail.com> parents: 36113 diff changeset	90 args.update(urlreq.parseqs(argvalue, keep_blank_values=True))
14093 ce99d887585f httprepo: long arguments support (issue2126) Steven Brown <StevenGBrown@gmail.com> parents: 13721 diff changeset	91 return args
35903 49426bb4476c wireprotoserver: add some blank lines between methods Gregory Szorc <gregory.szorc@gmail.com> parents: 35900 diff changeset	92
36108 90ca4986616c wireprotoserver: rename getfile() to forwardpayload() (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36107 diff changeset	93 def forwardpayload(self, fp):
36853 ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36852 diff changeset	94 # Existing clients always send Content-Length.
ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36852 diff changeset	95 length = int(self._req.headers[b'Content-Length'])
ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36852 diff changeset	96
33842 3c91cc0c5fde httppeer: add support for httppostargs when we're sending a file Augie Fackler <augie@google.com> parents: 33228 diff changeset	97 # If httppostargs is used, we need to read Content-Length
3c91cc0c5fde httppeer: add support for httppostargs when we're sending a file Augie Fackler <augie@google.com> parents: 33228 diff changeset	98 # minus the amount that was consumed by args.
36852 14f70c44af6c wireprotoserver: access headers through parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36821 diff changeset	99 length -= int(self._req.headers.get(b'X-HgArgs-Post', 0))
36863 da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36861 diff changeset	100 for s in util.filechunkiter(self._req.bodyfh, limit=length):
11621 e46a8b2331a6 protocol: shuffle server methods to group send methods Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 11618 diff changeset	101 fp.write(s)
35903 49426bb4476c wireprotoserver: add some blank lines between methods Gregory Szorc <gregory.szorc@gmail.com> parents: 35900 diff changeset	102
36104 2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	103 @contextlib.contextmanager
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	104 def mayberedirectstdio(self):
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	105 oldout = self._ui.fout
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	106 olderr = self._ui.ferr
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	107
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	108 out = util.stringio()
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	109
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	110 try:
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	111 self._ui.fout = out
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	112 self._ui.ferr = out
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	113 yield out
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	114 finally:
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	115 self._ui.fout = oldout
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	116 self._ui.ferr = olderr
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	117
36107 957e773614d0 wireprotoserver: rename _client to client (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36106 diff changeset	118 def client(self):
11595 368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	119 return 'remote:%s:%s:%s' % (
36873 a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36868 diff changeset	120 self._req.urlscheme,
a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36868 diff changeset	121 urlreq.quote(self._req.remotehost or ''),
a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36868 diff changeset	122 urlreq.quote(self._req.remoteuser or ''))
11595 368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	123
36642 6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	124 def addcapabilities(self, repo, caps):
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	125 caps.append('httpheader=%d' %
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	126 repo.ui.configint('server', 'maxhttpheaderlen'))
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	127 if repo.ui.configbool('experimental', 'httppostargs'):
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	128 caps.append('httppostargs')
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	129
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	130 # FUTURE advertise 0.2rx once support is implemented
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	131 # FUTURE advertise minrx and mintx after consulting config option
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	132 caps.append('httpmediatype=0.1rx,0.1tx,0.2tx')
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	133
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	134 compengines = wireproto.supportedcompengines(repo.ui, util.SERVERROLE)
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	135 if compengines:
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	136 comptypes = ','.join(urlreq.quote(e.wireprotosupport().name)
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	137 for e in compengines)
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	138 caps.append('compression=%s' % comptypes)
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	139
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	140 return caps
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	141
36809 66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	142 def checkperm(self, perm):
66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	143 return self._checkperm(perm)
66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	144
36269 72812ad205d1 wireprotoserver: return to using iscmd() method Augie Fackler <augie@google.com> parents: 36261 diff changeset	145 # This method exists mostly so that extensions like remotefilelog can
72812ad205d1 wireprotoserver: return to using iscmd() method Augie Fackler <augie@google.com> parents: 36261 diff changeset	146 # disable a kludgey legacy method only over http. As of early 2018,
72812ad205d1 wireprotoserver: return to using iscmd() method Augie Fackler <augie@google.com> parents: 36261 diff changeset	147 # there are no other known users, so with any luck we can discard this
72812ad205d1 wireprotoserver: return to using iscmd() method Augie Fackler <augie@google.com> parents: 36261 diff changeset	148 # hook if remotefilelog becomes a first-party extension.
11595 368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	149 def iscmd(cmd):
368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	150 return cmd in wireproto.commands
368cd5325348 protocol: move hgweb protocol support back into protocol.py Matt Mackall <mpm@selenic.com> parents: 11594 diff changeset	151
36883 02bea04b4c54 hgweb: transition permissions hooks to modern request type (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36873 diff changeset	152 def handlewsgirequest(rctx, req, res, checkperm):
36820 158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	153 """Possibly process a wire protocol request.
36023 cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	154
36820 158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	155 If the current request is a wire protocol request, the request is
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	156 processed by this function.
36023 cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	157
36818 886fba199022 hgweb: only recognize wire protocol commands from query string (BC) Gregory Szorc <gregory.szorc@gmail.com> parents: 36812 diff changeset	158 ``req`` is a ``parsedrequest`` instance.
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	159 ``res`` is a ``wsgiresponse`` instance.
36820 158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	160
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	161 Returns a bool indicating if the request was serviced. If set, the caller
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	162 should stop processing the request, as a response has already been issued.
36023 cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	163 """
36820 158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	164 # Avoid cycle involving hg module.
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	165 from .hgweb import common as hgwebcommon
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	166
36809 66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	167 repo = rctx.repo
66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	168
36023 cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	169 # HTTP version 1 wire protocol requests are denoted by a "cmd" query
cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	170 # string parameter. If it isn't present, this isn't a wire protocol
cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	171 # request.
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	172 if 'cmd' not in req.qsparams:
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	173 return False
36023 cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	174
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	175 cmd = req.qsparams['cmd']
36023 cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	176
cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	177 # The "cmd" request parameter is used by both the wire protocol and hgweb.
cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	178 # While not all wire protocol commands are available for all transports,
cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	179 # if we see a "cmd" value that resembles a known wire protocol command, we
cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	180 # route it to a protocol handler. This is better than routing possible
cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	181 # wire protocol requests to hgweb because it prevents hgweb from using
cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	182 # known wire protocol commands and it is less confusing for machine
cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	183 # clients.
36269 72812ad205d1 wireprotoserver: return to using iscmd() method Augie Fackler <augie@google.com> parents: 36261 diff changeset	184 if not iscmd(cmd):
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	185 return False
36820 158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	186
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	187 # The "cmd" query string argument is only valid on the root path of the
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	188 # repo. e.g. ``/?cmd=foo``, ``/repo?cmd=foo``. URL paths within the repo
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	189 # like ``/blah?cmd=foo`` are not allowed. So don't recognize the request
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	190 # in this case. We send an HTTP 404 for backwards compatibility reasons.
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	191 if req.dispatchpath:
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	192 res.status = hgwebcommon.statusmessage(404)
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	193 res.headers['Content-Type'] = HGTYPE
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	194 # TODO This is not a good response to issue for this request. This
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	195 # is mostly for BC for now.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	196 res.setbodybytes('0\n%s\n' % b'Not Found')
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	197 return True
36023 cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	198
36873 a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36868 diff changeset	199 proto = httpv1protocolhandler(req, repo.ui,
36883 02bea04b4c54 hgweb: transition permissions hooks to modern request type (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36873 diff changeset	200 lambda perm: checkperm(rctx, req, perm))
30764 e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	201
36820 158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	202 # The permissions checker should be the only thing that can raise an
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	203 # ErrorResponse. It is kind of a layer violation to catch an hgweb
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	204 # exception here. So consider refactoring into a exception type that
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	205 # is associated with the wire protocol.
158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	206 try:
36873 a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36868 diff changeset	207 _callhttp(repo, req, res, proto, cmd)
36820 158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	208 except hgwebcommon.ErrorResponse as e:
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	209 for k, v in e.headers:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	210 res.headers[k] = v
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	211 res.status = hgwebcommon.statusmessage(e.code, pycompat.bytestr(e))
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	212 # TODO This response body assumes the failed command was
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	213 # "unbundle." That assumption is not always valid.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	214 res.setbodybytes('0\n%s\n' % pycompat.bytestr(e))
36820 158d4ecc03c8 wireprotoserver: move all wire protocol handling logic out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36818 diff changeset	215
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	216 return True
36023 cdc93fe1da77 wireprotoserver: move protocol parsing and dispatch out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36021 diff changeset	217
37049 1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	218 def handlewsgiapirequest(rctx, req, res, checkperm):
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	219 """Handle requests to /api/*."""
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	220 assert req.dispatchparts[0] == b'api'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	221
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	222 repo = rctx.repo
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	223
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	224 # This whole URL space is experimental for now. But we want to
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	225 # reserve the URL space. So, 404 all URLs if the feature isn't enabled.
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	226 if not repo.ui.configbool('experimental', 'web.apiserver'):
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	227 res.status = b'404 Not Found'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	228 res.headers[b'Content-Type'] = b'text/plain'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	229 res.setbodybytes(_('Experimental API server endpoint not enabled'))
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	230 return
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	231
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	232 # The URL space is /api/<protocol>/*. The structure of URLs under varies
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	233 # by <protocol>.
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	234
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	235 # Registered APIs are made available via config options of the name of
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	236 # the protocol.
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	237 availableapis = set()
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	238 for k, v in API_HANDLERS.items():
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	239 section, option = v['config']
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	240 if repo.ui.configbool(section, option):
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	241 availableapis.add(k)
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	242
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	243 # Requests to /api/ list available APIs.
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	244 if req.dispatchparts == [b'api']:
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	245 res.status = b'200 OK'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	246 res.headers[b'Content-Type'] = b'text/plain'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	247 lines = [_('APIs can be accessed at /api/<name>, where <name> can be '
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	248 'one of the following:\n')]
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	249 if availableapis:
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	250 lines.extend(sorted(availableapis))
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	251 else:
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	252 lines.append(_('(no available APIs)\n'))
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	253 res.setbodybytes(b'\n'.join(lines))
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	254 return
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	255
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	256 proto = req.dispatchparts[1]
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	257
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	258 if proto not in API_HANDLERS:
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	259 res.status = b'404 Not Found'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	260 res.headers[b'Content-Type'] = b'text/plain'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	261 res.setbodybytes(_('Unknown API: %s\nKnown APIs: %s') % (
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	262 proto, b', '.join(sorted(availableapis))))
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	263 return
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	264
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	265 if proto not in availableapis:
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	266 res.status = b'404 Not Found'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	267 res.headers[b'Content-Type'] = b'text/plain'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	268 res.setbodybytes(_('API %s not enabled\n') % proto)
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	269 return
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	270
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	271 API_HANDLERS[proto]['handler'](rctx, req, res, checkperm,
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	272 req.dispatchparts[2:])
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	273
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	274 def _handlehttpv2request(rctx, req, res, checkperm, urlparts):
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	275 res.status = b'200 OK'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	276 res.headers[b'Content-Type'] = b'text/plain'
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	277 res.setbodybytes(b'/'.join(urlparts) + b'\n')
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	278
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	279 # Maps API name to metadata so custom API can be registered.
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	280 API_HANDLERS = {
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	281 HTTPV2: {
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	282 'config': ('experimental', 'web.api.http-v2'),
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	283 'handler': _handlehttpv2request,
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	284 },
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	285 }
1cfef5693203 wireproto: support /api/* URL space for exposing APIs Gregory Szorc <gregory.szorc@gmail.com> parents: 36883 diff changeset	286
36852 14f70c44af6c wireprotoserver: access headers through parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36821 diff changeset	287 def _httpresponsetype(ui, req, prefer_uncompressed):
36110 341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	288 """Determine the appropriate response type and compression settings.
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	289
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	290 Returns a tuple of (mediatype, compengine, engineopts).
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	291 """
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	292 # Determine the response media type and compression engine based
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	293 # on the request parameters.
36852 14f70c44af6c wireprotoserver: access headers through parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36821 diff changeset	294 protocaps = decodevaluefromheaders(req, 'X-HgProto').split(' ')
36110 341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	295
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	296 if '0.2' in protocaps:
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	297 # All clients are expected to support uncompressed data.
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	298 if prefer_uncompressed:
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	299 return HGTYPE2, util._noopengine(), {}
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	300
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	301 # Default as defined by wire protocol spec.
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	302 compformats = ['zlib', 'none']
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	303 for cap in protocaps:
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	304 if cap.startswith('comp='):
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	305 compformats = cap[5:].split(',')
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	306 break
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	307
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	308 # Now find an agreed upon compression format.
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	309 for engine in wireproto.supportedcompengines(ui, util.SERVERROLE):
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	310 if engine.wireprotosupport().name in compformats:
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	311 opts = {}
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	312 level = ui.configint('server', '%slevel' % engine.name())
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	313 if level is not None:
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	314 opts['level'] = level
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	315
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	316 return HGTYPE2, engine, opts
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	317
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	318 # No mutually supported compression format. Fall back to the
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	319 # legacy protocol.
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	320
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	321 # Don't allow untrusted settings because disabling compression or
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	322 # setting a very high compression level could lead to flooding
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	323 # the server's network or CPU.
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	324 opts = {'level': ui.configint('server', 'zliblevel')}
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	325 return HGTYPE, util.compengines['zlib'], opts
341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	326
36873 a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36868 diff changeset	327 def _callhttp(repo, req, res, proto, cmd):
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	328 # Avoid cycle involving hg module.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	329 from .hgweb import common as hgwebcommon
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	330
35750 a39a9df7ecca wireproto: split streamres into legacy and modern case Joerg Sonnenberger <joerg@bec.de> parents: 35705 diff changeset	331 def genversion2(gen, engine, engineopts):
30764 e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	332 # application/mercurial-0.2 always sends a payload header
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	333 # identifying the compression engine.
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	334 name = engine.wireprotosupport().name
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	335 assert 0 < len(name) < 256
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	336 yield struct.pack('B', len(name))
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	337 yield name
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	338
35750 a39a9df7ecca wireproto: split streamres into legacy and modern case Joerg Sonnenberger <joerg@bec.de> parents: 35705 diff changeset	339 for chunk in gen:
a39a9df7ecca wireproto: split streamres into legacy and modern case Joerg Sonnenberger <joerg@bec.de> parents: 35705 diff changeset	340 yield chunk
30764 e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	341
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	342 def setresponse(code, contenttype, bodybytes=None, bodygen=None):
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	343 if code == HTTP_OK:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	344 res.status = '200 Script output follows'
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	345 else:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	346 res.status = hgwebcommon.statusmessage(code)
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	347
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	348 res.headers['Content-Type'] = contenttype
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	349
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	350 if bodybytes is not None:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	351 res.setbodybytes(bodybytes)
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	352 if bodygen is not None:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	353 res.setbodygen(bodygen)
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	354
36021 5a56bf4180ad wireproto: function for testing if wire protocol command is available Gregory Szorc <gregory.szorc@gmail.com> parents: 36015 diff changeset	355 if not wireproto.commands.commandavailable(cmd, proto):
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	356 setresponse(HTTP_OK, HGERRTYPE,
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	357 _('requested wire protocol command is not available over '
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	358 'HTTP'))
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	359 return
36021 5a56bf4180ad wireproto: function for testing if wire protocol command is available Gregory Szorc <gregory.szorc@gmail.com> parents: 36015 diff changeset	360
36809 66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	361 proto.checkperm(wireproto.commands[cmd].permission)
36807 c638a13093cf wireprotoserver: check permissions in main dispatch function Gregory Szorc <gregory.szorc@gmail.com> parents: 36806 diff changeset	362
36806 7574c8173d5e wireprotoserver: check if command available before calling it Gregory Szorc <gregory.szorc@gmail.com> parents: 36768 diff changeset	363 rsp = wireproto.dispatch(repo, proto, cmd)
7574c8173d5e wireprotoserver: check if command available before calling it Gregory Szorc <gregory.szorc@gmail.com> parents: 36768 diff changeset	364
34510 c23fa3103925 hgweb: in protocol adapter, look for bytes instances, not str Augie Fackler <augie@google.com> parents: 34509 diff changeset	365 if isinstance(rsp, bytes):
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	366 setresponse(HTTP_OK, HGTYPE, bodybytes=rsp)
36112 2f7290555c96 wireproto: introduce type for raw byte responses (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36111 diff changeset	367 elif isinstance(rsp, wireprototypes.bytesresponse):
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	368 setresponse(HTTP_OK, HGTYPE, bodybytes=rsp.data)
36111 cd6ab329c5c7 wireprototypes: move wire protocol response types to new module Gregory Szorc <gregory.szorc@gmail.com> parents: 36110 diff changeset	369 elif isinstance(rsp, wireprototypes.streamreslegacy):
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	370 setresponse(HTTP_OK, HGTYPE, bodygen=rsp.gen)
36111 cd6ab329c5c7 wireprototypes: move wire protocol response types to new module Gregory Szorc <gregory.szorc@gmail.com> parents: 36110 diff changeset	371 elif isinstance(rsp, wireprototypes.streamres):
35705 8cdb671dbd0b wireproto: drop support for reader interface from streamres (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 34744 diff changeset	372 gen = rsp.gen
30475 2add671bf55b wireproto: perform chunking and compression at protocol layer (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 30376 diff changeset	373
30764 e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	374 # This code for compression should not be streamres specific. It
e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	375 # is here because we only compress streamres at the moment.
36110 341c886e411e wireprotoserver: move responsetype() out of http handler Gregory Szorc <gregory.szorc@gmail.com> parents: 36109 diff changeset	376 mediatype, engine, engineopts = _httpresponsetype(
36852 14f70c44af6c wireprotoserver: access headers through parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36821 diff changeset	377 repo.ui, req, rsp.prefer_uncompressed)
35750 a39a9df7ecca wireproto: split streamres into legacy and modern case Joerg Sonnenberger <joerg@bec.de> parents: 35705 diff changeset	378 gen = engine.compressstream(gen, engineopts)
30475 2add671bf55b wireproto: perform chunking and compression at protocol layer (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 30376 diff changeset	379
35750 a39a9df7ecca wireproto: split streamres into legacy and modern case Joerg Sonnenberger <joerg@bec.de> parents: 35705 diff changeset	380 if mediatype == HGTYPE2:
a39a9df7ecca wireproto: split streamres into legacy and modern case Joerg Sonnenberger <joerg@bec.de> parents: 35705 diff changeset	381 gen = genversion2(gen, engine, engineopts)
30764 e75463e3179f protocol: send application/mercurial-0.2 responses to capable clients Gregory Szorc <gregory.szorc@gmail.com> parents: 30759 diff changeset	382
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	383 setresponse(HTTP_OK, mediatype, bodygen=gen)
36111 cd6ab329c5c7 wireprototypes: move wire protocol response types to new module Gregory Szorc <gregory.szorc@gmail.com> parents: 36110 diff changeset	384 elif isinstance(rsp, wireprototypes.pushres):
36105 caca3ac2ac04 wireproto: use maybecapturestdio() for push responses (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36104 diff changeset	385 rsp = '%d\n%s' % (rsp.res, rsp.output)
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	386 setresponse(HTTP_OK, HGTYPE, bodybytes=rsp)
36111 cd6ab329c5c7 wireprototypes: move wire protocol response types to new module Gregory Szorc <gregory.szorc@gmail.com> parents: 36110 diff changeset	387 elif isinstance(rsp, wireprototypes.pusherr):
12703 40bb5853fc4b wireproto: introduce pusherr() to deal with "unsynced changes" error Benoit Boissinot <benoit.boissinot@ens-lyon.org> parents: 11626 diff changeset	388 rsp = '0\n%s\n' % rsp.res
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	389 res.drain = True
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	390 setresponse(HTTP_OK, HGTYPE, bodybytes=rsp)
36111 cd6ab329c5c7 wireprototypes: move wire protocol response types to new module Gregory Szorc <gregory.szorc@gmail.com> parents: 36110 diff changeset	391 elif isinstance(rsp, wireprototypes.ooberror):
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	392 setresponse(HTTP_OK, HGERRTYPE, bodybytes=rsp.message)
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	393 else:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36863 diff changeset	394 raise error.ProgrammingError('hgweb.protocol internal failure', rsp)
36025 98a00aa0288d wireprotoserver: move error response handling out of hgweb Gregory Szorc <gregory.szorc@gmail.com> parents: 36023 diff changeset	395
36102 5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	396 def _sshv1respondbytes(fout, value):
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	397 """Send a bytes response for protocol version 1."""
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	398 fout.write('%d\n' % len(value))
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	399 fout.write(value)
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	400 fout.flush()
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	401
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	402 def _sshv1respondstream(fout, source):
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	403 write = fout.write
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	404 for chunk in source.gen:
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	405 write(chunk)
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	406 fout.flush()
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	407
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	408 def _sshv1respondooberror(fout, ferr, rsp):
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	409 ferr.write(b'%s\n-\n' % rsp)
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	410 ferr.flush()
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	411 fout.write(b'\n')
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	412 fout.flush()
5767664d39a5 wireprotoserver: extract SSH response handling functions Gregory Szorc <gregory.szorc@gmail.com> parents: 36027 diff changeset	413
36402 0c231df1ffdc wireprototypes: move baseprotocolhandler from wireprotoserver Gregory Szorc <gregory.szorc@gmail.com> parents: 36313 diff changeset	414 class sshv1protocolhandler(wireprototypes.baseprotocolhandler):
36103 bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	415 """Handler for requests services via version 1 of SSH protocol."""
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	416 def __init__(self, ui, fin, fout):
35910 f1efc0caeab7 wireprotoserver: make some instance attributes private Gregory Szorc <gregory.szorc@gmail.com> parents: 35909 diff changeset	417 self._ui = ui
36103 bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	418 self._fin = fin
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	419 self._fout = fout
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	420
35913 29759c46aa1a wireprotoserver: make name part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 35912 diff changeset	421 @property
29759c46aa1a wireprotoserver: make name part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 35912 diff changeset	422 def name(self):
36565 3cd245945ef3 wireprotoserver: move SSHV1 and SSHV2 constants to wireprototypes Gregory Szorc <gregory.szorc@gmail.com> parents: 36555 diff changeset	423 return wireprototypes.SSHV1
35913 29759c46aa1a wireprotoserver: make name part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 35912 diff changeset	424
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	425 def getargs(self, args):
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	426 data = {}
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	427 keys = args.split()
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	428 for n in xrange(len(keys)):
35910 f1efc0caeab7 wireprotoserver: make some instance attributes private Gregory Szorc <gregory.szorc@gmail.com> parents: 35909 diff changeset	429 argline = self._fin.readline()[:-1]
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	430 arg, l = argline.split()
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	431 if arg not in keys:
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	432 raise error.Abort(_("unexpected parameter %r") % arg)
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	433 if arg == '*':
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	434 star = {}
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	435 for k in xrange(int(l)):
35910 f1efc0caeab7 wireprotoserver: make some instance attributes private Gregory Szorc <gregory.szorc@gmail.com> parents: 35909 diff changeset	436 argline = self._fin.readline()[:-1]
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	437 arg, l = argline.split()
35910 f1efc0caeab7 wireprotoserver: make some instance attributes private Gregory Szorc <gregory.szorc@gmail.com> parents: 35909 diff changeset	438 val = self._fin.read(int(l))
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	439 star[arg] = val
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	440 data['*'] = star
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	441 else:
35910 f1efc0caeab7 wireprotoserver: make some instance attributes private Gregory Szorc <gregory.szorc@gmail.com> parents: 35909 diff changeset	442 val = self._fin.read(int(l))
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	443 data[arg] = val
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	444 return [data[k] for k in keys]
1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	445
36108 90ca4986616c wireprotoserver: rename getfile() to forwardpayload() (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36107 diff changeset	446 def forwardpayload(self, fpout):
36403 b8d0761a85c7 wireproto: document the wonky push protocol for SSH Gregory Szorc <gregory.szorc@gmail.com> parents: 36402 diff changeset	447 # We initially send an empty response. This tells the client it is
b8d0761a85c7 wireproto: document the wonky push protocol for SSH Gregory Szorc <gregory.szorc@gmail.com> parents: 36402 diff changeset	448 # OK to start sending data. If a client sees any other response, it
b8d0761a85c7 wireproto: document the wonky push protocol for SSH Gregory Szorc <gregory.szorc@gmail.com> parents: 36402 diff changeset	449 # interprets it as an error.
b8d0761a85c7 wireproto: document the wonky push protocol for SSH Gregory Szorc <gregory.szorc@gmail.com> parents: 36402 diff changeset	450 _sshv1respondbytes(self._fout, b'')
b8d0761a85c7 wireproto: document the wonky push protocol for SSH Gregory Szorc <gregory.szorc@gmail.com> parents: 36402 diff changeset	451
36108 90ca4986616c wireprotoserver: rename getfile() to forwardpayload() (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36107 diff changeset	452 # The file is in the form:
90ca4986616c wireprotoserver: rename getfile() to forwardpayload() (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36107 diff changeset	453 #
90ca4986616c wireprotoserver: rename getfile() to forwardpayload() (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36107 diff changeset	454 # <chunk size>\n<chunk>
90ca4986616c wireprotoserver: rename getfile() to forwardpayload() (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36107 diff changeset	455 # ...
90ca4986616c wireprotoserver: rename getfile() to forwardpayload() (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36107 diff changeset	456 # 0\n
35910 f1efc0caeab7 wireprotoserver: make some instance attributes private Gregory Szorc <gregory.szorc@gmail.com> parents: 35909 diff changeset	457 count = int(self._fin.readline())
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	458 while count:
35910 f1efc0caeab7 wireprotoserver: make some instance attributes private Gregory Szorc <gregory.szorc@gmail.com> parents: 35909 diff changeset	459 fpout.write(self._fin.read(count))
f1efc0caeab7 wireprotoserver: make some instance attributes private Gregory Szorc <gregory.szorc@gmail.com> parents: 35909 diff changeset	460 count = int(self._fin.readline())
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	461
36104 2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	462 @contextlib.contextmanager
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	463 def mayberedirectstdio(self):
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	464 yield None
2ad145fbde54 wireprotoserver: add context manager mechanism for redirecting stdio Gregory Szorc <gregory.szorc@gmail.com> parents: 36103 diff changeset	465
36107 957e773614d0 wireprotoserver: rename _client to client (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36106 diff changeset	466 def client(self):
36103 bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	467 client = encoding.environ.get('SSH_CLIENT', '').split(' ', 1)[0]
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	468 return 'remote:ssh:' + client
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	469
36642 6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	470 def addcapabilities(self, repo, caps):
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	471 return caps
6e585bca962e wireproto: add transport specific capabilities in the transport Gregory Szorc <gregory.szorc@gmail.com> parents: 36639 diff changeset	472
36809 66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	473 def checkperm(self, perm):
66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	474 pass
66de4555cefd wireproto: formalize permissions checking as part of protocol interface Gregory Szorc <gregory.szorc@gmail.com> parents: 36808 diff changeset	475
36253 464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	476 class sshv2protocolhandler(sshv1protocolhandler):
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	477 """Protocol handler for version 2 of the SSH protocol."""
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	478
36639 af0d38f015bb wireprotoserver: identify requests via version 2 of SSH protocol as such Gregory Szorc <gregory.szorc@gmail.com> parents: 36565 diff changeset	479 @property
af0d38f015bb wireprotoserver: identify requests via version 2 of SSH protocol as such Gregory Szorc <gregory.szorc@gmail.com> parents: 36565 diff changeset	480 def name(self):
af0d38f015bb wireprotoserver: identify requests via version 2 of SSH protocol as such Gregory Szorc <gregory.szorc@gmail.com> parents: 36565 diff changeset	481 return wireprototypes.SSHV2
af0d38f015bb wireprotoserver: identify requests via version 2 of SSH protocol as such Gregory Szorc <gregory.szorc@gmail.com> parents: 36565 diff changeset	482
36552 e7411fb7ba7f wireprotoserver: ability to run an SSH server until an event is set Gregory Szorc <gregory.szorc@gmail.com> parents: 36403 diff changeset	483 def _runsshserver(ui, repo, fin, fout, ev):
36253 464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	484 # This function operates like a state machine of sorts. The following
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	485 # states are defined:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	486 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	487 # protov1-serving
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	488 # Server is in protocol version 1 serving mode. Commands arrive on
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	489 # new lines. These commands are processed in this state, one command
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	490 # after the other.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	491 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	492 # protov2-serving
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	493 # Server is in protocol version 2 serving mode.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	494 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	495 # upgrade-initial
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	496 # The server is going to process an upgrade request.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	497 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	498 # upgrade-v2-filter-legacy-handshake
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	499 # The protocol is being upgraded to version 2. The server is expecting
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	500 # the legacy handshake from version 1.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	501 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	502 # upgrade-v2-finish
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	503 # The upgrade to version 2 of the protocol is imminent.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	504 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	505 # shutdown
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	506 # The server is shutting down, possibly in reaction to a client event.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	507 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	508 # And here are their transitions:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	509 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	510 # protov1-serving -> shutdown
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	511 # When server receives an empty request or encounters another
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	512 # error.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	513 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	514 # protov1-serving -> upgrade-initial
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	515 # An upgrade request line was seen.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	516 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	517 # upgrade-initial -> upgrade-v2-filter-legacy-handshake
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	518 # Upgrade to version 2 in progress. Server is expecting to
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	519 # process a legacy handshake.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	520 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	521 # upgrade-v2-filter-legacy-handshake -> shutdown
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	522 # Client did not fulfill upgrade handshake requirements.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	523 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	524 # upgrade-v2-filter-legacy-handshake -> upgrade-v2-finish
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	525 # Client fulfilled version 2 upgrade requirements. Finishing that
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	526 # upgrade.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	527 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	528 # upgrade-v2-finish -> protov2-serving
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	529 # Protocol upgrade to version 2 complete. Server can now speak protocol
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	530 # version 2.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	531 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	532 # protov2-serving -> protov1-serving
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	533 # Ths happens by default since protocol version 2 is the same as
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	534 # version 1 except for the handshake.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	535
36252 3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	536 state = 'protov1-serving'
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	537 proto = sshv1protocolhandler(ui, fin, fout)
36253 464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	538 protoswitched = False
36252 3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	539
36552 e7411fb7ba7f wireprotoserver: ability to run an SSH server until an event is set Gregory Szorc <gregory.szorc@gmail.com> parents: 36403 diff changeset	540 while not ev.is_set():
36252 3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	541 if state == 'protov1-serving':
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	542 # Commands are issued on new lines.
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	543 request = fin.readline()[:-1]
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	544
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	545 # Empty lines signal to terminate the connection.
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	546 if not request:
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	547 state = 'shutdown'
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	548 continue
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	549
36253 464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	550 # It looks like a protocol upgrade request. Transition state to
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	551 # handle it.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	552 if request.startswith(b'upgrade '):
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	553 if protoswitched:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	554 _sshv1respondooberror(fout, ui.ferr,
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	555 b'cannot upgrade protocols multiple '
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	556 b'times')
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	557 state = 'shutdown'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	558 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	559
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	560 state = 'upgrade-initial'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	561 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	562
36252 3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	563 available = wireproto.commands.commandavailable(request, proto)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	564
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	565 # This command isn't available. Send an empty response and go
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	566 # back to waiting for a new command.
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	567 if not available:
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	568 _sshv1respondbytes(fout, b'')
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	569 continue
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	570
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	571 rsp = wireproto.dispatch(repo, proto, request)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	572
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	573 if isinstance(rsp, bytes):
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	574 _sshv1respondbytes(fout, rsp)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	575 elif isinstance(rsp, wireprototypes.bytesresponse):
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	576 _sshv1respondbytes(fout, rsp.data)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	577 elif isinstance(rsp, wireprototypes.streamres):
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	578 _sshv1respondstream(fout, rsp)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	579 elif isinstance(rsp, wireprototypes.streamreslegacy):
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	580 _sshv1respondstream(fout, rsp)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	581 elif isinstance(rsp, wireprototypes.pushres):
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	582 _sshv1respondbytes(fout, b'')
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	583 _sshv1respondbytes(fout, b'%d' % rsp.res)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	584 elif isinstance(rsp, wireprototypes.pusherr):
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	585 _sshv1respondbytes(fout, rsp.res)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	586 elif isinstance(rsp, wireprototypes.ooberror):
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	587 _sshv1respondooberror(fout, ui.ferr, rsp.message)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	588 else:
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	589 raise error.ProgrammingError('unhandled response type from '
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	590 'wire protocol command: %s' % rsp)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	591
36253 464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	592 # For now, protocol version 2 serving just goes back to version 1.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	593 elif state == 'protov2-serving':
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	594 state = 'protov1-serving'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	595 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	596
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	597 elif state == 'upgrade-initial':
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	598 # We should never transition into this state if we've switched
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	599 # protocols.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	600 assert not protoswitched
36565 3cd245945ef3 wireprotoserver: move SSHV1 and SSHV2 constants to wireprototypes Gregory Szorc <gregory.szorc@gmail.com> parents: 36555 diff changeset	601 assert proto.name == wireprototypes.SSHV1
36253 464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	602
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	603 # Expected: upgrade <token> <capabilities>
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	604 # If we get something else, the request is malformed. It could be
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	605 # from a future client that has altered the upgrade line content.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	606 # We treat this as an unknown command.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	607 try:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	608 token, caps = request.split(b' ')[1:]
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	609 except ValueError:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	610 _sshv1respondbytes(fout, b'')
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	611 state = 'protov1-serving'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	612 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	613
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	614 # Send empty response if we don't support upgrading protocols.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	615 if not ui.configbool('experimental', 'sshserver.support-v2'):
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	616 _sshv1respondbytes(fout, b'')
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	617 state = 'protov1-serving'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	618 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	619
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	620 try:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	621 caps = urlreq.parseqs(caps)
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	622 except ValueError:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	623 _sshv1respondbytes(fout, b'')
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	624 state = 'protov1-serving'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	625 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	626
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	627 # We don't see an upgrade request to protocol version 2. Ignore
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	628 # the upgrade request.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	629 wantedprotos = caps.get(b'proto', [b''])[0]
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	630 if SSHV2 not in wantedprotos:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	631 _sshv1respondbytes(fout, b'')
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	632 state = 'protov1-serving'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	633 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	634
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	635 # It looks like we can honor this upgrade request to protocol 2.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	636 # Filter the rest of the handshake protocol request lines.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	637 state = 'upgrade-v2-filter-legacy-handshake'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	638 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	639
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	640 elif state == 'upgrade-v2-filter-legacy-handshake':
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	641 # Client should have sent legacy handshake after an ``upgrade``
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	642 # request. Expected lines:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	643 #
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	644 # hello
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	645 # between
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	646 # pairs 81
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	647 # 0000...-0000...
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	648
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	649 ok = True
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	650 for line in (b'hello', b'between', b'pairs 81'):
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	651 request = fin.readline()[:-1]
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	652
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	653 if request != line:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	654 _sshv1respondooberror(fout, ui.ferr,
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	655 b'malformed handshake protocol: '
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	656 b'missing %s' % line)
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	657 ok = False
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	658 state = 'shutdown'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	659 break
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	660
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	661 if not ok:
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	662 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	663
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	664 request = fin.read(81)
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	665 if request != b'%s-%s' % (b'0' * 40, b'0' * 40):
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	666 _sshv1respondooberror(fout, ui.ferr,
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	667 b'malformed handshake protocol: '
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	668 b'missing between argument value')
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	669 state = 'shutdown'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	670 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	671
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	672 state = 'upgrade-v2-finish'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	673 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	674
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	675 elif state == 'upgrade-v2-finish':
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	676 # Send the upgrade response.
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	677 fout.write(b'upgraded %s %s\n' % (token, SSHV2))
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	678 servercaps = wireproto.capabilities(repo, proto)
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	679 rsp = b'capabilities: %s' % servercaps.data
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	680 fout.write(b'%d\n%s\n' % (len(rsp), rsp))
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	681 fout.flush()
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	682
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	683 proto = sshv2protocolhandler(ui, fin, fout)
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	684 protoswitched = True
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	685
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	686 state = 'protov2-serving'
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	687 continue
464bedc0fdb4 wireprotoserver: handle SSH protocol version 2 upgrade requests Gregory Szorc <gregory.szorc@gmail.com> parents: 36252 diff changeset	688
36252 3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	689 elif state == 'shutdown':
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	690 break
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	691
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	692 else:
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	693 raise error.ProgrammingError('unhandled ssh server state: %s' %
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	694 state)
3b3a987bbbaa wireprotoserver: move SSH server operation to a standalone function Gregory Szorc <gregory.szorc@gmail.com> parents: 36251 diff changeset	695
36103 bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	696 class sshserver(object):
36555 7cc4a9b9732a wireprotoserver: support logging SSH server I/O to a file descriptor Gregory Szorc <gregory.szorc@gmail.com> parents: 36552 diff changeset	697 def __init__(self, ui, repo, logfh=None):
36103 bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	698 self._ui = ui
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	699 self._repo = repo
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	700 self._fin = ui.fin
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	701 self._fout = ui.fout
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	702
36555 7cc4a9b9732a wireprotoserver: support logging SSH server I/O to a file descriptor Gregory Szorc <gregory.szorc@gmail.com> parents: 36552 diff changeset	703 # Log write I/O to stdout and stderr if configured.
7cc4a9b9732a wireprotoserver: support logging SSH server I/O to a file descriptor Gregory Szorc <gregory.szorc@gmail.com> parents: 36552 diff changeset	704 if logfh:
7cc4a9b9732a wireprotoserver: support logging SSH server I/O to a file descriptor Gregory Szorc <gregory.szorc@gmail.com> parents: 36552 diff changeset	705 self._fout = util.makeloggingfileobject(
7cc4a9b9732a wireprotoserver: support logging SSH server I/O to a file descriptor Gregory Szorc <gregory.szorc@gmail.com> parents: 36552 diff changeset	706 logfh, self._fout, 'o', logdata=True)
7cc4a9b9732a wireprotoserver: support logging SSH server I/O to a file descriptor Gregory Szorc <gregory.szorc@gmail.com> parents: 36552 diff changeset	707 ui.ferr = util.makeloggingfileobject(
7cc4a9b9732a wireprotoserver: support logging SSH server I/O to a file descriptor Gregory Szorc <gregory.szorc@gmail.com> parents: 36552 diff changeset	708 logfh, ui.ferr, 'e', logdata=True)
7cc4a9b9732a wireprotoserver: support logging SSH server I/O to a file descriptor Gregory Szorc <gregory.szorc@gmail.com> parents: 36552 diff changeset	709
36103 bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	710 hook.redirect(True)
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	711 ui.fout = repo.ui.fout = ui.ferr
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	712
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	713 # Prevent insertion/deletion of CRs
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	714 util.setbinary(self._fin)
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	715 util.setbinary(self._fout)
bf676267f64f wireprotoserver: split ssh protocol handler and server Gregory Szorc <gregory.szorc@gmail.com> parents: 36102 diff changeset	716
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	717 def serve_forever(self):
36552 e7411fb7ba7f wireprotoserver: ability to run an SSH server until an event is set Gregory Szorc <gregory.szorc@gmail.com> parents: 36403 diff changeset	718 self.serveuntil(threading.Event())
35899 1bf5263fe5cc wireprotoserver: move sshserver into module (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 35898 diff changeset	719 sys.exit(0)
36552 e7411fb7ba7f wireprotoserver: ability to run an SSH server until an event is set Gregory Szorc <gregory.szorc@gmail.com> parents: 36403 diff changeset	720
e7411fb7ba7f wireprotoserver: ability to run an SSH server until an event is set Gregory Szorc <gregory.szorc@gmail.com> parents: 36403 diff changeset	721 def serveuntil(self, ev):
e7411fb7ba7f wireprotoserver: ability to run an SSH server until an event is set Gregory Szorc <gregory.szorc@gmail.com> parents: 36403 diff changeset	722 """Serve until a threading.Event is set."""
e7411fb7ba7f wireprotoserver: ability to run an SSH server until an event is set Gregory Szorc <gregory.szorc@gmail.com> parents: 36403 diff changeset	723 _runsshserver(self._ui, self._repo, self._fin, self._fout, ev)

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/wireprotoserver.py @ 37049:1cfef5693203