manager/qubesmanager/backup_utils.py

#!/usr/bin/python2
# pylint: skip-file
#
# The Qubes OS Project, http://www.qubes-os.org
#
# Copyright (C) 2012  Agnieszka Kostrzewa <agnieszka.kostrzewa@gmail.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 Lesser General Public License along
# with this program; if not, see <http://www.gnu.org/licenses/>.
#
#
import re
from PyQt4 import QtGui
from PyQt4 import QtCore

import subprocess
from . import utils
import yaml

path_re = re.compile(r"[a-zA-Z0-9/:.,_+=() -]*")
path_max_len = 512

# TODO: replace it with a more dynamic approach: allowing user to turn on or off
# profile saving
backup_profile_path = '/etc/qubes/backup/qubes-manager-backup.conf'


def fill_appvms_list(dialog):
    dialog.appvm_combobox.clear()
    dialog.appvm_combobox.addItem("dom0")

    dialog.appvm_combobox.setCurrentIndex(0)  # current selected is null ""

    for vm in dialog.qvm_collection.domains:
        if vm.klass == 'AppVM' and vm.features.get('internal', False):
            continue
        if vm.klass == 'TemplateVM' and vm.installed_by_rpm:
            continue

        # TODO: is the is_running criterion really necessary? It's designed to
        # avoid backuping a VM into itself or surprising the user with starting
        # a VM when they didn't plan to.
        # TODO: remove debug
        debug = True
        if (debug or vm.is_running()) and vm.qid != 0:
            dialog.appvm_combobox.addItem(vm.name)


def enable_dir_line_edit(dialog, boolean):
    dialog.dir_line_edit.setEnabled(boolean)
    dialog.select_path_button.setEnabled(boolean)


def select_path_button_clicked(dialog, select_file=False):
    backup_location = str(dialog.dir_line_edit.text())
    file_dialog = QtGui.QFileDialog()
    file_dialog.setReadOnly(True)

    new_path = None
    # TODO: check if dom0 is available

    new_appvm = str(dialog.appvm_combobox.currentText())
    vm = dialog.qvm_collection.domains[new_appvm]
    try:
        new_path = utils.get_path_from_vm(
            vm,
            "qubes.SelectFile" if select_file
            else "qubes.SelectDirectory")
    except subprocess.CalledProcessError as ex:
        QtGui.QMessageBox.warning(
            None,
            dialog.tr("Nothing selected!"),
            dialog.tr("No file or directory selected."))

    # TODO: check if this works for restore
    if new_path:
        dialog.dir_line_edit.setText(new_path)

    if new_path and len(backup_location) > 0:
        dialog.select_dir_page.emit(QtCore.SIGNAL("completeChanged()"))


def load_backup_profile():
    with open(backup_profile_path) as profile_file:
        profile_data = yaml.safe_load(profile_file)
    return profile_data


def write_backup_profile(args):
    '''Format limited backup profile (for GUI purposes and print it to
    *output_stream* (a file or stdout)

    :param output_stream: file-like object ro print the profile to
    :param args: dictionary with arguments
    :param passphrase: passphrase to use
    '''

    acceptable_fields = ['include', 'passphrase_text', 'compression',
                         'destination_vm', 'destination_path']

    profile_data = {key: value for key, value in args.items()
                    if key in acceptable_fields}

    # TODO add compression parameter to GUI issue#943
    with open(backup_profile_path, 'w') as profile_file:
        yaml.safe_dump(profile_data, profile_file)