# Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net>

# Copyright 2005-2007 Matt Mackall <mpm@selenic.com>

#

# 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

from .i18n import _

from .node import (

    hex,

    nullid,

    nullrev,

)

from . import (

    changegroup,

    dagop,

    discovery,

    encoding,

    error,

    narrowspec,

    pycompat,

    streamclone,

    util,

    wireprotoframing,

    wireprototypes,

)

from .utils import (

    interfaceutil,

)

FRAMINGTYPE = b'application/mercurial-exp-framing-0005'

HTTP_WIREPROTO_V2 = wireprototypes.HTTP_WIREPROTO_V2

COMMANDS = wireprototypes.commanddict()

def handlehttpv2request(rctx, req, res, checkperm, urlparts):

    from .hgweb import common as hgwebcommon

    # URL space looks like: <permissions>/<command>, where <permission> can

    # be ``ro`` or ``rw`` to signal read-only or read-write, respectively.

    # Root URL does nothing meaningful... yet.

    if not urlparts:

        res.status = b'200 OK'

        res.headers[b'Content-Type'] = b'text/plain'

        res.setbodybytes(_('HTTP version 2 API handler'))

        return

    if len(urlparts) == 1:

        res.status = b'404 Not Found'

        res.headers[b'Content-Type'] = b'text/plain'

        res.setbodybytes(_('do not know how to process %s\n') %

                         req.dispatchpath)

        return

    permission, command = urlparts[0:2]

    if permission not in (b'ro', b'rw'):

        res.status = b'404 Not Found'

        res.headers[b'Content-Type'] = b'text/plain'

        res.setbodybytes(_('unknown permission: %s') % permission)

        return

    if req.method != 'POST':

        res.status = b'405 Method Not Allowed'

        res.headers[b'Allow'] = b'POST'

        res.setbodybytes(_('commands require POST requests'))

        return

    # At some point we'll want to use our own API instead of recycling the

    # behavior of version 1 of the wire protocol...

    # TODO return reasonable responses - not responses that overload the

    # HTTP status line message for error reporting.

    try:

        checkperm(rctx, req, 'pull' if permission == b'ro' else 'push')

    except hgwebcommon.ErrorResponse as e:

        res.status = hgwebcommon.statusmessage(e.code, pycompat.bytestr(e))

        for k, v in e.headers:

            res.headers[k] = v

        res.setbodybytes('permission denied')

        return

    # We have a special endpoint to reflect the request back at the client.

    if command == b'debugreflect':

        _processhttpv2reflectrequest(rctx.repo.ui, rctx.repo, req, res)

        return

    # Extra commands that we handle that aren't really wire protocol

    # commands. Think extra hard before making this hackery available to

    # extension.

    extracommands = {'multirequest'}

    if command not in COMMANDS and command not in extracommands:

        res.status = b'404 Not Found'

        res.headers[b'Content-Type'] = b'text/plain'

        res.setbodybytes(_('unknown wire protocol command: %s\n') % command)

        return

    repo = rctx.repo

    ui = repo.ui

    proto = httpv2protocolhandler(req, ui)

    if (not COMMANDS.commandavailable(command, proto)

        and command not in extracommands):

        res.status = b'404 Not Found'

        res.headers[b'Content-Type'] = b'text/plain'

        res.setbodybytes(_('invalid wire protocol command: %s') % command)

        return

    # TODO consider cases where proxies may add additional Accept headers.

    if req.headers.get(b'Accept') != FRAMINGTYPE:

        res.status = b'406 Not Acceptable'

        res.headers[b'Content-Type'] = b'text/plain'

        res.setbodybytes(_('client MUST specify Accept header with value: %s\n')

                           % FRAMINGTYPE)

        return

    if req.headers.get(b'Content-Type') != FRAMINGTYPE:

        res.status = b'415 Unsupported Media Type'

        # TODO we should send a response with appropriate media type,

        # since client does Accept it.

        res.headers[b'Content-Type'] = b'text/plain'

        res.setbodybytes(_('client MUST send Content-Type header with '

                           'value: %s\n') % FRAMINGTYPE)

        return

    _processhttpv2request(ui, repo, req, res, permission, command, proto)

def _processhttpv2reflectrequest(ui, repo, req, res):

    """Reads unified frame protocol request and dumps out state to client.

    This special endpoint can be used to help debug the wire protocol.

    Instead of routing the request through the normal dispatch mechanism,

    we instead read all frames, decode them, and feed them into our state

    tracker. We then dump the log of all that activity back out to the

    client.

    """

    import json

    # Reflection APIs have a history of being abused, accidentally disclosing

    # sensitive data, etc. So we have a config knob.

    if not ui.configbool('experimental', 'web.api.debugreflect'):

        res.status = b'404 Not Found'

        res.headers[b'Content-Type'] = b'text/plain'

        res.setbodybytes(_('debugreflect service not available'))

        return

    # We assume we have a unified framing protocol request body.

    reactor = wireprotoframing.serverreactor()

    states = []

    while True:

        frame = wireprotoframing.readframe(req.bodyfh)

        if not frame:

            states.append(b'received: <no frame>')

            break

        states.append(b'received: %d %d %d %s' % (frame.typeid, frame.flags,

                                                  frame.requestid,

                                                  frame.payload))

        action, meta = reactor.onframerecv(frame)

        states.append(json.dumps((action, meta), sort_keys=True,

                                 separators=(', ', ': ')))

    action, meta = reactor.oninputeof()

    meta['action'] = action

    states.append(json.dumps(meta, sort_keys=True, separators=(', ',': ')))

    res.status = b'200 OK'

    res.headers[b'Content-Type'] = b'text/plain'

    res.setbodybytes(b'\n'.join(states))

def _processhttpv2request(ui, repo, req, res, authedperm, reqcommand, proto):

    """Post-validation handler for HTTPv2 requests.

    Called when the HTTP request contains unified frame-based protocol

    frames for evaluation.

    """

    # TODO Some HTTP clients are full duplex and can receive data before

    # the entire request is transmitted. Figure out a way to indicate support

    # for that so we can opt into full duplex mode.

    reactor = wireprotoframing.serverreactor(deferoutput=True)

    seencommand = False

    outstream = reactor.makeoutputstream()

    while True:

        frame = wireprotoframing.readframe(req.bodyfh)

        if not frame:

            break

        action, meta = reactor.onframerecv(frame)

        if action == 'wantframe':

            # Need more data before we can do anything.

            continue

        elif action == 'runcommand':

            sentoutput = _httpv2runcommand(ui, repo, req, res, authedperm,

                                           reqcommand, reactor, outstream,

                                           meta, issubsequent=seencommand)

            if sentoutput:

                return

            seencommand = True

        elif action == 'error':

            # TODO define proper error mechanism.

            res.status = b'200 OK'

            res.headers[b'Content-Type'] = b'text/plain'

            res.setbodybytes(meta['message'] + b'\n')

            return

        else:

            raise error.ProgrammingError(

                'unhandled action from frame processor: %s' % action)

    action, meta = reactor.oninputeof()

    if action == 'sendframes':

        # We assume we haven't started sending the response yet. If we're

        # wrong, the response type will raise an exception.

        res.status = b'200 OK'

        res.headers[b'Content-Type'] = FRAMINGTYPE

        res.setbodygen(meta['framegen'])

    elif action == 'noop':

        pass

    else:

        raise error.ProgrammingError('unhandled action from frame processor: %s'

                                     % action)

def _httpv2runcommand(ui, repo, req, res, authedperm, reqcommand, reactor,

                      outstream, command, issubsequent):

    """Dispatch a wire protocol command made from HTTPv2 requests.

    The authenticated permission (``authedperm``) along with the original

    command from the URL (``reqcommand``) are passed in.

    """

    # We already validated that the session has permissions to perform the

    # actions in ``authedperm``. In the unified frame protocol, the canonical

    # command to run is expressed in a frame. However, the URL also requested

    # to run a specific command. We need to be careful that the command we

    # run doesn't have permissions requirements greater than what was granted

    # by ``authedperm``.

    #

    # Our rule for this is we only allow one command per HTTP request and

    # that command must match the command in the URL. However, we make

    # an exception for the ``multirequest`` URL. This URL is allowed to

    # execute multiple commands. We double check permissions of each command

    # as it is invoked to ensure there is no privilege escalation.

    # TODO consider allowing multiple commands to regular command URLs

    # iff each command is the same.

    proto = httpv2protocolhandler(req, ui, args=command['args'])

    if reqcommand == b'multirequest':

        if not COMMANDS.commandavailable(command['command'], proto):

            # TODO proper error mechanism

            res.status = b'200 OK'

            res.headers[b'Content-Type'] = b'text/plain'

            res.setbodybytes(_('wire protocol command not available: %s') %

                             command['command'])

            return True

        # TODO don't use assert here, since it may be elided by -O.

        assert authedperm in (b'ro', b'rw')

        wirecommand = COMMANDS[command['command']]

        assert wirecommand.permission in ('push', 'pull')

        if authedperm == b'ro' and wirecommand.permission != 'pull':

            # TODO proper error mechanism

            res.status = b'403 Forbidden'

            res.headers[b'Content-Type'] = b'text/plain'

            res.setbodybytes(_('insufficient permissions to execute '

                               'command: %s') % command['command'])

            return True

        # TODO should we also call checkperm() here? Maybe not if we're going

        # to overhaul that API. The granted scope from the URL check should

        # be good enough.

    else:

        # Don't allow multiple commands outside of ``multirequest`` URL.

        if issubsequent:

            # TODO proper error mechanism

            res.status = b'200 OK'

            res.headers[b'Content-Type'] = b'text/plain'

            res.setbodybytes(_('multiple commands cannot be issued to this '

                               'URL'))

            return True

        if reqcommand != command['command']:

            # TODO define proper error mechanism

            res.status = b'200 OK'

            res.headers[b'Content-Type'] = b'text/plain'

            res.setbodybytes(_('command in frame must match command in URL'))

            return True

    res.status = b'200 OK'

    res.headers[b'Content-Type'] = FRAMINGTYPE

    try:

        objs = dispatch(repo, proto, command['command'])

        action, meta = reactor.oncommandresponsereadyobjects(

            outstream, command['requestid'], objs)

    except error.WireprotoCommandError as e:

        action, meta = reactor.oncommanderror(

            outstream, command['requestid'], e.message, e.messageargs)

    except Exception as e:

        action, meta = reactor.onservererror(

            outstream, command['requestid'],

            _('exception when invoking command: %s') % e)

    if action == 'sendframes':

        res.setbodygen(meta['framegen'])

        return True

    elif action == 'noop':

        return False

    else:

        raise error.ProgrammingError('unhandled event from reactor: %s' %

                                     action)

def getdispatchrepo(repo, proto, command):

    return repo.filtered('served')

def dispatch(repo, proto, command):

    repo = getdispatchrepo(repo, proto, command)

    func, spec = COMMANDS[command]

    args = proto.getargs(spec)

    return func(repo, proto, **args)

@interfaceutil.implementer(wireprototypes.baseprotocolhandler)

class httpv2protocolhandler(object):

    def __init__(self, req, ui, args=None):

        self._req = req

        self._ui = ui

        self._args = args

    @property

    def name(self):

        return HTTP_WIREPROTO_V2

    def getargs(self, args):

        # First look for args that were passed but aren't registered on this

        # command.

        extra = set(self._args) - set(args)

        if extra:

            raise error.WireprotoCommandError(

                'unsupported argument to command: %s' %

                ', '.join(sorted(extra)))

        # And look for required arguments that are missing.

        missing = {a for a in args if args[a]['required']} - set(self._args)

        if missing:

            raise error.WireprotoCommandError(

                'missing required arguments: %s' % ', '.join(sorted(missing)))

        # Now derive the arguments to pass to the command, taking into

        # account the arguments specified by the client.

        data = {}

        for k, meta in sorted(args.items()):

            # This argument wasn't passed by the client.

            if k not in self._args:

                data[k] = meta['default']()

                continue

            v = self._args[k]

            # Sets may be expressed as lists. Silently normalize.

            if meta['type'] == 'set' and isinstance(v, list):

                v = set(v)

            # TODO consider more/stronger type validation.

            data[k] = v

        return data

    def getprotocaps(self):

        # Protocol capabilities are currently not implemented for HTTP V2.

        return set()

    def getpayload(self):

        raise NotImplementedError

    @contextlib.contextmanager

    def mayberedirectstdio(self):

        raise NotImplementedError

    def client(self):

        raise NotImplementedError

    def addcapabilities(self, repo, caps):

        return caps

    def checkperm(self, perm):

        raise NotImplementedError

def httpv2apidescriptor(req, repo):

    proto = httpv2protocolhandler(req, repo.ui)

    return _capabilitiesv2(repo, proto)

def _capabilitiesv2(repo, proto):

    """Obtain the set of capabilities for version 2 transports.

    These capabilities are distinct from the capabilities for version 1

    transports.

    """

    compression = []

    for engine in wireprototypes.supportedcompengines(repo.ui, util.SERVERROLE):

        compression.append({

            b'name': engine.wireprotosupport().name,

        })

    caps = {

        'commands': {},

        'compression': compression,

        'framingmediatypes': [FRAMINGTYPE],

        'pathfilterprefixes': set(narrowspec.VALID_PREFIXES),

    }

    # TODO expose available changesetdata fields.

    for command, entry in COMMANDS.items():

        caps['commands'][command] = {

            'args': args,

            'permissions': [entry.permission],

        }

    if streamclone.allowservergeneration(repo):

        caps['rawrepoformats'] = sorted(repo.requirements &

                                        repo.supportedformats)

    return proto.addcapabilities(repo, caps)

def builddeltarequests(store, nodes, haveparents):

    """Build a series of revision delta requests against a backend store.

    Returns a list of revision numbers in the order they should be sent

    and a list of ``irevisiondeltarequest`` instances to be made against

    the backend store.

    """

    # We sort and send nodes in DAG order because this is optimal for

    # storage emission.

    # TODO we may want a better storage API here - one where we can throw

    # a list of nodes and delta preconditions over a figurative wall and

    # have the storage backend figure it out for us.

    revs = dagop.linearize({store.rev(n) for n in nodes}, store.parentrevs)

    requests = []

    seenrevs = set()

    for rev in revs:

        node = store.node(rev)

        parentnodes = store.parents(node)

        parentrevs = [store.rev(n) for n in parentnodes]

        deltabaserev = store.deltaparent(rev)

        deltabasenode = store.node(deltabaserev)