( )⚙ D2783 hgweb: expose URL scheme and REMOTE_* attributes

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2783

hgweb: expose URL scheme and REMOTE_* attributes
ClosedPublic

Authored by indygreg on Mar 11 2018, 12:23 AM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHGa755fd3b7146: hgweb: expose URL scheme and REMOTE_* attributes
Summary

These are consulted by the HTTP wire protocol handler by reading from
the env dict. Let's expose them as attributes instead.

With the wire protocol handler updates to use the new attributes, we
no longer have any consumers of the legacy wsgirequest type in the
wire protocol code (outside of a proxied call to the permissions
checker). So, we remove most references to it.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Mar 11 2018, 12:23 AM
durin42 accepted this revision.Mar 12 2018, 5:06 PM
This revision is now accepted and ready to land.Mar 12 2018, 5:06 PM
Closed by commit rHGa755fd3b7146: hgweb: expose URL scheme and REMOTE_* attributes (authored by indygreg). · Explain WhyMar 12 2018, 5:32 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 6844

mercurial/hgweb/request.py

# Full URL for this request. # Full URL for this request.
url = attr.ib() url = attr.ib()
# URL without any path components. Just <proto>://<host><port>. # URL without any path components. Just <proto>://<host><port>.
baseurl = attr.ib() baseurl = attr.ib()
# Advertised URL. Like ``url`` and ``baseurl`` but uses SERVER_NAME instead # Advertised URL. Like ``url`` and ``baseurl`` but uses SERVER_NAME instead
# of HTTP: Host header for hostname. This is likely what clients used. # of HTTP: Host header for hostname. This is likely what clients used.
advertisedurl = attr.ib() advertisedurl = attr.ib()
advertisedbaseurl = attr.ib() advertisedbaseurl = attr.ib()
# URL scheme (part before ``://``). e.g. ``http`` or ``https``.
urlscheme = attr.ib()
# Value of REMOTE_USER, if set, or None.
remoteuser = attr.ib()
# Value of REMOTE_HOST, if set, or None.
remotehost = attr.ib()
# WSGI application path. # WSGI application path.
apppath = attr.ib() apppath = attr.ib()
# List of path parts to be used for dispatch. # List of path parts to be used for dispatch.
dispatchparts = attr.ib() dispatchparts = attr.ib()
# URL path component (no query string) used for dispatch. # URL path component (no query string) used for dispatch.
dispatchpath = attr.ib() dispatchpath = attr.ib()
# Whether there is a path component to this request. This can be true # Whether there is a path component to this request. This can be true
# when ``dispatchpath`` is empty due to REPO_NAME muckery. # when ``dispatchpath`` is empty due to REPO_NAME muckery.
#bodyfh = env['wsgi.input'] #bodyfh = env['wsgi.input']
#if 'Content-Length' in headers: #if 'Content-Length' in headers:
# bodyfh = util.cappedreader(bodyfh, int(headers['Content-Length'])) # bodyfh = util.cappedreader(bodyfh, int(headers['Content-Length']))
return parsedrequest(method=env['REQUEST_METHOD'], return parsedrequest(method=env['REQUEST_METHOD'],
url=fullurl, baseurl=baseurl, url=fullurl, baseurl=baseurl,
advertisedurl=advertisedfullurl, advertisedurl=advertisedfullurl,
advertisedbaseurl=advertisedbaseurl, advertisedbaseurl=advertisedbaseurl,
urlscheme=env['wsgi.url_scheme'],
remoteuser=env.get('REMOTE_USER'),
remotehost=env.get('REMOTE_HOST'),
apppath=apppath, apppath=apppath,
dispatchparts=dispatchparts, dispatchpath=dispatchpath, dispatchparts=dispatchparts, dispatchpath=dispatchpath,
havepathinfo='PATH_INFO' in env, havepathinfo='PATH_INFO' in env,
querystring=querystring, querystring=querystring,
qsparams=qsparams, qsparams=qsparams,
headers=headers, headers=headers,
bodyfh=bodyfh) bodyfh=bodyfh)

mercurial/wireprotoserver.py

if v is None: if v is None:
break break
chunks.append(pycompat.bytesurl(v)) chunks.append(pycompat.bytesurl(v))
i += 1 i += 1
return ''.join(chunks) return ''.join(chunks)
class httpv1protocolhandler(wireprototypes.baseprotocolhandler): class httpv1protocolhandler(wireprototypes.baseprotocolhandler):
def __init__(self, wsgireq, req, ui, checkperm): def __init__(self, req, ui, checkperm):
self._wsgireq = wsgireq
self._req = req self._req = req
self._ui = ui self._ui = ui
self._checkperm = checkperm self._checkperm = checkperm
@property @property
def name(self): def name(self):
return 'http-v1' return 'http-v1'
self._ui.ferr = out self._ui.ferr = out
yield out yield out
finally: finally:
self._ui.fout = oldout self._ui.fout = oldout
self._ui.ferr = olderr self._ui.ferr = olderr
def client(self): def client(self):
return 'remote:%s:%s:%s' % ( return 'remote:%s:%s:%s' % (
self._wsgireq.env.get('wsgi.url_scheme') or 'http', self._req.urlscheme,
urlreq.quote(self._wsgireq.env.get('REMOTE_HOST', '')), urlreq.quote(self._req.remotehost or ''),
urlreq.quote(self._wsgireq.env.get('REMOTE_USER', ''))) urlreq.quote(self._req.remoteuser or ''))
def addcapabilities(self, repo, caps): def addcapabilities(self, repo, caps):
caps.append('httpheader=%d' % caps.append('httpheader=%d' %
repo.ui.configint('server', 'maxhttpheaderlen')) repo.ui.configint('server', 'maxhttpheaderlen'))
if repo.ui.configbool('experimental', 'httppostargs'): if repo.ui.configbool('experimental', 'httppostargs'):
caps.append('httppostargs') caps.append('httppostargs')
# FUTURE advertise 0.2rx once support is implemented # FUTURE advertise 0.2rx once support is implemented
if req.dispatchpath: if req.dispatchpath:
res.status = hgwebcommon.statusmessage(404) res.status = hgwebcommon.statusmessage(404)
res.headers['Content-Type'] = HGTYPE res.headers['Content-Type'] = HGTYPE
# TODO This is not a good response to issue for this request. This # TODO This is not a good response to issue for this request. This
# is mostly for BC for now. # is mostly for BC for now.
res.setbodybytes('0\n%s\n' % b'Not Found') res.setbodybytes('0\n%s\n' % b'Not Found')
return True return True
proto = httpv1protocolhandler(wsgireq, req, repo.ui, proto = httpv1protocolhandler(req, repo.ui,
lambda perm: checkperm(rctx, wsgireq, perm)) lambda perm: checkperm(rctx, wsgireq, perm))
# The permissions checker should be the only thing that can raise an # The permissions checker should be the only thing that can raise an
# ErrorResponse. It is kind of a layer violation to catch an hgweb # ErrorResponse. It is kind of a layer violation to catch an hgweb
# exception here. So consider refactoring into a exception type that # exception here. So consider refactoring into a exception type that
# is associated with the wire protocol. # is associated with the wire protocol.
try: try:
_callhttp(repo, wsgireq, req, res, proto, cmd) _callhttp(repo, req, res, proto, cmd)
except hgwebcommon.ErrorResponse as e: except hgwebcommon.ErrorResponse as e:
for k, v in e.headers: for k, v in e.headers:
res.headers[k] = v res.headers[k] = v
res.status = hgwebcommon.statusmessage(e.code, pycompat.bytestr(e)) res.status = hgwebcommon.statusmessage(e.code, pycompat.bytestr(e))
# TODO This response body assumes the failed command was # TODO This response body assumes the failed command was
# "unbundle." That assumption is not always valid. # "unbundle." That assumption is not always valid.
res.setbodybytes('0\n%s\n' % pycompat.bytestr(e)) res.setbodybytes('0\n%s\n' % pycompat.bytestr(e))
# legacy protocol. # legacy protocol.
# Don't allow untrusted settings because disabling compression or # Don't allow untrusted settings because disabling compression or
# setting a very high compression level could lead to flooding # setting a very high compression level could lead to flooding
# the server's network or CPU. # the server's network or CPU.
opts = {'level': ui.configint('server', 'zliblevel')} opts = {'level': ui.configint('server', 'zliblevel')}
return HGTYPE, util.compengines['zlib'], opts return HGTYPE, util.compengines['zlib'], opts
def _callhttp(repo, wsgireq, req, res, proto, cmd): def _callhttp(repo, req, res, proto, cmd):
# Avoid cycle involving hg module. # Avoid cycle involving hg module.
from .hgweb import common as hgwebcommon from .hgweb import common as hgwebcommon
def genversion2(gen, engine, engineopts): def genversion2(gen, engine, engineopts):
# application/mercurial-0.2 always sends a payload header # application/mercurial-0.2 always sends a payload header
# identifying the compression engine. # identifying the compression engine.
name = engine.wireprotosupport().name name = engine.wireprotosupport().name
assert 0 < len(name) < 256 assert 0 < len(name) < 256