#!/usr/bin/python2 # -*- encoding: utf8 -*- # # The Qubes OS Project, http://www.qubes-os.org # # Copyright (C) 2010 Joanna Rutkowska # Copyright (C) 2010 Rafal Wojtczuk # # 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 qubes.qubes import QubesVmCollection from qubes.qubes import QubesException from qubes.guihelpers import notify_error_qubes_manager from optparse import OptionParser import subprocess import socket import errno import dbus import time import sys import os import os.path notify_object = None # how long (in sec) to wait for VMs to shutdown # before killing them (when used with --wait option) from qubes.qubes import defaults def tray_notify(str, label, timeout = 3000): if notify_object: notify_object.Notify("Qubes", 0, label.icon, "Qubes", str, [], [], timeout, dbus_interface="org.freedesktop.Notifications") def tray_notify_error(str, timeout = 3000): if notify_object: notify_object.Notify("Qubes", 0, "dialog-error", "Qubes", str, [], [], timeout, dbus_interface="org.freedesktop.Notifications") def vm_run_cmd(vm, cmd, options): if options.shutdown: if options.verbose: print >> sys.stderr, "Shutting down VM: '{0}'...".format(vm.name) try: vm.shutdown(force=options.force) except (QubesException) as err: # "There are other VMs connected to this VM:" print >> sys.stderr, "ERROR: {0}".format(err) if str(err).startswith("There are other VMs connected"): print >> sys.stderr, "Shutdown them first or use --force switch" exit(1) return 0 if options.pause: if options.verbose: print >> sys.stderr, "Pausing VM: '{0}'...".format(vm.name) vm.pause() return 0 if options.unpause: if options.verbose: print >> sys.stderr, "UnPausing VM: '{0}'...".format(vm.name) vm.unpause() return 0 if options.verbose: print >> sys.stderr, "Running command on VM: '{0}'...".format(vm.name) if options.passio and options.color_output: print "\033[0;31m", try: def tray_notify_generic(level, str): if level == "info": tray_notify(str, label=vm.label) elif level == "error": tray_notify_error(str) return vm.run(cmd, autostart = options.auto, verbose = options.verbose, user = options.user, notify_function = tray_notify_generic if options.tray else None, wait = options.passio, localcmd = options.localcmd, gui = options.gui, filter_esc = options.filter_esc) except QubesException as err: if options.passio and options.color_output: print "\033[0m", if options.tray: tray_notify_error(str(err)) notify_error_qubes_manager(vm.name, str(err)) print >> sys.stderr, "ERROR(%s): %s" % (str(vm.name), str(err)) return 1 finally: if options.passio and options.color_output: print "\033[0m", def main(): usage = "usage: %prog [options] [] []" parser = OptionParser (usage) parser.add_option ("-q", "--quiet", action="store_false", dest="verbose", default=True) parser.add_option ("-a", "--auto", action="store_true", dest="auto", default=False, help="Auto start the VM if not running") parser.add_option ("-u", "--user", action="store", dest="user", default=None, help="Run command in a VM as a specified user") parser.add_option ("--tray", action="store_true", dest="tray", default=False, help="Use tray notifications instead of stdout" ) parser.add_option ("--all", action="store_true", dest="run_on_all_running", default=False, help="Run command on all currently running VMs (or all paused, in case of --unpause)") parser.add_option ("--exclude", action="append", dest="exclude_list", help="When --all is used: exclude this VM name (may be " "repeated)") parser.add_option ("--wait", action="store_true", dest="wait_for_shutdown", default=False, help="Wait for the VM(s) to shutdown") parser.add_option ("--shutdown", action="store_true", dest="shutdown", default=False, help="(deprecated) Do 'xl shutdown' for the VM(s) (can be combined this with --all and --wait)") parser.add_option ("--pause", action="store_true", dest="pause", default=False, help="Do 'xl pause' for the VM(s) (can be combined this with --all and --wait)") parser.add_option ("--unpause", action="store_true", dest="unpause", default=False, help="Do 'xl unpause' for the VM(s) (can be combined this with --all and --wait)") parser.add_option ("-p", "--pass-io", action="store_true", dest="passio", default=False, help="Pass stdin/stdout/stderr from remote program (implies -q)") parser.add_option ("--localcmd", action="store", dest="localcmd", default=None, help="With --pass-io, pass stdin/stdout/stderr to the given program") parser.add_option ("--force", action="store_true", dest="force", default=False, help="Force operation, even if may damage other VMs (eg shutdown of NetVM)") parser.add_option ("--nogui", action="store_false", dest="gui", default=True, help="Run command without gui") parser.add_option ("--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_option("--no-filter-escape-chars", action="store_false", dest="filter_esc", help="Do not filter terminal escape sequences - " "overrides --filter-escape-chars, DANGEROUS when " "output is terminal") parser.add_option("--no-color-output", action="store_false", dest="color_output", default=None, help="Disable marking VM output with red color") (options, args) = parser.parse_args () if options.passio and options.run_on_all_running: parser.error ("Options --all and --pass-io cannot be used together") if options.passio: options.verbose = False if options.color_output is None: options.color_output = os.isatty(sys.stdout.fileno()) if options.shutdown: print >>sys.stderr, "WARNING: --shutdown is deprecated. Use qvm-shutdown instead." if (options.shutdown or options.pause or options.unpause): takes_cmd_argument = False else: takes_cmd_argument = True if options.run_on_all_running: if len(args) < 1 and takes_cmd_argument: parser.error ("You must provide a command to execute on all the VMs.") if len(args) > 1 or ((not takes_cmd_argument) and len(args) > 0): parser.error ("To many arguments...") cmdstr = args[0] if takes_cmd_argument else None else: if len (args) < 1 and not takes_cmd_argument: parser.error ("You must specify the VM name to shutdown/pause/unpause.") if len (args) < 2 and takes_cmd_argument: parser.error ("You must specify the VM name and the command to execute in the VM.") if len (args) > 2 or ((not takes_cmd_argument) and len(args) > 1): parser.error ("To many arguments...") vmname = args[0] cmdstr = args[1] if takes_cmd_argument else None if options.tray: global notify_object try: notify_object = dbus.SessionBus().get_object("org.freedesktop.Notifications", "/org/freedesktop/Notifications") except dbus.DBusException as ex: print >>sys.stderr, "WARNING: failed connect to tray notification service: %s" % str(ex) qvm_collection = QubesVmCollection() qvm_collection.lock_db_for_reading() qvm_collection.load() qvm_collection.unlock_db() vms_list = [] if options.run_on_all_running: all_vms = [vm for vm in qvm_collection.values()] for vm in all_vms: if options.exclude_list is not None and vm.name in options.exclude_list: continue if vm.qid == 0: continue if (options.unpause and vm.is_paused()) or (not options.unpause and vm.is_running()): vms_list.append (vm) # disable options incompatible with --all options.passio = False else: vm = qvm_collection.get_vm_by_name(vmname) if vm is None: print >> sys.stderr, "A VM with the name '{0}' does not exist in the system!".format(vmname) exit(1) vms_list.append(vm) retcode = 0 for vm in vms_list: r = vm_run_cmd(vm, cmdstr, options) retcode = max(r, retcode) if options.wait_for_shutdown: if options.verbose: print >> sys.stderr, "Waiting for the VM(s) to shutdown..." shutdown_counter = 0 while len (vms_list): if options.verbose: print >> sys.stderr, "Waiting for VMs: ", [vm.name for vm in vms_list] for vm in vms_list: if not vm.is_running(): vms_list.remove (vm) if shutdown_counter > defaults["shutdown_counter_max"]: # kill the VM if options.verbose: print >> sys.stderr, "Killing the (apparently hanging) VM '{0}'...".format(vm.name) vm.force_shutdown() #vms_list.remove(vm) shutdown_counter += 1 time.sleep (1) exit (0) # there is no point in executing the other daemons in the case of --wait exit(retcode) main()