hgweb_mod.py
454 lines
| 16.3 KiB
| text/x-python
|
PythonLexer
|
r2391 | # hgweb/hgweb_mod.py - Web interface for a repository. | ||
|
r2356 | # | ||
# Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net> | ||||
|
r4635 | # Copyright 2005-2007 Matt Mackall <mpm@selenic.com> | ||
|
r2356 | # | ||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r2356 | |||
|
r27046 | from __future__ import absolute_import | ||
|
r26220 | import contextlib | ||
|
r26162 | import os | ||
|
r27046 | |||
from .common import ( | ||||
ErrorResponse, | ||||
HTTP_BAD_REQUEST, | ||||
|
r30766 | cspvalues, | ||
|
r27046 | permhooks, | ||
|
r36895 | statusmessage, | ||
|
r27046 | ) | ||
from .. import ( | ||||
encoding, | ||||
error, | ||||
|
r36535 | formatter, | ||
|
r27046 | hg, | ||
hook, | ||||
|
r29787 | profiling, | ||
|
r34516 | pycompat, | ||
|
r27046 | repoview, | ||
templatefilters, | ||||
templater, | ||||
|
r36938 | templateutil, | ||
|
r27046 | ui as uimod, | ||
util, | ||||
|
r35874 | wireprotoserver, | ||
|
r27046 | ) | ||
from . import ( | ||||
|
r36822 | request as requestmod, | ||
|
r27046 | webcommands, | ||
webutil, | ||||
wsgicgi, | ||||
) | ||||
|
r2356 | |||
r30749 | archivespecs = util.sortdict(( | |||
('zip', ('application/zip', 'zip', '.zip', None)), | ||||
('gz', ('application/x-gzip', 'tgz', '.tar.gz', None)), | ||||
('bz2', ('application/x-bzip2', 'tbz2', '.tar.bz2', None)), | ||||
)) | ||||
|
r34516 | def getstyle(req, configfn, templatepath): | ||
styles = ( | ||||
|
r36879 | req.qsparams.get('style', None), | ||
|
r34516 | configfn('web', 'style'), | ||
'paper', | ||||
) | ||||
return styles, templater.stylemap(styles, templatepath) | ||||
|
r18515 | def makebreadcrumb(url, prefix=''): | ||
|
r18258 | '''Return a 'URL breadcrumb' list | ||
A 'URL breadcrumb' is a list of URL-name pairs, | ||||
corresponding to each of the path items on a URL. | ||||
This can be used to create path navigation entries. | ||||
''' | ||||
if url.endswith('/'): | ||||
url = url[:-1] | ||||
|
r18515 | if prefix: | ||
url = '/' + prefix + url | ||||
|
r18258 | relpath = url | ||
if relpath.startswith('/'): | ||||
relpath = relpath[1:] | ||||
breadcrumb = [] | ||||
urlel = url | ||||
pathitems = [''] + relpath.split('/') | ||||
for pathel in reversed(pathitems): | ||||
if not pathel or not urlel: | ||||
break | ||||
breadcrumb.append({'url': urlel, 'name': pathel}) | ||||
urlel = os.path.dirname(urlel) | ||||
return reversed(breadcrumb) | ||||
|
r26134 | class requestcontext(object): | ||
"""Holds state/context for an individual request. | ||||
Servers can be multi-threaded. Holding state on the WSGI application | ||||
is prone to race conditions. Instances of this class exist to hold | ||||
mutable and race-free state for requests. | ||||
""" | ||||
|
r36886 | def __init__(self, app, repo, req, res): | ||
|
r26219 | self.repo = repo | ||
|
r26217 | self.reponame = app.reponame | ||
|
r36886 | self.req = req | ||
self.res = res | ||||
|
r26134 | |||
r30749 | self.archivespecs = archivespecs | |||
|
r34591 | self.maxchanges = self.configint('web', 'maxchanges') | ||
|
r34242 | self.stripecount = self.configint('web', 'stripes') | ||
|
r34589 | self.maxshortchanges = self.configint('web', 'maxshortchanges') | ||
|
r34590 | self.maxfiles = self.configint('web', 'maxfiles') | ||
|
r35028 | self.allowpull = self.configbool('web', 'allow-pull') | ||
|
r26135 | |||
|
r26163 | # we use untrusted=False to prevent a repo owner from using | ||
# web.templates in .hg/hgrc to get access to any file readable | ||||
# by the user running the CGI script | ||||
|
r26217 | self.templatepath = self.config('web', 'templates', untrusted=False) | ||
|
r26163 | |||
|
r26164 | # This object is more expensive to build than simple config values. | ||
# It is shared across requests. The app will replace the object | ||||
# if it is updated. Since this is a reference and nothing should | ||||
# modify the underlying object, it should be constant for the lifetime | ||||
# of the request. | ||||
|
r26217 | self.websubtable = app.websubtable | ||
|
r26164 | |||
|
r30766 | self.csp, self.nonce = cspvalues(self.repo.ui) | ||
|
r26135 | # Trust the settings from the .hg/hgrc files by default. | ||
|
r33328 | def config(self, section, name, default=uimod._unset, untrusted=True): | ||
|
r26135 | return self.repo.ui.config(section, name, default, | ||
untrusted=untrusted) | ||||
|
r33328 | def configbool(self, section, name, default=uimod._unset, untrusted=True): | ||
|
r26135 | return self.repo.ui.configbool(section, name, default, | ||
untrusted=untrusted) | ||||
|
r33328 | def configint(self, section, name, default=uimod._unset, untrusted=True): | ||
|
r26135 | return self.repo.ui.configint(section, name, default, | ||
untrusted=untrusted) | ||||
|
r33328 | def configlist(self, section, name, default=uimod._unset, untrusted=True): | ||
|
r26135 | return self.repo.ui.configlist(section, name, default, | ||
untrusted=untrusted) | ||||
|
r26136 | def archivelist(self, nodeid): | ||
allowed = self.configlist('web', 'allow_archive') | ||||
r30748 | for typ, spec in self.archivespecs.iteritems(): | |||
|
r26136 | if typ in allowed or self.configbool('web', 'allow%s' % typ): | ||
yield {'type': typ, 'extension': spec[2], 'node': nodeid} | ||||
|
r18258 | |||
|
r36884 | def templater(self, req): | ||
|
r26183 | # determine scheme, port and server name | ||
# this is needed to create absolute urls | ||||
|
r34613 | logourl = self.config('web', 'logourl') | ||
|
r34612 | logoimg = self.config('web', 'logoimg') | ||
|
r36820 | staticurl = (self.config('web', 'staticurl') | ||
|
r36826 | or req.apppath + '/static/') | ||
|
r26183 | if not staticurl.endswith('/'): | ||
staticurl += '/' | ||||
# some functions for the templater | ||||
def motd(**map): | ||||
|
r34588 | yield self.config('web', 'motd') | ||
|
r26183 | |||
# figure out which style to use | ||||
vars = {} | ||||
|
r36884 | styles, (style, mapfile) = getstyle(req, self.config, | ||
|
r34516 | self.templatepath) | ||
|
r26183 | if style == styles[0]: | ||
vars['style'] = style | ||||
|
r36823 | sessionvars = webutil.sessionvars(vars, '?') | ||
|
r26183 | |||
if not self.reponame: | ||||
|
r34587 | self.reponame = (self.config('web', 'name', '') | ||
|
r36884 | or req.reponame | ||
or req.apppath | ||||
or self.repo.root) | ||||
|
r26183 | |||
def websubfilter(text): | ||||
|
r27008 | return templatefilters.websub(text, self.websubtable) | ||
|
r26183 | |||
# create the templater | ||||
|
r36535 | # TODO: export all keywords: defaults = templatekw.keywords.copy() | ||
|
r28954 | defaults = { | ||
|
r36826 | 'url': req.apppath + '/', | ||
|
r28954 | 'logourl': logourl, | ||
'logoimg': logoimg, | ||||
'staticurl': staticurl, | ||||
|
r36825 | 'urlbase': req.advertisedbaseurl, | ||
|
r28954 | 'repo': self.reponame, | ||
'encoding': encoding.encoding, | ||||
'motd': motd, | ||||
'sessionvars': sessionvars, | ||||
|
r36826 | 'pathdef': makebreadcrumb(req.apppath), | ||
|
r28954 | 'style': style, | ||
|
r30766 | 'nonce': self.nonce, | ||
|
r28954 | } | ||
|
r36535 | tres = formatter.templateresources(self.repo.ui, self.repo) | ||
|
r28954 | tmpl = templater.templater.frommapfile(mapfile, | ||
filters={'websub': websubfilter}, | ||||
|
r36535 | defaults=defaults, | ||
resources=tres) | ||||
|
r26183 | return tmpl | ||
|
r36899 | def sendtemplate(self, name, **kwargs): | ||
"""Helper function to send a response generated from a template.""" | ||||
self.res.setbodygen(self.tmpl(name, **kwargs)) | ||||
return self.res.sendresponse() | ||||
|
r26183 | |||
|
r2356 | class hgweb(object): | ||
|
r26132 | """HTTP server for individual repositories. | ||
Instances of this class serve HTTP responses for a particular | ||||
repository. | ||||
Instances are typically used as WSGI applications. | ||||
Some servers are multi-threaded. On these servers, there may | ||||
be multiple active threads inside __call__. | ||||
""" | ||||
|
r10994 | def __init__(self, repo, name=None, baseui=None): | ||
|
r4874 | if isinstance(repo, str): | ||
|
r10994 | if baseui: | ||
u = baseui.copy() | ||||
else: | ||||
|
r30559 | u = uimod.ui.load() | ||
|
r20168 | r = hg.repository(u, repo) | ||
|
r2356 | else: | ||
|
r22087 | # we trust caller to give us a private copy | ||
|
r20168 | r = repo | ||
|
r2356 | |||
|
r20790 | r.ui.setconfig('ui', 'report_untrusted', 'off', 'hgweb') | ||
r.baseui.setconfig('ui', 'report_untrusted', 'off', 'hgweb') | ||||
r.ui.setconfig('ui', 'nontty', 'true', 'hgweb') | ||||
r.baseui.setconfig('ui', 'nontty', 'true', 'hgweb') | ||||
|
r26294 | # resolve file patterns relative to repo root | ||
r.ui.setconfig('ui', 'forcecwd', r.root, 'hgweb') | ||||
r.baseui.setconfig('ui', 'forcecwd', r.root, 'hgweb') | ||||
|
r25488 | # displaying bundling progress bar while serving feel wrong and may | ||
# break some wsgi implementation. | ||||
r.ui.setconfig('progress', 'disable', 'true', 'hgweb') | ||||
r.baseui.setconfig('progress', 'disable', 'true', 'hgweb') | ||||
|
r26220 | self._repos = [hg.cachedlocalrepo(self._webifyrepo(r))] | ||
self._lastrepo = self._repos[0] | ||||
|
r5833 | hook.redirect(True) | ||
|
r2356 | self.reponame = name | ||
|
r3555 | |||
|
r26218 | def _webifyrepo(self, repo): | ||
repo = getwebview(repo) | ||||
self.websubtable = webutil.getwebsubs(repo) | ||||
return repo | ||||
|
r26220 | @contextlib.contextmanager | ||
def _obtainrepo(self): | ||||
"""Obtain a repo unique to the caller. | ||||
Internally we maintain a stack of cachedlocalrepo instances | ||||
to be handed out. If one is available, we pop it and return it, | ||||
ensuring it is up to date in the process. If one is not available, | ||||
we clone the most recently used repo instance and return it. | ||||
|
r26219 | |||
|
r26220 | It is currently possible for the stack to grow without bounds | ||
if the server allows infinite threads. However, servers should | ||||
have a thread limit, thus establishing our limit. | ||||
""" | ||||
if self._repos: | ||||
cached = self._repos.pop() | ||||
r, created = cached.fetch() | ||||
else: | ||||
cached = self._lastrepo.copy() | ||||
r, created = cached.fetch() | ||||
|
r26240 | if created: | ||
r = self._webifyrepo(r) | ||||
|
r26220 | |||
self._lastrepo = cached | ||||
self.mtime = cached.mtime | ||||
try: | ||||
yield r | ||||
finally: | ||||
self._repos.append(cached) | ||||
|
r2356 | |||
|
r5591 | def run(self): | ||
|
r26132 | """Start a server from CGI environment. | ||
Modern servers should be using WSGI and should avoid this | ||||
method, if possible. | ||||
""" | ||||
|
r30636 | if not encoding.environ.get('GATEWAY_INTERFACE', | ||
'').startswith("CGI/1."): | ||||
|
r8663 | raise RuntimeError("This function is only intended to be " | ||
"called while running as a CGI script.") | ||||
|
r5591 | wsgicgi.launch(self) | ||
def __call__(self, env, respond): | ||||
|
r26132 | """Run the WSGI application. | ||
This may be called by multiple threads. | ||||
""" | ||||
|
r36928 | req = requestmod.parserequestfromenv(env) | ||
res = requestmod.wsgiresponse(req, respond) | ||||
|
r5591 | |||
|
r36928 | return self.run_wsgi(req, res) | ||
def run_wsgi(self, req, res): | ||||
|
r26132 | """Internal method to run the WSGI application. | ||
|
r5591 | |||
|
r26132 | This is typically only called by Mercurial. External consumers | ||
should be using instances of this class as the WSGI application. | ||||
""" | ||||
|
r26220 | with self._obtainrepo() as repo: | ||
r32788 | profile = repo.ui.configbool('profiling', 'enabled') | |||
with profiling.profile(repo.ui, enabled=profile): | ||||
|
r36928 | for r in self._runwsgi(req, res, repo): | ||
|
r29787 | yield r | ||
|
r26220 | |||
|
r36928 | def _runwsgi(self, req, res, repo): | ||
|
r36886 | rctx = requestcontext(self, repo, req, res) | ||
|
r5591 | |||
|
r26160 | # This state is global across all threads. | ||
|
r34236 | encoding.encoding = rctx.config('web', 'encoding') | ||
|
r36925 | rctx.repo.ui.environ = req.rawenv | ||
|
r5591 | |||
|
r30766 | if rctx.csp: | ||
# hgwebdir may have added CSP header. Since we generate our own, | ||||
# replace it. | ||||
|
r36877 | res.headers['Content-Security-Policy'] = rctx.csp | ||
|
r30766 | |||
|
r36877 | handled = wireprotoserver.handlewsgirequest( | ||
|
r36893 | rctx, req, res, self.check_perm) | ||
|
r36830 | if handled: | ||
|
r36877 | return res.sendresponse() | ||
|
r36830 | |||
|
r36914 | # Old implementations of hgweb supported dispatching the request via | ||
# the initial query string parameter instead of using PATH_INFO. | ||||
# If PATH_INFO is present (signaled by ``req.dispatchpath`` having | ||||
# a value), we use it. Otherwise fall back to the query string. | ||||
if req.dispatchpath is not None: | ||||
|
r36829 | query = req.dispatchpath | ||
|
r5596 | else: | ||
|
r36829 | query = req.querystring.partition('&')[0].partition(';')[0] | ||
|
r5591 | |||
|
r5596 | # translate user-visible url structure to internal structure | ||
|
r36829 | args = query.split('/', 2) | ||
|
r36881 | if 'cmd' not in req.qsparams and args and args[0]: | ||
|
r5591 | cmd = args.pop(0) | ||
style = cmd.rfind('-') | ||||
if style != -1: | ||||
|
r36879 | req.qsparams['style'] = cmd[:style] | ||
|
r10282 | cmd = cmd[style + 1:] | ||
|
r5596 | |||
|
r5591 | # avoid accepting e.g. style parameter as command | ||
|
r14953 | if util.safehasattr(webcommands, cmd): | ||
|
r36880 | req.qsparams['cmd'] = cmd | ||
|
r5591 | |||
|
r7287 | if cmd == 'static': | ||
|
r36880 | req.qsparams['file'] = '/'.join(args) | ||
|
r7287 | else: | ||
if args and args[0]: | ||||
r25777 | node = args.pop(0).replace('%2F', '/') | |||
|
r36880 | req.qsparams['node'] = node | ||
|
r7287 | if args: | ||
|
r36880 | if 'file' in req.qsparams: | ||
del req.qsparams['file'] | ||||
for a in args: | ||||
req.qsparams.add('file', a) | ||||
|
r5591 | |||
|
r36832 | ua = req.headers.get('User-Agent', '') | ||
|
r9731 | if cmd == 'rev' and 'mercurial' in ua: | ||
|
r36879 | req.qsparams['style'] = 'raw' | ||
|
r9731 | |||
|
r7287 | if cmd == 'archive': | ||
|
r36881 | fn = req.qsparams['node'] | ||
|
r26136 | for type_, spec in rctx.archivespecs.iteritems(): | ||
|
r5591 | ext = spec[2] | ||
if fn.endswith(ext): | ||||
|
r36881 | req.qsparams['node'] = fn[:-len(ext)] | ||
|
r36880 | req.qsparams['type'] = type_ | ||
|
r36002 | else: | ||
|
r36881 | cmd = req.qsparams.get('cmd', '') | ||
|
r5591 | |||
|
r6149 | # process the web interface request | ||
|
r5599 | |||
try: | ||||
|
r36899 | rctx.tmpl = rctx.templater(req) | ||
ctype = rctx.tmpl('mimetype', encoding=encoding.encoding) | ||||
|
r36938 | ctype = templateutil.stringify(ctype) | ||
|
r6149 | |||
|
r7562 | # check read permissions non-static content | ||
if cmd != 'static': | ||||
|
r36893 | self.check_perm(rctx, req, None) | ||
|
r7336 | |||
|
r6149 | if cmd == '': | ||
|
r36899 | req.qsparams['cmd'] = rctx.tmpl.cache['default'] | ||
|
r36881 | cmd = req.qsparams['cmd'] | ||
|
r5890 | |||
|
r30766 | # Don't enable caching if using a CSP nonce because then it wouldn't | ||
# be a nonce. | ||||
|
r34606 | if rctx.configbool('web', 'cache') and not rctx.nonce: | ||
|
r36885 | tag = 'W/"%d"' % self.mtime | ||
if req.headers.get('If-None-Match') == tag: | ||||
|
r36894 | res.status = '304 Not Modified' | ||
# Response body not allowed on 304. | ||||
res.setbodybytes('') | ||||
return res.sendresponse() | ||||
|
r36885 | |||
res.headers['ETag'] = tag | ||||
|
r6149 | if cmd not in webcommands.__all__: | ||
|
r6368 | msg = 'no such method: %s' % cmd | ||
|
r6149 | raise ErrorResponse(HTTP_BAD_REQUEST, msg) | ||
else: | ||||
|
r36886 | # Set some globals appropriate for web handlers. Commands can | ||
# override easily enough. | ||||
res.status = '200 Script output follows' | ||||
res.headers['Content-Type'] = ctype | ||||
|
r36903 | return getattr(webcommands, cmd)(rctx) | ||
|
r5600 | |||
|
r25660 | except (error.LookupError, error.RepoLookupError) as err: | ||
|
r36272 | msg = pycompat.bytestr(err) | ||
|
r18855 | if (util.safehasattr(err, 'name') and | ||
not isinstance(err, error.ManifestLookupError)): | ||||
|
r6368 | msg = 'revision not found: %s' % err.name | ||
|
r36895 | |||
res.status = '404 Not Found' | ||||
res.headers['Content-Type'] = ctype | ||||
|
r36899 | return rctx.sendtemplate('error', error=msg) | ||
|
r36895 | except (error.RepoError, error.RevlogError) as e: | ||
res.status = '500 Internal Server Error' | ||||
res.headers['Content-Type'] = ctype | ||||
|
r36899 | return rctx.sendtemplate('error', error=pycompat.bytestr(e)) | ||
|
r36895 | except ErrorResponse as e: | ||
res.status = statusmessage(e.code, pycompat.bytestr(e)) | ||||
res.headers['Content-Type'] = ctype | ||||
|
r36899 | return rctx.sendtemplate('error', error=pycompat.bytestr(e)) | ||
|
r5599 | |||
|
r26134 | def check_perm(self, rctx, req, op): | ||
|
r22200 | for permhook in permhooks: | ||
|
r26134 | permhook(rctx, req, op) | ||
|
r26208 | |||
def getwebview(repo): | ||||
"""The 'web.view' config controls changeset filter to hgweb. Possible | ||||
values are ``served``, ``visible`` and ``all``. Default is ``served``. | ||||
The ``served`` filter only shows changesets that can be pulled from the | ||||
hgweb instance. The``visible`` filter includes secret changesets but | ||||
still excludes "hidden" one. | ||||
See the repoview module for details. | ||||
The option has been around undocumented since Mercurial 2.5, but no | ||||
user ever asked about it. So we better keep it undocumented for now.""" | ||||
|
r34585 | # experimental config: web.view | ||
viewconfig = repo.ui.config('web', 'view', untrusted=True) | ||||
|
r26208 | if viewconfig == 'all': | ||
return repo.unfiltered() | ||||
elif viewconfig in repoview.filtertable: | ||||
return repo.filtered(viewconfig) | ||||
else: | ||||
return repo.filtered('served') | ||||