mercurial-scm/hg-stable: mercurial/hgweb/request.py annotate

annotate mercurial/hgweb/request.py @ 37000:44467a4d472f

hgweb: refactor multirequest to be a dict of lists ... instead of a list of 2-tuples. This makes key lookups faster. The only downside is we lose total ordering of all entries. But we weren't relying on that before, so it's no loss. Differential Revision: https://phab.mercurial-scm.org/D2881

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Fri, 16 Mar 2018 09:41:21 -0700
parents	f0a851542a05
children	55e901396005

rev	line source
2391 d351a3be3371 Fixing up comment headers for split up code. Eric Hopper <hopper@omnifarious.org> parents: 2355 diff changeset	1 # hgweb/request.py - An http request from either CGI or the standalone server.
131 c9d51742471c moving hgweb to mercurial subdir jake@edge2.net parents: diff changeset	2 #
238 3b92f8fe47ae hgweb.py: kill #! line, clean up copyright notice mpm@selenic.com parents: 222 diff changeset	3 # Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net>
2859 345bac2bc4ec update copyrights. Vadim Gelfer <vadim.gelfer@gmail.com> parents: 2535 diff changeset	4 # Copyright 2005, 2006 Matt Mackall <mpm@selenic.com>
131 c9d51742471c moving hgweb to mercurial subdir jake@edge2.net parents: diff changeset	5 #
8225 46293a0c7e9f updated license to be explicit about GPL version 2 Martin Geisler <mg@lazybytes.net> parents: 7742 diff changeset	6 # 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: 10261 diff changeset	7 # GNU General Public License version 2 or any later version.
131 c9d51742471c moving hgweb to mercurial subdir jake@edge2.net parents: diff changeset	8
27046 37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 26846 diff changeset	9 from __future__ import absolute_import
37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 26846 diff changeset	10
36822 f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	11 import wsgiref.headers as wsgiheaders
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	12 #import wsgiref.validate
27046 37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 26846 diff changeset	13
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	14 from ..thirdparty import (
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	15 attr,
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	16 )
27046 37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 26846 diff changeset	17 from .. import (
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	18 error,
34514 528b21b853aa request: coerce content-type to native str Augie Fackler <augie@google.com> parents: 34513 diff changeset	19 pycompat,
27046 37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 26846 diff changeset	20 util,
37fcfe52c68c hgweb: use absolute_import Yuya Nishihara <yuya@tcha.org> parents: 26846 diff changeset	21 )
138 c77a679e9cfa Revamped templated hgweb mpm@selenic.com parents: 137 diff changeset	22
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	23 class multidict(object):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	24 """A dict like object that can store multiple values for a key.
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	25
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	26 Used to store parsed request parameters.
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	27
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	28 This is inspired by WebOb's class of the same name.
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	29 """
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	30 def __init__(self):
37000 44467a4d472f hgweb: refactor multirequest to be a dict of lists Gregory Szorc <gregory.szorc@gmail.com> parents: 36917 diff changeset	31 self._items = {}
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	32
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	33 def __getitem__(self, key):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	34 """Returns the last set value for a key."""
37000 44467a4d472f hgweb: refactor multirequest to be a dict of lists Gregory Szorc <gregory.szorc@gmail.com> parents: 36917 diff changeset	35 return self._items[key][-1]
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	36
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	37 def __setitem__(self, key, value):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	38 """Replace a values for a key with a new value."""
37000 44467a4d472f hgweb: refactor multirequest to be a dict of lists Gregory Szorc <gregory.szorc@gmail.com> parents: 36917 diff changeset	39 self._items[key] = [value]
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	40
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	41 def __delitem__(self, key):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	42 """Delete all values for a key."""
37000 44467a4d472f hgweb: refactor multirequest to be a dict of lists Gregory Szorc <gregory.szorc@gmail.com> parents: 36917 diff changeset	43 del self._items[key]
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	44
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	45 def __contains__(self, key):
37000 44467a4d472f hgweb: refactor multirequest to be a dict of lists Gregory Szorc <gregory.szorc@gmail.com> parents: 36917 diff changeset	46 return key in self._items
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	47
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	48 def __len__(self):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	49 return len(self._items)
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	50
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	51 def get(self, key, default=None):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	52 try:
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	53 return self.__getitem__(key)
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	54 except KeyError:
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	55 return default
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	56
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	57 def add(self, key, value):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	58 """Add a new value for a key. Does not replace existing values."""
37000 44467a4d472f hgweb: refactor multirequest to be a dict of lists Gregory Szorc <gregory.szorc@gmail.com> parents: 36917 diff changeset	59 self._items.setdefault(key, []).append(value)
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	60
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	61 def getall(self, key):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	62 """Obtains all values for a key."""
37000 44467a4d472f hgweb: refactor multirequest to be a dict of lists Gregory Szorc <gregory.szorc@gmail.com> parents: 36917 diff changeset	63 return self._items.get(key, [])
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	64
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	65 def getone(self, key):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	66 """Obtain a single value for a key.
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	67
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	68 Raises KeyError if key not defined or it has multiple values set.
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	69 """
37000 44467a4d472f hgweb: refactor multirequest to be a dict of lists Gregory Szorc <gregory.szorc@gmail.com> parents: 36917 diff changeset	70 vals = self._items[key]
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	71
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	72 if len(vals) > 1:
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	73 raise KeyError('multiple values for %r' % key)
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	74
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	75 return vals[0]
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	76
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	77 def asdictoflists(self):
37000 44467a4d472f hgweb: refactor multirequest to be a dict of lists Gregory Szorc <gregory.szorc@gmail.com> parents: 36917 diff changeset	78 return {k: list(v) for k, v in self._items.iteritems()}
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	79
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	80 @attr.s(frozen=True)
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	81 class parsedrequest(object):
36863 da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36862 diff changeset	82 """Represents a parsed WSGI request.
da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36862 diff changeset	83
da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36862 diff changeset	84 Contains both parsed parameters as well as a handle on the input stream.
da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36862 diff changeset	85 """
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	86
36854 16292bbda39c hgweb: store and use request method on parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36853 diff changeset	87 # Request method.
16292bbda39c hgweb: store and use request method on parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36853 diff changeset	88 method = attr.ib()
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	89 # Full URL for this request.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	90 url = attr.ib()
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	91 # URL without any path components. Just <proto>://<host><port>.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	92 baseurl = attr.ib()
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	93 # Advertised URL. Like ``url`` and ``baseurl`` but uses SERVER_NAME instead
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	94 # of HTTP: Host header for hostname. This is likely what clients used.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	95 advertisedurl = attr.ib()
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	96 advertisedbaseurl = attr.ib()
36873 a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36872 diff changeset	97 # URL scheme (part before ``://``). e.g. ``http`` or ``https``.
a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36872 diff changeset	98 urlscheme = attr.ib()
a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36872 diff changeset	99 # Value of REMOTE_USER, if set, or None.
a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36872 diff changeset	100 remoteuser = attr.ib()
a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36872 diff changeset	101 # Value of REMOTE_HOST, if set, or None.
a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36872 diff changeset	102 remotehost = attr.ib()
36905 e67a2e05fa8a hgweb: clarify that apppath begins with a forward slash Gregory Szorc <gregory.szorc@gmail.com> parents: 36904 diff changeset	103 # Relative WSGI application path. If defined, will begin with a
e67a2e05fa8a hgweb: clarify that apppath begins with a forward slash Gregory Szorc <gregory.szorc@gmail.com> parents: 36904 diff changeset	104 # ``/``.
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	105 apppath = attr.ib()
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	106 # List of path parts to be used for dispatch.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	107 dispatchparts = attr.ib()
36904 d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	108 # URL path component (no query string) used for dispatch. Can be
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	109 # ``None`` to signal no path component given to the request, an
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	110 # empty string to signal a request to the application's root URL,
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	111 # or a string not beginning with ``/`` containing the requested
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	112 # path under the application.
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	113 dispatchpath = attr.ib()
36874 8ddb5c354906 hgweb: expose repo name on parsedrequest Gregory Szorc <gregory.szorc@gmail.com> parents: 36873 diff changeset	114 # The name of the repository being accessed.
8ddb5c354906 hgweb: expose repo name on parsedrequest Gregory Szorc <gregory.szorc@gmail.com> parents: 36873 diff changeset	115 reponame = attr.ib()
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	116 # Raw query string (part after "?" in URL).
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	117 querystring = attr.ib()
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	118 # multidict of query string parameters.
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	119 qsparams = attr.ib()
36822 f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	120 # wsgiref.headers.Headers instance. Operates like a dict with case
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	121 # insensitive keys.
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	122 headers = attr.ib()
36863 da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36862 diff changeset	123 # Request body input stream.
da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36862 diff changeset	124 bodyfh = attr.ib()
36915 84110a1d0f7d hgweb: store the raw WSGI environment dict Gregory Szorc <gregory.szorc@gmail.com> parents: 36914 diff changeset	125 # WSGI environment dict, unmodified.
84110a1d0f7d hgweb: store the raw WSGI environment dict Gregory Szorc <gregory.szorc@gmail.com> parents: 36914 diff changeset	126 rawenv = attr.ib()
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	127
36917 f0a851542a05 hgweb: remove wsgirequest (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36915 diff changeset	128 def parserequestfromenv(env, reponame=None, altbaseurl=None):
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	129 """Parse URL components from environment variables.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	130
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	131 WSGI defines request attributes via environment variables. This function
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	132 parses the environment variables into a data structure.
36903 d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	133
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	134 If ``reponame`` is defined, the leading path components matching that
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	135 string are effectively shifted from ``PATH_INFO`` to ``SCRIPT_NAME``.
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	136 This simulates the world view of a WSGI application that processes
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	137 requests from the base URL of a repo.
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	138
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	139 If ``altbaseurl`` (typically comes from ``web.baseurl`` config option)
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	140 is defined, it is used - instead of the WSGI environment variables - for
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	141 constructing URL components up to and including the WSGI application path.
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	142 For example, if the current WSGI application is at ``/repo`` and a request
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	143 is made to ``/rev/@`` with this argument set to
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	144 ``http://myserver:9000/prefix``, the URL and path components will resolve as
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	145 if the request were to ``http://myserver:9000/prefix/rev/@``. In other
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	146 words, ``wsgi.url_scheme``, ``SERVER_NAME``, ``SERVER_PORT``, and
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	147 ``SCRIPT_NAME`` are all effectively replaced by components from this URL.
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	148 """
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	149 # PEP 3333 defines the WSGI spec and is a useful reference for this code.
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	150
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	151 # We first validate that the incoming object conforms with the WSGI spec.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	152 # We only want to be dealing with spec-conforming WSGI implementations.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	153 # TODO enable this once we fix internal violations.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	154 #wsgiref.validate.check_environ(env)
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	155
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	156 # PEP-0333 states that environment keys and values are native strings
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	157 # (bytes on Python 2 and str on Python 3). The code points for the Unicode
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	158 # strings on Python 3 must be between \00000-\000FF. We deal with bytes
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	159 # in Mercurial, so mass convert string keys and values to bytes.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	160 if pycompat.ispy3:
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	161 env = {k.encode('latin-1'): v for k, v in env.iteritems()}
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	162 env = {k: v.encode('latin-1') if isinstance(v, str) else v
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	163 for k, v in env.iteritems()}
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	164
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	165 if altbaseurl:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	166 altbaseurl = util.url(altbaseurl)
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	167
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	168 # https://www.python.org/dev/peps/pep-0333/#environ-variables defines
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	169 # the environment variables.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	170 # https://www.python.org/dev/peps/pep-0333/#url-reconstruction defines
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	171 # how URLs are reconstructed.
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	172 fullurl = env['wsgi.url_scheme'] + '://'
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	173
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	174 if altbaseurl and altbaseurl.scheme:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	175 advertisedfullurl = altbaseurl.scheme + '://'
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	176 else:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	177 advertisedfullurl = fullurl
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	178
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	179 def addport(s, port):
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	180 if s.startswith('https://'):
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	181 if port != '443':
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	182 s += ':' + port
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	183 else:
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	184 if port != '80':
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	185 s += ':' + port
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	186
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	187 return s
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	188
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	189 if env.get('HTTP_HOST'):
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	190 fullurl += env['HTTP_HOST']
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	191 else:
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	192 fullurl += env['SERVER_NAME']
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	193 fullurl = addport(fullurl, env['SERVER_PORT'])
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	194
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	195 if altbaseurl and altbaseurl.host:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	196 advertisedfullurl += altbaseurl.host
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	197
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	198 if altbaseurl.port:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	199 port = altbaseurl.port
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	200 elif altbaseurl.scheme == 'http' and not altbaseurl.port:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	201 port = '80'
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	202 elif altbaseurl.scheme == 'https' and not altbaseurl.port:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	203 port = '443'
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	204 else:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	205 port = env['SERVER_PORT']
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	206
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	207 advertisedfullurl = addport(advertisedfullurl, port)
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	208 else:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	209 advertisedfullurl += env['SERVER_NAME']
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	210 advertisedfullurl = addport(advertisedfullurl, env['SERVER_PORT'])
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	211
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	212 baseurl = fullurl
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	213 advertisedbaseurl = advertisedfullurl
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	214
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	215 fullurl += util.urlreq.quote(env.get('SCRIPT_NAME', ''))
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	216 fullurl += util.urlreq.quote(env.get('PATH_INFO', ''))
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	217
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	218 if altbaseurl:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	219 path = altbaseurl.path or ''
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	220 if path and not path.startswith('/'):
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	221 path = '/' + path
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	222 advertisedfullurl += util.urlreq.quote(path)
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	223 else:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	224 advertisedfullurl += util.urlreq.quote(env.get('SCRIPT_NAME', ''))
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	225
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	226 advertisedfullurl += util.urlreq.quote(env.get('PATH_INFO', ''))
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	227
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	228 if env.get('QUERY_STRING'):
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	229 fullurl += '?' + env['QUERY_STRING']
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	230 advertisedfullurl += '?' + env['QUERY_STRING']
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	231
36903 d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	232 # If ``reponame`` is defined, that must be a prefix on PATH_INFO
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	233 # that represents the repository being dispatched to. When computing
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	234 # the dispatch info, we ignore these leading path components.
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	235
36906 219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	236 if altbaseurl:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	237 apppath = altbaseurl.path or ''
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	238 if apppath and not apppath.startswith('/'):
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	239 apppath = '/' + apppath
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	240 else:
219b23359f4c hgweb: support constructing URLs from an alternate base URL Gregory Szorc <gregory.szorc@gmail.com> parents: 36905 diff changeset	241 apppath = env.get('SCRIPT_NAME', '')
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	242
36903 d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	243 if reponame:
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	244 repoprefix = '/' + reponame.strip('/')
36816 0031e972ded2 hgweb: use the parsed application path directly Gregory Szorc <gregory.szorc@gmail.com> parents: 36814 diff changeset	245
36903 d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	246 if not env.get('PATH_INFO'):
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	247 raise error.ProgrammingError('reponame requires PATH_INFO')
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	248
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	249 if not env['PATH_INFO'].startswith(repoprefix):
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	250 raise error.ProgrammingError('PATH_INFO does not begin with repo '
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	251 'name: %s (%s)' % (env['PATH_INFO'],
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	252 reponame))
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	253
36903 d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	254 dispatchpath = env['PATH_INFO'][len(repoprefix):]
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	255
36903 d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	256 if dispatchpath and not dispatchpath.startswith('/'):
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	257 raise error.ProgrammingError('reponame prefix of PATH_INFO does '
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	258 'not end at path delimiter: %s (%s)' %
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	259 (env['PATH_INFO'], reponame))
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	260
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	261 apppath = apppath.rstrip('/') + repoprefix
d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	262 dispatchparts = dispatchpath.strip('/').split('/')
36904 d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	263 dispatchpath = '/'.join(dispatchparts)
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	264
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	265 elif 'PATH_INFO' in env:
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	266 if env['PATH_INFO'].strip('/'):
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	267 dispatchparts = env['PATH_INFO'].strip('/').split('/')
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	268 dispatchpath = '/'.join(dispatchparts)
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	269 else:
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	270 dispatchparts = []
d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	271 dispatchpath = ''
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	272 else:
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	273 dispatchparts = []
36904 d0b0fedbfb53 hgweb: change how dispatch path is reported Gregory Szorc <gregory.szorc@gmail.com> parents: 36903 diff changeset	274 dispatchpath = None
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	275
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	276 querystring = env.get('QUERY_STRING', '')
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	277
36817 3c15b84ab66c hgweb: teach WSGI parser about query strings Gregory Szorc <gregory.szorc@gmail.com> parents: 36816 diff changeset	278 # We store as a list so we have ordering information. We also store as
3c15b84ab66c hgweb: teach WSGI parser about query strings Gregory Szorc <gregory.szorc@gmail.com> parents: 36816 diff changeset	279 # a dict to facilitate fast lookup.
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	280 qsparams = multidict()
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	281 for k, v in util.urlreq.parseqsl(querystring, keep_blank_values=True):
ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	282 qsparams.add(k, v)
36817 3c15b84ab66c hgweb: teach WSGI parser about query strings Gregory Szorc <gregory.szorc@gmail.com> parents: 36816 diff changeset	283
36822 f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	284 # HTTP_* keys contain HTTP request headers. The Headers structure should
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	285 # perform case normalization for us. We just rewrite underscore to dash
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	286 # so keys match what likely went over the wire.
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	287 headers = []
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	288 for k, v in env.iteritems():
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	289 if k.startswith('HTTP_'):
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	290 headers.append((k[len('HTTP_'):].replace('_', '-'), v))
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	291
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	292 headers = wsgiheaders.Headers(headers)
f9078c6caeb6 hgweb: parse and store HTTP request headers Gregory Szorc <gregory.szorc@gmail.com> parents: 36819 diff changeset	293
36853 ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36822 diff changeset	294 # This is kind of a lie because the HTTP header wasn't explicitly
ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36822 diff changeset	295 # sent. But for all intents and purposes it should be OK to lie about
ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36822 diff changeset	296 # this, since a consumer will either either value to determine how many
ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36822 diff changeset	297 # bytes are available to read.
ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36822 diff changeset	298 if 'CONTENT_LENGTH' in env and 'HTTP_CONTENT_LENGTH' not in env:
ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36822 diff changeset	299 headers['Content-Length'] = env['CONTENT_LENGTH']
ed0456fde625 hgweb: handle CONTENT_LENGTH Gregory Szorc <gregory.szorc@gmail.com> parents: 36822 diff changeset	300
36917 f0a851542a05 hgweb: remove wsgirequest (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36915 diff changeset	301 bodyfh = env['wsgi.input']
f0a851542a05 hgweb: remove wsgirequest (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36915 diff changeset	302 if 'Content-Length' in headers:
f0a851542a05 hgweb: remove wsgirequest (API) Gregory Szorc <gregory.szorc@gmail.com> parents: 36915 diff changeset	303 bodyfh = util.cappedreader(bodyfh, int(headers['Content-Length']))
36863 da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36862 diff changeset	304
36854 16292bbda39c hgweb: store and use request method on parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36853 diff changeset	305 return parsedrequest(method=env['REQUEST_METHOD'],
16292bbda39c hgweb: store and use request method on parsed request Gregory Szorc <gregory.szorc@gmail.com> parents: 36853 diff changeset	306 url=fullurl, baseurl=baseurl,
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	307 advertisedurl=advertisedfullurl,
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	308 advertisedbaseurl=advertisedbaseurl,
36873 a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36872 diff changeset	309 urlscheme=env['wsgi.url_scheme'],
a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36872 diff changeset	310 remoteuser=env.get('REMOTE_USER'),
a755fd3b7146 hgweb: expose URL scheme and REMOTE_* attributes Gregory Szorc <gregory.szorc@gmail.com> parents: 36872 diff changeset	311 remotehost=env.get('REMOTE_HOST'),
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	312 apppath=apppath,
69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	313 dispatchparts=dispatchparts, dispatchpath=dispatchpath,
36903 d7fd203e36cc hgweb: refactor repository name URL parsing Gregory Szorc <gregory.szorc@gmail.com> parents: 36902 diff changeset	314 reponame=reponame,
36817 3c15b84ab66c hgweb: teach WSGI parser about query strings Gregory Szorc <gregory.szorc@gmail.com> parents: 36816 diff changeset	315 querystring=querystring,
36868 ec0af9c59270 hgweb: use a multidict for holding query string parameters Gregory Szorc <gregory.szorc@gmail.com> parents: 36867 diff changeset	316 qsparams=qsparams,
36863 da4e2f87167d hgweb: expose input stream on parsed WSGI request object Gregory Szorc <gregory.szorc@gmail.com> parents: 36862 diff changeset	317 headers=headers,
36915 84110a1d0f7d hgweb: store the raw WSGI environment dict Gregory Szorc <gregory.szorc@gmail.com> parents: 36914 diff changeset	318 bodyfh=bodyfh,
84110a1d0f7d hgweb: store the raw WSGI environment dict Gregory Szorc <gregory.szorc@gmail.com> parents: 36914 diff changeset	319 rawenv=env)
36814 69b2d0900cd7 hgweb: parse WSGI request into a data structure Gregory Szorc <gregory.szorc@gmail.com> parents: 36736 diff changeset	320
36881 16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	321 class offsettrackingwriter(object):
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	322 """A file object like object that is append only and tracks write count.
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	323
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	324 Instances are bound to a callable. This callable is called with data
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	325 whenever a ``write()`` is attempted.
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	326
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	327 Instances track the amount of written data so they can answer ``tell()``
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	328 requests.
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	329
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	330 The intent of this class is to wrap the ``write()`` function returned by
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	331 a WSGI ``start_response()`` function. Since ``write()`` is a callable and
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	332 not a file object, it doesn't implement other file object methods.
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	333 """
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	334 def __init__(self, writefn):
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	335 self._write = writefn
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	336 self._offset = 0
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	337
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	338 def write(self, s):
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	339 res = self._write(s)
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	340 # Some Python objects don't report the number of bytes written.
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	341 if res is None:
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	342 self._offset += len(s)
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	343 else:
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	344 self._offset += res
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	345
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	346 def flush(self):
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	347 pass
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	348
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	349 def tell(self):
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	350 return self._offset
16499427f6de hgweb: refactor fake file object proxy for archiving Gregory Szorc <gregory.szorc@gmail.com> parents: 36874 diff changeset	351
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	352 class wsgiresponse(object):
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	353 """Represents a response to a WSGI request.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	354
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	355 A response consists of a status line, headers, and a body.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	356
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	357 Consumers must populate the ``status`` and ``headers`` fields and
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	358 make a call to a ``setbody*()`` method before the response can be
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	359 issued.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	360
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	361 When it is time to start sending the response over the wire,
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	362 ``sendresponse()`` is called. It handles emitting the header portion
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	363 of the response message. It then yields chunks of body data to be
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	364 written to the peer. Typically, the WSGI application itself calls
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	365 and returns the value from ``sendresponse()``.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	366 """
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	367
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	368 def __init__(self, req, startresponse):
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	369 """Create an empty response tied to a specific request.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	370
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	371 ``req`` is a ``parsedrequest``. ``startresponse`` is the
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	372 ``start_response`` function passed to the WSGI application.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	373 """
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	374 self._req = req
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	375 self._startresponse = startresponse
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	376
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	377 self.status = None
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	378 self.headers = wsgiheaders.Headers([])
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	379
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	380 self._bodybytes = None
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	381 self._bodygen = None
36882 97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	382 self._bodywillwrite = False
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	383 self._started = False
36882 97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	384 self._bodywritefn = None
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	385
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	386 def _verifybody(self):
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	387 if (self._bodybytes is not None or self._bodygen is not None
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	388 or self._bodywillwrite):
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	389 raise error.ProgrammingError('cannot define body multiple times')
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	390
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	391 def setbodybytes(self, b):
36884 ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	392 """Define the response body as static bytes.
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	393
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	394 The empty string signals that there is no response body.
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	395 """
36882 97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	396 self._verifybody()
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	397 self._bodybytes = b
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	398 self.headers['Content-Length'] = '%d' % len(b)
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	399
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	400 def setbodygen(self, gen):
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	401 """Define the response body as a generator of bytes."""
36882 97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	402 self._verifybody()
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	403 self._bodygen = gen
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	404
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	405 def setbodywillwrite(self):
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	406 """Signal an intent to use write() to emit the response body.
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	407
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	408 This is the least preferred way to send a body.
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	409
36882 97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	410 It is preferred for WSGI applications to emit a generator of chunks
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	411 constituting the response body. However, some consumers can't emit
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	412 data this way. So, WSGI provides a way to obtain a ``write(data)``
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	413 function that can be used to synchronously perform an unbuffered
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	414 write.
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	415
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	416 Calling this function signals an intent to produce the body in this
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	417 manner.
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	418 """
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	419 self._verifybody()
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	420 self._bodywillwrite = True
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	421
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	422 def sendresponse(self):
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	423 """Send the generated response to the client.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	424
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	425 Before this is called, ``status`` must be set and one of
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	426 ``setbodybytes()`` or ``setbodygen()`` must be called.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	427
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	428 Calling this method multiple times is not allowed.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	429 """
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	430 if self._started:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	431 raise error.ProgrammingError('sendresponse() called multiple times')
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	432
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	433 self._started = True
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	434
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	435 if not self.status:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	436 raise error.ProgrammingError('status line not defined')
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	437
36882 97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	438 if (self._bodybytes is None and self._bodygen is None
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	439 and not self._bodywillwrite):
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	440 raise error.ProgrammingError('response body not defined')
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	441
36884 ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	442 # RFC 7232 Section 4.1 states that a 304 MUST generate one of
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	443 # {Cache-Control, Content-Location, Date, ETag, Expires, Vary}
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	444 # and SHOULD NOT generate other headers unless they could be used
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	445 # to guide cache updates. Furthermore, RFC 7230 Section 3.3.2
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	446 # states that no response body can be issued. Content-Length can
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	447 # be sent. But if it is present, it should be the size of the response
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	448 # that wasn't transferred.
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	449 if self.status.startswith('304 '):
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	450 # setbodybytes('') will set C-L to 0. This doesn't conform with the
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	451 # spec. So remove it.
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	452 if self.headers.get('Content-Length') == '0':
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	453 del self.headers['Content-Length']
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	454
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	455 # Strictly speaking, this is too strict. But until it causes
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	456 # problems, let's be strict.
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	457 badheaders = {k for k in self.headers.keys()
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	458 if k.lower() not in ('date', 'etag', 'expires',
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	459 'cache-control',
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	460 'content-location',
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	461 'vary')}
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	462 if badheaders:
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	463 raise error.ProgrammingError(
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	464 'illegal header on 304 response: %s' %
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	465 ', '.join(sorted(badheaders)))
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	466
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	467 if self._bodygen is not None or self._bodywillwrite:
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	468 raise error.ProgrammingError("must use setbodybytes('') with "
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	469 "304 responses")
ccb70a77f746 hgweb: refactor 304 handling code Gregory Szorc <gregory.szorc@gmail.com> parents: 36882 diff changeset	470
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	471 # Various HTTP clients (notably httplib) won't read the HTTP response
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	472 # until the HTTP request has been sent in full. If servers (us) send a
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	473 # response before the HTTP request has been fully sent, the connection
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	474 # may deadlock because neither end is reading.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	475 #
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	476 # We work around this by "draining" the request data before
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	477 # sending any response in some conditions.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	478 drain = False
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	479 close = False
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	480
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	481 # If the client sent Expect: 100-continue, we assume it is smart enough
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	482 # to deal with the server sending a response before reading the request.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	483 # (httplib doesn't do this.)
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	484 if self._req.headers.get('Expect', '').lower() == '100-continue':
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	485 pass
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	486 # Only tend to request methods that have bodies. Strictly speaking,
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	487 # we should sniff for a body. But this is fine for our existing
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	488 # WSGI applications.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	489 elif self._req.method not in ('POST', 'PUT'):
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	490 pass
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	491 else:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	492 # If we don't know how much data to read, there's no guarantee
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	493 # that we can drain the request responsibly. The WSGI
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	494 # specification only says that servers should ensure the
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	495 # input stream doesn't overrun the actual request. So there's
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	496 # no guarantee that reading until EOF won't corrupt the stream
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	497 # state.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	498 if not isinstance(self._req.bodyfh, util.cappedreader):
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	499 close = True
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	500 else:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	501 # We /could/ only drain certain HTTP response codes. But 200 and
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	502 # non-200 wire protocol responses both require draining. Since
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	503 # we have a capped reader in place for all situations where we
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	504 # drain, it is safe to read from that stream. We'll either do
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	505 # a drain or no-op if we're already at EOF.
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	506 drain = True
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	507
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	508 if close:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	509 self.headers['Connection'] = 'Close'
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	510
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	511 if drain:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	512 assert isinstance(self._req.bodyfh, util.cappedreader)
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	513 while True:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	514 chunk = self._req.bodyfh.read(32768)
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	515 if not chunk:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	516 break
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	517
36882 97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	518 write = self._startresponse(pycompat.sysstr(self.status),
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	519 self.headers.items())
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	520
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	521 if self._bodybytes:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	522 yield self._bodybytes
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	523 elif self._bodygen:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	524 for chunk in self._bodygen:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	525 yield chunk
36882 97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	526 elif self._bodywillwrite:
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	527 self._bodywritefn = write
36867 a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	528 else:
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	529 error.ProgrammingError('do not know how to send body')
a88d68dc3ee8 hgweb: create dedicated type for WSGI responses Gregory Szorc <gregory.szorc@gmail.com> parents: 36865 diff changeset	530
36882 97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	531 def getbodyfile(self):
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	532 """Obtain a file object like object representing the response body.
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	533
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	534 For this to work, you must call ``setbodywillwrite()`` and then
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	535 ``sendresponse()`` first. ``sendresponse()`` is a generator and the
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	536 function won't run to completion unless the generator is advanced. The
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	537 generator yields not items. The easiest way to consume it is with
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	538 ``list(res.sendresponse())``, which should resolve to an empty list -
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	539 ``[]``.
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	540 """
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	541 if not self._bodywillwrite:
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	542 raise error.ProgrammingError('must call setbodywillwrite() first')
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	543
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	544 if not self._started:
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	545 raise error.ProgrammingError('must call sendresponse() first; did '
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	546 'you remember to consume it since it '
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	547 'is a generator?')
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	548
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	549 assert self._bodywritefn
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	550 return offsettrackingwriter(self._bodywritefn)
97f44b0720e2 hgweb: port archive command to modern response API Gregory Szorc <gregory.szorc@gmail.com> parents: 36881 diff changeset	551
5566 d74fc8dec2b4 Less indirection in the WSGI web interface. This simplifies some code, and makes it more compliant with WSGI. Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 5563 diff changeset	552 def wsgiapplication(app_maker):
5887 41a3fce17625 hgweb: return iterable, add deprecation note Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 5886 diff changeset	553 '''For compatibility with old CGI scripts. A plain hgweb() or hgwebdir()
41a3fce17625 hgweb: return iterable, add deprecation note Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 5886 diff changeset	554 can and should now be used as a WSGI application.'''
5760 0145f9afb0e7 Removed tabs and trailing whitespace in python files Thomas Arendsen Hein <thomas@intevation.de> parents: 5566 diff changeset	555 application = app_maker()
0145f9afb0e7 Removed tabs and trailing whitespace in python files Thomas Arendsen Hein <thomas@intevation.de> parents: 5566 diff changeset	556 def run_wsgi(env, respond):
5887 41a3fce17625 hgweb: return iterable, add deprecation note Dirkjan Ochtman <dirkjan@ochtman.nl> parents: 5886 diff changeset	557 return application(env, respond)
5760 0145f9afb0e7 Removed tabs and trailing whitespace in python files Thomas Arendsen Hein <thomas@intevation.de> parents: 5566 diff changeset	558 return run_wsgi

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/hgweb/request.py @ 37000:44467a4d472f