hook.py
350 lines
| 11.2 KiB
| text/x-python
|
PythonLexer
/ mercurial / hook.py
|
r4622 | # hook.py - hook support for mercurial | ||
# | ||||
# Copyright 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. | ||
|
r4622 | |||
|
r25953 | from __future__ import absolute_import | ||
|
r45140 | import contextlib | ||
|
r46329 | import errno | ||
|
r25953 | import os | ||
import sys | ||||
from .i18n import _ | ||||
|
r43359 | from .pycompat import getattr | ||
|
r25953 | from . import ( | ||
demandimport, | ||||
|
r32642 | encoding, | ||
|
r25953 | error, | ||
extensions, | ||||
|
r30519 | pycompat, | ||
|
r25953 | util, | ||
) | ||||
|
r37137 | from .utils import ( | ||
procutil, | ||||
|
r44067 | resourceutil, | ||
|
r37769 | stringutil, | ||
|
r37137 | ) | ||
|
r4622 | |||
|
r43346 | |||
|
r38052 | def pythonhook(ui, repo, htype, hname, funcname, args, throw): | ||
|
r46554 | """call python hook. hook is callable object, looked up as | ||
|
r4622 | name in python module. if callable returns "true", hook | ||
fails, else passes. if hook raises exception, treated as | ||||
hook failure. exception propagates if throw is "true". | ||||
reason for "true" meaning "hook failed" is so that | ||||
unmodified commands (e.g. mercurial.commands.update) can | ||||
|
r46554 | be run as hooks without wrappers to convert return values.""" | ||
|
r4622 | |||
|
r21797 | if callable(funcname): | ||
|
r20548 | obj = funcname | ||
|
r43809 | funcname = pycompat.sysbytes(obj.__module__ + "." + obj.__name__) | ||
|
r20548 | else: | ||
|
r43347 | d = funcname.rfind(b'.') | ||
|
r4622 | if d == -1: | ||
|
r26692 | raise error.HookLoadError( | ||
|
r43347 | _(b'%s hook is invalid: "%s" not in a module') | ||
|
r43346 | % (hname, funcname) | ||
) | ||||
|
r4622 | modname = funcname[:d] | ||
|
r10103 | oldpaths = sys.path | ||
|
r44067 | if resourceutil.mainfrozen(): | ||
|
r9332 | # binary installs require sys.path manipulation | ||
|
r10103 | modpath, modfile = os.path.split(modname) | ||
if modpath and modfile: | ||||
sys.path = sys.path[:] + [modpath] | ||||
modname = modfile | ||||
|
r25328 | with demandimport.deactivated(): | ||
|
r4622 | try: | ||
|
r36125 | obj = __import__(pycompat.sysstr(modname)) | ||
|
r28109 | except (ImportError, SyntaxError): | ||
|
r28078 | e1 = sys.exc_info() | ||
|
r25328 | try: | ||
# extensions are loaded with hgext_ prefix | ||||
|
r43809 | obj = __import__("hgext_%s" % pycompat.sysstr(modname)) | ||
|
r28109 | except (ImportError, SyntaxError): | ||
|
r28078 | e2 = sys.exc_info() | ||
|
r25328 | if ui.tracebackflag: | ||
|
r43346 | ui.warn( | ||
_( | ||||
|
r43347 | b'exception from first failed import ' | ||
b'attempt:\n' | ||||
|
r43346 | ) | ||
) | ||||
|
r25328 | ui.traceback(e1) | ||
if ui.tracebackflag: | ||||
|
r43346 | ui.warn( | ||
_( | ||||
|
r43347 | b'exception from second failed import ' | ||
b'attempt:\n' | ||||
|
r43346 | ) | ||
) | ||||
|
r25328 | ui.traceback(e2) | ||
|
r28080 | |||
if not ui.tracebackflag: | ||||
tracebackhint = _( | ||||
|
r43347 | b'run with --traceback for stack trace' | ||
|
r43346 | ) | ||
|
r28080 | else: | ||
tracebackhint = None | ||||
|
r26692 | raise error.HookLoadError( | ||
|
r43347 | _(b'%s hook is invalid: import of "%s" failed') | ||
|
r43346 | % (hname, modname), | ||
hint=tracebackhint, | ||||
) | ||||
|
r9332 | sys.path = oldpaths | ||
|
r4622 | try: | ||
|
r43347 | for p in funcname.split(b'.')[1:]: | ||
|
r4622 | obj = getattr(obj, p) | ||
|
r7280 | except AttributeError: | ||
|
r26692 | raise error.HookLoadError( | ||
|
r43347 | _(b'%s hook is invalid: "%s" is not defined') | ||
% (hname, funcname) | ||||
|
r43346 | ) | ||
|
r21797 | if not callable(obj): | ||
|
r26692 | raise error.HookLoadError( | ||
|
r43347 | _(b'%s hook is invalid: "%s" is not callable') | ||
|
r43346 | % (hname, funcname) | ||
) | ||||
|
r20547 | |||
|
r43347 | ui.note(_(b"calling hook %s: %s\n") % (hname, funcname)) | ||
|
r30975 | starttime = util.timer() | ||
|
r20547 | |||
|
r4622 | try: | ||
|
r35358 | r = obj(ui=ui, repo=repo, hooktype=htype, **pycompat.strkwargs(args)) | ||
|
r25660 | except Exception as exc: | ||
|
r26587 | if isinstance(exc, error.Abort): | ||
|
r43347 | ui.warn(_(b'error: %s hook failed: %s\n') % (hname, exc.args[0])) | ||
|
r25084 | else: | ||
|
r43346 | ui.warn( | ||
|
r43387 | _(b'error: %s hook raised an exception: %s\n') | ||
|
r43346 | % (hname, stringutil.forcebytestr(exc)) | ||
) | ||||
|
r25084 | if throw: | ||
|
r4622 | raise | ||
|
r28108 | if not ui.tracebackflag: | ||
|
r43347 | ui.warn(_(b'(run with --traceback for stack trace)\n')) | ||
|
r25084 | ui.traceback() | ||
|
r26739 | return True, True | ||
|
r14889 | finally: | ||
|
r30975 | duration = util.timer() - starttime | ||
|
r43346 | ui.log( | ||
|
r43347 | b'pythonhook', | ||
b'pythonhook-%s: %s finished in %0.2f seconds\n', | ||||
|
r43346 | htype, | ||
funcname, | ||||
duration, | ||||
) | ||||
|
r4622 | if r: | ||
if throw: | ||||
|
r43347 | raise error.HookAbort(_(b'%s hook failed') % hname) | ||
ui.warn(_(b'warning: %s hook failed\n') % hname) | ||||
|
r26739 | return r, False | ||
|
r4622 | |||
|
r43346 | |||
|
r31746 | def _exthook(ui, repo, htype, name, cmd, args, throw): | ||
|
r30975 | starttime = util.timer() | ||
|
r7787 | env = {} | ||
|
r26751 | |||
# make in-memory changes visible to external process | ||||
|
r27228 | if repo is not None: | ||
tr = repo.currenttransaction() | ||||
repo.dirstate.write(tr) | ||||
if tr and tr.writepending(): | ||||
|
r43347 | env[b'HG_PENDING'] = repo.root | ||
env[b'HG_HOOKTYPE'] = htype | ||||
env[b'HG_HOOKNAME'] = name | ||||
|
r46753 | env[b'HGPLAIN'] = b'1' | ||
|
r26751 | |||
|
r43376 | for k, v in pycompat.iteritems(args): | ||
|
r45350 | # transaction changes can accumulate MBs of data, so skip it | ||
# for external hooks | ||||
if k == b'changes': | ||||
continue | ||||
|
r21797 | if callable(v): | ||
|
r7787 | v = v() | ||
|
r37770 | if isinstance(v, (dict, list)): | ||
|
r37961 | v = stringutil.pprint(v) | ||
|
r43347 | env[b'HG_' + k.upper()] = v | ||
|
r7787 | |||
|
r43347 | if ui.configbool(b'hooks', b'tonative.%s' % name, False): | ||
|
r38746 | oldcmd = cmd | ||
|
r38648 | cmd = procutil.shelltonative(cmd, env) | ||
|
r38746 | if cmd != oldcmd: | ||
|
r43347 | ui.note(_(b'converting hook "%s" to native\n') % name) | ||
|
r38503 | |||
|
r43347 | ui.note(_(b"running hook %s: %s\n") % (name, cmd)) | ||
|
r38503 | |||
|
r5869 | if repo: | ||
cwd = repo.root | ||||
else: | ||||
|
r39843 | cwd = encoding.getcwd() | ||
|
r43347 | r = ui.system(cmd, environ=env, cwd=cwd, blockedtag=b'exthook-%s' % (name,)) | ||
|
r18671 | |||
|
r30975 | duration = util.timer() - starttime | ||
|
r43346 | ui.log( | ||
|
r43347 | b'exthook', | ||
b'exthook-%s: %s finished in %0.2f seconds\n', | ||||
|
r43346 | name, | ||
cmd, | ||||
duration, | ||||
) | ||||
|
r4622 | if r: | ||
|
r37481 | desc = procutil.explainexit(r) | ||
|
r4622 | if throw: | ||
|
r43347 | raise error.HookAbort(_(b'%s hook %s') % (name, desc)) | ||
ui.warn(_(b'warning: %s hook %s\n') % (name, desc)) | ||||
|
r4622 | return r | ||
|
r43346 | |||
|
r28938 | # represent an untrusted hook command | ||
_fromuntrusted = object() | ||||
|
r43346 | |||
|
r15896 | def _allhooks(ui): | ||
|
r28937 | """return a list of (hook-id, cmd) pairs sorted by priority""" | ||
hooks = _hookitems(ui) | ||||
|
r28938 | # Be careful in this section, propagating the real commands from untrusted | ||
# sources would create a security vulnerability, make sure anything altered | ||||
# in that section uses "_fromuntrusted" as its command. | ||||
untrustedhooks = _hookitems(ui, _untrusted=True) | ||||
for name, value in untrustedhooks.items(): | ||||
|
r45371 | trustedvalue = hooks.get(name, ((), (), name, _fromuntrusted)) | ||
|
r28938 | if value != trustedvalue: | ||
(lp, lo, lk, lv) = trustedvalue | ||||
hooks[name] = (lp, lo, lk, _fromuntrusted) | ||||
# (end of the security sensitive section) | ||||
|
r28937 | return [(k, v) for p, o, k, v in sorted(hooks.values())] | ||
|
r43346 | |||
|
r28938 | def _hookitems(ui, _untrusted=False): | ||
|
r28937 | """return all hooks items ready to be sorted""" | ||
|
r28936 | hooks = {} | ||
|
r43347 | for name, cmd in ui.configitems(b'hooks', untrusted=_untrusted): | ||
if name.startswith(b'priority.') or name.startswith(b'tonative.'): | ||||
|
r38648 | continue | ||
|
r43347 | priority = ui.configint(b'hooks', b'priority.%s' % name, 0) | ||
|
r45371 | hooks[name] = ((-priority,), (len(hooks),), name, cmd) | ||
|
r28937 | return hooks | ||
|
r15896 | |||
|
r43346 | |||
|
r5833 | _redirect = False | ||
|
r43346 | |||
|
r5833 | def redirect(state): | ||
|
r6266 | global _redirect | ||
|
r5833 | _redirect = state | ||
|
r43346 | |||
|
r34688 | def hashook(ui, htype): | ||
"""return True if a hook is configured for 'htype'""" | ||||
if not ui.callhooks: | ||||
return False | ||||
for hname, cmd in _allhooks(ui): | ||||
|
r43347 | if hname.split(b'.')[0] == htype and cmd: | ||
|
r34688 | return True | ||
return False | ||||
|
r43346 | |||
|
r31745 | def hook(ui, repo, htype, throw=False, **args): | ||
|
r17048 | if not ui.callhooks: | ||
return False | ||||
|
r26737 | hooks = [] | ||
for hname, cmd in _allhooks(ui): | ||||
|
r43347 | if hname.split(b'.')[0] == htype and cmd: | ||
|
r26737 | hooks.append((hname, cmd)) | ||
|
r31745 | res = runhooks(ui, repo, htype, hooks, throw=throw, **args) | ||
|
r26738 | r = False | ||
for hname, cmd in hooks: | ||||
|
r26739 | r = res[hname][0] or r | ||
|
r26738 | return r | ||
|
r26737 | |||
|
r43346 | |||
|
r45140 | @contextlib.contextmanager | ||
def redirect_stdio(): | ||||
"""Redirects stdout to stderr, if possible.""" | ||||
oldstdout = -1 | ||||
try: | ||||
if _redirect: | ||||
try: | ||||
stdoutno = procutil.stdout.fileno() | ||||
stderrno = procutil.stderr.fileno() | ||||
# temporarily redirect stdout to stderr, if possible | ||||
if stdoutno >= 0 and stderrno >= 0: | ||||
procutil.stdout.flush() | ||||
oldstdout = os.dup(stdoutno) | ||||
os.dup2(stderrno, stdoutno) | ||||
except (OSError, AttributeError): | ||||
# files seem to be bogus, give up on redirecting (WSGI, etc) | ||||
pass | ||||
yield | ||||
finally: | ||||
# The stderr is fully buffered on Windows when connected to a pipe. | ||||
# A forcible flush is required to make small stderr data in the | ||||
# remote side available to the client immediately. | ||||
|
r46329 | try: | ||
procutil.stderr.flush() | ||||
except IOError as err: | ||||
if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF): | ||||
raise error.StdioError(err) | ||||
|
r45140 | |||
if _redirect and oldstdout >= 0: | ||||
|
r46329 | try: | ||
procutil.stdout.flush() # write hook output to stderr fd | ||||
except IOError as err: | ||||
if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF): | ||||
raise error.StdioError(err) | ||||
|
r45140 | os.dup2(oldstdout, stdoutno) | ||
os.close(oldstdout) | ||||
|
r31744 | def runhooks(ui, repo, htype, hooks, throw=False, **args): | ||
|
r32897 | args = pycompat.byteskwargs(args) | ||
|
r26738 | res = {} | ||
|
r5833 | |||
|
r45140 | with redirect_stdio(): | ||
|
r26737 | for hname, cmd in hooks: | ||
|
r28938 | if cmd is _fromuntrusted: | ||
if throw: | ||||
raise error.HookAbort( | ||||
|
r43347 | _(b'untrusted hook %s not executed') % hname, | ||
hint=_(b"see 'hg help config.trusted'"), | ||||
|
r43346 | ) | ||
|
r43347 | ui.warn(_(b'warning: untrusted hook %s not executed\n') % hname) | ||
|
r28938 | r = 1 | ||
raised = False | ||||
elif callable(cmd): | ||||
|
r43346 | r, raised = pythonhook(ui, repo, htype, hname, cmd, args, throw) | ||
|
r43347 | elif cmd.startswith(b'python:'): | ||
if cmd.count(b':') >= 2: | ||||
path, cmd = cmd[7:].rsplit(b':', 1) | ||||
|
r13118 | path = util.expandpath(path) | ||
|
r13119 | if repo: | ||
path = os.path.join(repo.root, path) | ||||
|
r17217 | try: | ||
|
r43347 | mod = extensions.loadpath(path, b'hghook.%s' % hname) | ||
|
r17217 | except Exception: | ||
|
r43347 | ui.write(_(b"loading %s hook failed:\n") % hname) | ||
|
r17217 | raise | ||
|
r7916 | hookfn = getattr(mod, cmd) | ||
else: | ||||
hookfn = cmd[7:].strip() | ||||
|
r43346 | r, raised = pythonhook( | ||
ui, repo, htype, hname, hookfn, args, throw | ||||
) | ||||
|
r7416 | else: | ||
|
r31746 | r = _exthook(ui, repo, htype, hname, cmd, args, throw) | ||
|
r26739 | raised = False | ||
|
r26738 | |||
|
r26739 | res[hname] = r, raised | ||
|
r6266 | |||
|
r26738 | return res | ||