This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2773

hgweb: remove support for short query string based aliases (BC)
ClosedPublic

Authored by indygreg on Mar 9 2018, 8:23 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG422be99519e5: hgweb: remove support for short query string based aliases (BC)
Summary

Form data exposed by hgweb is post-processed to expand certain
shortcuts. For example, URLs with "?cs=@" is essentially expanded to
"?cmd=changeset&node=@". And the URL router treats this the same
as "/changeset/@".

These shortcuts were initially added in 2005 in 34cb3957d875 and
964baa35faf8. They have rarely been touched in the last decade (just
moving code around a bit).

We have almost no test coverage of this feature. AFAICT no templates
reference URLs of this form. I even looked at the initial version
of paper and coal from ~2008 and they use the "/command/params" URL
form and not these shortcuts.

Furthermore, I couldn't even get some shortcuts to work! For example,
"?sl=@" attempts to do a revision search instead of showing shortlog
starting at revision @. Maybe I'm just doing it wrong?

Because this is ancient, mostly untested code, there is a migration
path to something better, and because anyone passionate enough to
preserve URLs can install URL redirects, let's nuke the feature.

.. bc::

Query string shorts in hgweb like ``?cs=@`` have been removed. Use
URLs of the form ``/:cmd`` instead.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Revision Contents
Changeset List

PathPackages
Mmercurial/hgweb/request.py (33 lines)
Mtests/test-hgweb-raw.t (8 lines)

Diff 6911

mercurial/hgweb/request.py

from ..thirdparty import ( from ..thirdparty import (
attr, attr,
) )
from .. import ( from .. import (
pycompat, pycompat,
util, util,
) )
shortcuts = {
'cl': [('cmd', ['changelog']), ('rev', None)],
'sl': [('cmd', ['shortlog']), ('rev', None)],
'cs': [('cmd', ['changeset']), ('node', None)],
'f': [('cmd', ['file']), ('filenode', None)],
'fl': [('cmd', ['filelog']), ('filenode', None)],
'fd': [('cmd', ['filediff']), ('node', None)],
'fa': [('cmd', ['annotate']), ('filenode', None)],
'mf': [('cmd', ['manifest']), ('manifest', None)],
'ca': [('cmd', ['archive']), ('node', None)],
'tags': [('cmd', ['tags'])],
'tip': [('cmd', ['changeset']), ('node', ['tip'])],
'static': [('cmd', ['static']), ('file', None)]
}
def normalize(form):
# first expand the shortcuts
for k in shortcuts:
if k in form:
for name, value in shortcuts[k]:
if value is None:
value = form[k]
form[name] = value
del form[k]
# And strip the values
bytesform = {}
for k, v in form.iteritems():
bytesform[pycompat.bytesurl(k)] = [
pycompat.bytesurl(i.strip()) for i in v]
return bytesform
@attr.s(frozen=True) @attr.s(frozen=True)
class parsedrequest(object): class parsedrequest(object):
"""Represents a parsed WSGI request. """Represents a parsed WSGI request.
Contains both parsed parameters as well as a handle on the input stream. Contains both parsed parameters as well as a handle on the input stream.
""" """
# Request method. # Request method.
inp = util.cappedreader(inp, int(wsgienv[r'CONTENT_LENGTH'])) inp = util.cappedreader(inp, int(wsgienv[r'CONTENT_LENGTH']))
self.err = wsgienv[r'wsgi.errors'] self.err = wsgienv[r'wsgi.errors']
self.threaded = wsgienv[r'wsgi.multithread'] self.threaded = wsgienv[r'wsgi.multithread']
self.multiprocess = wsgienv[r'wsgi.multiprocess'] self.multiprocess = wsgienv[r'wsgi.multiprocess']
self.run_once = wsgienv[r'wsgi.run_once'] self.run_once = wsgienv[r'wsgi.run_once']
self.env = wsgienv self.env = wsgienv
self.req = parserequestfromenv(wsgienv, inp) self.req = parserequestfromenv(wsgienv, inp)
self.form = normalize(self.req.querystringdict) self.form = self.req.querystringdict
self._start_response = start_response self._start_response = start_response
self.server_write = None self.server_write = None
self.headers = [] self.headers = []
def respond(self, status, type, filename=None, body=None): def respond(self, status, type, filename=None, body=None):
if not isinstance(type, str): if not isinstance(type, str):
type = pycompat.sysstr(type) type = pycompat.sysstr(type)
if self._start_response is not None: if self._start_response is not None:

tests/test-hgweb-raw.t

> care about things like that. > care about things like that.
> ENDSOME > ENDSOME
$ hg add 'sub/some text%.txt' $ hg add 'sub/some text%.txt'
$ hg commit -d "1 0" -m "Just some text" $ hg commit -d "1 0" -m "Just some text"
$ hg serve -p $HGPORT -A access.log -E error.log -d --pid-file=hg.pid $ hg serve -p $HGPORT -A access.log -E error.log -d --pid-file=hg.pid
$ cat hg.pid >> $DAEMON_PIDS $ cat hg.pid >> $DAEMON_PIDS
$ (get-with-headers.py localhost:$HGPORT '?f=bf0ff59095c9;file=sub/some%20text%25.txt;style=raw' content-type content-length content-disposition) >getoutput.txt $ (get-with-headers.py localhost:$HGPORT 'raw-file/bf0ff59095c9/sub/some%20text%25.txt' content-type content-length content-disposition) >getoutput.txt
$ killdaemons.py hg.pid $ killdaemons.py hg.pid
$ cat getoutput.txt $ cat getoutput.txt
200 Script output follows 200 Script output follows
content-type: application/binary content-type: application/binary
content-length: 157 content-length: 157
content-disposition: inline; filename="some text%.txt" content-disposition: inline; filename="some text%.txt"
This is just some random text This is just some random text
that will go inside the file and take a few lines. that will go inside the file and take a few lines.
It is very boring to read, but computers don't It is very boring to read, but computers don't
care about things like that. care about things like that.
$ cat access.log error.log $ cat access.log error.log
$LOCALIP - - [*] "GET /?f=bf0ff59095c9;file=sub/some%20text%25.txt;style=raw HTTP/1.1" 200 - (glob) $LOCALIP - - [$LOGDATE$] "GET /raw-file/bf0ff59095c9/sub/some%20text%25.txt HTTP/1.1" 200 - (glob)
$ rm access.log error.log $ rm access.log error.log
$ hg serve -p $HGPORT -A access.log -E error.log -d --pid-file=hg.pid \ $ hg serve -p $HGPORT -A access.log -E error.log -d --pid-file=hg.pid \
> --config web.guessmime=True > --config web.guessmime=True
$ cat hg.pid >> $DAEMON_PIDS $ cat hg.pid >> $DAEMON_PIDS
$ (get-with-headers.py localhost:$HGPORT '?f=bf0ff59095c9;file=sub/some%20text%25.txt;style=raw' content-type content-length content-disposition) >getoutput.txt $ (get-with-headers.py localhost:$HGPORT 'raw-file/bf0ff59095c9/sub/some%20text%25.txt' content-type content-length content-disposition) >getoutput.txt
$ killdaemons.py hg.pid $ killdaemons.py hg.pid
$ cat getoutput.txt $ cat getoutput.txt
200 Script output follows 200 Script output follows
content-type: text/plain; charset="ascii" content-type: text/plain; charset="ascii"
content-length: 157 content-length: 157
content-disposition: inline; filename="some text%.txt" content-disposition: inline; filename="some text%.txt"
This is just some random text This is just some random text
that will go inside the file and take a few lines. that will go inside the file and take a few lines.
It is very boring to read, but computers don't It is very boring to read, but computers don't
care about things like that. care about things like that.
$ cat access.log error.log $ cat access.log error.log
$LOCALIP - - [*] "GET /?f=bf0ff59095c9;file=sub/some%20text%25.txt;style=raw HTTP/1.1" 200 - (glob) $LOCALIP - - [$LOGDATE$] "GET /raw-file/bf0ff59095c9/sub/some%20text%25.txt HTTP/1.1" 200 - (glob)
$ cd .. $ cd ..