hgweb_mod.py
306 lines
| 11.5 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 | |||
|
r7873 | import os | ||
|
r14953 | from mercurial import ui, hg, hook, error, encoding, templater, util | ||
|
r13958 | from common import get_stat, ErrorResponse, permhooks, caching | ||
|
r12739 | from common import HTTP_OK, HTTP_NOT_MODIFIED, HTTP_BAD_REQUEST | ||
from common import HTTP_NOT_FOUND, HTTP_SERVER_ERROR | ||||
|
r5566 | from request import wsgirequest | ||
|
r6392 | import webcommands, protocol, webutil | ||
|
r2356 | |||
|
r6779 | perms = { | ||
'changegroup': 'pull', | ||||
'changegroupsubset': 'pull', | ||||
|
r13741 | 'getbundle': 'pull', | ||
|
r11370 | 'stream_out': 'pull', | ||
'listkeys': 'pull', | ||||
|
r6779 | 'unbundle': 'push', | ||
|
r11370 | 'pushkey': 'push', | ||
|
r6779 | } | ||
|
r2356 | class hgweb(object): | ||
|
r10994 | def __init__(self, repo, name=None, baseui=None): | ||
|
r4874 | if isinstance(repo, str): | ||
|
r10994 | if baseui: | ||
u = baseui.copy() | ||||
else: | ||||
|
r12696 | u = ui.ui() | ||
|
r8191 | self.repo = hg.repository(u, repo) | ||
|
r2356 | else: | ||
self.repo = repo | ||||
|
r10995 | self.repo.ui.setconfig('ui', 'report_untrusted', 'off') | ||
self.repo.ui.setconfig('ui', 'interactive', 'off') | ||||
|
r5833 | hook.redirect(True) | ||
|
r2356 | self.mtime = -1 | ||
|
r13958 | self.size = -1 | ||
|
r2356 | self.reponame = name | ||
self.archives = 'zip', 'gz', 'bz2' | ||||
|
r2666 | self.stripecount = 1 | ||
|
r3555 | # a repo owner may set web.templates in .hg/hgrc to get any file | ||
# readable by the user running the CGI script | ||||
|
r7966 | self.templatepath = self.config('web', 'templates') | ||
|
r3555 | |||
# The CGI scripts are often run by a user different from the repo owner. | ||||
# Trust the settings from the .hg/hgrc files by default. | ||||
def config(self, section, name, default=None, untrusted=True): | ||||
return self.repo.ui.config(section, name, default, | ||||
untrusted=untrusted) | ||||
def configbool(self, section, name, default=False, untrusted=True): | ||||
return self.repo.ui.configbool(section, name, default, | ||||
untrusted=untrusted) | ||||
def configlist(self, section, name, default=None, untrusted=True): | ||||
return self.repo.ui.configlist(section, name, default, | ||||
untrusted=untrusted) | ||||
|
r2356 | |||
|
r9887 | def refresh(self, request=None): | ||
if request: | ||||
|
r9888 | self.repo.ui.environ = request.env | ||
|
r13958 | st = get_stat(self.repo.spath) | ||
# compare changelog size in addition to mtime to catch | ||||
# rollbacks made less than a second ago | ||||
if st.st_mtime != self.mtime or st.st_size != self.size: | ||||
self.mtime = st.st_mtime | ||||
self.size = st.st_size | ||||
|
r2356 | self.repo = hg.repository(self.repo.ui, self.repo.root) | ||
|
r3555 | self.maxchanges = int(self.config("web", "maxchanges", 10)) | ||
self.stripecount = int(self.config("web", "stripes", 1)) | ||||
|
r16683 | self.maxshortchanges = int(self.config("web", "maxshortchanges", | ||
60)) | ||||
|
r3555 | self.maxfiles = int(self.config("web", "maxfiles", 10)) | ||
self.allowpull = self.configbool("web", "allowpull", True) | ||||
|
r8859 | encoding.encoding = self.config("web", "encoding", | ||
encoding.encoding) | ||||
|
r2356 | |||
|
r5591 | def run(self): | ||
if not os.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 | import mercurial.hgweb.wsgicgi as wsgicgi | ||
wsgicgi.launch(self) | ||||
def __call__(self, env, respond): | ||||
req = wsgirequest(env, respond) | ||||
|
r6784 | return self.run_wsgi(req) | ||
|
r5591 | |||
def run_wsgi(self, req): | ||||
|
r9887 | self.refresh(req) | ||
|
r5591 | |||
|
r5596 | # work with CGI variables to create coherent structure | ||
# use SCRIPT_NAME, PATH_INFO and QUERY_STRING as well as our REPO_NAME | ||||
|
r5591 | |||
|
r5596 | req.url = req.env['SCRIPT_NAME'] | ||
if not req.url.endswith('/'): | ||||
req.url += '/' | ||||
|
r5915 | if 'REPO_NAME' in req.env: | ||
|
r5596 | req.url += req.env['REPO_NAME'] + '/' | ||
|
r5591 | |||
|
r6459 | if 'PATH_INFO' in req.env: | ||
parts = req.env['PATH_INFO'].strip('/').split('/') | ||||
|
r5596 | repo_parts = req.env.get('REPO_NAME', '').split('/') | ||
if parts[:len(repo_parts)] == repo_parts: | ||||
parts = parts[len(repo_parts):] | ||||
query = '/'.join(parts) | ||||
else: | ||||
query = req.env['QUERY_STRING'].split('&', 1)[0] | ||||
query = query.split(';', 1)[0] | ||||
|
r5591 | |||
|
r8860 | # process this if it's a protocol request | ||
# protocol bits don't need to create any URLs | ||||
# and the clients always use the old URL structure | ||||
cmd = req.form.get('cmd', [''])[0] | ||||
|
r11595 | if protocol.iscmd(cmd): | ||
|
r13445 | try: | ||
if query: | ||||
raise ErrorResponse(HTTP_NOT_FOUND) | ||||
if cmd in perms: | ||||
|
r11595 | self.check_perm(req, perms[cmd]) | ||
|
r13445 | return protocol.call(self.repo, req, cmd) | ||
except ErrorResponse, inst: | ||||
|
r13571 | # A client that sends unbundle without 100-continue will | ||
# break if we respond early. | ||||
if (cmd == 'unbundle' and | ||||
|
r14991 | (req.env.get('HTTP_EXPECT', | ||
'').lower() != '100-continue') or | ||||
req.env.get('X-HgHttp2', '')): | ||||
|
r13445 | req.drain() | ||
req.respond(inst, protocol.HGTYPE) | ||||
return '0\n%s\n' % inst.message | ||||
|
r8860 | |||
|
r5596 | # translate user-visible url structure to internal structure | ||
args = query.split('/', 2) | ||||
if 'cmd' not in req.form and args and args[0]: | ||||
|
r5591 | |||
cmd = args.pop(0) | ||||
style = cmd.rfind('-') | ||||
if style != -1: | ||||
req.form['style'] = [cmd[:style]] | ||||
|
r10282 | cmd = cmd[style + 1:] | ||
|
r5596 | |||
|
r5591 | # avoid accepting e.g. style parameter as command | ||
|
r14953 | if util.safehasattr(webcommands, cmd): | ||
|
r5591 | req.form['cmd'] = [cmd] | ||
|
r6777 | else: | ||
cmd = '' | ||||
|
r5591 | |||
|
r7287 | if cmd == 'static': | ||
req.form['file'] = ['/'.join(args)] | ||||
else: | ||||
if args and args[0]: | ||||
node = args.pop(0) | ||||
req.form['node'] = [node] | ||||
if args: | ||||
req.form['file'] = args | ||||
|
r5591 | |||
|
r9731 | ua = req.env.get('HTTP_USER_AGENT', '') | ||
if cmd == 'rev' and 'mercurial' in ua: | ||||
req.form['style'] = ['raw'] | ||||
|
r7287 | if cmd == 'archive': | ||
|
r5591 | fn = req.form['node'][0] | ||
for type_, spec in self.archive_specs.iteritems(): | ||||
ext = spec[2] | ||||
if fn.endswith(ext): | ||||
req.form['node'] = [fn[:-len(ext)]] | ||||
req.form['type'] = [type_] | ||||
|
r6149 | # process the web interface request | ||
|
r5599 | |||
try: | ||||
|
r6149 | tmpl = self.templater(req) | ||
|
r8859 | ctype = tmpl('mimetype', encoding=encoding.encoding) | ||
|
r6391 | ctype = templater.stringify(ctype) | ||
|
r6149 | |||
|
r7562 | # check read permissions non-static content | ||
if cmd != 'static': | ||||
self.check_perm(req, None) | ||||
|
r7336 | |||
|
r6149 | if cmd == '': | ||
req.form['cmd'] = [tmpl.cache['default']] | ||||
cmd = req.form['cmd'][0] | ||||
|
r5890 | |||
|
r13966 | if self.configbool('web', 'cache', True): | ||
caching(self, req) # sets ETag header or raises NOT_MODIFIED | ||||
|
r6149 | if cmd not in webcommands.__all__: | ||
|
r6368 | msg = 'no such method: %s' % cmd | ||
|
r6149 | raise ErrorResponse(HTTP_BAD_REQUEST, msg) | ||
elif cmd == 'file' and 'raw' in req.form.get('style', []): | ||||
self.ctype = ctype | ||||
content = webcommands.rawfile(self, req, tmpl) | ||||
else: | ||||
content = getattr(webcommands, cmd)(self, req, tmpl) | ||||
req.respond(HTTP_OK, ctype) | ||||
|
r5890 | |||
|
r7396 | return content | ||
|
r5600 | |||
|
r7633 | except error.LookupError, err: | ||
|
r5993 | req.respond(HTTP_NOT_FOUND, ctype) | ||
|
r6374 | msg = str(err) | ||
if 'manifest' not in msg: | ||||
|
r6368 | msg = 'revision not found: %s' % err.name | ||
|
r7396 | return tmpl('error', error=msg) | ||
|
r7637 | except (error.RepoError, error.RevlogError), inst: | ||
|
r5993 | req.respond(HTTP_SERVER_ERROR, ctype) | ||
|
r7396 | return tmpl('error', error=str(inst)) | ||
|
r5600 | except ErrorResponse, inst: | ||
|
r7740 | req.respond(inst, ctype) | ||
|
r12739 | if inst.code == HTTP_NOT_MODIFIED: | ||
# Not allowed to return a body on a 304 | ||||
return [''] | ||||
|
r7396 | return tmpl('error', error=inst.message) | ||
|
r5599 | |||
def templater(self, req): | ||||
|
r5596 | # determine scheme, port and server name | ||
# this is needed to create absolute urls | ||||
|
r5591 | |||
proto = req.env.get('wsgi.url_scheme') | ||||
if proto == 'https': | ||||
proto = 'https' | ||||
default_port = "443" | ||||
else: | ||||
proto = 'http' | ||||
default_port = "80" | ||||
port = req.env["SERVER_PORT"] | ||||
port = port != default_port and (":" + port) or "" | ||||
urlbase = '%s://%s%s' % (proto, req.env['SERVER_NAME'], port) | ||||
|
r13964 | logourl = self.config("web", "logourl", "http://mercurial.selenic.com/") | ||
|
r14913 | logoimg = self.config("web", "logoimg", "hglogo.png") | ||
|
r5591 | staticurl = self.config("web", "staticurl") or req.url + 'static/' | ||
if not staticurl.endswith('/'): | ||||
staticurl += '/' | ||||
|
r5596 | # some functions for the templater | ||
def header(**map): | ||||
|
r8859 | yield tmpl('header', encoding=encoding.encoding, **map) | ||
|
r5596 | |||
def footer(**map): | ||||
|
r5600 | yield tmpl("footer", **map) | ||
|
r5596 | |||
def motd(**map): | ||||
yield self.config("web", "motd", "") | ||||
|
r5599 | # figure out which style to use | ||
|
r7345 | vars = {} | ||
|
r9842 | styles = ( | ||
req.form.get('style', [None])[0], | ||||
self.config('web', 'style'), | ||||
'paper', | ||||
) | ||||
style, mapfile = templater.stylemap(styles, self.templatepath) | ||||
if style == styles[0]: | ||||
|
r7345 | vars['style'] = style | ||
start = req.url[-1] == '?' and '&' or '?' | ||||
sessionvars = webutil.sessionvars(vars, start) | ||||
|
r5596 | |||
|
r5591 | if not self.reponame: | ||
self.reponame = (self.config("web", "name") | ||||
or req.env.get('REPO_NAME') | ||||
or req.url.strip('/') or self.repo.root) | ||||
|
r5599 | # create the templater | ||
|
r8360 | tmpl = templater.templater(mapfile, | ||
|
r5600 | defaults={"url": req.url, | ||
|
r13964 | "logourl": logourl, | ||
|
r14913 | "logoimg": logoimg, | ||
|
r5600 | "staticurl": staticurl, | ||
"urlbase": urlbase, | ||||
"repo": self.reponame, | ||||
"header": header, | ||||
"footer": footer, | ||||
"motd": motd, | ||||
"sessionvars": sessionvars | ||||
}) | ||||
return tmpl | ||||
|
r5591 | |||
|
r2356 | def archivelist(self, nodeid): | ||
|
r3555 | allowed = self.configlist("web", "allow_archive") | ||
|
r3260 | for i, spec in self.archive_specs.iteritems(): | ||
|
r3555 | if i in allowed or self.configbool("web", "allow" + i): | ||
|
r3260 | yield {"type" : i, "extension" : spec[2], "node" : nodeid} | ||
|
r2356 | |||
archive_specs = { | ||||
|
r12570 | 'bz2': ('application/x-bzip2', 'tbz2', '.tar.bz2', None), | ||
'gz': ('application/x-gzip', 'tgz', '.tar.gz', None), | ||||
|
r2356 | 'zip': ('application/zip', 'zip', '.zip', None), | ||
} | ||||
|
r6779 | def check_perm(self, req, op): | ||
|
r9910 | for hook in permhooks: | ||
hook(self, req, op) | ||||