dispatch.py
1007 lines
| 35.5 KiB
| text/x-python
|
PythonLexer
/ mercurial / dispatch.py
|
r5178 | # dispatch.py - command dispatching for mercurial | ||
# | ||||
# Copyright 2005-2007 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
|
r8225 | # This software may be used and distributed according to the terms of the | ||
|
r10263 | # GNU General Public License version 2 or any later version. | ||
|
r5178 | |||
|
r27615 | from __future__ import absolute_import, print_function | ||
|
r25932 | |||
|
r24221 | import difflib | ||
|
r25932 | import errno | ||
|
r30576 | import getopt | ||
|
r25932 | import os | ||
import pdb | ||||
import re | ||||
import signal | ||||
import sys | ||||
import time | ||||
import traceback | ||||
from .i18n import _ | ||||
from . import ( | ||||
cmdutil, | ||||
|
r30653 | color, | ||
|
r25932 | commands, | ||
demandimport, | ||||
encoding, | ||||
error, | ||||
extensions, | ||||
fancyopts, | ||||
|
r28447 | fileset, | ||
|
r31060 | help, | ||
|
r25932 | hg, | ||
hook, | ||||
|
r29781 | profiling, | ||
|
r30468 | pycompat, | ||
|
r28394 | revset, | ||
|
r30520 | scmutil, | ||
|
r28692 | templatefilters, | ||
|
r28538 | templatekw, | ||
|
r28695 | templater, | ||
|
r25932 | ui as uimod, | ||
util, | ||||
) | ||||
|
r5178 | |||
|
r14438 | class request(object): | ||
|
r16683 | def __init__(self, args, ui=None, repo=None, fin=None, fout=None, | ||
|
r32379 | ferr=None, prereposetups=None): | ||
|
r14438 | self.args = args | ||
|
r14439 | self.ui = ui | ||
|
r14510 | self.repo = repo | ||
|
r14438 | |||
|
r14613 | # input/output/error streams | ||
self.fin = fin | ||||
self.fout = fout | ||||
self.ferr = ferr | ||||
|
r32379 | # reposetups which run before extensions, useful for chg to pre-fill | ||
# low-level repo state (for example, changelog) before extensions. | ||||
self.prereposetups = prereposetups or [] | ||||
|
r31956 | def _runexithandlers(self): | ||
exc = None | ||||
handlers = self.ui._exithandlers | ||||
try: | ||||
while handlers: | ||||
func, args, kwargs = handlers.pop() | ||||
try: | ||||
func(*args, **kwargs) | ||||
except: # re-raises below | ||||
if exc is None: | ||||
exc = sys.exc_info()[1] | ||||
self.ui.warn(('error in exit handlers:\n')) | ||||
self.ui.traceback(force=True) | ||||
finally: | ||||
if exc is not None: | ||||
raise exc | ||||
|
r5178 | def run(): | ||
"run the command in sys.argv" | ||||
|
r31960 | req = request(pycompat.sysargv[1:]) | ||
err = None | ||||
try: | ||||
status = (dispatch(req) or 0) & 255 | ||||
except error.StdioError as err: | ||||
status = -1 | ||||
if util.safehasattr(req.ui, 'fout'): | ||||
try: | ||||
req.ui.fout.close() | ||||
except IOError as err: | ||||
status = -1 | ||||
if util.safehasattr(req.ui, 'ferr'): | ||||
if err is not None and err.errno != errno.EPIPE: | ||||
req.ui.ferr.write('abort: %s\n' % err.strerror) | ||||
req.ui.ferr.close() | ||||
sys.exit(status & 255) | ||||
|
r5178 | |||
|
r24221 | 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] | ||||
|
r27623 | 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) | ||||
|
r24039 | def _formatparse(write, inst): | ||
|
r24221 | similar = [] | ||
if isinstance(inst, error.UnknownIdentifier): | ||||
# make sure to check fileset first, as revset can invoke fileset | ||||
similar = _getsimilar(inst.symbols, inst.function) | ||||
|
r24039 | 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]) | ||||
|
r27623 | _reportsimilar(write, similar) | ||
|
r28515 | if inst.hint: | ||
write(_("(%s)\n") % inst.hint) | ||||
|
r24039 | |||
|
r31492 | def _formatargs(args): | ||
|
r31500 | return ' '.join(util.shellquote(a) for a in args) | ||
|
r31492 | |||
|
r14438 | def dispatch(req): | ||
"run the command specified in req.args" | ||||
|
r14615 | if req.ferr: | ||
ferr = req.ferr | ||||
elif req.ui: | ||||
ferr = req.ui.ferr | ||||
else: | ||||
|
r30473 | ferr = util.stderr | ||
|
r14615 | |||
|
r5178 | try: | ||
|
r14439 | if not req.ui: | ||
|
r30559 | req.ui = uimod.ui.load() | ||
|
r14438 | if '--traceback' in req.args: | ||
|
r20788 | req.ui.setconfig('ui', 'traceback', 'on', '--traceback') | ||
|
r14615 | |||
# 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 | ||||
|
r26587 | except error.Abort as inst: | ||
|
r14615 | ferr.write(_("abort: %s\n") % inst) | ||
|
r11574 | if inst.hint: | ||
|
r14615 | ferr.write(_("(%s)\n") % inst.hint) | ||
|
r5178 | return -1 | ||
|
r25660 | except error.ParseError as inst: | ||
|
r24039 | _formatparse(ferr.write, inst) | ||
|
r9470 | return -1 | ||
|
r14615 | |||
|
r31492 | msg = _formatargs(req.args) | ||
|
r30975 | starttime = util.timer() | ||
|
r19229 | ret = None | ||
try: | ||||
ret = _runcatch(req) | ||||
|
r32340 | except error.ProgrammingError as inst: | ||
req.ui.warn(_('** ProgrammingError: %s\n') % inst) | ||||
if inst.hint: | ||||
req.ui.warn(_('** (%s)\n') % inst.hint) | ||||
raise | ||||
|
r32111 | except KeyboardInterrupt as inst: | ||
|
r28520 | try: | ||
|
r32111 | if isinstance(inst, error.SignalInterrupt): | ||
msg = _("killed!\n") | ||||
else: | ||||
msg = _("interrupted!\n") | ||||
req.ui.warn(msg) | ||||
|
r32044 | except error.SignalInterrupt: | ||
# maybe pager would quit without consuming all the output, and | ||||
# SIGPIPE was raised. we cannot print anything in this case. | ||||
pass | ||||
|
r28520 | except IOError as inst: | ||
if inst.errno != errno.EPIPE: | ||||
raise | ||||
ret = -1 | ||||
|
r19229 | finally: | ||
|
r30975 | duration = util.timer() - starttime | ||
|
r28534 | req.ui.flush() | ||
|
r30976 | if req.ui.logblockedtimes: | ||
req.ui._blockedtimes['command_duration'] = duration * 1000 | ||||
req.ui.log('uiblocked', 'ui blocked ms', **req.ui._blockedtimes) | ||||
|
r32130 | req.ui.log("commandfinish", "%s exited %d after %0.2f seconds\n", | ||
|
r19229 | msg, ret or 0, duration) | ||
|
r31956 | try: | ||
req._runexithandlers() | ||||
except: # exiting, so no re-raises | ||||
ret = ret or -1 | ||||
|
r28520 | return ret | ||
|
r5178 | |||
|
r14439 | def _runcatch(req): | ||
|
r5178 | def catchterm(*args): | ||
|
r7644 | raise error.SignalInterrupt | ||
|
r5178 | |||
|
r14439 | ui = req.ui | ||
|
r10952 | 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 | ||||
|
r5178 | |||
|
r29761 | def _runcatchfunc(): | ||
|
r32050 | realcmd = None | ||
try: | ||||
cmdargs = fancyopts.fancyopts(req.args[:], commands.globalopts, {}) | ||||
cmd = cmdargs[0] | ||||
aliases, entry = cmdutil.findcmd(cmd, commands.table, False) | ||||
realcmd = aliases[0] | ||||
except (error.UnknownCommand, error.AmbiguousCommand, | ||||
IndexError, getopt.GetoptError): | ||||
# Don't handle this here. We know the command is | ||||
# invalid, but all we're worried about for now is that | ||||
# it's not a command that server operators expect to | ||||
# be safe to offer to users in a sandbox. | ||||
pass | ||||
if realcmd == 'serve' and '--stdio' in cmdargs: | ||||
# We want to constrain 'hg serve --stdio' instances pretty | ||||
# closely, as many shared-ssh access tools want to grant | ||||
# access to run *only* 'hg -R $repo serve --stdio'. We | ||||
# restrict to exactly that set of arguments, and prohibit | ||||
# any repo name that starts with '--' to prevent | ||||
# shenanigans wherein a user does something like pass | ||||
# --debugger or --config=ui.debugger=1 as a repo | ||||
# name. This used to actually run the debugger. | ||||
if (len(req.args) != 4 or | ||||
req.args[0] != '-R' or | ||||
req.args[1].startswith('--') or | ||||
req.args[2] != 'serve' or | ||||
req.args[3] != '--stdio'): | ||||
raise error.Abort( | ||||
_('potentially unsafe serve --stdio invocation: %r') % | ||||
(req.args,)) | ||||
|
r5178 | try: | ||
|
r19640 | debugger = 'pdb' | ||
debugtrace = { | ||||
'pdb' : pdb.set_trace | ||||
} | ||||
debugmortem = { | ||||
'pdb' : pdb.post_mortem | ||||
} | ||||
|
r19639 | |||
# 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 | ||||
|
r20796 | for sec, name, val in cfgs: | ||
req.repo.ui.setconfig(sec, name, val, source='--config') | ||||
|
r19639 | |||
|
r25833 | # developer config: ui.debugger | ||
|
r19640 | debugger = ui.config("ui", "debugger") | ||
|
r20826 | debugmod = pdb | ||
|
r20122 | if not debugger or ui.plain(): | ||
|
r25833 | # if we are in HGPLAIN mode, then disable custom debugging | ||
|
r19640 | debugger = 'pdb' | ||
|
r20826 | 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 | ||||
|
r25329 | with demandimport.deactivated(): | ||
try: | ||||
debugmod = __import__(debugger) | ||||
except ImportError: | ||||
pass # Leave debugmod = pdb | ||||
|
r19640 | |||
debugtrace[debugger] = debugmod.set_trace | ||||
debugmortem[debugger] = debugmod.post_mortem | ||||
|
r5178 | # enter the debugger before command execution | ||
|
r14438 | if '--debugger' in req.args: | ||
|
r11495 | ui.warn(_("entering debugger - " | ||
"type c to continue starting hg or h for help\n")) | ||||
|
r19640 | |||
if (debugger != 'pdb' and | ||||
debugtrace[debugger] == debugtrace['pdb']): | ||||
ui.warn(_("%s debugger specified " | ||||
"but its module was not found\n") % debugger) | ||||
|
r26236 | with demandimport.deactivated(): | ||
|
r26216 | debugtrace[debugger]() | ||
|
r5178 | try: | ||
|
r14439 | return _dispatch(req) | ||
|
r5178 | finally: | ||
ui.flush() | ||||
|
r16705 | except: # re-raises | ||
|
r5178 | # enter the debugger when we hit an exception | ||
|
r14438 | if '--debugger' in req.args: | ||
|
r11494 | traceback.print_exc() | ||
|
r19640 | debugmortem[debugger](sys.exc_info()[2]) | ||
|
r5178 | raise | ||
|
r32040 | return _callcatch(ui, _runcatchfunc) | ||
|
r29761 | |||
|
r32040 | def _callcatch(ui, func): | ||
|
r30520 | """like scmutil.callcatch but handles more high-level exceptions about | ||
config parsing and commands. besides, use handlecommandexception to handle | ||||
uncaught exceptions. | ||||
|
r29761 | """ | ||
try: | ||||
|
r30520 | return scmutil.callcatch(ui, func) | ||
|
r25660 | except error.AmbiguousCommand as inst: | ||
|
r5178 | ui.warn(_("hg: command '%s' is ambiguous:\n %s\n") % | ||
(inst.args[0], " ".join(inst.args[1]))) | ||||
|
r25660 | except error.CommandError as inst: | ||
|
r7645 | if inst.args[0]: | ||
|
r31266 | ui.pager('help') | ||
|
r32620 | msgbytes = pycompat.bytestr(inst.args[1]) | ||
ui.warn(_("hg %s: %s\n") % (inst.args[0], msgbytes)) | ||||
|
r14286 | commands.help_(ui, inst.args[0], full=False, command=True) | ||
|
r7645 | else: | ||
|
r31266 | ui.pager('help') | ||
|
r7645 | ui.warn(_("hg: %s\n") % inst.args[1]) | ||
commands.help_(ui, 'shortlist') | ||||
|
r30520 | except error.ParseError as inst: | ||
_formatparse(ui.warn, inst) | ||||
return -1 | ||||
|
r25660 | except error.UnknownCommand as inst: | ||
|
r31060 | nocmdmsg = _("hg: unknown command '%s'\n") % inst.args[0] | ||
|
r10364 | try: | ||
# check if the command is in a disabled extension | ||||
# (but don't check for extensions themselves) | ||||
|
r32567 | formatted = help.formattedhelp(ui, commands, inst.args[0], | ||
unknowncmd=True) | ||||
|
r31060 | ui.warn(nocmdmsg) | ||
ui.write(formatted) | ||||
|
r26587 | except (error.UnknownCommand, error.Abort): | ||
|
r24222 | suggested = False | ||
if len(inst.args) == 2: | ||||
sim = _getsimilar(inst.args[1], inst.args[0]) | ||||
if sim: | ||||
|
r31060 | ui.warn(nocmdmsg) | ||
|
r27623 | _reportsimilar(ui.warn, sim) | ||
|
r24222 | suggested = True | ||
if not suggested: | ||||
|
r31060 | ui.pager('help') | ||
ui.warn(nocmdmsg) | ||||
|
r24222 | commands.help_(ui, 'shortlist') | ||
|
r30520 | except IOError: | ||
raise | ||||
|
r7645 | except KeyboardInterrupt: | ||
|
r28520 | raise | ||
|
r30520 | except: # probably re-raises | ||
|
r28784 | if not handlecommandexception(ui): | ||
raise | ||||
|
r5178 | |||
return -1 | ||||
|
r14265 | def aliasargs(fn, givenargs): | ||
args = getattr(fn, 'args', []) | ||||
|
r16294 | if args: | ||
|
r14265 | cmd = ' '.join(map(util.shellquote, args)) | ||
nums = [] | ||||
def replacer(m): | ||||
num = int(m.group(1)) - 1 | ||||
nums.append(num) | ||||
|
r16277 | if num < len(givenargs): | ||
return givenargs[num] | ||||
|
r26587 | raise error.Abort(_('too few arguments for command alias')) | ||
|
r31491 | cmd = re.sub(br'\$(\d+|\$)', replacer, cmd) | ||
|
r14265 | givenargs = [x for i, x in enumerate(givenargs) | ||
if i not in nums] | ||||
|
r30678 | args = pycompat.shlexsplit(cmd) | ||
|
r14265 | return args + givenargs | ||
|
r8655 | |||
|
r22158 | 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) | ||||
|
r8655 | class cmdalias(object): | ||
|
r28828 | def __init__(self, name, definition, cmdtable, source): | ||
|
r12039 | self.name = self.cmd = name | ||
|
r12092 | self.cmdname = '' | ||
|
r8655 | self.definition = definition | ||
|
r22160 | self.fn = None | ||
|
r29087 | self.givenargs = [] | ||
|
r8655 | self.opts = [] | ||
self.help = '' | ||||
|
r22160 | self.badalias = None | ||
|
r22161 | self.unknowncmd = False | ||
|
r28828 | self.source = source | ||
|
r8655 | |||
try: | ||||
|
r12039 | aliases, entry = cmdutil.findcmd(self.name, cmdtable) | ||
for alias, e in cmdtable.iteritems(): | ||||
if e is entry: | ||||
self.cmd = alias | ||||
break | ||||
|
r8655 | self.shadows = True | ||
except error.UnknownCommand: | ||||
self.shadows = False | ||||
if not self.definition: | ||||
|
r22160 | self.badalias = _("no definition for alias '%s'") % self.name | ||
|
r8655 | return | ||
|
r11524 | if self.definition.startswith('!'): | ||
|
r12536 | self.shell = True | ||
|
r11524 | def fn(ui, *args): | ||
|
r11989 | env = {'HG_ARGS': ' '.join((self.name,) + args)} | ||
def _checkvar(m): | ||||
|
r13392 | if m.groups()[0] == '$': | ||
return m.group() | ||||
elif int(m.groups()[0]) <= len(args): | ||||
|
r11989 | return m.group() | ||
else: | ||||
|
r14708 | ui.debug("No argument found for substitution " | ||
"of %i variable in alias '%s' definition." | ||||
|
r13393 | % (int(m.groups()[0]), self.name)) | ||
|
r11989 | return '' | ||
|
r13392 | cmd = re.sub(r'\$(\d+|\$)', _checkvar, self.definition[1:]) | ||
|
r22158 | cmd = aliasinterpolate(self.name, args, cmd) | ||
|
r31199 | return ui.system(cmd, environ=env, | ||
blockedtag='alias_%s' % self.name) | ||||
|
r11524 | self.fn = fn | ||
return | ||||
|
r21569 | try: | ||
|
r30678 | args = pycompat.shlexsplit(self.definition) | ||
|
r25660 | except ValueError as inst: | ||
|
r22160 | self.badalias = (_("error in definition for alias '%s': %s") | ||
% (self.name, inst)) | ||||
|
r21569 | return | ||
|
r12092 | self.cmdname = cmd = args.pop(0) | ||
|
r29087 | self.givenargs = args | ||
|
r8655 | |||
|
r18693 | for invalidarg in ("--cwd", "-R", "--repository", "--repo", "--config"): | ||
|
r11695 | if _earlygetopt([invalidarg], args): | ||
|
r22160 | self.badalias = (_("error in definition for alias '%s': %s may " | ||
"only be given on the command line") | ||||
% (self.name, invalidarg)) | ||||
|
r11695 | return | ||
|
r8655 | try: | ||
|
r9993 | tableentry = cmdutil.findcmd(cmd, cmdtable, False)[1] | ||
if len(tableentry) > 2: | ||||
self.fn, self.opts, self.help = tableentry | ||||
else: | ||||
self.fn, self.opts = tableentry | ||||
|
r9876 | if self.help.startswith("hg " + cmd): | ||
# drop prefix in old-style help lines so hg shows the alias | ||||
self.help = self.help[4 + len(cmd):] | ||||
|
r10564 | self.__doc__ = self.fn.__doc__ | ||
|
r9876 | |||
|
r8655 | except error.UnknownCommand: | ||
|
r22160 | self.badalias = (_("alias '%s' resolves to unknown command '%s'") | ||
% (self.name, cmd)) | ||||
|
r22161 | self.unknowncmd = True | ||
|
r8655 | except error.AmbiguousCommand: | ||
|
r22160 | self.badalias = (_("alias '%s' resolves to ambiguous command '%s'") | ||
% (self.name, cmd)) | ||||
|
r8655 | |||
|
r29087 | @property | ||
def args(self): | ||||
|
r31629 | args = pycompat.maplist(util.expandpath, self.givenargs) | ||
|
r29087 | return aliasargs(self.fn, args) | ||
|
r28621 | def __getattr__(self, name): | ||
|
r32158 | adefaults = {r'norepo': True, | ||
r'optionalrepo': False, r'inferrepo': False} | ||||
|
r28621 | if name not in adefaults: | ||
raise AttributeError(name) | ||||
if self.badalias or util.safehasattr(self, 'shell'): | ||||
return adefaults[name] | ||||
return getattr(self.fn, name) | ||||
|
r8655 | def __call__(self, ui, *args, **opts): | ||
|
r22160 | if self.badalias: | ||
|
r22164 | hint = None | ||
|
r22161 | if self.unknowncmd: | ||
|
r10364 | try: | ||
# check if the command is in a disabled extension | ||||
|
r22163 | cmd, ext = extensions.disabledcmd(ui, self.cmdname)[:2] | ||
|
r22164 | hint = _("'%s' is provided by '%s' extension") % (cmd, ext) | ||
|
r10364 | except error.UnknownCommand: | ||
pass | ||||
|
r26587 | raise error.Abort(self.badalias, hint=hint) | ||
|
r8655 | if self.shadows: | ||
|
r14704 | ui.debug("alias '%s' shadows command '%s'\n" % | ||
|
r12092 | (self.name, self.cmdname)) | ||
|
r8655 | |||
|
r29846 | ui.log('commandalias', "alias '%s' expands to '%s'\n", | ||
self.name, self.definition) | ||||
|
r14950 | if util.safehasattr(self, 'shell'): | ||
|
r11989 | return self.fn(ui, *args, **opts) | ||
else: | ||||
|
r12093 | try: | ||
|
r21556 | return util.checksignature(self.fn)(ui, *args, **opts) | ||
|
r12093 | except error.SignatureError: | ||
args = ' '.join([self.cmdname] + self.args) | ||||
|
r14704 | ui.debug("alias '%s' expands to '%s'\n" % (self.name, args)) | ||
|
r12093 | raise | ||
|
r8655 | |||
def addaliases(ui, cmdtable): | ||||
# aliases are processed after extensions have been loaded, so they | ||||
# may use extension commands. Aliases can also use other alias definitions, | ||||
# but only if they have been defined prior to the current definition. | ||||
for alias, definition in ui.configitems('alias'): | ||||
|
r28828 | source = ui.configsource('alias', alias) | ||
aliasdef = cmdalias(alias, definition, cmdtable, source) | ||||
|
r15019 | |||
try: | ||||
olddef = cmdtable[aliasdef.cmd][0] | ||||
if olddef.definition == aliasdef.definition: | ||||
continue | ||||
except (KeyError, AttributeError): | ||||
# definition might not exist or it might not be a cmdalias | ||||
pass | ||||
|
r15233 | cmdtable[aliasdef.name] = (aliasdef, aliasdef.opts, aliasdef.help) | ||
|
r8655 | |||
|
r5178 | def _parse(ui, args): | ||
options = {} | ||||
cmdoptions = {} | ||||
try: | ||||
args = fancyopts.fancyopts(args, commands.globalopts, options) | ||||
|
r30576 | except getopt.GetoptError as inst: | ||
|
r11287 | raise error.CommandError(None, inst) | ||
|
r5178 | |||
if args: | ||||
cmd, args = args[0], args[1:] | ||||
|
r9875 | aliases, entry = cmdutil.findcmd(cmd, commands.table, | ||
|
r16591 | ui.configbool("ui", "strict")) | ||
|
r5178 | cmd = aliases[0] | ||
|
r14265 | args = aliasargs(entry[0], args) | ||
|
r5178 | defaults = ui.config("defaults", cmd) | ||
if defaults: | ||||
|
r31502 | args = pycompat.maplist( | ||
util.expandpath, pycompat.shlexsplit(defaults)) + args | ||||
|
r9875 | c = list(entry[1]) | ||
|
r5178 | else: | ||
cmd = None | ||||
c = [] | ||||
# combine global options into local | ||||
for o in commands.globalopts: | ||||
c.append((o[0], o[1], options[o[1]], o[3])) | ||||
try: | ||||
|
r29822 | args = fancyopts.fancyopts(args, c, cmdoptions, gnu=True) | ||
|
r30576 | except getopt.GetoptError as inst: | ||
|
r11287 | raise error.CommandError(cmd, inst) | ||
|
r5178 | |||
# separate global options back out | ||||
for o in commands.globalopts: | ||||
n = o[1] | ||||
options[n] = cmdoptions[n] | ||||
del cmdoptions[n] | ||||
|
r9875 | return (cmd, cmd and entry[0] or None, args, options, cmdoptions) | ||
|
r5178 | |||
|
r8137 | def _parseconfig(ui, config): | ||
|
r5178 | """parse the --config options from the command line""" | ||
|
r14753 | configs = [] | ||
|
r5178 | for cfg in config: | ||
try: | ||||
|
r28081 | name, value = [cfgelem.strip() | ||
for cfgelem in cfg.split('=', 1)] | ||||
|
r5178 | section, name = name.split('.', 1) | ||
if not section or not name: | ||||
raise IndexError | ||||
|
r20788 | ui.setconfig(section, name, value, '--config') | ||
|
r14753 | configs.append((section, name, value)) | ||
|
r5178 | except (IndexError, ValueError): | ||
|
r26587 | raise error.Abort(_('malformed --config option: %r ' | ||
|
r9825 | '(use --config section.name=value)') % cfg) | ||
|
r5178 | |||
|
r14753 | return configs | ||
|
r5178 | def _earlygetopt(aliases, args): | ||
"""Return list of values for an option (or aliases). | ||||
The values are listed in the order they appear in args. | ||||
The options and values are removed from args. | ||||
|
r19098 | |||
>>> args = ['x', '--cwd', 'foo', 'y'] | ||||
>>> _earlygetopt(['--cwd'], args), args | ||||
(['foo'], ['x', 'y']) | ||||
|
r19099 | >>> args = ['x', '--cwd=bar', 'y'] | ||
>>> _earlygetopt(['--cwd'], args), args | ||||
(['bar'], ['x', 'y']) | ||||
|
r19098 | >>> args = ['x', '-R', 'foo', 'y'] | ||
>>> _earlygetopt(['-R'], args), args | ||||
(['foo'], ['x', 'y']) | ||||
>>> args = ['x', '-Rbar', 'y'] | ||||
>>> _earlygetopt(['-R'], args), args | ||||
(['bar'], ['x', 'y']) | ||||
|
r5178 | """ | ||
try: | ||||
argcount = args.index("--") | ||||
except ValueError: | ||||
argcount = len(args) | ||||
shortopts = [opt for opt in aliases if len(opt) == 2] | ||||
values = [] | ||||
pos = 0 | ||||
while pos < argcount: | ||||
|
r19099 | fullarg = arg = args[pos] | ||
equals = arg.find('=') | ||||
if equals > -1: | ||||
arg = arg[:equals] | ||||
if arg in aliases: | ||||
|
r5178 | del args[pos] | ||
|
r19099 | if equals > -1: | ||
values.append(fullarg[equals + 1:]) | ||||
argcount -= 1 | ||||
else: | ||||
if pos + 1 >= argcount: | ||||
# ignore and let getopt report an error if there is no value | ||||
break | ||||
values.append(args.pop(pos)) | ||||
argcount -= 2 | ||||
elif arg[:2] in shortopts: | ||||
|
r5178 | # short option can have no following space, e.g. hg log -Rfoo | ||
values.append(args.pop(pos)[2:]) | ||||
argcount -= 1 | ||||
else: | ||||
pos += 1 | ||||
return values | ||||
|
r11330 | def runcommand(lui, repo, cmd, fullargs, ui, options, d, cmdpats, cmdoptions): | ||
|
r7819 | # run pre-hook, and abort if it fails | ||
|
r19011 | hook.hook(lui, repo, "pre-%s" % cmd, True, args=" ".join(fullargs), | ||
pats=cmdpats, opts=cmdoptions) | ||||
|
r29129 | try: | ||
ret = _runcommand(ui, options, cmd, d) | ||||
# run post-hook, passing command result | ||||
hook.hook(lui, repo, "post-%s" % cmd, False, args=" ".join(fullargs), | ||||
result=ret, pats=cmdpats, opts=cmdoptions) | ||||
except Exception: | ||||
# run failure hook and re-raise | ||||
hook.hook(lui, repo, "fail-%s" % cmd, False, args=" ".join(fullargs), | ||||
pats=cmdpats, opts=cmdoptions) | ||||
raise | ||||
|
r7819 | return ret | ||
|
r28263 | def _getlocal(ui, rpath, wd=None): | ||
|
r12536 | """Return (path, local ui object) for the given target path. | ||
|
r12770 | |||
|
r12536 | Takes paths in [cwd]/.hg/hgrc into account." | ||
""" | ||||
|
r28263 | if wd is None: | ||
try: | ||||
|
r30500 | wd = pycompat.getcwd() | ||
|
r28263 | except OSError as e: | ||
raise error.Abort(_("error getting current working directory: %s") % | ||||
e.strerror) | ||||
|
r11675 | path = cmdutil.findrepo(wd) or "" | ||
|
r5178 | if not path: | ||
lui = ui | ||||
|
r9436 | else: | ||
|
r12636 | lui = ui.copy() | ||
|
r12637 | lui.readconfig(os.path.join(path, ".hg", "hgrc"), path) | ||
|
r5178 | |||
|
r14860 | if rpath and rpath[-1]: | ||
|
r5178 | path = lui.expandpath(rpath[-1]) | ||
|
r8190 | lui = ui.copy() | ||
|
r12637 | lui.readconfig(os.path.join(path, ".hg", "hgrc"), path) | ||
|
r5178 | |||
|
r12536 | return path, lui | ||
|
r29132 | def _checkshellalias(lui, ui, args): | ||
"""Return the function to run the shell alias, if it is required""" | ||||
|
r12536 | options = {} | ||
|
r12748 | |||
try: | ||||
args = fancyopts.fancyopts(args, commands.globalopts, options) | ||||
|
r30576 | except getopt.GetoptError: | ||
|
r12748 | return | ||
|
r12536 | |||
if not args: | ||||
return | ||||
|
r29132 | cmdtable = commands.table | ||
|
r12536 | |||
cmd = args[0] | ||||
try: | ||||
|
r29132 | strict = ui.configbool("ui", "strict") | ||
|
r22377 | aliases, entry = cmdutil.findcmd(cmd, cmdtable, strict) | ||
|
r12932 | except (error.AmbiguousCommand, error.UnknownCommand): | ||
|
r12536 | return | ||
cmd = aliases[0] | ||||
fn = entry[0] | ||||
|
r14950 | if cmd and util.safehasattr(fn, 'shell'): | ||
|
r12536 | d = lambda: fn(ui, *args[1:]) | ||
|
r16683 | return lambda: runcommand(lui, None, cmd, args[:1], ui, options, d, | ||
[], {}) | ||||
|
r12536 | |||
_loaded = set() | ||||
|
r28391 | |||
# list of (objname, loadermod, loadername) tuple: | ||||
# - objname is the name of an object in extension module, from which | ||||
# extra information is loaded | ||||
# - loadermod is the module where loader is placed | ||||
# - loadername is the name of the function, which takes (ui, extensionname, | ||||
# extraobj) arguments | ||||
extraloaders = [ | ||||
('cmdtable', commands, 'loadcmdtable'), | ||||
|
r30653 | ('colortable', color, 'loadcolortable'), | ||
|
r28447 | ('filesetpredicate', fileset, 'loadpredicate'), | ||
|
r28394 | ('revsetpredicate', revset, 'loadpredicate'), | ||
|
r28692 | ('templatefilter', templatefilters, 'loadfilter'), | ||
|
r28695 | ('templatefunc', templater, 'loadfunction'), | ||
|
r28538 | ('templatekeyword', templatekw, 'loadkeyword'), | ||
|
r28391 | ] | ||
|
r14439 | def _dispatch(req): | ||
|
r14438 | args = req.args | ||
|
r14439 | ui = req.ui | ||
|
r12536 | # check for cwd | ||
cwd = _earlygetopt(['--cwd'], args) | ||||
if cwd: | ||||
os.chdir(cwd[-1]) | ||||
rpath = _earlygetopt(["-R", "--repository", "--repo"], args) | ||||
path, lui = _getlocal(ui, rpath) | ||||
|
r32291 | uis = {ui, lui} | ||
|
r30933 | |||
if req.repo: | ||||
uis.add(req.repo.ui) | ||||
if '--profile' in args: | ||||
for ui_ in uis: | ||||
ui_.setconfig('profiling', 'enabled', 'true', '--profile') | ||||
|
r30934 | with profiling.maybeprofile(lui): | ||
# Configure extensions in phases: uisetup, extsetup, cmdtable, and | ||||
# reposetup. Programs like TortoiseHg will call _dispatch several | ||||
# times so we keep track of configured extensions in _loaded. | ||||
extensions.loadall(lui) | ||||
exts = [ext for ext in extensions.extensions() if ext[0] not in _loaded] | ||||
# Propagate any changes to lui.__class__ by extensions | ||||
ui.__class__ = lui.__class__ | ||||
|
r5828 | |||
|
r30934 | # (uisetup and extsetup are handled in extensions.loadall) | ||
|
r5828 | |||
|
r30934 | for name, module in exts: | ||
for objname, loadermod, loadername in extraloaders: | ||||
extraobj = getattr(module, objname, None) | ||||
if extraobj is not None: | ||||
getattr(loadermod, loadername)(ui, name, extraobj) | ||||
_loaded.add(name) | ||||
|
r8655 | |||
|
r30934 | # (reposetup is handled in hg.repository) | ||
|
r9410 | |||
|
r30934 | addaliases(lui, commands.table) | ||
|
r8655 | |||
|
r30934 | # All aliases and commands are completely defined, now. | ||
# Check abbreviation/ambiguity of shell alias. | ||||
shellaliasfn = _checkshellalias(lui, ui, args) | ||||
if shellaliasfn: | ||||
|
r30006 | return shellaliasfn() | ||
|
r22377 | |||
|
r30934 | # check for fallback encoding | ||
fallback = lui.config('ui', 'fallbackencoding') | ||||
if fallback: | ||||
encoding.fallbackencoding = fallback | ||||
|
r5178 | |||
|
r30934 | fullargs = args | ||
cmd, func, args, options, cmdoptions = _parse(lui, args) | ||||
|
r5178 | |||
|
r30934 | if options["config"]: | ||
raise error.Abort(_("option --config may not be abbreviated!")) | ||||
if options["cwd"]: | ||||
raise error.Abort(_("option --cwd may not be abbreviated!")) | ||||
if options["repository"]: | ||||
raise error.Abort(_( | ||||
"option -R has to be separated from other options (e.g. not " | ||||
"-qR) and --repository may only be abbreviated as --repo!")) | ||||
|
r5178 | |||
|
r30934 | if options["encoding"]: | ||
encoding.encoding = options["encoding"] | ||||
if options["encodingmode"]: | ||||
encoding.encodingmode = options["encodingmode"] | ||||
if options["time"]: | ||||
def get_times(): | ||||
t = os.times() | ||||
if t[4] == 0.0: | ||||
# Windows leaves this as zero, so use time.clock() | ||||
t = (t[0], t[1], t[2], t[3], time.clock()) | ||||
return t | ||||
s = get_times() | ||||
def print_time(): | ||||
t = get_times() | ||||
ui.warn( | ||||
_("time: real %.3f secs (user %.3f+%.3f sys %.3f+%.3f)\n") % | ||||
(t[4]-s[4], t[0]-s[0], t[2]-s[2], t[1]-s[1], t[3]-s[3])) | ||||
|
r31958 | ui.atexit(print_time) | ||
|
r5178 | |||
|
r30934 | if options['verbose'] or options['debug'] or options['quiet']: | ||
for opt in ('verbose', 'debug', 'quiet'): | ||||
val = str(bool(options[opt])) | ||||
|
r31305 | if pycompat.ispy3: | ||
val = val.encode('ascii') | ||||
|
r30934 | for ui_ in uis: | ||
ui_.setconfig('ui', opt, val, '--' + opt) | ||||
if options['traceback']: | ||||
|
r14752 | for ui_ in uis: | ||
|
r30934 | ui_.setconfig('ui', 'traceback', 'on', '--traceback') | ||
|
r14992 | |||
|
r30934 | if options['noninteractive']: | ||
for ui_ in uis: | ||||
ui_.setconfig('ui', 'interactive', 'off', '-y') | ||||
|
r5178 | |||
|
r31027 | if util.parsebool(options['pager']): | ||
ui.pager('internal-always-' + cmd) | ||||
elif options['pager'] != 'auto': | ||||
|
r31026 | ui.disablepager() | ||
|
r30994 | |||
|
r30934 | if cmdoptions.get('insecure', False): | ||
for ui_ in uis: | ||||
ui_.insecureconnections = True | ||||
|
r13328 | |||
|
r31105 | # setup color handling | ||
|
r31110 | coloropt = options['color'] | ||
|
r31105 | for ui_ in uis: | ||
|
r31110 | if coloropt: | ||
ui_.setconfig('ui', 'color', coloropt, '--color') | ||||
color.setup(ui_) | ||||
|
r31105 | |||
|
r30934 | if options['version']: | ||
return commands.version_(ui) | ||||
if options['help']: | ||||
return commands.help_(ui, cmd, command=cmd is not None) | ||||
elif not cmd: | ||||
return commands.help_(ui, 'shortlist') | ||||
|
r5178 | |||
|
r30005 | repo = None | ||
cmdpats = args[:] | ||||
|
r30485 | if not func.norepo: | ||
|
r30005 | # use the repo from the request only if we don't have -R | ||
if not rpath and not cwd: | ||||
repo = req.repo | ||||
|
r14510 | |||
|
r30005 | if repo: | ||
# set the descriptors of the repo ui to those of ui | ||||
repo.ui.fin = ui.fin | ||||
repo.ui.fout = ui.fout | ||||
repo.ui.ferr = ui.ferr | ||||
else: | ||||
try: | ||||
|
r32379 | repo = hg.repository(ui, path=path, | ||
presetupfuncs=req.prereposetups) | ||||
|
r30005 | if not repo.local(): | ||
raise error.Abort(_("repository '%s' is not local") | ||||
% path) | ||||
repo.ui.setconfig("bundle", "mainreporoot", repo.root, | ||||
'repo') | ||||
except error.RequirementError: | ||||
|
r26142 | raise | ||
|
r30005 | except error.RepoError: | ||
if rpath and rpath[-1]: # invalid -R path | ||||
raise | ||||
|
r30485 | if not func.optionalrepo: | ||
if func.inferrepo and args and not path: | ||||
|
r30005 | # try to infer -R from command args | ||
repos = map(cmdutil.findrepo, args) | ||||
guess = repos[0] | ||||
if guess and repos.count(guess) == len(repos): | ||||
req.args = ['--repository', guess] + fullargs | ||||
return _dispatch(req) | ||||
if not path: | ||||
raise error.RepoError(_("no repository found in" | ||||
" '%s' (.hg not found)") | ||||
|
r30519 | % pycompat.getcwd()) | ||
|
r30005 | raise | ||
if repo: | ||||
ui = repo.ui | ||||
if options['hidden']: | ||||
repo = repo.unfiltered() | ||||
args.insert(0, repo) | ||||
elif rpath: | ||||
ui.warn(_("warning: --repository ignored\n")) | ||||
|
r7388 | |||
|
r31492 | msg = _formatargs(fullargs) | ||
|
r30005 | ui.log("command", '%s\n', msg) | ||
|
r30586 | strcmdopt = pycompat.strkwargs(cmdoptions) | ||
d = lambda: util.checksignature(func)(ui, *args, **strcmdopt) | ||||
|
r30005 | try: | ||
return runcommand(lui, repo, cmd, fullargs, ui, options, d, | ||||
cmdpats, cmdoptions) | ||||
finally: | ||||
if repo and repo != req.repo: | ||||
repo.close() | ||||
|
r5178 | |||
def _runcommand(ui, options, cmd, cmdfunc): | ||||
|
r29784 | """Run a command function, possibly with profiling enabled.""" | ||
|
r30006 | try: | ||
return cmdfunc() | ||||
except error.SignatureError: | ||||
raise error.CommandError(cmd, _('invalid arguments')) | ||||
|
r28784 | |||
|
r28821 | def _exceptionwarning(ui): | ||
"""Produce a warning message for the current active exception""" | ||||
|
r28784 | |||
# 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', '') | ||||
|
r31179 | if pycompat.ispy3 and isinstance(testedwith, str): | ||
testedwith = testedwith.encode(u'utf-8') | ||||
|
r28784 | 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. | ||||
|
r29884 | if extensions.ismoduleinternal(mod): | ||
|
r28784 | 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 | ||||
|
r31179 | if not isinstance(testedwith, (bytes, str)): | ||
|
r28784 | 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') | ||||
|
r31180 | if pycompat.ispy3: | ||
sysversion = sys.version.encode(u'utf-8') | ||||
else: | ||||
sysversion = sys.version | ||||
sysversion = sysversion.replace('\n', '') | ||||
warning += ((_("** Python %s\n") % sysversion) + | ||||
|
r28784 | (_("** Mercurial Distributed SCM (version %s)\n") % | ||
util.version()) + | ||||
(_("** Extensions loaded: %s\n") % | ||||
", ".join([x[0] for x in extensions.extensions()]))) | ||||
|
r28821 | return warning | ||
def handlecommandexception(ui): | ||||
"""Produce a warning message for broken commands | ||||
Called when handling an exception; the exception is reraised if | ||||
this function returns False, ignored otherwise. | ||||
""" | ||||
warning = _exceptionwarning(ui) | ||||
|
r28784 | ui.log("commandexception", "%s\n%s\n", warning, traceback.format_exc()) | ||
ui.warn(warning) | ||||
return False # re-raise the exception | ||||