mirror of
https://github.com/facebook/sapling.git
synced 2024-10-07 07:17:55 +03:00
a5a452bf52
Reviewed By: yancouto Differential Revision: D41218851 fbshipit-source-id: 7eb258a2e93dbb7f98b63bc9c4615cd64c9d01fa
286 lines
9.6 KiB
Python
286 lines
9.6 KiB
Python
# Portions Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
#
|
|
# This software may be used and distributed according to the terms of the
|
|
# GNU General Public License version 2.
|
|
|
|
# hook.py - hook support for mercurial
|
|
#
|
|
# Copyright 2007 Olivia Mackall <olivia@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 os
|
|
import sys
|
|
|
|
from edenscm import hgdemandimport as demandimport
|
|
|
|
from . import encoding, error, extensions, pycompat, util
|
|
from .i18n import _
|
|
|
|
|
|
def _pythonhook(ui, repo, htype, hname, funcname, args, throw):
|
|
"""call python hook. hook is callable object, looked up as
|
|
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. commands.update) can
|
|
be run as hooks without wrappers to convert return values."""
|
|
|
|
if callable(funcname):
|
|
obj = funcname
|
|
funcname = obj.__module__ + r"." + obj.__name__
|
|
else:
|
|
d = funcname.rfind(".")
|
|
if d == -1:
|
|
raise error.HookLoadError(
|
|
_('%s hook is invalid: "%s" not in a module') % (hname, funcname)
|
|
)
|
|
modname = funcname[:d]
|
|
oldpaths = sys.path
|
|
if util.mainfrozen():
|
|
# binary installs require sys.path manipulation
|
|
modpath, modfile = os.path.split(modname)
|
|
if modpath and modfile:
|
|
sys.path = sys.path[:] + [modpath]
|
|
modname = modfile
|
|
with demandimport.deactivated():
|
|
try:
|
|
obj = __import__(modname)
|
|
except (ImportError, SyntaxError):
|
|
e1 = sys.exc_info()
|
|
try:
|
|
# extensions are loaded with ext_ prefix
|
|
obj = __import__("edenscm_ext_%s" % modname)
|
|
except (ImportError, SyntaxError):
|
|
e2 = sys.exc_info()
|
|
ui.warn(_("exception from first failed import " "attempt:\n"))
|
|
ui.traceback(e1, force=True)
|
|
ui.warn(_("exception from second failed import " "attempt:\n"))
|
|
ui.traceback(e2, force=True)
|
|
|
|
raise error.HookLoadError(
|
|
_('%s hook is invalid: import of "%s" failed')
|
|
% (hname, modname),
|
|
)
|
|
sys.path = oldpaths
|
|
try:
|
|
for p in funcname.split(".")[1:]:
|
|
obj = getattr(obj, p)
|
|
except AttributeError:
|
|
raise error.HookLoadError(
|
|
_('%s hook is invalid: "%s" is not defined') % (hname, funcname)
|
|
)
|
|
if not callable(obj):
|
|
raise error.HookLoadError(
|
|
_('%s hook is invalid: "%s" is not callable') % (hname, funcname)
|
|
)
|
|
|
|
ui.note(_("calling hook %s: %s\n") % (hname, funcname))
|
|
starttime = util.timer()
|
|
|
|
try:
|
|
with util.traced("pythonhook", hookname=hname, cat="blocked"):
|
|
r = obj(ui=ui, repo=repo, hooktype=htype, **args)
|
|
except Exception as exc:
|
|
if isinstance(exc, error.Abort):
|
|
ui.warn(_("error: %s hook failed: %s\n") % (hname, exc.args[0]))
|
|
else:
|
|
ui.warn(
|
|
_("error: %s hook raised an exception: " "%s\n")
|
|
% (hname, encoding.strtolocal(str(exc)))
|
|
)
|
|
if throw:
|
|
raise
|
|
ui.traceback(force=True)
|
|
return True, True
|
|
finally:
|
|
duration = util.timer() - starttime
|
|
ui.log(
|
|
"pythonhook",
|
|
"pythonhook-%s: %s finished in %0.2f seconds\n",
|
|
htype,
|
|
funcname,
|
|
duration,
|
|
)
|
|
if r:
|
|
if throw:
|
|
raise error.HookAbort(_("%s hook failed") % hname)
|
|
ui.warn(_("warning: %s hook failed\n") % hname)
|
|
return r, False
|
|
|
|
|
|
def _exthook(ui, repo, htype, name, cmd, args, throw):
|
|
ui.note(_("running hook %s: %s\n") % (name, cmd))
|
|
|
|
starttime = util.timer()
|
|
env = {}
|
|
|
|
# make in-memory changes visible to external process
|
|
if repo is not None:
|
|
tr = repo.currenttransaction()
|
|
repo.dirstate.write(tr)
|
|
if tr and tr.writepending(env=env):
|
|
env["HG_PENDING"] = repo.root
|
|
env["HG_SHAREDPENDING"] = repo.sharedroot
|
|
env["HG_HOOKTYPE"] = htype
|
|
env["HG_HOOKNAME"] = name
|
|
|
|
for k, v in pycompat.iteritems(args):
|
|
if callable(v):
|
|
v = v()
|
|
if isinstance(v, dict):
|
|
# make the dictionary element order stable across Python
|
|
# implementations
|
|
v = (
|
|
"{"
|
|
+ ", ".join("%r: %r" % i for i in sorted(pycompat.iteritems(v)))
|
|
+ "}"
|
|
)
|
|
env["HG_" + k.upper()] = v
|
|
|
|
if repo:
|
|
cwd = repo.root
|
|
else:
|
|
cwd = pycompat.getcwd()
|
|
|
|
r = ui.system(cmd, environ=env, cwd=cwd, blockedtag="exthook")
|
|
|
|
duration = util.timer() - starttime
|
|
ui.log("exthook", "exthook-%s: %s finished in %0.2f seconds\n", name, cmd, duration)
|
|
if r:
|
|
desc, r = util.explainexit(r)
|
|
if throw:
|
|
raise error.HookAbort(_("%s hook %s") % (name, desc))
|
|
ui.warn(_("warning: %s hook %s\n") % (name, desc))
|
|
return r
|
|
|
|
|
|
# represent an untrusted hook command
|
|
_fromuntrusted = object()
|
|
|
|
|
|
def _allhooks(ui):
|
|
"""return a list of (hook-id, cmd) pairs sorted by priority"""
|
|
hooks = _hookitems(ui)
|
|
return [(k, v) for p, o, k, v in sorted(hooks.values())]
|
|
|
|
|
|
def _hookitems(ui):
|
|
"""return all hooks items ready to be sorted"""
|
|
hooks = {}
|
|
for name, cmd in ui.configitems("hooks"):
|
|
if not name.startswith("priority"):
|
|
priority = ui.configint("hooks", "priority.%s" % name, 0)
|
|
# TODO: check whether the hook item is trusted or not
|
|
hooks[name] = (-priority, len(hooks), name, cmd)
|
|
return hooks
|
|
|
|
|
|
_redirect = False
|
|
|
|
|
|
def redirect(state: bool) -> None:
|
|
global _redirect
|
|
_redirect = state
|
|
|
|
|
|
def hashook(ui, htype) -> bool:
|
|
"""return True if a hook is configured for 'htype'"""
|
|
if not ui.callhooks:
|
|
return False
|
|
for hname, cmd in _allhooks(ui):
|
|
if hname.split(".")[0] == htype and cmd:
|
|
return True
|
|
return False
|
|
|
|
|
|
def hook(ui, repo, htype, throw: bool = False, **args) -> bool:
|
|
if not ui.callhooks:
|
|
return False
|
|
|
|
hooks = []
|
|
for hname, cmd in _allhooks(ui):
|
|
if hname.split(".")[0] == htype and cmd:
|
|
hooks.append((hname, cmd))
|
|
|
|
res = runhooks(ui, repo, htype, hooks, throw=throw, **args)
|
|
r = False
|
|
for hname, cmd in hooks:
|
|
r = res[hname][0] or r
|
|
return r
|
|
|
|
|
|
def runhooks(ui, repo, htype, hooks, throw: bool = False, **args):
|
|
args = args
|
|
res = {}
|
|
oldstdout = -1
|
|
|
|
try:
|
|
for hname, cmd in hooks:
|
|
if oldstdout == -1 and _redirect:
|
|
try:
|
|
stdoutno = util.stdout.fileno()
|
|
stderrno = util.stderr.fileno()
|
|
# temporarily redirect stdout to stderr, if possible
|
|
if stdoutno >= 0 and stderrno >= 0:
|
|
util.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
|
|
|
|
if cmd is _fromuntrusted:
|
|
if throw:
|
|
raise error.HookAbort(
|
|
_("untrusted hook %s not executed") % hname,
|
|
hint=_("see '@prog@ help config.trusted'"),
|
|
)
|
|
ui.warn(_("warning: untrusted hook %s not executed\n") % hname)
|
|
r = 1
|
|
raised = False
|
|
elif callable(cmd):
|
|
r, raised = _pythonhook(ui, repo, htype, hname, cmd, args, throw)
|
|
elif cmd.startswith("python:"):
|
|
if cmd.count(":") >= 2:
|
|
path, cmd = cmd[7:].rsplit(":", 1)
|
|
path = util.expandpath(path)
|
|
if repo:
|
|
path = os.path.join(repo.root, path)
|
|
try:
|
|
mod = extensions.loadpath(path, "hghook.%s" % hname)
|
|
except Exception as e:
|
|
ui.write(_("loading %s hook failed: %s\n") % (hname, e))
|
|
raise
|
|
hookfn = getattr(mod, cmd)
|
|
else:
|
|
hookfn = cmd[7:].strip()
|
|
# Compatibility: Change "ext" to "edenscm.ext"
|
|
# automatically.
|
|
if hookfn.startswith("ext."):
|
|
hookfn = "edenscm." + hookfn
|
|
r, raised = _pythonhook(ui, repo, htype, hname, hookfn, args, throw)
|
|
else:
|
|
r = _exthook(ui, repo, htype, hname, cmd, args, throw)
|
|
raised = False
|
|
|
|
res[hname] = r, raised
|
|
|
|
# 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.
|
|
util.stderr.flush()
|
|
finally:
|
|
if _redirect and oldstdout >= 0:
|
|
util.stdout.flush() # write hook output to stderr fd
|
|
# pyre-fixme[61]: `stdoutno` is undefined, or not always defined.
|
|
os.dup2(oldstdout, stdoutno)
|
|
os.close(oldstdout)
|
|
|
|
return res
|