# dispatch.py - command dispatching for mercurial

#

# 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, print_function

import atexit

import difflib

import errno

import os

import pdb

import re

import shlex

import signal

import socket

import sys

import time

import traceback

from .i18n import _

from . import (

    cmdutil,

    commands,

    demandimport,

    encoding,

    error,

    extensions,

    fancyopts,

    fileset,

    hg,

    hook,

    revset,

    templatefilters,

    templatekw,

    ui as uimod,

    util,

)

class request(object):

    def __init__(self, args, ui=None, repo=None, fin=None, fout=None,

                 ferr=None):

        self.args = args

        self.ui = ui

        self.repo = repo

        # input/output/error streams

        self.fin = fin

        self.fout = fout

        self.ferr = ferr

def run():

    "run the command in sys.argv"

    sys.exit((dispatch(request(sys.argv[1:])) or 0) & 255)

def _getsimilar(symbols, value):

    sim = lambda x: difflib.SequenceMatcher(None, value, x).ratio()

    # The cutoff for similarity here is pretty arbitrary. It should

    # probably be investigated and tweaked.

    return [s for s in symbols if sim(s) > 0.6]

def _reportsimilar(write, similar):

    if len(similar) == 1:

        write(_("(did you mean %s?)\n") % similar[0])

    elif similar:

        ss = ", ".join(sorted(similar))

        write(_("(did you mean one of %s?)\n") % ss)

def _formatparse(write, inst):

    similar = []

    if isinstance(inst, error.UnknownIdentifier):

        # make sure to check fileset first, as revset can invoke fileset

        similar = _getsimilar(inst.symbols, inst.function)

    if len(inst.args) > 1:

        write(_("hg: parse error at %s: %s\n") %

                         (inst.args[1], inst.args[0]))

        if (inst.args[0][0] == ' '):

            write(_("unexpected leading whitespace\n"))

    else:

        write(_("hg: parse error: %s\n") % inst.args[0])

        _reportsimilar(write, similar)

    if inst.hint:

        write(_("(%s)\n") % inst.hint)

def dispatch(req):

    "run the command specified in req.args"

    if req.ferr:

        ferr = req.ferr

    elif req.ui:

        ferr = req.ui.ferr

    else:

        ferr = sys.stderr

    try:

        if not req.ui:

            req.ui = uimod.ui()

        if '--traceback' in req.args:

            req.ui.setconfig('ui', 'traceback', 'on', '--traceback')

        # set ui streams from the request

        if req.fin:

            req.ui.fin = req.fin

        if req.fout:

            req.ui.fout = req.fout

        if req.ferr:

            req.ui.ferr = req.ferr

    except error.Abort as inst:

        ferr.write(_("abort: %s\n") % inst)

        if inst.hint:

            ferr.write(_("(%s)\n") % inst.hint)

        return -1

    except error.ParseError as inst:

        _formatparse(ferr.write, inst)

        return -1

    msg = ' '.join(' ' in a and repr(a) or a for a in req.args)

    starttime = time.time()

    ret = None

    try:

        ret = _runcatch(req)

    except KeyboardInterrupt:

        try:

            req.ui.warn(_("interrupted!\n"))

        except IOError as inst:

            if inst.errno != errno.EPIPE:

                raise

        ret = -1

    finally:

        duration = time.time() - starttime

        req.ui.flush()

        req.ui.log("commandfinish", "%s exited %s after %0.2f seconds\n",

                   msg, ret or 0, duration)

    return ret

def _runcatch(req):

    def catchterm(*args):

        raise error.SignalInterrupt

    ui = req.ui

    try:

        for name in 'SIGBREAK', 'SIGHUP', 'SIGTERM':

            num = getattr(signal, name, None)

            if num:

                signal.signal(num, catchterm)

    except ValueError:

        pass # happens if called in a thread

    try:

        try:

            debugger = 'pdb'

            debugtrace = {

                'pdb' : pdb.set_trace

            }

            debugmortem = {

                'pdb' : pdb.post_mortem

            }

            # read --config before doing anything else

            # (e.g. to change trust settings for reading .hg/hgrc)

            cfgs = _parseconfig(req.ui, _earlygetopt(['--config'], req.args))

            if req.repo:

                # copy configs that were passed on the cmdline (--config) to

                # the repo ui

                for sec, name, val in cfgs:

                    req.repo.ui.setconfig(sec, name, val, source='--config')

            # developer config: ui.debugger

            debugger = ui.config("ui", "debugger")

            debugmod = pdb

            if not debugger or ui.plain():

                # if we are in HGPLAIN mode, then disable custom debugging

                debugger = 'pdb'

            elif '--debugger' in req.args:

                # This import can be slow for fancy debuggers, so only

                # do it when absolutely necessary, i.e. when actual

                # debugging has been requested

                with demandimport.deactivated():

                    try:

                        debugmod = __import__(debugger)

                    except ImportError:

                        pass # Leave debugmod = pdb

            debugtrace[debugger] = debugmod.set_trace

            debugmortem[debugger] = debugmod.post_mortem

            # enter the debugger before command execution

            if '--debugger' in req.args:

                ui.warn(_("entering debugger - "

                        "type c to continue starting hg or h for help\n"))

                if (debugger != 'pdb' and

                    debugtrace[debugger] == debugtrace['pdb']):

                    ui.warn(_("%s debugger specified "

                              "but its module was not found\n") % debugger)

                with demandimport.deactivated():

                    debugtrace[debugger]()

            try:

                return _dispatch(req)

            finally:

                ui.flush()

        except: # re-raises

            # enter the debugger when we hit an exception

            if '--debugger' in req.args:

                traceback.print_exc()

                debugmortem[debugger](sys.exc_info()[2])

            ui.traceback()

            raise

    # Global exception handling, alphabetically

    # Mercurial-specific first, followed by built-in and library exceptions

    except error.AmbiguousCommand as inst:

        ui.warn(_("hg: command '%s' is ambiguous:\n    %s\n") %

                (inst.args[0], " ".join(inst.args[1])))

    except error.ParseError as inst:

        _formatparse(ui.warn, inst)

        return -1

    except error.LockHeld as inst:

        if inst.errno == errno.ETIMEDOUT:

            reason = _('timed out waiting for lock held by %s') % inst.locker

        else:

            reason = _('lock held by %s') % inst.locker

        ui.warn(_("abort: %s: %s\n") % (inst.desc or inst.filename, reason))

    except error.LockUnavailable as inst:

        ui.warn(_("abort: could not lock %s: %s\n") %

               (inst.desc or inst.filename, inst.strerror))

    except error.CommandError as inst:

        if inst.args[0]:

            ui.warn(_("hg %s: %s\n") % (inst.args[0], inst.args[1]))

            commands.help_(ui, inst.args[0], full=False, command=True)

        else:

            ui.warn(_("hg: %s\n") % inst.args[1])

            commands.help_(ui, 'shortlist')

    except error.OutOfBandError as inst:

        if inst.args:

            msg = _("abort: remote error:\n")

        else:

            msg = _("abort: remote error\n")

        ui.warn(msg)

        if inst.args:

            ui.warn(''.join(inst.args))

        if inst.hint:

            ui.warn('(%s)\n' % inst.hint)

    except error.RepoError as inst:

        ui.warn(_("abort: %s!\n") % inst)

        if inst.hint:

            ui.warn(_("(%s)\n") % inst.hint)

    except error.ResponseError as inst:

        ui.warn(_("abort: %s") % inst.args[0])

        if not isinstance(inst.args[1], basestring):

            ui.warn(" %r\n" % (inst.args[1],))

        elif not inst.args[1]:

            ui.warn(_(" empty string\n"))

        else:

            ui.warn("\n%r\n" % util.ellipsis(inst.args[1]))

    except error.CensoredNodeError as inst:

        ui.warn(_("abort: file censored %s!\n") % inst)

    except error.RevlogError as inst:

        ui.warn(_("abort: %s!\n") % inst)

    except error.SignalInterrupt:

        ui.warn(_("killed!\n"))

    except error.UnknownCommand as inst:

        ui.warn(_("hg: unknown command '%s'\n") % inst.args[0])

        try:

            # check if the command is in a disabled extension

            # (but don't check for extensions themselves)

            commands.help_(ui, inst.args[0], unknowncmd=True)

        except (error.UnknownCommand, error.Abort):

            suggested = False

            if len(inst.args) == 2:

                sim = _getsimilar(inst.args[1], inst.args[0])

                if sim:

                    _reportsimilar(ui.warn, sim)

                    suggested = True

            if not suggested:

                commands.help_(ui, 'shortlist')

    except error.InterventionRequired as inst:

        ui.warn("%s\n" % inst)

        if inst.hint:

            ui.warn(_("(%s)\n") % inst.hint)

        return 1

    except error.Abort as inst:

        ui.warn(_("abort: %s\n") % inst)

        if inst.hint:

            ui.warn(_("(%s)\n") % inst.hint)

    except ImportError as inst:

        ui.warn(_("abort: %s!\n") % inst)

        m = str(inst).split()[-1]

        if m in "mpatch bdiff".split():

            ui.warn(_("(did you forget to compile extensions?)\n"))

        elif m in "zlib".split():

            ui.warn(_("(is your Python install correct?)\n"))

    except IOError as inst:

        if util.safehasattr(inst, "code"):

            ui.warn(_("abort: %s\n") % inst)

        elif util.safehasattr(inst, "reason"):

            try: # usually it is in the form (errno, strerror)

                reason = inst.reason.args[1]

            except (AttributeError, IndexError):

                # it might be anything, for example a string

                reason = inst.reason

            if isinstance(reason, unicode):

                # SSLError of Python 2.7.9 contains a unicode

                reason = reason.encode(encoding.encoding, 'replace')

            ui.warn(_("abort: error: %s\n") % reason)

        elif (util.safehasattr(inst, "args")

              and inst.args and inst.args[0] == errno.EPIPE):

            pass

        elif getattr(inst, "strerror", None):

            if getattr(inst, "filename", None):

                ui.warn(_("abort: %s: %s\n") % (inst.strerror, inst.filename))

            else:

                ui.warn(_("abort: %s\n") % inst.strerror)

        else:

            raise

    except OSError as inst:

        if getattr(inst, "filename", None) is not None:

            ui.warn(_("abort: %s: '%s'\n") % (inst.strerror, inst.filename))

        else:

            ui.warn(_("abort: %s\n") % inst.strerror)

    except KeyboardInterrupt:

        raise

    except MemoryError:

        ui.warn(_("abort: out of memory\n"))

    except SystemExit as inst:

        # Commands shouldn't sys.exit directly, but give a return code.

        # Just in case catch this and and pass exit code to caller.

        return inst.code

    except socket.error as inst:

        ui.warn(_("abort: %s\n") % inst.args[-1])

    except: # re-raises

        # For compatibility checking, we discard the portion of the hg

        # version after the + on the assumption that if a "normal

        # user" is running a build with a + in it the packager

        # probably built from fairly close to a tag and anyone with a

        # 'make local' copy of hg (where the version number can be out

        # of date) will be clueful enough to notice the implausible

        # version number and try updating.

        ct = util.versiontuple(n=2)

        worst = None, ct, ''

        if ui.config('ui', 'supportcontact', None) is None:

            for name, mod in extensions.extensions():

                testedwith = getattr(mod, 'testedwith', '')

                report = getattr(mod, 'buglink', _('the extension author.'))

                if not testedwith.strip():

                    # We found an untested extension. It's likely the culprit.

                    worst = name, 'unknown', report

                    break

                # Never blame on extensions bundled with Mercurial.

                if testedwith == 'internal':

                    continue

                tested = [util.versiontuple(t, 2) for t in testedwith.split()]

                if ct in tested:

                    continue

                lower = [t for t in tested if t < ct]

                nearest = max(lower or tested)

                if worst[0] is None or nearest < worst[1]:

                    worst = name, nearest, report

        if worst[0] is not None:

            name, testedwith, report = worst

            if not isinstance(testedwith, str):

                testedwith = '.'.join([str(c) for c in testedwith])

            warning = (_('** Unknown exception encountered with '

                         'possibly-broken third-party extension %s\n'

                         '** which supports versions %s of Mercurial.\n'

                         '** Please disable %s and try your action again.\n'

                         '** If that fixes the bug please report it to %s\n')

                       % (name, testedwith, name, report))

        else:

            bugtracker = ui.config('ui', 'supportcontact', None)

            if bugtracker is None:

                bugtracker = _("https://mercurial-scm.org/wiki/BugTracker")

            warning = (_("** unknown exception encountered, "

                         "please report by visiting\n** ") + bugtracker + '\n')

        warning += ((_("** Python %s\n") % sys.version.replace('\n', '')) +

                    (_("** Mercurial Distributed SCM (version %s)\n") %

                     util.version()) +

                    (_("** Extensions loaded: %s\n") %

                     ", ".join([x[0] for x in extensions.extensions()])))

        ui.log("commandexception", "%s\n%s\n", warning, traceback.format_exc())

        ui.warn(warning)

        raise

    return -1

def aliasargs(fn, givenargs):

    args = getattr(fn, 'args', [])

    if args:

        cmd = ' '.join(map(util.shellquote, args))

        nums = []

        def replacer(m):

            num = int(m.group(1)) - 1

            nums.append(num)

            if num < len(givenargs):

                return givenargs[num]

            raise error.Abort(_('too few arguments for command alias'))

        cmd = re.sub(r'\$(\d+|\$)', replacer, cmd)

        givenargs = [x for i, x in enumerate(givenargs)

                     if i not in nums]

        args = shlex.split(cmd)

    return args + givenargs

def aliasinterpolate(name, args, cmd):

    '''interpolate args into cmd for shell aliases

    This also handles $0, $@ and "$@".

    '''

    # util.interpolate can't deal with "$@" (with quotes) because it's only

    # built to match prefix + patterns.

    replacemap = dict(('$%d' % (i + 1), arg) for i, arg in enumerate(args))

    replacemap['$0'] = name

    replacemap['$$'] = '$'

    replacemap['$@'] = ' '.join(args)

    # Typical Unix shells interpolate "$@" (with quotes) as all the positional

    # parameters, separated out into words. Emulate the same behavior here by

    # quoting the arguments individually. POSIX shells will then typically

    # tokenize each argument into exactly one word.

    replacemap['"$@"'] = ' '.join(util.shellquote(arg) for arg in args)

    # escape '\$' for regex

    regex = '|'.join(replacemap.keys()).replace('$', r'\$')

    r = re.compile(regex)

    return r.sub(lambda x: replacemap[x.group()], cmd)

class cmdalias(object):

    def __init__(self, name, definition, cmdtable):

        self.name = self.cmd = name

        self.cmdname = ''

        self.definition = definition

        self.fn = None

        self.args = []

        self.opts = []

        self.help = ''

        self.badalias = None

        self.unknowncmd = False

        try:

            aliases, entry = cmdutil.findcmd(self.name, cmdtable)

            for alias, e in cmdtable.iteritems():

                if e is entry:

                    self.cmd = alias

                    break

            self.shadows = True

        except error.UnknownCommand:

            self.shadows = False

        if not self.definition:

            self.badalias = _("no definition for alias '%s'") % self.name

            return

        if self.definition.startswith('!'):

            self.shell = True

            def fn(ui, *args):

                env = {'HG_ARGS': ' '.join((self.name,) + args)}

                def _checkvar(m):

                    if m.groups()[0] == '$':

                        return m.group()

                    elif int(m.groups()[0]) <= len(args):

                        return m.group()

                    else:

                        ui.debug("No argument found for substitution "

                                 "of %i variable in alias '%s' definition."

                                 % (int(m.groups()[0]), self.name))

                        return ''

                cmd = re.sub(r'\$(\d+|\$)', _checkvar, self.definition[1:])

                cmd = aliasinterpolate(self.name, args, cmd)

                return ui.system(cmd, environ=env)

            self.fn = fn

            return

        try:

            args = shlex.split(self.definition)

        except ValueError as inst:

            self.badalias = (_("error in definition for alias '%s': %s")

                             % (self.name, inst))

            return

        self.cmdname = cmd = args.pop(0)