backup.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  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 signal
  23. from qubesadmin import exc
  24. from qubesadmin import utils as admin_utils
  25. from PyQt5 import QtCore, QtWidgets, QtGui # pylint: disable=import-error
  26. from . import ui_backupdlg # pylint: disable=no-name-in-module
  27. from . import multiselectwidget
  28. from . import backup_utils
  29. from . import utils
  30. import grp
  31. import pwd
  32. import os
  33. import shutil
  34. # pylint: disable=too-few-public-methods
  35. class BackupThread(QtCore.QThread):
  36. def __init__(self, vm):
  37. QtCore.QThread.__init__(self)
  38. self.vm = vm
  39. self.msg = None
  40. def run(self):
  41. msg = []
  42. try:
  43. if not self.vm.is_running():
  44. self.vm.start()
  45. except exc.QubesException:
  46. # we may have insufficient permissions to ensure the qube is running
  47. # let us hope for the best (worst case scenario, we will fail at the
  48. # next step
  49. pass
  50. try:
  51. self.vm.app.qubesd_call(
  52. 'dom0', 'admin.backup.Execute',
  53. backup_utils.get_profile_name(True))
  54. except exc.BackupAlreadyRunningError:
  55. msg.append("This backup is already in progress! Cancel it "
  56. "or wait until it finishes.")
  57. except Exception as ex: # pylint: disable=broad-except
  58. msg.append(str(ex))
  59. if msg:
  60. self.msg = '\n'.join(msg)
  61. class BackupVMsWindow(ui_backupdlg.Ui_Backup, QtWidgets.QWizard):
  62. def __init__(self, qt_app, qubes_app, dispatcher, parent=None):
  63. super(BackupVMsWindow, self).__init__(parent)
  64. self.qt_app = qt_app
  65. self.qubes_app = qubes_app
  66. self.selected_vms = []
  67. self.thread = None
  68. self.setupUi(self)
  69. self.progress_status.text = self.tr("Backup in progress...")
  70. self.dir_line_edit.setReadOnly(False)
  71. self.select_vms_widget = multiselectwidget.MultiSelectWidget(self)
  72. self.verticalLayout.insertWidget(1, self.select_vms_widget)
  73. self.currentIdChanged.connect(self.current_page_changed)
  74. self.select_vms_widget.itemsRemoved.connect(self.vms_removed)
  75. self.select_vms_widget.itemsAdded.connect(self.vms_added)
  76. self.dir_line_edit.textChanged.connect(self.backup_location_changed)
  77. self.select_vms_page.isComplete = self.has_selected_vms
  78. self.select_dir_page.isComplete = self.has_selected_dir_and_pass
  79. # FIXME
  80. # this causes to run isComplete() twice, I don't know why
  81. # update 2020-08: selectedChanged is emitted once,
  82. # but completeChanged twice. Somehow.
  83. self.select_vms_widget.selectedChanged.connect(
  84. self.select_vms_page.completeChanged.emit)
  85. self.passphrase_line_edit.textChanged.connect(
  86. self.backup_location_changed)
  87. self.passphrase_line_edit_verify.textChanged.connect(
  88. self.backup_location_changed)
  89. self.total_size = 0
  90. utils.initialize_widget_with_vms(
  91. widget=self.appvm_combobox,
  92. qubes_app=self.qubes_app,
  93. filter_function=(lambda vm:
  94. vm.klass != 'TemplateVM'
  95. and utils.is_running(vm, False)
  96. and not utils.get_feature(vm, 'internal', False)),
  97. allow_internal=True,
  98. )
  99. self.appvm_combobox.setCurrentIndex(
  100. self.appvm_combobox.findText("dom0"))
  101. self.unrecognized_config_label.setVisible(False)
  102. self.load_settings()
  103. selected = self.vms_to_include()
  104. self.__fill_vms_list__(selected)
  105. # Connect backup events for progress_bar
  106. self.progress_bar.setMinimum(0)
  107. self.progress_bar.setMaximum(100)
  108. self.dispatcher = dispatcher
  109. dispatcher.add_handler('backup-progress', self.on_backup_progress)
  110. def setup_application(self):
  111. self.qt_app.setApplicationName(self.tr("Qubes Backup VMs"))
  112. self.qt_app.setWindowIcon(QtGui.QIcon.fromTheme("qubes-manager"))
  113. def on_backup_progress(self, __submitter, _event, **kwargs):
  114. self.progress_bar.setValue(int(float(kwargs['progress'])))
  115. def vms_to_include(self):
  116. """
  117. Helper function that returns list of VMs with 'include_in_backups'
  118. attribute set to True.
  119. :return: list of VM names
  120. """
  121. result = []
  122. for domain in self.qubes_app.domains:
  123. if getattr(domain, 'include_in_backups', False):
  124. result.append(domain.name)
  125. return result
  126. def load_settings(self):
  127. """
  128. Helper function that tries to load existing backup profile
  129. (default path: /etc/qubes/backup/qubes-manager-backup.conf )
  130. and then apply its contents to the Backup window.
  131. Ignores listed VMs, to prioritize include_in_backups feature.
  132. :return: None
  133. """
  134. try:
  135. profile_data = backup_utils.load_backup_profile()
  136. except FileNotFoundError:
  137. return
  138. except exc.QubesException:
  139. QtWidgets.QMessageBox.information(
  140. self, self.tr("Error loading backup profile"),
  141. self.tr("Unable to load saved backup profile."))
  142. return
  143. if not profile_data:
  144. return
  145. if 'destination_vm' in profile_data:
  146. dest_vm_name = profile_data['destination_vm']
  147. dest_vm_idx = self.appvm_combobox.findText(dest_vm_name)
  148. if dest_vm_idx > -1:
  149. self.appvm_combobox.setCurrentIndex(dest_vm_idx)
  150. else:
  151. self.warning_running_label.setText(
  152. "NOTE: Only running qubes are listed. The profile "
  153. "lists {} as the destination qube, but it is not "
  154. "currently running.".format(dest_vm_name))
  155. if 'destination_path' in profile_data:
  156. dest_path = profile_data['destination_path']
  157. self.dir_line_edit.setText(dest_path)
  158. if 'passphrase_text' in profile_data:
  159. self.passphrase_line_edit.setText(profile_data['passphrase_text'])
  160. self.passphrase_line_edit_verify.setText(
  161. profile_data['passphrase_text'])
  162. if 'compression' in profile_data:
  163. self.compress_checkbox.setChecked(profile_data['compression'])
  164. def save_settings(self, use_temp):
  165. """
  166. Helper function that saves backup profile to either
  167. /etc/qubes/backup/qubes-manager-backup.conf or
  168. /etc/qubes/backup/qubes-manager-backup-tmp.conf
  169. :param use_temp: whether to use temporary profile (True) or the default
  170. backup profile (False)
  171. """
  172. settings = {'destination_vm': self.appvm_combobox.currentText(),
  173. 'destination_path': self.dir_line_edit.text(),
  174. 'include': [vm.name for vm in self.selected_vms],
  175. 'passphrase_text': self.passphrase_line_edit.text(),
  176. 'compression': self.compress_checkbox.isChecked()}
  177. backup_utils.write_backup_profile(settings, use_temp)
  178. class VmListItem(QtWidgets.QListWidgetItem):
  179. # pylint: disable=too-few-public-methods
  180. def __init__(self, vm):
  181. self.vm = vm
  182. if vm.klass == 'AdminVM':
  183. local_user = grp.getgrnam('qubes').gr_mem[0]
  184. home_dir = pwd.getpwnam(local_user).pw_dir
  185. self.size = shutil.disk_usage(home_dir)[1]
  186. else:
  187. try:
  188. self.size = vm.get_disk_utilization()
  189. except exc.QubesDaemonAccessError:
  190. self.size = None
  191. if self.size is not None:
  192. text = vm.name + " (" + admin_utils.size_to_human(
  193. self.size) + ")"
  194. else:
  195. text = vm.name + " (size unavailable)"
  196. self.size = 0
  197. super(BackupVMsWindow.VmListItem, self).__init__(text)
  198. def __fill_vms_list__(self, selected=None):
  199. for vm in self.qubes_app.domains:
  200. if utils.get_feature(vm, 'internal', False):
  201. continue
  202. item = BackupVMsWindow.VmListItem(vm)
  203. if (selected is None and
  204. getattr(vm, 'include_in_backups', True)) \
  205. or (selected and vm.name in selected):
  206. self.select_vms_widget.selected_list.addItem(item)
  207. self.total_size += item.size
  208. else:
  209. self.select_vms_widget.available_list.addItem(item)
  210. self.select_vms_widget.available_list.sortItems()
  211. self.select_vms_widget.selected_list.sortItems()
  212. self.total_size_label.setText(
  213. admin_utils.size_to_human(self.total_size))
  214. def vms_added(self, items):
  215. for i in items:
  216. self.total_size += i.size
  217. self.total_size_label.setText(
  218. admin_utils.size_to_human(self.total_size))
  219. def vms_removed(self, items):
  220. for i in items:
  221. self.total_size -= i.size
  222. self.total_size_label.setText(
  223. admin_utils.size_to_human(self.total_size))
  224. @QtCore.pyqtSlot(name='on_select_path_button_clicked')
  225. def select_path_button_clicked(self):
  226. backup_utils.select_path_button_clicked(self)
  227. def validateCurrentPage(self):
  228. # pylint: disable=invalid-name
  229. if self.currentPage() is self.select_vms_page:
  230. self.selected_vms = []
  231. for i in range(self.select_vms_widget.selected_list.count()):
  232. self.selected_vms.append(
  233. self.select_vms_widget.selected_list.item(i).vm)
  234. elif self.currentPage() is self.select_dir_page:
  235. backup_location = str(self.dir_line_edit.text())
  236. if not backup_location:
  237. QtWidgets.QMessageBox.information(
  238. self, self.tr("Wait!"),
  239. self.tr("Enter backup target location first."))
  240. return False
  241. if self.appvm_combobox.currentText() == "dom0" \
  242. and not os.path.isdir(backup_location):
  243. QtWidgets.QMessageBox.information(
  244. self, self.tr("Wait!"),
  245. self.tr("Selected directory do not exists or "
  246. "not a directory (%s).") % backup_location)
  247. return False
  248. if not self.passphrase_line_edit.text():
  249. QtWidgets.QMessageBox.information(
  250. self, self.tr("Wait!"),
  251. self.tr("Enter passphrase for backup "
  252. "encryption/verification first."))
  253. return False
  254. if self.passphrase_line_edit.text() !=\
  255. self.passphrase_line_edit_verify.text():
  256. QtWidgets.QMessageBox.information(
  257. self, self.tr("Wait!"),
  258. self.tr("Enter the same passphrase in both fields."))
  259. return False
  260. return True
  261. @staticmethod
  262. def cleanup_temporary_files():
  263. try:
  264. os.remove(backup_utils.get_profile_path(use_temp=True))
  265. except FileNotFoundError:
  266. pass
  267. def current_page_changed(self, page_id): # pylint: disable=unused-argument
  268. old_sigchld_handler = signal.signal(signal.SIGCHLD, signal.SIG_DFL)
  269. if self.currentPage() is self.confirm_page:
  270. self.save_settings(use_temp=True)
  271. try:
  272. backup_summary = self.qubes_app.qubesd_call(
  273. 'dom0', 'admin.backup.Info',
  274. backup_utils.get_profile_name(True)).decode()
  275. except exc.QubesDaemonAccessError:
  276. backup_summary = "Failed to get backup summary: " \
  277. "insufficient permissions"
  278. self.textEdit.setReadOnly(True)
  279. self.textEdit.setFontFamily("Monospace")
  280. self.textEdit.setText(backup_summary)
  281. elif self.currentPage() is self.commit_page:
  282. if self.save_profile_checkbox.isChecked():
  283. self.save_settings(use_temp=False)
  284. self.button(self.FinishButton).setDisabled(True)
  285. self.showFileDialog.setEnabled(
  286. self.appvm_combobox.currentIndex() != 0)
  287. self.showFileDialog.setChecked(self.showFileDialog.isEnabled()
  288. and str(self.dir_line_edit.text())
  289. .count("media/") > 0)
  290. vm = self.qubes_app.domains[
  291. self.appvm_combobox.currentText()]
  292. self.thread = BackupThread(vm)
  293. self.thread.finished.connect(self.backup_finished)
  294. self.thread.start()
  295. signal.signal(signal.SIGCHLD, old_sigchld_handler)
  296. def backup_finished(self):
  297. if self.thread.msg:
  298. self.progress_status.setText(self.tr("Backup error"))
  299. QtWidgets.QMessageBox.warning(
  300. self, self.tr("Backup error"),
  301. self.tr("ERROR: {}").format(
  302. self.thread.msg))
  303. self.button(self.CancelButton).setEnabled(False)
  304. self.button(self.FinishButton).setEnabled(True)
  305. self.cleanup_temporary_files()
  306. else:
  307. self.progress_bar.setValue(100)
  308. self.progress_status.setText(self.tr("Backup finished."))
  309. if self.showFileDialog.isChecked():
  310. orig_text = self.progress_status.text
  311. self.progress_status.setText(
  312. orig_text + self.tr(
  313. " Please unmount your backup volume and cancel "
  314. "the file selection dialog."))
  315. backup_utils.select_path_button_clicked(self, False, True)
  316. self.button(self.CancelButton).setEnabled(False)
  317. self.button(self.FinishButton).setEnabled(True)
  318. self.showFileDialog.setEnabled(False)
  319. self.cleanup_temporary_files()
  320. # turn off only when backup was successful
  321. if self.turn_off_checkbox.isChecked():
  322. os.system('systemctl poweroff')
  323. def reject(self):
  324. if (self.currentPage() is self.commit_page) and \
  325. self.button(self.CancelButton).isEnabled():
  326. try:
  327. self.qubes_app.qubesd_call(
  328. 'dom0', 'admin.backup.Cancel',
  329. backup_utils.get_profile_name(True))
  330. except exc.QubesException as ex:
  331. QtWidgets.QMessageBox.warning(
  332. self, self.tr("Error cancelling backup!"),
  333. self.tr("ERROR: {}").format(str(ex)))
  334. self.thread.wait()
  335. QtWidgets.QMessageBox.warning(
  336. self, self.tr("Backup aborted!"),
  337. self.tr("ERROR: Aborted"))
  338. self.cleanup_temporary_files()
  339. self.done(0)
  340. def has_selected_vms(self):
  341. return self.select_vms_widget.selected_list.count() > 0
  342. def has_selected_dir_and_pass(self):
  343. if not self.passphrase_line_edit.text():
  344. return False
  345. if self.passphrase_line_edit.text() != \
  346. self.passphrase_line_edit_verify.text():
  347. return False
  348. return len(self.dir_line_edit.text()) > 0
  349. def backup_location_changed(self, new_dir=None):
  350. # pylint: disable=unused-argument
  351. self.select_dir_page.completeChanged.emit()
  352. def main():
  353. utils.run_asynchronous(BackupVMsWindow)
  354. if __name__ == "__main__":
  355. main()