core-admin/dom0/qvm-tools/qvm-prefs

#!/usr/bin/python2.6
#
# The Qubes OS Project, http://www.qubes-os.org
#
# Copyright (C) 2010  Joanna Rutkowska <joanna@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 qubes.qubes import QubesVmCollection
from qubes.qubes import QubesVmLabels
from optparse import OptionParser
import subprocess

def do_list(vm):
    label_width = 18
    fmt="{{0:<{0}}}: {{1}}".format(label_width)

    print fmt.format ("name", vm.name)
    print fmt.format ("label", vm.label.name)
    print fmt.format ("type", vm.type)
    if vm.is_appvm():
        print fmt.format ("template", vm.template_vm.name)
    if vm.netvm_vm is not None:
        print fmt.format ("netvm", vm.netvm_vm.name)
    print fmt.format ("updateable?", vm.is_updateable())
    print fmt.format ("installed by RPM?", vm.installed_by_rpm)
    print fmt.format ("dir", vm.dir_path)
    print fmt.format ("config", vm.conf_file)
    if not vm.is_appvm():
        print fmt.format ("root img", vm.root_img)
    if vm.is_templete():
        print fmt.format ("root COW img", vm.rootcow_img)
    if vm.is_appvm():
        print fmt.format ("root img", vm.template_vm.root_img)
        print fmt.format ("root COW img", vm.rootcow_img)

    print fmt.format ("private img", vm.private_img)


def set_label(vms, vm, args):
    if len (args) != 1:
        print "Missing label name argument!"

    label = args[0]
    if label not in QubesVmLabels:
        print "Wrong label name, supported values are the following:"
        for l in QubesVmLabels.values():
            print "* {0}".format(l.name)
        exit (1)

    vm.label = QubesVmLabels[label]
    subprocess.check_call (["ln", "-sf", vm.label.icon_path, vm.icon_path])


def set_netvm(vms, vm, args):
    if len (args) != 1:
        print "Missing netvm name argument!"
        print "Possible values:"
        print "1) default"
        print "2) none"
        print "3) <vmaname>"
        return

    netvm = args[0]
    if netvm == "none":
        netvm_vm = None
        vm.uses_default_netvm = False
    elif netvm == "default":
        netvm_vm = vms.get_default_netvm_vm()
        vm.uses_default_netvm = True
    else:
        netvm_vm = vms.get_vm_by_name (netvm)
        if netvm_vm is None:
            print "A VM with the name '{0}' does not exist in the system.".format(netvm)
            exit(1)
        if not netvm_vm.is_netvm():
            print "VM '{0}' is not a NetVM".format(netvm)
            exit (1)
        vm.uses_default_netvm = False

    vm.netvm_vm = netvm_vm


def set_updateable(vms, vm, args):
    if vm.is_updateable():
        print "VM '{0}' is already set 'updateable', no action required.".format(vm.name)
        return True

    if vm.is_running():
        print "Cannot change 'updateable' attribute of a running VM. Shut it down first."
        return False

    if vm.is_appvm():
        # Check if the Template is *non* updateable...
        if not vm.template_vm.is_updateable():
            print "VM '{0}': Setting 'updateable' attribute to True.".format(vm.name)
            vm.set_updateable()
        else:
            print "The Template VM ('{0}') is marked as 'updateable' itself!".format(vm.template_vm.name)
            print "Cannot make the AppVM updateable too, as this might cause COW-backed storage incoherency."
            print "If you want to make this AppVM updateable, you must first make the Template VM nonupdateable."
            return False

    if vm.is_templete():
        # Make sure that all the AppVMs are non-updateable...
        for appvm in vm.appvms.values():
            if appvm.is_updateable():
                print "At least one of the AppVMs ('{0}') of this Template VM is also marked 'updateable'.".format(appvm.name)
                print "Cannot make the Template VM updateable too, as this might cause COW-backed storage incoherency."
                print "If you want to make this Template VM updateable, you must first make all its decedent AppVMs nonupdateable."
                return False


        print "VM '{0}': Setting 'updateable' attribute to True.".format(vm.name)
        vm.set_updateable()
 
    return True

def set_nonupdateable(vms, vm, args):
    if not vm.is_updateable():
        print "VM '{0}' is already set 'nonupdateable', no action required.".format(vm.name)
        return True

    if vm.is_running():
        print "Cannot change 'updateable' attribute of a running VM. Shut it down first."
        return False

    if vm.is_netvm():
        print "Why, on earth, would you want to make a NetVM 'nonupdateable'?"
        return False


    print "VM '{0}': Setting 'updateable' attribute to False.".format(vm.name)
    vm.set_nonupdateable()
    return True

properties = {
    "updateable": set_updateable,
    "nonupdateable": set_nonupdateable,
    "label" : set_label,
    "netvm" : set_netvm,
}


def do_set(vms, vm, property, args):
    if property not in properties.keys():
        print "ERROR: Wrong property name: '{0}'".format(property)
        return False

    return properties[property](vms, vm, args)


def main():
    usage = "usage: %prog -l [options] <vm-name>\n"\
            "usage: %prog -s [options] <vm-name> <property> [...]\n"\
            "List/set various per-VM properties."

    parser = OptionParser (usage)
    parser.add_option ("-l", "--list", action="store_true", dest="do_list", default=False)
    parser.add_option ("-s", "--set", action="store_true", dest="do_set", default=False)

    (options, args) = parser.parse_args ()
    if (len (args) < 1):
        parser.error ("You must provide at least the vmname!")

    vmname = args[0]

    if options.do_list and options.do_set:
        print "You cannot provide -l and -s at the same time!"
        exit (1)



    if options.do_set:
        qvm_collection = QubesVmCollection()
        qvm_collection.lock_db_for_writing()
        qvm_collection.load()
    else:
        qvm_collection = QubesVmCollection()
        qvm_collection.lock_db_for_reading()
        qvm_collection.load()
        qvm_collection.unlock_db()

    vm = qvm_collection.get_vm_by_name(vmname)
    if vm is None or vm.qid not in qvm_collection:
        print "A VM with the name '{0}' does not exist in the system.".format(vmname)
        exit(1)

    if options.do_set:
        if len (args) < 2:
            print "You must specify the property you wish to set..."
            print "Available properties:"
            for p in properties.keys():
                print "--> '{0}'".format(p)
            exit (1)

        property = args[1]
        do_set(qvm_collection, vm, property, args[2:])
        qvm_collection.save()
        qvm_collection.unlock_db()


    else: 
        # do_list
        do_list(vm)

main()