backup.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. #!/usr/bin/python3
  2. #
  3. # The Qubes OS Project, http://www.qubes-os.org
  4. #
  5. # Copyright (C) 2012 Agnieszka Kostrzewa <agnieszka.kostrzewa@gmail.com>
  6. # Copyright (C) 2012 Marek Marczykowski <marmarek@mimuw.edu.pl>
  7. #
  8. # This program is free software; you can redistribute it and/or
  9. # modify it under the terms of the GNU General Public License
  10. # as published by the Free Software Foundation; either version 2
  11. # of the License, or (at your option) any later version.
  12. #
  13. # This program is distributed in the hope that it will be useful,
  14. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. # GNU General Public License for more details.
  17. #
  18. # You should have received a copy of the GNU Lesser General Public License along
  19. # with this program; if not, see <http://www.gnu.org/licenses/>.
  20. #
  21. #
  22. import traceback
  23. import signal
  24. import shutil
  25. from qubesadmin import Qubes, events, exc
  26. from qubesadmin import utils as admin_utils
  27. from qubes.storage.file import get_disk_usage
  28. from PyQt4 import QtCore # pylint: disable=import-error
  29. from PyQt4 import QtGui # pylint: disable=import-error
  30. from . import ui_backupdlg # pylint: disable=no-name-in-module
  31. from . import multiselectwidget
  32. from . import backup_utils
  33. from . import utils
  34. import grp
  35. import pwd
  36. import sys
  37. import os
  38. from . import thread_monitor
  39. import threading
  40. import time
  41. class BackupVMsWindow(ui_backupdlg.Ui_Backup, multiselectwidget.QtGui.QWizard):
  42. __pyqtSignals__ = ("backup_progress(int)",)
  43. def __init__(self, app, qvm_collection, parent=None):
  44. super(BackupVMsWindow, self).__init__(parent)
  45. self.app = app
  46. self.qvm_collection = qvm_collection
  47. self.backup_settings = QtCore.QSettings()
  48. self.selected_vms = []
  49. self.tmpdir_to_remove = None
  50. self.canceled = False
  51. self.thread_monitor = None
  52. self.setupUi(self)
  53. self.progress_status.text = self.tr("Backup in progress...")
  54. self.dir_line_edit.setReadOnly(False)
  55. self.select_vms_widget = multiselectwidget.MultiSelectWidget(self)
  56. self.verticalLayout.insertWidget(1, self.select_vms_widget)
  57. self.connect(self, QtCore.SIGNAL("currentIdChanged(int)"),
  58. self.current_page_changed)
  59. self.connect(self.select_vms_widget,
  60. QtCore.SIGNAL("items_removed(PyQt_PyObject)"),
  61. self.vms_removed)
  62. self.connect(self.select_vms_widget,
  63. QtCore.SIGNAL("items_added(PyQt_PyObject)"),
  64. self.vms_added)
  65. self.connect(self, QtCore.SIGNAL("backup_progress(int)"),
  66. self.progress_bar.setValue)
  67. self.dir_line_edit.connect(self.dir_line_edit,
  68. QtCore.SIGNAL("textChanged(QString)"),
  69. self.backup_location_changed)
  70. self.select_vms_page.isComplete = self.has_selected_vms
  71. self.select_dir_page.isComplete = self.has_selected_dir_and_pass
  72. # FIXME
  73. # this causes to run isComplete() twice, I don't know why
  74. self.select_vms_page.connect(
  75. self.select_vms_widget,
  76. QtCore.SIGNAL("selected_changed()"),
  77. QtCore.SIGNAL("completeChanged()"))
  78. self.passphrase_line_edit.connect(
  79. self.passphrase_line_edit,
  80. QtCore.SIGNAL("textChanged(QString)"),
  81. self.backup_location_changed)
  82. self.passphrase_line_edit_verify.connect(
  83. self.passphrase_line_edit_verify,
  84. QtCore.SIGNAL("textChanged(QString)"),
  85. self.backup_location_changed)
  86. self.total_size = 0
  87. self.target_vm_list, self.target_vm_idx = utils.prepare_vm_choice(
  88. self.appvm_combobox,
  89. self.qvm_collection,
  90. None,
  91. self.qvm_collection.domains['dom0'],
  92. (lambda vm: vm.klass != 'TemplateVM' and vm.is_running()),
  93. allow_internal=False,
  94. allow_default=False,
  95. allow_none=False
  96. )
  97. selected = self.load_settings()
  98. self.__fill_vms_list__(selected)
  99. def load_settings(self):
  100. try:
  101. profile_data = backup_utils.load_backup_profile()
  102. except FileNotFoundError:
  103. return
  104. except exc.QubesException:
  105. QtGui.QMessageBox.information(
  106. None, self.tr("Error loading backup profile"),
  107. self.tr("Unable to load saved backup profile."))
  108. return
  109. if not profile_data:
  110. return
  111. if 'destination_vm' in profile_data:
  112. dest_vm_name = profile_data['destination_vm']
  113. dest_vm_idx = self.appvm_combobox.findText(dest_vm_name)
  114. if dest_vm_idx > -1:
  115. self.appvm_combobox.setCurrentIndex(dest_vm_idx)
  116. if 'destination_path' in profile_data:
  117. dest_path = profile_data['destination_path']
  118. self.dir_line_edit.setText(dest_path)
  119. if 'passphrase_text' in profile_data:
  120. self.passphrase_line_edit.setText(profile_data['passphrase_text'])
  121. self.passphrase_line_edit_verify.setText(
  122. profile_data['passphrase_text'])
  123. if 'include' in profile_data:
  124. return profile_data['include']
  125. return None
  126. def save_settings(self, use_temp):
  127. settings = {'destination_vm': self.appvm_combobox.currentText(),
  128. 'destination_path': self.dir_line_edit.text(),
  129. 'include': [vm.name for vm in self.selected_vms],
  130. 'passphrase_text': self.passphrase_line_edit.text()}
  131. # TODO: add compression when it is added
  132. backup_utils.write_backup_profile(settings, use_temp)
  133. class VmListItem(QtGui.QListWidgetItem):
  134. # pylint: disable=too-few-public-methods
  135. def __init__(self, vm):
  136. self.vm = vm
  137. if vm.qid == 0:
  138. local_user = grp.getgrnam('qubes').gr_mem[0]
  139. home_dir = pwd.getpwnam(local_user).pw_dir
  140. self.size = get_disk_usage(home_dir)
  141. else:
  142. self.size = vm.get_disk_utilization()
  143. super(BackupVMsWindow.VmListItem, self).__init__(
  144. vm.name + " (" + admin_utils.size_to_human(self.size) + ")")
  145. def __fill_vms_list__(self, selected=None):
  146. for vm in self.qvm_collection.domains:
  147. if vm.features.get('internal', False):
  148. continue
  149. item = BackupVMsWindow.VmListItem(vm)
  150. if (selected is None and
  151. getattr(vm, 'include_in_backups', True)) \
  152. or (selected and vm.name in selected):
  153. self.select_vms_widget.selected_list.addItem(item)
  154. self.total_size += item.size
  155. else:
  156. self.select_vms_widget.available_list.addItem(item)
  157. self.select_vms_widget.available_list.sortItems()
  158. self.select_vms_widget.selected_list.sortItems()
  159. self.unrecognized_config_label.setVisible(
  160. selected is not None and
  161. len(selected) != len(self.select_vms_widget.selected_list))
  162. self.total_size_label.setText(
  163. admin_utils.size_to_human(self.total_size))
  164. def vms_added(self, items):
  165. for i in items:
  166. self.total_size += i.size
  167. self.total_size_label.setText(
  168. admin_utils.size_to_human(self.total_size))
  169. def vms_removed(self, items):
  170. for i in items:
  171. self.total_size -= i.size
  172. self.total_size_label.setText(
  173. admin_utils.size_to_human(self.total_size))
  174. @QtCore.pyqtSlot(name='on_select_path_button_clicked')
  175. def select_path_button_clicked(self):
  176. backup_utils.select_path_button_clicked(self)
  177. def validateCurrentPage(self):
  178. # pylint: disable=invalid-name
  179. if self.currentPage() is self.select_vms_page:
  180. self.selected_vms = []
  181. for i in range(self.select_vms_widget.selected_list.count()):
  182. self.selected_vms.append(
  183. self.select_vms_widget.selected_list.item(i).vm)
  184. elif self.currentPage() is self.select_dir_page:
  185. backup_location = str(self.dir_line_edit.text())
  186. if not backup_location:
  187. QtGui.QMessageBox.information(
  188. None, self.tr("Wait!"),
  189. self.tr("Enter backup target location first."))
  190. return False
  191. if self.appvm_combobox.currentIndex() == 0 \
  192. and not os.path.isdir(backup_location):
  193. QtGui.QMessageBox.information(
  194. None, self.tr("Wait!"),
  195. self.tr("Selected directory do not exists or "
  196. "not a directory (%s).") % backup_location)
  197. return False
  198. if not self.passphrase_line_edit.text():
  199. QtGui.QMessageBox.information(
  200. None, self.tr("Wait!"),
  201. self.tr("Enter passphrase for backup "
  202. "encryption/verification first."))
  203. return False
  204. if self.passphrase_line_edit.text() !=\
  205. self.passphrase_line_edit_verify.text():
  206. QtGui.QMessageBox.information(
  207. None, self.tr("Wait!"),
  208. self.tr("Enter the same passphrase in both fields."))
  209. return False
  210. return True
  211. def update_progress_bar(self, value):
  212. self.emit(QtCore.SIGNAL("backup_progress(int)"), value)
  213. def __do_backup__(self, t_monitor):
  214. msg = []
  215. try:
  216. # TODO: this does nothing, events are not handled
  217. events_dispatcher = events.EventsDispatcher(self.app)
  218. events_dispatcher.add_handler('backup-progress',
  219. self.update_progress_bar)
  220. vm = self.qvm_collection.domains[
  221. self.appvm_combobox.currentText()]
  222. if not vm.is_running():
  223. vm.start()
  224. self.qvm_collection.qubesd_call(
  225. 'dom0', 'admin.backup.Execute',
  226. backup_utils.get_profile_name(True))
  227. except Exception as ex: # pylint: disable=broad-except
  228. msg.append(str(ex))
  229. if msg:
  230. t_monitor.set_error_msg('\n'.join(msg))
  231. t_monitor.set_finished()
  232. def current_page_changed(self, page_id): # pylint: disable=unused-argument
  233. old_sigchld_handler = signal.signal(signal.SIGCHLD, signal.SIG_DFL)
  234. if self.currentPage() is self.confirm_page:
  235. self.save_settings(True)
  236. backup_summary = self.qvm_collection.qubesd_call(
  237. 'dom0', 'admin.backup.Info',
  238. backup_utils.get_profile_name(True))
  239. self.textEdit.setReadOnly(True)
  240. self.textEdit.setFontFamily("Monospace")
  241. self.textEdit.setText(backup_summary.decode())
  242. elif self.currentPage() is self.commit_page:
  243. if self.save_profile_checkbox.isChecked():
  244. self.save_settings(False)
  245. self.button(self.FinishButton).setDisabled(True)
  246. self.showFileDialog.setEnabled(
  247. self.appvm_combobox.currentIndex() != 0)
  248. self.showFileDialog.setChecked(self.showFileDialog.isEnabled()
  249. and str(self.dir_line_edit.text())
  250. .count("media/") > 0)
  251. self.thread_monitor = thread_monitor.ThreadMonitor()
  252. thread = threading.Thread(
  253. target=self.__do_backup__,
  254. args=(self.thread_monitor,))
  255. thread.daemon = True
  256. thread.start()
  257. while not self.thread_monitor.is_finished():
  258. self.app.processEvents()
  259. time.sleep(0.1)
  260. if not self.thread_monitor.success:
  261. if self.canceled:
  262. self.progress_status.setText(self.tr("Backup aborted."))
  263. if self.tmpdir_to_remove:
  264. if QtGui.QMessageBox.warning(
  265. None, self.tr("Backup aborted"),
  266. self.tr(
  267. "Do you want to remove temporary files "
  268. "from %s?") % self.tmpdir_to_remove,
  269. QtGui.QMessageBox.Yes,
  270. QtGui.QMessageBox.No) == QtGui.QMessageBox.Yes:
  271. shutil.rmtree(self.tmpdir_to_remove)
  272. else:
  273. self.progress_status.setText(self.tr("Backup error."))
  274. QtGui.QMessageBox.warning(
  275. self, self.tr("Backup error!"),
  276. self.tr("ERROR: {}").format(
  277. self.thread_monitor.error_msg))
  278. else:
  279. self.progress_bar.setValue(100)
  280. self.progress_status.setText(self.tr("Backup finished."))
  281. if self.showFileDialog.isChecked():
  282. orig_text = self.progress_status.text
  283. self.progress_status.setText(
  284. orig_text + self.tr(
  285. " Please unmount your backup volume and cancel "
  286. "the file selection dialog."))
  287. if self.target_appvm: # FIXME I'm not sure if this works
  288. self.target_appvm.run(
  289. "QUBESRPC %s dom0" % "qubes.SelectDirectory")
  290. self.button(self.CancelButton).setEnabled(False)
  291. self.button(self.FinishButton).setEnabled(True)
  292. self.showFileDialog.setEnabled(False)
  293. signal.signal(signal.SIGCHLD, old_sigchld_handler)
  294. def reject(self):
  295. # cancell clicked while the backup is in progress.
  296. # calling kill on tar.
  297. if self.currentPage() is self.commit_page:
  298. pass # TODO: this does nothing
  299. # if backup.backup_cancel():
  300. # self.button(self.CancelButton).setDisabled(True)
  301. else:
  302. self.done(0)
  303. def has_selected_vms(self):
  304. return self.select_vms_widget.selected_list.count() > 0
  305. def has_selected_dir_and_pass(self):
  306. if not self.passphrase_line_edit.text():
  307. return False
  308. if self.passphrase_line_edit.text() != \
  309. self.passphrase_line_edit_verify.text():
  310. return False
  311. return len(self.dir_line_edit.text()) > 0
  312. def backup_location_changed(self, new_dir=None):
  313. # pylint: disable=unused-argument
  314. self.select_dir_page.emit(QtCore.SIGNAL("completeChanged()"))
  315. # Bases on the original code by:
  316. # Copyright (c) 2002-2007 Pascal Varet <p.varet@gmail.com>
  317. def handle_exception(exc_type, exc_value, exc_traceback):
  318. filename, line, dummy, dummy = traceback.extract_tb(exc_traceback).pop()
  319. filename = os.path.basename(filename)
  320. error = "%s: %s" % (exc_type.__name__, exc_value)
  321. QtGui.QMessageBox.critical(
  322. None,
  323. "Houston, we have a problem...",
  324. "Whoops. A critical error has occured. This is most likely a bug "
  325. "in Qubes Global Settings application.<br><br><b><i>%s</i></b>" %
  326. error + "at <b>line %d</b> of file <b>%s</b>.<br/><br/>"
  327. % (line, filename))
  328. def main():
  329. qtapp = QtGui.QApplication(sys.argv)
  330. qtapp.setOrganizationName("The Qubes Project")
  331. qtapp.setOrganizationDomain("http://qubes-os.org")
  332. qtapp.setApplicationName("Qubes Backup VMs")
  333. sys.excepthook = handle_exception
  334. app = Qubes()
  335. backup_window = BackupVMsWindow(qtapp, app)
  336. backup_window.show()
  337. qtapp.exec_()
  338. qtapp.exit()
  339. if __name__ == "__main__":
  340. main()