core-admin/qubes/tools/qvm_run.py

#
# The Qubes OS Project, http://www.qubes-os.org
#
# Copyright (C) 2010-2015  Joanna Rutkowska <joanna@invisiblethingslab.com>
# Copyright (C) 2015       Wojtek Porczyk <woju@invisiblethingslab.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

from __future__ import print_function

import os
import sys

import qubes
import qubes.exc
import qubes.tools


parser = qubes.tools.QubesArgumentParser(vmname_nargs='+')

parser.add_argument('--user', '-u', metavar='USER',
    help='run command in a qube as USER')

parser.add_argument('--autostart', '--auto', '-a',
    action='store_true', default=False,
    help='start the qube if it is not running')

parser.add_argument('--pass-io', '-p',
    action='store_true', dest='passio', default=False,
    help='pass stdio from remote program')

parser.add_argument('--localcmd', metavar='COMMAND',
    help='with --pass-io, pass stdio to the given program')

parser.add_argument('--gui',
    action='store_true', default=True,
    help='run the command with GUI (default on)')

parser.add_argument('--no-gui', '--nogui',
    action='store_false', dest='gui',
    help='run the command without GUI')

parser.add_argument('--colour-output', '--color-output', metavar='COLOUR',
    action='store', dest='color_output', default=None,
    help='mark the qube output with given ANSI colour (ie. "31" for red)')

parser.add_argument('--colour-stderr', '--color-stderr', metavar='COLOUR',
    action='store', dest='color_stderr', default=None,
    help='mark the qube stderr with given ANSI colour (ie. "31" for red)')

parser.add_argument('--no-colour-output', '--no-color-output',
    action='store_false', dest='color_output',
    help='disable colouring the stdio')

parser.add_argument('--no-colour-stderr', '--no-color-stderr',
    action='store_false', dest='color_stderr',
    help='disable colouring the stderr')

parser.add_argument('--filter-escape-chars',
    action='store_true', dest='filter_esc',
    default=os.isatty(sys.stdout.fileno()),
    help='filter terminal escape sequences (default if output is terminal)')

parser.add_argument('--no-filter-escape-chars',
    action='store_false', dest='filter_esc',
    help='do not filter terminal escape sequences; DANGEROUS when output is a'
        ' terminal emulator')

parser.add_argument('cmd', metavar='COMMAND',
    help='command to run')


def main(args=None):
    args = parser.parse_args(args)
    if args.color_output is None and args.filter_esc:
        args.color_output = '31'

    if args.color_output is None and os.isatty(sys.stderr.fileno()):
        args.color_stderr = 31

    if len(args.domains) > 1 and args.passio:
        parser.error('--passio cannot be used when more than 1 qube is chosen')
    if args.localcmd and not args.passio:
        parser.error('--localcmd have no effect without --pass-io')
    if args.color_output and not args.filter_esc:
        parser.error('--color-output must be used with --filter-escape-chars')

    retcode = 0
    for vm in args.domains:
        if args.autostart and not vm.is_running():
            vm.start()

        if args.color_output:
            sys.stdout.write('\033[0;{}m'.format(args.color_output))
            sys.stdout.flush()
        if args.color_stderr:
            sys.stderr.write('\033[0;{}m'.format(args.color_stderr))
            sys.stderr.flush()

        try:
            retcode = max(retcode, vm.run(args.cmd,
                user=args.user,
                passio=args.passio,
                localcmd=args.localcmd,
                gui=args.gui,
                filter_esc=args.filter_esc))

        except qubes.exc.QubesException as e:
            if args.color_output:
                sys.stdout.write('\033[0m')
                sys.stdout.flush()
            vm.log.error(str(e))
            return -1

        finally:
            if args.color_output:
                sys.stdout.write('\033[0m')
                sys.stdout.flush()
            if args.color_stderr:
                sys.stderr.write('\033[0m')
                sys.stderr.flush()

    return retcode


if __name__ == '__main__':
    sys.exit(main())