wireproto: support /api/* URL space for exposing APIs

I will soon be introducing a new version of the HTTP wire protocol.
One of the things I want to change with it is the URL routing.
I want to rely on URL paths to define endpoints rather than the
"cmd" query string argument. That should be pretty straightforward.

I was thinking about what URL space to reserve for the new protocol.
We /could/ put everything at a top-level path. e.g.
/wireproto/* or /http-v2-wireproto/*. However, these constrain us
a bit because they assume there will only be 1 API: version 2 of
the HTTP wire protocol. I think there is room to grow multiple
APIs. For example, there may someday be a proper JSON API to query
or even manipulate the repository. And I don't think we should have
to create a new top-level URL space for each API nor should we
attempt to shoehorn each future API into the same shared URL space:
that would just be too chaotic.

This commits reserves the /api/* URL space for all our future API
needs. Essentially, all requests to /api/* get routed to a new WSGI
handler. By default, it 404's the entire URL space unless the
"api server" feature is enabled. When enabled, requests to "/api"
list available APIs. URLs of the form /api/<name>/* are reserved for
a particular named API. Behavior within each API is left up to that
API. So, we can grow new APIs easily without worrying about URL
space conflicts.

APIs can be registered by adding entries to a global dict. This allows
extensions to provide their own APIs should they choose to do so.
This is probably a premature feature. But IMO the code is easier
to read if we're not dealing with API-specific behavior like config
option querying inline.

To prove it works, we implement a very basic API for version 2
of the HTTP wire protocol. It does nothing of value except
facilitate testing of the /api/* URL space.

We currently emit plain text responses for all /api/* endpoints.
There's definitely room to look at Accept and other request headers
to vary the response format. But we have to start somewhere.

Differential Revision: https://phab.mercurial-scm.org/D2834

tests/test-http-api-httpv2.t

@@ -0,0 +1,65 b''
+  $ send() {
+  >   hg --verbose debugwireproto --peer raw http://$LOCALIP:$HGPORT/
+  > }
+
+  $ hg init server
+  $ cat > server/.hg/hgrc << EOF
+  > [experimental]
+  > web.apiserver = true
+  > EOF
+  $ hg -R server serve -p $HGPORT -d --pid-file hg.pid
+  $ cat hg.pid > $DAEMON_PIDS
+
+HTTP v2 protocol not enabled by default
+
+  $ send << EOF
+  > httprequest GET api/exp-http-v2-0001
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api/exp-http-v2-0001 HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 404 Not Found\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 33\r\n
+  s>     \r\n
+  s>     API exp-http-v2-0001 not enabled\n
+
+Restart server with support for HTTP v2 API
+
+  $ killdaemons.py
+  $ cat > server/.hg/hgrc << EOF
+  > [experimental]
+  > web.apiserver = true
+  > web.api.http-v2 = true
+  > EOF
+
+  $ hg -R server serve -p $HGPORT -d --pid-file hg.pid
+  $ cat hg.pid > $DAEMON_PIDS
+
+Requests simply echo their path (for now)
+
+  $ send << EOF
+  > httprequest GET api/exp-http-v2-0001/path1/path2
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api/exp-http-v2-0001/path1/path2 HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 200 OK\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 12\r\n
+  s>     \r\n
+  s>     path1/path2\n

tests/test-http-api.t

@@ -0,0 +1,201 b''
+  $ send() {
+  >   hg --verbose debugwireproto --peer raw http://$LOCALIP:$HGPORT/
+  > }
+
+  $ hg init server
+  $ hg -R server serve -p $HGPORT -d --pid-file hg.pid
+  $ cat hg.pid > $DAEMON_PIDS
+
+Request to /api fails unless web.apiserver is enabled
+
+  $ send << EOF
+  > httprequest GET api
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 404 Not Found\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 44\r\n
+  s>     \r\n
+  s>     Experimental API server endpoint not enabled
+
+  $ send << EOF
+  > httprequest GET api/
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api/ HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 404 Not Found\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 44\r\n
+  s>     \r\n
+  s>     Experimental API server endpoint not enabled
+
+Restart server with support for API server
+
+  $ killdaemons.py
+  $ cat > server/.hg/hgrc << EOF
+  > [experimental]
+  > web.apiserver = true
+  > EOF
+
+  $ hg -R server serve -p $HGPORT -d --pid-file hg.pid
+  $ cat hg.pid > $DAEMON_PIDS
+
+/api lists available APIs (empty since none are available by default)
+
+  $ send << EOF
+  > httprequest GET api
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 200 OK\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 100\r\n
+  s>     \r\n
+  s>     APIs can be accessed at /api/<name>, where <name> can be one of the following:\n
+  s>     \n
+  s>     (no available APIs)\n
+
+  $ send << EOF
+  > httprequest GET api/
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api/ HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 200 OK\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 100\r\n
+  s>     \r\n
+  s>     APIs can be accessed at /api/<name>, where <name> can be one of the following:\n
+  s>     \n
+  s>     (no available APIs)\n
+
+Accessing an unknown API yields a 404
+
+  $ send << EOF
+  > httprequest GET api/unknown
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api/unknown HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 404 Not Found\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 33\r\n
+  s>     \r\n
+  s>     Unknown API: unknown\n
+  s>     Known APIs: 
+
+Accessing a known but not enabled API yields a different error
+
+  $ send << EOF
+  > httprequest GET api/exp-http-v2-0001
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api/exp-http-v2-0001 HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 404 Not Found\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 33\r\n
+  s>     \r\n
+  s>     API exp-http-v2-0001 not enabled\n
+
+Restart server with support for HTTP v2 API
+
+  $ killdaemons.py
+  $ cat > server/.hg/hgrc << EOF
+  > [experimental]
+  > web.apiserver = true
+  > web.api.http-v2 = true
+  > EOF
+
+  $ hg -R server serve -p $HGPORT -d --pid-file hg.pid
+  $ cat hg.pid > $DAEMON_PIDS
+
+/api lists the HTTP v2 protocol as available
+
+  $ send << EOF
+  > httprequest GET api
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 200 OK\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 96\r\n
+  s>     \r\n
+  s>     APIs can be accessed at /api/<name>, where <name> can be one of the following:\n
+  s>     \n
+  s>     exp-http-v2-0001
+
+  $ send << EOF
+  > httprequest GET api/
+  >     user-agent: test
+  > EOF
+  using raw connection to peer
+  s>     GET /api/ HTTP/1.1\r\n
+  s>     Accept-Encoding: identity\r\n
+  s>     user-agent: test\r\n
+  s>     host: $LOCALIP:$HGPORT\r\n (glob)
+  s>     \r\n
+  s> makefile('rb', None)
+  s>     HTTP/1.1 200 OK\r\n
+  s>     Server: testing stub value\r\n
+  s>     Date: $HTTP_DATE$\r\n
+  s>     Content-Type: text/plain\r\n
+  s>     Content-Length: 96\r\n
+  s>     \r\n
+  s>     APIs can be accessed at /api/<name>, where <name> can be one of the following:\n
+  s>     \n
+  s>     exp-http-v2-0001

mercurial/configitems.py

@@ -1,1311 +1,1317 b''
 # configitems.py - centralized declaration of configuration option
 #
 #  Copyright 2017 Pierre-Yves David <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import functools
 import re
 
 from . import (
     encoding,
     error,
 )
 
 def loadconfigtable(ui, extname, configtable):
     """update config item known to the ui with the extension ones"""
     for section, items in sorted(configtable.items()):
         knownitems = ui._knownconfig.setdefault(section, itemregister())
         knownkeys = set(knownitems)
         newkeys = set(items)
         for key in sorted(knownkeys & newkeys):
             msg = "extension '%s' overwrite config item '%s.%s'"
             msg %= (extname, section, key)
             ui.develwarn(msg, config='warn-config')
 
         knownitems.update(items)
 
 class configitem(object):
     """represent a known config item
 
     :section: the official config section where to find this item,
        :name: the official name within the section,
     :default: default value for this item,
     :alias: optional list of tuples as alternatives,
     :generic: this is a generic definition, match name using regular expression.
     """
 
     def __init__(self, section, name, default=None, alias=(),
                  generic=False, priority=0):
         self.section = section
         self.name = name
         self.default = default
         self.alias = list(alias)
         self.generic = generic
         self.priority = priority
         self._re = None
         if generic:
             self._re = re.compile(self.name)
 
 class itemregister(dict):
     """A specialized dictionary that can handle wild-card selection"""
 
     def __init__(self):
         super(itemregister, self).__init__()
         self._generics = set()
 
     def update(self, other):
         super(itemregister, self).update(other)
         self._generics.update(other._generics)
 
     def __setitem__(self, key, item):
         super(itemregister, self).__setitem__(key, item)
         if item.generic:
             self._generics.add(item)
 
     def get(self, key):
         baseitem = super(itemregister, self).get(key)
         if baseitem is not None and not baseitem.generic:
             return baseitem
 
         # search for a matching generic item
         generics = sorted(self._generics, key=(lambda x: (x.priority, x.name)))
         for item in generics:
             # we use 'match' instead of 'search' to make the matching simpler
             # for people unfamiliar with regular expression. Having the match
             # rooted to the start of the string will produce less surprising
             # result for user writing simple regex for sub-attribute.
             #
             # For example using "color\..*" match produces an unsurprising
             # result, while using search could suddenly match apparently
             # unrelated configuration that happens to contains "color."
             # anywhere. This is a tradeoff where we favor requiring ".*" on
             # some match to avoid the need to prefix most pattern with "^".
             # The "^" seems more error prone.
             if item._re.match(key):
                 return item
 
         return None
 
 coreitems = {}
 
 def _register(configtable, *args, **kwargs):
     item = configitem(*args, **kwargs)
     section = configtable.setdefault(item.section, itemregister())
     if item.name in section:
         msg = "duplicated config item registration for '%s.%s'"
         raise error.ProgrammingError(msg % (item.section, item.name))
     section[item.name] = item
 
 # special value for case where the default is derived from other values
 dynamicdefault = object()
 
 # Registering actual config items
 
 def getitemregister(configtable):
     f = functools.partial(_register, configtable)
     # export pseudo enum as configitem.*
     f.dynamicdefault = dynamicdefault
     return f
 
 coreconfigitem = getitemregister(coreitems)
 
 coreconfigitem('alias', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('annotate', 'nodates',
     default=False,
 )
 coreconfigitem('annotate', 'showfunc',
     default=False,
 )
 coreconfigitem('annotate', 'unified',
     default=None,
 )
 coreconfigitem('annotate', 'git',
     default=False,
 )
 coreconfigitem('annotate', 'ignorews',
     default=False,
 )
 coreconfigitem('annotate', 'ignorewsamount',
     default=False,
 )
 coreconfigitem('annotate', 'ignoreblanklines',
     default=False,
 )
 coreconfigitem('annotate', 'ignorewseol',
     default=False,
 )
 coreconfigitem('annotate', 'nobinary',
     default=False,
 )
 coreconfigitem('annotate', 'noprefix',
     default=False,
 )
 coreconfigitem('auth', 'cookiefile',
     default=None,
 )
 # bookmarks.pushing: internal hack for discovery
 coreconfigitem('bookmarks', 'pushing',
     default=list,
 )
 # bundle.mainreporoot: internal hack for bundlerepo
 coreconfigitem('bundle', 'mainreporoot',
     default='',
 )
 # bundle.reorder: experimental config
 coreconfigitem('bundle', 'reorder',
     default='auto',
 )
 coreconfigitem('censor', 'policy',
     default='abort',
 )
 coreconfigitem('chgserver', 'idletimeout',
     default=3600,
 )
 coreconfigitem('chgserver', 'skiphash',
     default=False,
 )
 coreconfigitem('cmdserver', 'log',
     default=None,
 )
 coreconfigitem('color', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('color', 'mode',
     default='auto',
 )
 coreconfigitem('color', 'pagermode',
     default=dynamicdefault,
 )
 coreconfigitem('commands', 'show.aliasprefix',
     default=list,
 )
 coreconfigitem('commands', 'status.relative',
     default=False,
 )
 coreconfigitem('commands', 'status.skipstates',
     default=[],
 )
 coreconfigitem('commands', 'status.verbose',
     default=False,
 )
 coreconfigitem('commands', 'update.check',
     default=None,
     # Deprecated, remove after 4.4 release
     alias=[('experimental', 'updatecheck')]
 )
 coreconfigitem('commands', 'update.requiredest',
     default=False,
 )
 coreconfigitem('committemplate', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('convert', 'cvsps.cache',
     default=True,
 )
 coreconfigitem('convert', 'cvsps.fuzz',
     default=60,
 )
 coreconfigitem('convert', 'cvsps.logencoding',
     default=None,
 )
 coreconfigitem('convert', 'cvsps.mergefrom',
     default=None,
 )
 coreconfigitem('convert', 'cvsps.mergeto',
     default=None,
 )
 coreconfigitem('convert', 'git.committeractions',
     default=lambda: ['messagedifferent'],
 )
 coreconfigitem('convert', 'git.extrakeys',
     default=list,
 )
 coreconfigitem('convert', 'git.findcopiesharder',
     default=False,
 )
 coreconfigitem('convert', 'git.remoteprefix',
     default='remote',
 )
 coreconfigitem('convert', 'git.renamelimit',
     default=400,
 )
 coreconfigitem('convert', 'git.saverev',
     default=True,
 )
 coreconfigitem('convert', 'git.similarity',
     default=50,
 )
 coreconfigitem('convert', 'git.skipsubmodules',
     default=False,
 )
 coreconfigitem('convert', 'hg.clonebranches',
     default=False,
 )
 coreconfigitem('convert', 'hg.ignoreerrors',
     default=False,
 )
 coreconfigitem('convert', 'hg.revs',
     default=None,
 )
 coreconfigitem('convert', 'hg.saverev',
     default=False,
 )
 coreconfigitem('convert', 'hg.sourcename',
     default=None,
 )
 coreconfigitem('convert', 'hg.startrev',
     default=None,
 )
 coreconfigitem('convert', 'hg.tagsbranch',
     default='default',
 )
 coreconfigitem('convert', 'hg.usebranchnames',
     default=True,
 )
 coreconfigitem('convert', 'ignoreancestorcheck',
     default=False,
 )
 coreconfigitem('convert', 'localtimezone',
     default=False,
 )
 coreconfigitem('convert', 'p4.encoding',
     default=dynamicdefault,
 )
 coreconfigitem('convert', 'p4.startrev',
     default=0,
 )
 coreconfigitem('convert', 'skiptags',
     default=False,
 )
 coreconfigitem('convert', 'svn.debugsvnlog',
     default=True,
 )
 coreconfigitem('convert', 'svn.trunk',
     default=None,
 )
 coreconfigitem('convert', 'svn.tags',
     default=None,
 )
 coreconfigitem('convert', 'svn.branches',
     default=None,
 )
 coreconfigitem('convert', 'svn.startrev',
     default=0,
 )
 coreconfigitem('debug', 'dirstate.delaywrite',
     default=0,
 )
 coreconfigitem('defaults', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('devel', 'all-warnings',
     default=False,
 )
 coreconfigitem('devel', 'bundle2.debug',
     default=False,
 )
 coreconfigitem('devel', 'cache-vfs',
     default=None,
 )
 coreconfigitem('devel', 'check-locks',
     default=False,
 )
 coreconfigitem('devel', 'check-relroot',
     default=False,
 )
 coreconfigitem('devel', 'default-date',
     default=None,
 )
 coreconfigitem('devel', 'deprec-warn',
     default=False,
 )
 coreconfigitem('devel', 'disableloaddefaultcerts',
     default=False,
 )
 coreconfigitem('devel', 'warn-empty-changegroup',
     default=False,
 )
 coreconfigitem('devel', 'legacy.exchange',
     default=list,
 )
 coreconfigitem('devel', 'servercafile',
     default='',
 )
 coreconfigitem('devel', 'serverexactprotocol',
     default='',
 )
 coreconfigitem('devel', 'serverrequirecert',
     default=False,
 )
 coreconfigitem('devel', 'strip-obsmarkers',
     default=True,
 )
 coreconfigitem('devel', 'warn-config',
     default=None,
 )
 coreconfigitem('devel', 'warn-config-default',
     default=None,
 )
 coreconfigitem('devel', 'user.obsmarker',
     default=None,
 )
 coreconfigitem('devel', 'warn-config-unknown',
     default=None,
 )
 coreconfigitem('devel', 'debug.peer-request',
     default=False,
 )
 coreconfigitem('diff', 'nodates',
     default=False,
 )
 coreconfigitem('diff', 'showfunc',
     default=False,
 )
 coreconfigitem('diff', 'unified',
     default=None,
 )
 coreconfigitem('diff', 'git',
     default=False,
 )
 coreconfigitem('diff', 'ignorews',
     default=False,
 )
 coreconfigitem('diff', 'ignorewsamount',
     default=False,
 )
 coreconfigitem('diff', 'ignoreblanklines',
     default=False,
 )
 coreconfigitem('diff', 'ignorewseol',
     default=False,
 )
 coreconfigitem('diff', 'nobinary',
     default=False,
 )
 coreconfigitem('diff', 'noprefix',
     default=False,
 )
 coreconfigitem('email', 'bcc',
     default=None,
 )
 coreconfigitem('email', 'cc',
     default=None,
 )
 coreconfigitem('email', 'charsets',
     default=list,
 )
 coreconfigitem('email', 'from',
     default=None,
 )
 coreconfigitem('email', 'method',
     default='smtp',
 )
 coreconfigitem('email', 'reply-to',
     default=None,
 )
 coreconfigitem('email', 'to',
     default=None,
 )
 coreconfigitem('experimental', 'archivemetatemplate',
     default=dynamicdefault,
 )
 coreconfigitem('experimental', 'bundle-phases',
     default=False,
 )
 coreconfigitem('experimental', 'bundle2-advertise',
     default=True,
 )
 coreconfigitem('experimental', 'bundle2-output-capture',
     default=False,
 )
 coreconfigitem('experimental', 'bundle2.pushback',
     default=False,
 )
 coreconfigitem('experimental', 'bundle2.stream',
     default=False,
 )
 coreconfigitem('experimental', 'bundle2lazylocking',
     default=False,
 )
 coreconfigitem('experimental', 'bundlecomplevel',
     default=None,
 )
 coreconfigitem('experimental', 'changegroup3',
     default=False,
 )
 coreconfigitem('experimental', 'clientcompressionengines',
     default=list,
 )
 coreconfigitem('experimental', 'copytrace',
     default='on',
 )
 coreconfigitem('experimental', 'copytrace.movecandidateslimit',
     default=100,
 )
 coreconfigitem('experimental', 'copytrace.sourcecommitlimit',
     default=100,
 )
 coreconfigitem('experimental', 'crecordtest',
     default=None,
 )
 coreconfigitem('experimental', 'directaccess',
     default=False,
 )
 coreconfigitem('experimental', 'directaccess.revnums',
     default=False,
 )
 coreconfigitem('experimental', 'editortmpinhg',
     default=False,
 )
 coreconfigitem('experimental', 'evolution',
     default=list,
 )
 coreconfigitem('experimental', 'evolution.allowdivergence',
     default=False,
     alias=[('experimental', 'allowdivergence')]
 )
 coreconfigitem('experimental', 'evolution.allowunstable',
     default=None,
 )
 coreconfigitem('experimental', 'evolution.createmarkers',
     default=None,
 )
 coreconfigitem('experimental', 'evolution.effect-flags',
     default=True,
     alias=[('experimental', 'effect-flags')]
 )
 coreconfigitem('experimental', 'evolution.exchange',
     default=None,
 )
 coreconfigitem('experimental', 'evolution.bundle-obsmarker',
     default=False,
 )
 coreconfigitem('experimental', 'evolution.report-instabilities',
     default=True,
 )
 coreconfigitem('experimental', 'evolution.track-operation',
     default=True,
 )
 coreconfigitem('experimental', 'worddiff',
     default=False,
 )
 coreconfigitem('experimental', 'maxdeltachainspan',
     default=-1,
 )
 coreconfigitem('experimental', 'mergetempdirprefix',
     default=None,
 )
 coreconfigitem('experimental', 'mmapindexthreshold',
     default=None,
 )
 coreconfigitem('experimental', 'nonnormalparanoidcheck',
     default=False,
 )
 coreconfigitem('experimental', 'exportableenviron',
     default=list,
 )
 coreconfigitem('experimental', 'extendedheader.index',
     default=None,
 )
 coreconfigitem('experimental', 'extendedheader.similarity',
     default=False,
 )
 coreconfigitem('experimental', 'format.compression',
     default='zlib',
 )
 coreconfigitem('experimental', 'graphshorten',
     default=False,
 )
 coreconfigitem('experimental', 'graphstyle.parent',
     default=dynamicdefault,
 )
 coreconfigitem('experimental', 'graphstyle.missing',
     default=dynamicdefault,
 )
 coreconfigitem('experimental', 'graphstyle.grandparent',
     default=dynamicdefault,
 )
 coreconfigitem('experimental', 'hook-track-tags',
     default=False,
 )
 coreconfigitem('experimental', 'httppostargs',
     default=False,
 )
 coreconfigitem('experimental', 'mergedriver',
     default=None,
 )
 coreconfigitem('experimental', 'obsmarkers-exchange-debug',
     default=False,
 )
 coreconfigitem('experimental', 'remotenames',
     default=False,
 )
 coreconfigitem('experimental', 'revlogv2',
     default=None,
 )
 coreconfigitem('experimental', 'single-head-per-branch',
     default=False,
 )
 coreconfigitem('experimental', 'sshserver.support-v2',
     default=False,
 )
 coreconfigitem('experimental', 'spacemovesdown',
     default=False,
 )
 coreconfigitem('experimental', 'sparse-read',
     default=False,
 )
 coreconfigitem('experimental', 'sparse-read.density-threshold',
     default=0.25,
 )
 coreconfigitem('experimental', 'sparse-read.min-gap-size',
     default='256K',
 )
 coreconfigitem('experimental', 'treemanifest',
     default=False,
 )
 coreconfigitem('experimental', 'update.atomic-file',
     default=False,
 )
 coreconfigitem('experimental', 'sshpeer.advertise-v2',
     default=False,
 )
+coreconfigitem('experimental', 'web.apiserver',
+    default=False,
+)
+coreconfigitem('experimental', 'web.api.http-v2',
+    default=False,
+)
 coreconfigitem('experimental', 'xdiff',
     default=False,
 )
 coreconfigitem('extensions', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('extdata', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('format', 'aggressivemergedeltas',
     default=False,
 )
 coreconfigitem('format', 'chunkcachesize',
     default=None,
 )
 coreconfigitem('format', 'dotencode',
     default=True,
 )
 coreconfigitem('format', 'generaldelta',
     default=False,
 )
 coreconfigitem('format', 'manifestcachesize',
     default=None,
 )
 coreconfigitem('format', 'maxchainlen',
     default=None,
 )
 coreconfigitem('format', 'obsstore-version',
     default=None,
 )
 coreconfigitem('format', 'usefncache',
     default=True,
 )
 coreconfigitem('format', 'usegeneraldelta',
     default=True,
 )
 coreconfigitem('format', 'usestore',
     default=True,
 )
 coreconfigitem('fsmonitor', 'warn_when_unused',
     default=True,
 )
 coreconfigitem('fsmonitor', 'warn_update_file_count',
     default=50000,
 )
 coreconfigitem('hooks', '.*',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem('hgweb-paths', '.*',
     default=list,
     generic=True,
 )
 coreconfigitem('hostfingerprints', '.*',
     default=list,
     generic=True,
 )
 coreconfigitem('hostsecurity', 'ciphers',
     default=None,
 )
 coreconfigitem('hostsecurity', 'disabletls10warning',
     default=False,
 )
 coreconfigitem('hostsecurity', 'minimumprotocol',
     default=dynamicdefault,
 )
 coreconfigitem('hostsecurity', '.*:minimumprotocol$',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem('hostsecurity', '.*:ciphers$',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem('hostsecurity', '.*:fingerprints$',
     default=list,
     generic=True,
 )
 coreconfigitem('hostsecurity', '.*:verifycertsfile$',
     default=None,
     generic=True,
 )
 
 coreconfigitem('http_proxy', 'always',
     default=False,
 )
 coreconfigitem('http_proxy', 'host',
     default=None,
 )
 coreconfigitem('http_proxy', 'no',
     default=list,
 )
 coreconfigitem('http_proxy', 'passwd',
     default=None,
 )
 coreconfigitem('http_proxy', 'user',
     default=None,
 )
 coreconfigitem('logtoprocess', 'commandexception',
     default=None,
 )
 coreconfigitem('logtoprocess', 'commandfinish',
     default=None,
 )
 coreconfigitem('logtoprocess', 'command',
     default=None,
 )
 coreconfigitem('logtoprocess', 'develwarn',
     default=None,
 )
 coreconfigitem('logtoprocess', 'uiblocked',
     default=None,
 )
 coreconfigitem('merge', 'checkunknown',
     default='abort',
 )
 coreconfigitem('merge', 'checkignored',
     default='abort',
 )
 coreconfigitem('experimental', 'merge.checkpathconflicts',
     default=False,
 )
 coreconfigitem('merge', 'followcopies',
     default=True,
 )
 coreconfigitem('merge', 'on-failure',
     default='continue',
 )
 coreconfigitem('merge', 'preferancestor',
         default=lambda: ['*'],
 )
 coreconfigitem('merge-tools', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('merge-tools', br'.*\.args$',
     default="$local $base $other",
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.binary$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.check$',
     default=list,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.checkchanged$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.executable$',
     default=dynamicdefault,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.fixeol$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.gui$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.mergemarkers$',
     default='basic',
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.mergemarkertemplate$',
     default=dynamicdefault,  # take from ui.mergemarkertemplate
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.priority$',
     default=0,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.premerge$',
     default=dynamicdefault,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.symlink$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('pager', 'attend-.*',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem('pager', 'ignore',
     default=list,
 )
 coreconfigitem('pager', 'pager',
     default=dynamicdefault,
 )
 coreconfigitem('patch', 'eol',
     default='strict',
 )
 coreconfigitem('patch', 'fuzz',
     default=2,
 )
 coreconfigitem('paths', 'default',
     default=None,
 )
 coreconfigitem('paths', 'default-push',
     default=None,
 )
 coreconfigitem('paths', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('phases', 'checksubrepos',
     default='follow',
 )
 coreconfigitem('phases', 'new-commit',
     default='draft',
 )
 coreconfigitem('phases', 'publish',
     default=True,
 )
 coreconfigitem('profiling', 'enabled',
     default=False,
 )
 coreconfigitem('profiling', 'format',
     default='text',
 )
 coreconfigitem('profiling', 'freq',
     default=1000,
 )
 coreconfigitem('profiling', 'limit',
     default=30,
 )
 coreconfigitem('profiling', 'nested',
     default=0,
 )
 coreconfigitem('profiling', 'output',
     default=None,
 )
 coreconfigitem('profiling', 'showmax',
     default=0.999,
 )
 coreconfigitem('profiling', 'showmin',
     default=dynamicdefault,
 )
 coreconfigitem('profiling', 'sort',
     default='inlinetime',
 )
 coreconfigitem('profiling', 'statformat',
     default='hotpath',
 )
 coreconfigitem('profiling', 'type',
     default='stat',
 )
 coreconfigitem('progress', 'assume-tty',
     default=False,
 )
 coreconfigitem('progress', 'changedelay',
     default=1,
 )
 coreconfigitem('progress', 'clear-complete',
     default=True,
 )
 coreconfigitem('progress', 'debug',
     default=False,
 )
 coreconfigitem('progress', 'delay',
     default=3,
 )
 coreconfigitem('progress', 'disable',
     default=False,
 )
 coreconfigitem('progress', 'estimateinterval',
     default=60.0,
 )
 coreconfigitem('progress', 'format',
     default=lambda: ['topic', 'bar', 'number', 'estimate'],
 )
 coreconfigitem('progress', 'refresh',
     default=0.1,
 )
 coreconfigitem('progress', 'width',
     default=dynamicdefault,
 )
 coreconfigitem('push', 'pushvars.server',
     default=False,
 )
 coreconfigitem('server', 'bookmarks-pushkey-compat',
     default=True,
 )
 coreconfigitem('server', 'bundle1',
     default=True,
 )
 coreconfigitem('server', 'bundle1gd',
     default=None,
 )
 coreconfigitem('server', 'bundle1.pull',
     default=None,
 )
 coreconfigitem('server', 'bundle1gd.pull',
     default=None,
 )
 coreconfigitem('server', 'bundle1.push',
     default=None,
 )
 coreconfigitem('server', 'bundle1gd.push',
     default=None,
 )
 coreconfigitem('server', 'compressionengines',
     default=list,
 )
 coreconfigitem('server', 'concurrent-push-mode',
     default='strict',
 )
 coreconfigitem('server', 'disablefullbundle',
     default=False,
 )
 coreconfigitem('server', 'maxhttpheaderlen',
     default=1024,
 )
 coreconfigitem('server', 'preferuncompressed',
     default=False,
 )
 coreconfigitem('server', 'uncompressed',
     default=True,
 )
 coreconfigitem('server', 'uncompressedallowsecret',
     default=False,
 )
 coreconfigitem('server', 'validate',
     default=False,
 )
 coreconfigitem('server', 'zliblevel',
     default=-1,
 )
 coreconfigitem('share', 'pool',
     default=None,
 )
 coreconfigitem('share', 'poolnaming',
     default='identity',
 )
 coreconfigitem('smtp', 'host',
     default=None,
 )
 coreconfigitem('smtp', 'local_hostname',
     default=None,
 )
 coreconfigitem('smtp', 'password',
     default=None,
 )
 coreconfigitem('smtp', 'port',
     default=dynamicdefault,
 )
 coreconfigitem('smtp', 'tls',
     default='none',
 )
 coreconfigitem('smtp', 'username',
     default=None,
 )
 coreconfigitem('sparse', 'missingwarning',
     default=True,
 )
 coreconfigitem('subrepos', 'allowed',
     default=dynamicdefault,  # to make backporting simpler
 )
 coreconfigitem('subrepos', 'hg:allowed',
     default=dynamicdefault,
 )
 coreconfigitem('subrepos', 'git:allowed',
     default=dynamicdefault,
 )
 coreconfigitem('subrepos', 'svn:allowed',
     default=dynamicdefault,
 )
 coreconfigitem('templates', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('trusted', 'groups',
     default=list,
 )
 coreconfigitem('trusted', 'users',
     default=list,
 )
 coreconfigitem('ui', '_usedassubrepo',
     default=False,
 )
 coreconfigitem('ui', 'allowemptycommit',
     default=False,
 )
 coreconfigitem('ui', 'archivemeta',
     default=True,
 )
 coreconfigitem('ui', 'askusername',
     default=False,
 )
 coreconfigitem('ui', 'clonebundlefallback',
     default=False,
 )
 coreconfigitem('ui', 'clonebundleprefers',
     default=list,
 )
 coreconfigitem('ui', 'clonebundles',
     default=True,
 )
 coreconfigitem('ui', 'color',
     default='auto',
 )
 coreconfigitem('ui', 'commitsubrepos',
     default=False,
 )
 coreconfigitem('ui', 'debug',
     default=False,
 )
 coreconfigitem('ui', 'debugger',
     default=None,
 )
 coreconfigitem('ui', 'editor',
     default=dynamicdefault,
 )
 coreconfigitem('ui', 'fallbackencoding',
     default=None,
 )
 coreconfigitem('ui', 'forcecwd',
     default=None,
 )
 coreconfigitem('ui', 'forcemerge',
     default=None,
 )
 coreconfigitem('ui', 'formatdebug',
     default=False,
 )
 coreconfigitem('ui', 'formatjson',
     default=False,
 )
 coreconfigitem('ui', 'formatted',
     default=None,
 )
 coreconfigitem('ui', 'graphnodetemplate',
     default=None,
 )
 coreconfigitem('ui', 'interactive',
     default=None,
 )
 coreconfigitem('ui', 'interface',
     default=None,
 )
 coreconfigitem('ui', 'interface.chunkselector',
     default=None,
 )
 coreconfigitem('ui', 'logblockedtimes',
     default=False,
 )
 coreconfigitem('ui', 'logtemplate',
     default=None,
 )
 coreconfigitem('ui', 'merge',
     default=None,
 )
 coreconfigitem('ui', 'mergemarkers',
     default='basic',
 )
 coreconfigitem('ui', 'mergemarkertemplate',
     default=('{node|short} '
             '{ifeq(tags, "tip", "", '
             'ifeq(tags, "", "", "{tags} "))}'
             '{if(bookmarks, "{bookmarks} ")}'
             '{ifeq(branch, "default", "", "{branch} ")}'
             '- {author|user}: {desc|firstline}')
 )
 coreconfigitem('ui', 'nontty',
     default=False,
 )
 coreconfigitem('ui', 'origbackuppath',
     default=None,
 )
 coreconfigitem('ui', 'paginate',
     default=True,
 )
 coreconfigitem('ui', 'patch',
     default=None,
 )
 coreconfigitem('ui', 'portablefilenames',
     default='warn',
 )
 coreconfigitem('ui', 'promptecho',
     default=False,
 )
 coreconfigitem('ui', 'quiet',
     default=False,
 )
 coreconfigitem('ui', 'quietbookmarkmove',
     default=False,
 )
 coreconfigitem('ui', 'remotecmd',
     default='hg',
 )
 coreconfigitem('ui', 'report_untrusted',
     default=True,
 )
 coreconfigitem('ui', 'rollback',
     default=True,
 )
 coreconfigitem('ui', 'slash',
     default=False,
 )
 coreconfigitem('ui', 'ssh',
     default='ssh',
 )
 coreconfigitem('ui', 'ssherrorhint',
     default=None,
 )
 coreconfigitem('ui', 'statuscopies',
     default=False,
 )
 coreconfigitem('ui', 'strict',
     default=False,
 )
 coreconfigitem('ui', 'style',
     default='',
 )
 coreconfigitem('ui', 'supportcontact',
     default=None,
 )
 coreconfigitem('ui', 'textwidth',
     default=78,
 )
 coreconfigitem('ui', 'timeout',
     default='600',
 )
 coreconfigitem('ui', 'timeout.warn',
     default=0,
 )
 coreconfigitem('ui', 'traceback',
     default=False,
 )
 coreconfigitem('ui', 'tweakdefaults',
     default=False,
 )
 coreconfigitem('ui', 'username',
     alias=[('ui', 'user')]
 )
 coreconfigitem('ui', 'verbose',
     default=False,
 )
 coreconfigitem('verify', 'skipflags',
     default=None,
 )
 coreconfigitem('web', 'allowbz2',
     default=False,
 )
 coreconfigitem('web', 'allowgz',
     default=False,
 )
 coreconfigitem('web', 'allow-pull',
     alias=[('web', 'allowpull')],
     default=True,
 )
 coreconfigitem('web', 'allow-push',
     alias=[('web', 'allow_push')],
     default=list,
 )
 coreconfigitem('web', 'allowzip',
     default=False,
 )
 coreconfigitem('web', 'archivesubrepos',
     default=False,
 )
 coreconfigitem('web', 'cache',
     default=True,
 )
 coreconfigitem('web', 'contact',
     default=None,
 )
 coreconfigitem('web', 'deny_push',
     default=list,
 )
 coreconfigitem('web', 'guessmime',
     default=False,
 )
 coreconfigitem('web', 'hidden',
     default=False,
 )
 coreconfigitem('web', 'labels',
     default=list,
 )
 coreconfigitem('web', 'logoimg',
     default='hglogo.png',
 )
 coreconfigitem('web', 'logourl',
     default='https://mercurial-scm.org/',
 )
 coreconfigitem('web', 'accesslog',
     default='-',
 )
 coreconfigitem('web', 'address',
     default='',
 )
 coreconfigitem('web', 'allow_archive',
     default=list,
 )
 coreconfigitem('web', 'allow_read',
     default=list,
 )
 coreconfigitem('web', 'baseurl',
     default=None,
 )
 coreconfigitem('web', 'cacerts',
     default=None,
 )
 coreconfigitem('web', 'certificate',
     default=None,
 )
 coreconfigitem('web', 'collapse',
     default=False,
 )
 coreconfigitem('web', 'csp',
     default=None,
 )
 coreconfigitem('web', 'deny_read',
     default=list,
 )
 coreconfigitem('web', 'descend',
     default=True,
 )
 coreconfigitem('web', 'description',
     default="",
 )
 coreconfigitem('web', 'encoding',
     default=lambda: encoding.encoding,
 )
 coreconfigitem('web', 'errorlog',
     default='-',
 )
 coreconfigitem('web', 'ipv6',
     default=False,
 )
 coreconfigitem('web', 'maxchanges',
     default=10,
 )
 coreconfigitem('web', 'maxfiles',
     default=10,
 )
 coreconfigitem('web', 'maxshortchanges',
     default=60,
 )
 coreconfigitem('web', 'motd',
     default='',
 )
 coreconfigitem('web', 'name',
     default=dynamicdefault,
 )
 coreconfigitem('web', 'port',
     default=8000,
 )
 coreconfigitem('web', 'prefix',
     default='',
 )
 coreconfigitem('web', 'push_ssl',
     default=True,
 )
 coreconfigitem('web', 'refreshinterval',
     default=20,
 )
 coreconfigitem('web', 'server-header',
     default=None,
 )
 coreconfigitem('web', 'staticurl',
     default=None,
 )
 coreconfigitem('web', 'stripes',
     default=1,
 )
 coreconfigitem('web', 'style',
     default='paper',
 )
 coreconfigitem('web', 'templates',
     default=None,
 )
 coreconfigitem('web', 'view',
     default='served',
 )
 coreconfigitem('worker', 'backgroundclose',
     default=dynamicdefault,
 )
 # Windows defaults to a limit of 512 open files. A buffer of 128
 # should give us enough headway.
 coreconfigitem('worker', 'backgroundclosemaxqueue',
     default=384,
 )
 coreconfigitem('worker', 'backgroundcloseminfilecount',
     default=2048,
 )
 coreconfigitem('worker', 'backgroundclosethreadcount',
     default=4,
 )
 coreconfigitem('worker', 'enabled',
     default=True,
 )
 coreconfigitem('worker', 'numcpus',
     default=None,
 )
 
 # Rebase related configuration moved to core because other extension are doing
 # strange things. For example, shelve import the extensions to reuse some bit
 # without formally loading it.
 coreconfigitem('commands', 'rebase.requiredest',
             default=False,
 )
 coreconfigitem('experimental', 'rebaseskipobsolete',
     default=True,
 )
 coreconfigitem('rebase', 'singletransaction',
     default=False,
 )
 coreconfigitem('rebase', 'experimental.inmemory',
     default=False,
 )

mercurial/hgweb/hgweb_mod.py

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

mercurial/wireprotoserver.py

@@ -1,653 +1,723 b''
 # Copyright 21 May 2005 - (c) 2005 Jake Edge <[e-mail]>
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import contextlib
 import struct
 import sys
 import threading
 
 from .i18n import _
 from . import (
     encoding,
     error,
     hook,
     pycompat,
     util,
     wireproto,
     wireprototypes,
 )
 
 stringio = util.stringio
 
 urlerr = util.urlerr
 urlreq = util.urlreq
 
 HTTP_OK = 200
 
 HGTYPE = 'application/mercurial-0.1'
 HGTYPE2 = 'application/mercurial-0.2'
 HGERRTYPE = 'application/hg-error'
 
+HTTPV2 = wireprototypes.HTTPV2
 SSHV1 = wireprototypes.SSHV1
 SSHV2 = wireprototypes.SSHV2
 
 def decodevaluefromheaders(req, headerprefix):
     """Decode a long value from multiple HTTP request headers.
 
     Returns the value as a bytes, not a str.
     """
     chunks = []
     i = 1
     while True:
         v = req.headers.get(b'%s-%d' % (headerprefix, i))
         if v is None:
             break
         chunks.append(pycompat.bytesurl(v))
         i += 1
 
     return ''.join(chunks)
 
 class httpv1protocolhandler(wireprototypes.baseprotocolhandler):
     def __init__(self, req, ui, checkperm):
         self._req = req
         self._ui = ui
         self._checkperm = checkperm
 
     @property
     def name(self):
         return 'http-v1'
 
     def getargs(self, args):
         knownargs = self._args()
         data = {}
         keys = args.split()
         for k in keys:
             if k == '*':
                 star = {}
                 for key in knownargs.keys():
                     if key != 'cmd' and key not in keys:
                         star[key] = knownargs[key][0]
                 data['*'] = star
             else:
                 data[k] = knownargs[k][0]
         return [data[k] for k in keys]
 
     def _args(self):
         args = self._req.qsparams.asdictoflists()
         postlen = int(self._req.headers.get(b'X-HgArgs-Post', 0))
         if postlen:
             args.update(urlreq.parseqs(
                 self._req.bodyfh.read(postlen), keep_blank_values=True))
             return args
 
         argvalue = decodevaluefromheaders(self._req, b'X-HgArg')
         args.update(urlreq.parseqs(argvalue, keep_blank_values=True))
         return args
 
     def forwardpayload(self, fp):
         # Existing clients *always* send Content-Length.
         length = int(self._req.headers[b'Content-Length'])
 
         # If httppostargs is used, we need to read Content-Length
         # minus the amount that was consumed by args.
         length -= int(self._req.headers.get(b'X-HgArgs-Post', 0))
         for s in util.filechunkiter(self._req.bodyfh, limit=length):
             fp.write(s)
 
     @contextlib.contextmanager
     def mayberedirectstdio(self):
         oldout = self._ui.fout
         olderr = self._ui.ferr
 
         out = util.stringio()
 
         try:
             self._ui.fout = out
             self._ui.ferr = out
             yield out
         finally:
             self._ui.fout = oldout
             self._ui.ferr = olderr
 
     def client(self):
         return 'remote:%s:%s:%s' % (
             self._req.urlscheme,
             urlreq.quote(self._req.remotehost or ''),
             urlreq.quote(self._req.remoteuser or ''))
 
     def addcapabilities(self, repo, caps):
         caps.append('httpheader=%d' %
                     repo.ui.configint('server', 'maxhttpheaderlen'))
         if repo.ui.configbool('experimental', 'httppostargs'):
             caps.append('httppostargs')
 
         # FUTURE advertise 0.2rx once support is implemented
         # FUTURE advertise minrx and mintx after consulting config option
         caps.append('httpmediatype=0.1rx,0.1tx,0.2tx')
 
         compengines = wireproto.supportedcompengines(repo.ui, util.SERVERROLE)
         if compengines:
             comptypes = ','.join(urlreq.quote(e.wireprotosupport().name)
                                  for e in compengines)
             caps.append('compression=%s' % comptypes)
 
         return caps
 
     def checkperm(self, perm):
         return self._checkperm(perm)
 
 # This method exists mostly so that extensions like remotefilelog can
 # disable a kludgey legacy method only over http. As of early 2018,
 # there are no other known users, so with any luck we can discard this
 # hook if remotefilelog becomes a first-party extension.
 def iscmd(cmd):
     return cmd in wireproto.commands
 
 def handlewsgirequest(rctx, req, res, checkperm):
     """Possibly process a wire protocol request.
 
     If the current request is a wire protocol request, the request is
     processed by this function.
 
     ``req`` is a ``parsedrequest`` instance.
     ``res`` is a ``wsgiresponse`` instance.
 
     Returns a bool indicating if the request was serviced. If set, the caller
     should stop processing the request, as a response has already been issued.
     """
     # Avoid cycle involving hg module.
     from .hgweb import common as hgwebcommon
 
     repo = rctx.repo
 
     # HTTP version 1 wire protocol requests are denoted by a "cmd" query
     # string parameter. If it isn't present, this isn't a wire protocol
     # request.
     if 'cmd' not in req.qsparams:
         return False
 
     cmd = req.qsparams['cmd']
 
     # The "cmd" request parameter is used by both the wire protocol and hgweb.
     # While not all wire protocol commands are available for all transports,
     # if we see a "cmd" value that resembles a known wire protocol command, we
     # route it to a protocol handler. This is better than routing possible
     # wire protocol requests to hgweb because it prevents hgweb from using
     # known wire protocol commands and it is less confusing for machine
     # clients.
     if not iscmd(cmd):
         return False
 
     # The "cmd" query string argument is only valid on the root path of the
     # repo. e.g. ``/?cmd=foo``, ``/repo?cmd=foo``. URL paths within the repo
     # like ``/blah?cmd=foo`` are not allowed. So don't recognize the request
     # in this case. We send an HTTP 404 for backwards compatibility reasons.
     if req.dispatchpath:
         res.status = hgwebcommon.statusmessage(404)
         res.headers['Content-Type'] = HGTYPE
         # TODO This is not a good response to issue for this request. This
         # is mostly for BC for now.
         res.setbodybytes('0\n%s\n' % b'Not Found')
         return True
 
     proto = httpv1protocolhandler(req, repo.ui,
                                   lambda perm: checkperm(rctx, req, perm))
 
     # The permissions checker should be the only thing that can raise an
     # ErrorResponse. It is kind of a layer violation to catch an hgweb
     # exception here. So consider refactoring into a exception type that
     # is associated with the wire protocol.
     try:
         _callhttp(repo, req, res, proto, cmd)
     except hgwebcommon.ErrorResponse as e:
         for k, v in e.headers:
             res.headers[k] = v
         res.status = hgwebcommon.statusmessage(e.code, pycompat.bytestr(e))
         # TODO This response body assumes the failed command was
         # "unbundle." That assumption is not always valid.
         res.setbodybytes('0\n%s\n' % pycompat.bytestr(e))
 
     return True
 
+def handlewsgiapirequest(rctx, req, res, checkperm):
+    """Handle requests to /api/*."""
+    assert req.dispatchparts[0] == b'api'
+
+    repo = rctx.repo
+
+    # This whole URL space is experimental for now. But we want to
+    # reserve the URL space. So, 404 all URLs if the feature isn't enabled.
+    if not repo.ui.configbool('experimental', 'web.apiserver'):
+        res.status = b'404 Not Found'
+        res.headers[b'Content-Type'] = b'text/plain'
+        res.setbodybytes(_('Experimental API server endpoint not enabled'))
+        return
+
+    # The URL space is /api/<protocol>/*. The structure of URLs under varies
+    # by <protocol>.
+
+    # Registered APIs are made available via config options of the name of
+    # the protocol.
+    availableapis = set()
+    for k, v in API_HANDLERS.items():
+        section, option = v['config']
+        if repo.ui.configbool(section, option):
+            availableapis.add(k)
+
+    # Requests to /api/ list available APIs.
+    if req.dispatchparts == [b'api']:
+        res.status = b'200 OK'
+        res.headers[b'Content-Type'] = b'text/plain'
+        lines = [_('APIs can be accessed at /api/<name>, where <name> can be '
+                   'one of the following:\n')]
+        if availableapis:
+            lines.extend(sorted(availableapis))
+        else:
+            lines.append(_('(no available APIs)\n'))
+        res.setbodybytes(b'\n'.join(lines))
+        return
+
+    proto = req.dispatchparts[1]
+
+    if proto not in API_HANDLERS:
+        res.status = b'404 Not Found'
+        res.headers[b'Content-Type'] = b'text/plain'
+        res.setbodybytes(_('Unknown API: %s\nKnown APIs: %s') % (
+            proto, b', '.join(sorted(availableapis))))
+        return
+
+    if proto not in availableapis:
+        res.status = b'404 Not Found'
+        res.headers[b'Content-Type'] = b'text/plain'
+        res.setbodybytes(_('API %s not enabled\n') % proto)
+        return
+
+    API_HANDLERS[proto]['handler'](rctx, req, res, checkperm,
+                                   req.dispatchparts[2:])
+
+def _handlehttpv2request(rctx, req, res, checkperm, urlparts):
+    res.status = b'200 OK'
+    res.headers[b'Content-Type'] = b'text/plain'
+    res.setbodybytes(b'/'.join(urlparts) + b'\n')
+
+# Maps API name to metadata so custom API can be registered.
+API_HANDLERS = {
+    HTTPV2: {
+        'config': ('experimental', 'web.api.http-v2'),
+        'handler': _handlehttpv2request,
+    },
+}
+
 def _httpresponsetype(ui, req, prefer_uncompressed):
     """Determine the appropriate response type and compression settings.
 
     Returns a tuple of (mediatype, compengine, engineopts).
     """
     # Determine the response media type and compression engine based
     # on the request parameters.
     protocaps = decodevaluefromheaders(req, 'X-HgProto').split(' ')
 
     if '0.2' in protocaps:
         # All clients are expected to support uncompressed data.
         if prefer_uncompressed:
             return HGTYPE2, util._noopengine(), {}
 
         # Default as defined by wire protocol spec.
         compformats = ['zlib', 'none']
         for cap in protocaps:
             if cap.startswith('comp='):
                 compformats = cap[5:].split(',')
                 break
 
         # Now find an agreed upon compression format.
         for engine in wireproto.supportedcompengines(ui, util.SERVERROLE):
             if engine.wireprotosupport().name in compformats:
                 opts = {}
                 level = ui.configint('server', '%slevel' % engine.name())
                 if level is not None:
                     opts['level'] = level
 
                 return HGTYPE2, engine, opts
 
         # No mutually supported compression format. Fall back to the
         # legacy protocol.
 
     # Don't allow untrusted settings because disabling compression or
     # setting a very high compression level could lead to flooding
     # the server's network or CPU.
     opts = {'level': ui.configint('server', 'zliblevel')}
     return HGTYPE, util.compengines['zlib'], opts
 
 def _callhttp(repo, req, res, proto, cmd):
     # Avoid cycle involving hg module.
     from .hgweb import common as hgwebcommon
 
     def genversion2(gen, engine, engineopts):
         # application/mercurial-0.2 always sends a payload header
         # identifying the compression engine.
         name = engine.wireprotosupport().name
         assert 0 < len(name) < 256
         yield struct.pack('B', len(name))
         yield name
 
         for chunk in gen:
             yield chunk
 
     def setresponse(code, contenttype, bodybytes=None, bodygen=None):
         if code == HTTP_OK:
             res.status = '200 Script output follows'
         else:
             res.status = hgwebcommon.statusmessage(code)
 
         res.headers['Content-Type'] = contenttype
 
         if bodybytes is not None:
             res.setbodybytes(bodybytes)
         if bodygen is not None:
             res.setbodygen(bodygen)
 
     if not wireproto.commands.commandavailable(cmd, proto):
         setresponse(HTTP_OK, HGERRTYPE,
                     _('requested wire protocol command is not available over '
                       'HTTP'))
         return
 
     proto.checkperm(wireproto.commands[cmd].permission)
 
     rsp = wireproto.dispatch(repo, proto, cmd)
 
     if isinstance(rsp, bytes):
         setresponse(HTTP_OK, HGTYPE, bodybytes=rsp)
     elif isinstance(rsp, wireprototypes.bytesresponse):
         setresponse(HTTP_OK, HGTYPE, bodybytes=rsp.data)
     elif isinstance(rsp, wireprototypes.streamreslegacy):
         setresponse(HTTP_OK, HGTYPE, bodygen=rsp.gen)
     elif isinstance(rsp, wireprototypes.streamres):
         gen = rsp.gen
 
         # This code for compression should not be streamres specific. It
         # is here because we only compress streamres at the moment.
         mediatype, engine, engineopts = _httpresponsetype(
             repo.ui, req, rsp.prefer_uncompressed)
         gen = engine.compressstream(gen, engineopts)
 
         if mediatype == HGTYPE2:
             gen = genversion2(gen, engine, engineopts)
 
         setresponse(HTTP_OK, mediatype, bodygen=gen)
     elif isinstance(rsp, wireprototypes.pushres):
         rsp = '%d\n%s' % (rsp.res, rsp.output)
         setresponse(HTTP_OK, HGTYPE, bodybytes=rsp)
     elif isinstance(rsp, wireprototypes.pusherr):
         rsp = '0\n%s\n' % rsp.res
         res.drain = True
         setresponse(HTTP_OK, HGTYPE, bodybytes=rsp)
     elif isinstance(rsp, wireprototypes.ooberror):
         setresponse(HTTP_OK, HGERRTYPE, bodybytes=rsp.message)
     else:
         raise error.ProgrammingError('hgweb.protocol internal failure', rsp)
 
 def _sshv1respondbytes(fout, value):
     """Send a bytes response for protocol version 1."""
     fout.write('%d\n' % len(value))
     fout.write(value)
     fout.flush()
 
 def _sshv1respondstream(fout, source):
     write = fout.write
     for chunk in source.gen:
         write(chunk)
     fout.flush()
 
 def _sshv1respondooberror(fout, ferr, rsp):
     ferr.write(b'%s\n-\n' % rsp)
     ferr.flush()
     fout.write(b'\n')
     fout.flush()
 
 class sshv1protocolhandler(wireprototypes.baseprotocolhandler):
     """Handler for requests services via version 1 of SSH protocol."""
     def __init__(self, ui, fin, fout):
         self._ui = ui
         self._fin = fin
         self._fout = fout
 
     @property
     def name(self):
         return wireprototypes.SSHV1
 
     def getargs(self, args):
         data = {}
         keys = args.split()
         for n in xrange(len(keys)):
             argline = self._fin.readline()[:-1]
             arg, l = argline.split()
             if arg not in keys:
                 raise error.Abort(_("unexpected parameter %r") % arg)
             if arg == '*':
                 star = {}
                 for k in xrange(int(l)):
                     argline = self._fin.readline()[:-1]
                     arg, l = argline.split()
                     val = self._fin.read(int(l))
                     star[arg] = val
                 data['*'] = star
             else:
                 val = self._fin.read(int(l))
                 data[arg] = val
         return [data[k] for k in keys]
 
     def forwardpayload(self, fpout):
         # We initially send an empty response. This tells the client it is
         # OK to start sending data. If a client sees any other response, it
         # interprets it as an error.
         _sshv1respondbytes(self._fout, b'')
 
         # The file is in the form:
         #
         # <chunk size>\n<chunk>
         # ...
         # 0\n
         count = int(self._fin.readline())
         while count:
             fpout.write(self._fin.read(count))
             count = int(self._fin.readline())
 
     @contextlib.contextmanager
     def mayberedirectstdio(self):
         yield None
 
     def client(self):
         client = encoding.environ.get('SSH_CLIENT', '').split(' ', 1)[0]
         return 'remote:ssh:' + client
 
     def addcapabilities(self, repo, caps):
         return caps
 
     def checkperm(self, perm):
         pass
 
 class sshv2protocolhandler(sshv1protocolhandler):
     """Protocol handler for version 2 of the SSH protocol."""
 
     @property
     def name(self):
         return wireprototypes.SSHV2
 
 def _runsshserver(ui, repo, fin, fout, ev):
     # This function operates like a state machine of sorts. The following
     # states are defined:
     #
     # protov1-serving
     #    Server is in protocol version 1 serving mode. Commands arrive on
     #    new lines. These commands are processed in this state, one command
     #    after the other.
     #
     # protov2-serving
     #    Server is in protocol version 2 serving mode.
     #
     # upgrade-initial
     #    The server is going to process an upgrade request.
     #
     # upgrade-v2-filter-legacy-handshake
     #    The protocol is being upgraded to version 2. The server is expecting
     #    the legacy handshake from version 1.
     #
     # upgrade-v2-finish
     #    The upgrade to version 2 of the protocol is imminent.
     #
     # shutdown
     #    The server is shutting down, possibly in reaction to a client event.
     #
     # And here are their transitions:
     #
     # protov1-serving -> shutdown
     #    When server receives an empty request or encounters another
     #    error.
     #
     # protov1-serving -> upgrade-initial
     #    An upgrade request line was seen.
     #
     # upgrade-initial -> upgrade-v2-filter-legacy-handshake
     #    Upgrade to version 2 in progress. Server is expecting to
     #    process a legacy handshake.
     #
     # upgrade-v2-filter-legacy-handshake -> shutdown
     #    Client did not fulfill upgrade handshake requirements.
     #
     # upgrade-v2-filter-legacy-handshake -> upgrade-v2-finish
     #    Client fulfilled version 2 upgrade requirements. Finishing that
     #    upgrade.
     #
     # upgrade-v2-finish -> protov2-serving
     #    Protocol upgrade to version 2 complete. Server can now speak protocol
     #    version 2.
     #
     # protov2-serving -> protov1-serving
     #    Ths happens by default since protocol version 2 is the same as
     #    version 1 except for the handshake.
 
     state = 'protov1-serving'
     proto = sshv1protocolhandler(ui, fin, fout)
     protoswitched = False
 
     while not ev.is_set():
         if state == 'protov1-serving':
             # Commands are issued on new lines.
             request = fin.readline()[:-1]
 
             # Empty lines signal to terminate the connection.
             if not request:
                 state = 'shutdown'
                 continue
 
             # It looks like a protocol upgrade request. Transition state to
             # handle it.
             if request.startswith(b'upgrade '):
                 if protoswitched:
                     _sshv1respondooberror(fout, ui.ferr,
                                           b'cannot upgrade protocols multiple '
                                           b'times')
                     state = 'shutdown'
                     continue
 
                 state = 'upgrade-initial'
                 continue
 
             available = wireproto.commands.commandavailable(request, proto)
 
             # This command isn't available. Send an empty response and go
             # back to waiting for a new command.
             if not available:
                 _sshv1respondbytes(fout, b'')
                 continue
 
             rsp = wireproto.dispatch(repo, proto, request)
 
             if isinstance(rsp, bytes):
                 _sshv1respondbytes(fout, rsp)
             elif isinstance(rsp, wireprototypes.bytesresponse):
                 _sshv1respondbytes(fout, rsp.data)
             elif isinstance(rsp, wireprototypes.streamres):
                 _sshv1respondstream(fout, rsp)
             elif isinstance(rsp, wireprototypes.streamreslegacy):
                 _sshv1respondstream(fout, rsp)
             elif isinstance(rsp, wireprototypes.pushres):
                 _sshv1respondbytes(fout, b'')
                 _sshv1respondbytes(fout, b'%d' % rsp.res)
             elif isinstance(rsp, wireprototypes.pusherr):
                 _sshv1respondbytes(fout, rsp.res)
             elif isinstance(rsp, wireprototypes.ooberror):
                 _sshv1respondooberror(fout, ui.ferr, rsp.message)
             else:
                 raise error.ProgrammingError('unhandled response type from '
                                              'wire protocol command: %s' % rsp)
 
         # For now, protocol version 2 serving just goes back to version 1.
         elif state == 'protov2-serving':
             state = 'protov1-serving'
             continue
 
         elif state == 'upgrade-initial':
             # We should never transition into this state if we've switched
             # protocols.
             assert not protoswitched
             assert proto.name == wireprototypes.SSHV1
 
             # Expected: upgrade <token> <capabilities>
             # If we get something else, the request is malformed. It could be
             # from a future client that has altered the upgrade line content.
             # We treat this as an unknown command.
             try:
                 token, caps = request.split(b' ')[1:]
             except ValueError:
                 _sshv1respondbytes(fout, b'')
                 state = 'protov1-serving'
                 continue
 
             # Send empty response if we don't support upgrading protocols.
             if not ui.configbool('experimental', 'sshserver.support-v2'):
                 _sshv1respondbytes(fout, b'')
                 state = 'protov1-serving'
                 continue
 
             try:
                 caps = urlreq.parseqs(caps)
             except ValueError:
                 _sshv1respondbytes(fout, b'')
                 state = 'protov1-serving'
                 continue
 
             # We don't see an upgrade request to protocol version 2. Ignore
             # the upgrade request.
             wantedprotos = caps.get(b'proto', [b''])[0]
             if SSHV2 not in wantedprotos:
                 _sshv1respondbytes(fout, b'')
                 state = 'protov1-serving'
                 continue
 
             # It looks like we can honor this upgrade request to protocol 2.
             # Filter the rest of the handshake protocol request lines.
             state = 'upgrade-v2-filter-legacy-handshake'
             continue
 
         elif state == 'upgrade-v2-filter-legacy-handshake':
             # Client should have sent legacy handshake after an ``upgrade``
             # request. Expected lines:
             #
             #    hello
             #    between
             #    pairs 81
             #    0000...-0000...
 
             ok = True
             for line in (b'hello', b'between', b'pairs 81'):
                 request = fin.readline()[:-1]
 
                 if request != line:
                     _sshv1respondooberror(fout, ui.ferr,
                                           b'malformed handshake protocol: '
                                           b'missing %s' % line)
                     ok = False
                     state = 'shutdown'
                     break
 
             if not ok:
                 continue
 
             request = fin.read(81)
             if request != b'%s-%s' % (b'0' * 40, b'0' * 40):
                 _sshv1respondooberror(fout, ui.ferr,
                                       b'malformed handshake protocol: '
                                       b'missing between argument value')
                 state = 'shutdown'
                 continue
 
             state = 'upgrade-v2-finish'
             continue
 
         elif state == 'upgrade-v2-finish':
             # Send the upgrade response.
             fout.write(b'upgraded %s %s\n' % (token, SSHV2))
             servercaps = wireproto.capabilities(repo, proto)
             rsp = b'capabilities: %s' % servercaps.data
             fout.write(b'%d\n%s\n' % (len(rsp), rsp))
             fout.flush()
 
             proto = sshv2protocolhandler(ui, fin, fout)
             protoswitched = True
 
             state = 'protov2-serving'
             continue
 
         elif state == 'shutdown':
             break
 
         else:
             raise error.ProgrammingError('unhandled ssh server state: %s' %
                                          state)
 
 class sshserver(object):
     def __init__(self, ui, repo, logfh=None):
         self._ui = ui
         self._repo = repo
         self._fin = ui.fin
         self._fout = ui.fout
 
         # Log write I/O to stdout and stderr if configured.
         if logfh:
             self._fout = util.makeloggingfileobject(
                 logfh, self._fout, 'o', logdata=True)
             ui.ferr = util.makeloggingfileobject(
                 logfh, ui.ferr, 'e', logdata=True)
 
         hook.redirect(True)
         ui.fout = repo.ui.fout = ui.ferr
 
         # Prevent insertion/deletion of CRs
         util.setbinary(self._fin)
         util.setbinary(self._fout)
 
     def serve_forever(self):
         self.serveuntil(threading.Event())
         sys.exit(0)
 
     def serveuntil(self, ev):
         """Serve until a threading.Event is set."""
         _runsshserver(self._ui, self._repo, self._fin, self._fout, ev)

mercurial/wireprototypes.py

@@ -1,157 +1,162 b''
 # Copyright 2018 Gregory Szorc <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import abc
 
 # Names of the SSH protocol implementations.
 SSHV1 = 'ssh-v1'
-# This is advertised over the wire. Incremental the counter at the end
+# These are advertised over the wire. Increment the counters at the end
 # to reflect BC breakages.
 SSHV2 = 'exp-ssh-v2-0001'
+HTTPV2 = 'exp-http-v2-0001'
 
 # All available wire protocol transports.
 TRANSPORTS = {
     SSHV1: {
         'transport': 'ssh',
         'version': 1,
     },
     SSHV2: {
         'transport': 'ssh',
         'version': 2,
     },
     'http-v1': {
         'transport': 'http',
         'version': 1,
+    },
+    HTTPV2: {
+        'transport': 'http',
+        'version': 2,
     }
 }
 
 class bytesresponse(object):
     """A wire protocol response consisting of raw bytes."""
     def __init__(self, data):
         self.data = data
 
 class ooberror(object):
     """wireproto reply: failure of a batch of operation
 
     Something failed during a batch call. The error message is stored in
     `self.message`.
     """
     def __init__(self, message):
         self.message = message
 
 class pushres(object):
     """wireproto reply: success with simple integer return
 
     The call was successful and returned an integer contained in `self.res`.
     """
     def __init__(self, res, output):
         self.res = res
         self.output = output
 
 class pusherr(object):
     """wireproto reply: failure
 
     The call failed. The `self.res` attribute contains the error message.
     """
     def __init__(self, res, output):
         self.res = res
         self.output = output
 
 class streamres(object):
     """wireproto reply: binary stream
 
     The call was successful and the result is a stream.
 
     Accepts a generator containing chunks of data to be sent to the client.
 
     ``prefer_uncompressed`` indicates that the data is expected to be
     uncompressable and that the stream should therefore use the ``none``
     engine.
     """
     def __init__(self, gen=None, prefer_uncompressed=False):
         self.gen = gen
         self.prefer_uncompressed = prefer_uncompressed
 
 class streamreslegacy(object):
     """wireproto reply: uncompressed binary stream
 
     The call was successful and the result is a stream.
 
     Accepts a generator containing chunks of data to be sent to the client.
 
     Like ``streamres``, but sends an uncompressed data for "version 1" clients
     using the application/mercurial-0.1 media type.
     """
     def __init__(self, gen=None):
         self.gen = gen
 
 class baseprotocolhandler(object):
     """Abstract base class for wire protocol handlers.
 
     A wire protocol handler serves as an interface between protocol command
     handlers and the wire protocol transport layer. Protocol handlers provide
     methods to read command arguments, redirect stdio for the duration of
     the request, handle response types, etc.
     """
 
     __metaclass__ = abc.ABCMeta
 
     @abc.abstractproperty
     def name(self):
         """The name of the protocol implementation.
 
         Used for uniquely identifying the transport type.
         """
 
     @abc.abstractmethod
     def getargs(self, args):
         """return the value for arguments in <args>
 
         returns a list of values (same order as <args>)"""
 
     @abc.abstractmethod
     def forwardpayload(self, fp):
         """Read the raw payload and forward to a file.
 
         The payload is read in full before the function returns.
         """
 
     @abc.abstractmethod
     def mayberedirectstdio(self):
         """Context manager to possibly redirect stdio.
 
         The context manager yields a file-object like object that receives
         stdout and stderr output when the context manager is active. Or it
         yields ``None`` if no I/O redirection occurs.
 
         The intent of this context manager is to capture stdio output
         so it may be sent in the response. Some transports support streaming
         stdio to the client in real time. For these transports, stdio output
         won't be captured.
         """
 
     @abc.abstractmethod
     def client(self):
         """Returns a string representation of this client (as bytes)."""
 
     @abc.abstractmethod
     def addcapabilities(self, repo, caps):
         """Adds advertised capabilities specific to this protocol.
 
         Receives the list of capabilities collected so far.
 
         Returns a list of capabilities. The passed in argument can be returned.
         """
 
     @abc.abstractmethod
     def checkperm(self, perm):
         """Validate that the client has permissions to perform a request.
 
         The argument is the permission required to proceed. If the client
         doesn't have that permission, the exception should raise or abort
         in a protocol specific manner.
         """