This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1534

logtoprocess: add an option to parse script command
AbandonedPublic

Authored by lothiraldan on Nov 28 2017, 3:36 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

With shell=False, the logtoprocess script will not be parsed by a shell and
we won't be able to pass arguments in logtoprocess configuration. Add a new
option logtoprocess.parsescript that calls shlex.split on the script so we
can pass arguments. As shlex.split is only designed for POSIX system, this
option have no impact on Windows.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

lothiraldan created this revision.Nov 28 2017, 3:36 PM
lothiraldan abandoned this revision.Jun 19 2019, 2:31 AM

Revision Contents
Changeset List

Diff 3915

hgext/logtoprocess.py

not ensure that they exit cleanly. not ensure that they exit cleanly.
""" """
from __future__ import absolute_import from __future__ import absolute_import
import itertools import itertools
import os import os
import shlex
import subprocess import subprocess
import sys import sys
from mercurial import ( from mercurial import (
encoding, encoding,
pycompat, pycompat,
) )
# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
# be specifying the version(s) of Mercurial they are tested with, or # be specifying the version(s) of Mercurial they are tested with, or
# leave the attribute unspecified. # leave the attribute unspecified.
testedwith = 'ships-with-hg-core' testedwith = 'ships-with-hg-core'
def uisetup(ui): def uisetup(ui):
if pycompat.iswindows: if pycompat.iswindows:
# no fork on Windows, but we can create a detached process # no fork on Windows, but we can create a detached process
# https://msdn.microsoft.com/en-us/library/windows/desktop/ms684863.aspx # https://msdn.microsoft.com/en-us/library/windows/desktop/ms684863.aspx
# No stdlib constant exists for this value # No stdlib constant exists for this value
DETACHED_PROCESS = 0x00000008 DETACHED_PROCESS = 0x00000008
_creationflags = DETACHED_PROCESS | subprocess.CREATE_NEW_PROCESS_GROUP _creationflags = DETACHED_PROCESS | subprocess.CREATE_NEW_PROCESS_GROUP
def runshellcommand(script, env, shell=True): def runshellcommand(script, env, shell=True, _=False):
# we can't use close_fds *and* redirect stdin. I'm not sure that we # we can't use close_fds *and* redirect stdin. I'm not sure that we
# need to because the detached process has no console connection. # need to because the detached process has no console connection.
subprocess.Popen( subprocess.Popen(
script, shell=shell, env=env, close_fds=True, script, shell=shell, env=env, close_fds=True,
creationflags=_creationflags) creationflags=_creationflags)
else: else:
def runshellcommand(script, env, shell=True): def runshellcommand(script, env, shell=True, parse_script=False):
# double-fork to completely detach from the parent process # double-fork to completely detach from the parent process
# based on http://code.activestate.com/recipes/278731 # based on http://code.activestate.com/recipes/278731
pid = os.fork() pid = os.fork()
if pid: if pid:
# parent # parent
return return
# subprocess.Popen() forks again, all we need to add is # subprocess.Popen() forks again, all we need to add is
# flag the new process as a new session. # flag the new process as a new session.
if sys.version_info < (3, 2): if sys.version_info < (3, 2):
newsession = {'preexec_fn': os.setsid} newsession = {'preexec_fn': os.setsid}
else: else:
newsession = {'start_new_session': True} newsession = {'start_new_session': True}
# Try to split the arguments when shell is False
if not shell and parse_script:
script = shlex.split(script)
try: try:
# connect stdin to devnull to make sure the subprocess can't # connect stdin to devnull to make sure the subprocess can't
# muck up that stream for mercurial. # muck up that stream for mercurial.
subprocess.Popen( subprocess.Popen(
script, shell=shell, stdin=open(os.devnull, 'r'), env=env, script, shell=shell, stdin=open(os.devnull, 'r'), env=env,
close_fds=True, **newsession) close_fds=True, **newsession)
finally: finally:
# mission accomplished, this child needs to exit and not # mission accomplished, this child needs to exit and not
# keyword arguments get prefixed with OPT_ and uppercased # keyword arguments get prefixed with OPT_ and uppercased
optpairs = ( optpairs = (
('OPT_{0}'.format(key.upper()), str(value)) ('OPT_{0}'.format(key.upper()), str(value))
for key, value in opts.iteritems()) for key, value in opts.iteritems())
env = dict(itertools.chain(encoding.environ.items(), env = dict(itertools.chain(encoding.environ.items(),
msgpairs, optpairs), msgpairs, optpairs),
EVENT=event, HGPID=str(os.getpid())) EVENT=event, HGPID=str(os.getpid()))
shell = self.configbool('logtoprocess', 'shell') shell = self.configbool('logtoprocess', 'shell')
runshellcommand(script, env, shell) parsescript = self.configbool('logtoprocess', 'parsescript')
runshellcommand(script, env, shell, parsescript)
return super(logtoprocessui, self).log(event, *msg, **opts) return super(logtoprocessui, self).log(event, *msg, **opts)
# Replace the class for this instance and all clones created from it: # Replace the class for this instance and all clones created from it:
ui.__class__ = logtoprocessui ui.__class__ = logtoprocessui

mercurial/configitems.py

default=None, default=None,
) )
coreconfigitem('logtoprocess', 'command', coreconfigitem('logtoprocess', 'command',
default=None, default=None,
) )
coreconfigitem('logtoprocess', 'develwarn', coreconfigitem('logtoprocess', 'develwarn',
default=None, default=None,
) )
coreconfigitem('logtoprocess', 'parsescript',
default=False,
)
coreconfigitem('logtoprocess', 'shell', coreconfigitem('logtoprocess', 'shell',
default=True, default=True,
) )
coreconfigitem('logtoprocess', 'uiblocked', coreconfigitem('logtoprocess', 'uiblocked',
default=None, default=None,
) )
coreconfigitem('merge', 'checkunknown', coreconfigitem('merge', 'checkunknown',
default='abort', default='abort',