class VortaApp(QtSingleApplication):
"""
All windows and QWidgets are children of this app.
When running Borg-commands, the class `BorgThread` will emit events
via the `VortaApp` class to which other windows will subscribe to.
"""
backup_started_event = QtCore.pyqtSignal()
backup_finished_event = QtCore.pyqtSignal(dict)
backup_cancelled_event = QtCore.pyqtSignal()
backup_log_event = QtCore.pyqtSignal(str, dict)
backup_progress_event = QtCore.pyqtSignal(str)
def __init__(self, args_raw, single_app=False):
super().__init__(APP_ID, args_raw)
args = parse_args()
if self.isRunning():
if single_app:
self.sendMessage("open main window")
print(
'An instance of Vorta is already running. Opening main window.'
)
sys.exit()
elif args.profile:
self.sendMessage(f"create {args.profile}")
print('Creating backup using existing Vorta instance.')
sys.exit()
elif args.profile:
sys.exit('Vorta must already be running for --create to work')
init_translations(self)
self.setQuitOnLastWindowClosed(False)
self.scheduler = VortaScheduler(self)
self.setApplicationName("Vorta")
# Prepare tray and main window
self.tray = TrayMenu(self)
self.main_window = MainWindow(self)
if getattr(args, 'daemonize', False):
pass
elif SettingsModel.get(key='foreground').value:
self.open_main_window_action()
self.backup_started_event.connect(self.backup_started_event_response)
self.backup_finished_event.connect(self.backup_finished_event_response)
self.backup_cancelled_event.connect(
self.backup_cancelled_event_response)
self.message_received_event.connect(
self.message_received_event_response)
self.backup_log_event.connect(self.react_to_log)
self.aboutToQuit.connect(self.quit_app_action)
self.set_borg_details_action()
self.installEventFilter(self)
def create_backups_cmdline(self, profile_name):
profile = BackupProfileModel.get_or_none(name=profile_name)
if profile is not None:
if profile.repo is None:
logger.warning(f"Add a repository to {profile_name}")
# Wait a bit in case something is running
while BorgThread.is_running():
time.sleep(0.1)
self.create_backup_action(profile_id=profile.id)
else:
logger.warning(f"Invalid profile name {profile_name}")
def eventFilter(self, source, event):
if event.type(
) == QtCore.QEvent.ApplicationPaletteChange and isinstance(
source, MainWindow):
self.main_window.set_icons()
self.main_window.repoTab.set_icons()
self.main_window.archiveTab.set_icons()
self.main_window.scheduleTab.set_icons()
if event.type(
) == QtCore.QEvent.ApplicationPaletteChange and source == self.tray.contextMenu(
):
self.tray.set_tray_icon()
return False
def quit_app_action(self):
self.backup_cancelled_event.emit()
self.scheduler.shutdown()
del self.main_window
self.tray.deleteLater()
del self.tray
cleanup_db()
def create_backup_action(self, profile_id=None):
if not profile_id:
profile_id = self.main_window.current_profile.id
profile = BackupProfileModel.get(id=profile_id)
msg = BorgCreateThread.prepare(profile)
if msg['ok']:
thread = BorgCreateThread(msg['cmd'], msg, parent=self)
thread.start()
else:
notifier = VortaNotifications.pick()
notifier.deliver(self.tr('Vorta Backup'),
translate('messages', msg['message']),
level='error')
self.backup_progress_event.emit(
translate('messages', msg['message']))
def open_main_window_action(self):
self.main_window.show()
self.main_window.raise_()
self.main_window.activateWindow()
def toggle_main_window_visibility(self):
if self.main_window.isVisible():
self.main_window.close()
else:
self.open_main_window_action()
def backup_started_event_response(self):
self.tray.set_tray_icon(active=True)
def backup_finished_event_response(self):
self.tray.set_tray_icon()
def backup_cancelled_event_response(self):
self.tray.set_tray_icon()
def message_received_event_response(self, message):
if message == "open main window":
self.open_main_window_action()
elif message.startswith("create"):
message = message[7:] # Remove create
if BorgThread.is_running():
logger.warning("Cannot run while backups are already running")
else:
self.create_backups_cmdline(message)
def set_borg_details_action(self):
params = BorgVersionThread.prepare()
if not params['ok']:
self._alert_missing_borg()
return
thread = BorgVersionThread(params['cmd'], params, parent=self)
thread.result.connect(self.set_borg_details_result)
thread.start()
def set_borg_details_result(self, result):
"""
Receive result from BorgVersionThread.
If no valid version was found, display an error.
"""
if 'version' in result['data']:
borg_compat.set_version(result['data']['version'],
result['data']['path'])
self.main_window.miscTab.set_borg_details(borg_compat.version,
borg_compat.path)
self.main_window.repoTab.toggle_available_compression()
else:
self._alert_missing_borg()
def _alert_missing_borg(self):
msg = QMessageBox()
msg.setIcon(QMessageBox.Critical)
msg.setText(self.tr("No Borg Binary Found"))
msg.setInformativeText(
self.tr("Vorta was unable to locate a usable Borg Backup binary."))
msg.setStandardButtons(QMessageBox.Ok)
msg.exec()
def react_to_log(self, mgs, context):
"""
Trigger Vorta actions based on Borg logs. E.g. repo lock.
"""
msgid = context.get('msgid')
if msgid == 'LockTimeout':
profile = BackupProfileModel.get(name=context['profile_name'])
repo_url = context.get('repo_url')
msg = QMessageBox()
msg.setWindowTitle(self.tr("Repository In Use"))
msg.setIcon(QMessageBox.Critical)
abortButton = msg.addButton(self.tr("Abort"),
QMessageBox.RejectRole)
msg.addButton(self.tr("Continue"), QMessageBox.AcceptRole)
msg.setDefaultButton(abortButton)
msg.setText(
self.
tr(f"The repository at {repo_url} might be in use elsewhere."))
msg.setInformativeText(
self.
tr("Only break the lock if you are certain no other Borg process "
"on any machine is accessing the repository. Abort or break the lock?"
))
msg.accepted.connect(lambda: self.break_lock(profile))
self._msg = msg
msg.show()
elif msgid == 'LockFailed':
repo_url = context.get('repo_url')
msg = QMessageBox()
msg.setText(
self.
tr(f"You do not have permission to access the repository at {repo_url}. Gain access and try again."
)) # noqa: E501
msg.setWindowTitle(self.tr("No Repository Permissions"))
self._msg = msg
msg.show()
def break_lock(self, profile):
params = BorgBreakThread.prepare(profile)
if not params['ok']:
self.set_progress(params['message'])
return
thread = BorgBreakThread(params['cmd'], params, parent=self)
thread.start()
class VortaApp(QtSingleApplication):
"""
All windows and QWidgets are children of this app.
When running Borg-commands, the class `BorgThread` will emit events
via the `VortaApp` class to which other windows will subscribe to.
"""
backup_started_event = QtCore.pyqtSignal()
backup_finished_event = QtCore.pyqtSignal(dict)
backup_cancelled_event = QtCore.pyqtSignal()
backup_log_event = QtCore.pyqtSignal(str, dict)
backup_progress_event = QtCore.pyqtSignal(str)
def __init__(self, args_raw, single_app=False):
super().__init__(APP_ID, args_raw)
args = parse_args()
if self.isRunning():
if single_app:
self.sendMessage("open main window")
print(
'An instance of Vorta is already running. Opening main window.'
)
sys.exit()
elif args.profile:
self.sendMessage(f"create {args.profile}")
print('Creating backup using existing Vorta instance.')
sys.exit()
elif args.profile:
sys.exit('Vorta must already be running for --create to work')
init_translations(self)
self.setQuitOnLastWindowClosed(False)
self.scheduler = VortaScheduler(self)
self.setApplicationName("Vorta")
# Import profile from ~/.vorta-init.json or add empty "Default" profile.
self.bootstrap_profile()
# Prepare tray and main window
self.tray = TrayMenu(self)
self.main_window = MainWindow(self)
if getattr(args, 'daemonize', False):
pass
elif SettingsModel.get(key='foreground').value:
self.open_main_window_action()
self.backup_started_event.connect(self.backup_started_event_response)
self.backup_finished_event.connect(self.backup_finished_event_response)
self.backup_cancelled_event.connect(
self.backup_cancelled_event_response)
self.message_received_event.connect(
self.message_received_event_response)
self.backup_log_event.connect(self.react_to_log)
self.aboutToQuit.connect(self.quit_app_action)
self.set_borg_details_action()
if sys.platform == 'darwin':
self.check_darwin_permissions()
self.installEventFilter(self)
def create_backups_cmdline(self, profile_name):
profile = BackupProfileModel.get_or_none(name=profile_name)
if profile is not None:
if profile.repo is None:
logger.warning(f"Add a repository to {profile_name}")
# Wait a bit in case something is running
while BorgThread.is_running():
time.sleep(0.1)
self.create_backup_action(profile_id=profile.id)
else:
logger.warning(f"Invalid profile name {profile_name}")
def eventFilter(self, source, event):
if event.type(
) == QtCore.QEvent.ApplicationPaletteChange and isinstance(
source, MainWindow):
self.main_window.set_icons()
self.main_window.repoTab.set_icons()
self.main_window.archiveTab.set_icons()
self.main_window.scheduleTab.set_icons()
if event.type(
) == QtCore.QEvent.ApplicationPaletteChange and source == self.tray.contextMenu(
):
self.tray.set_tray_icon()
return False
def quit_app_action(self):
self.backup_cancelled_event.emit()
self.scheduler.shutdown()
del self.main_window
self.tray.deleteLater()
del self.tray
cleanup_db()
def create_backup_action(self, profile_id=None):
if not profile_id:
profile_id = self.main_window.current_profile.id
profile = BackupProfileModel.get(id=profile_id)
msg = BorgCreateThread.prepare(profile)
if msg['ok']:
thread = BorgCreateThread(msg['cmd'], msg, parent=self)
thread.start()
else:
notifier = VortaNotifications.pick()
notifier.deliver(self.tr('Vorta Backup'),
translate('messages', msg['message']),
level='error')
self.backup_progress_event.emit(
translate('messages', msg['message']))
def open_main_window_action(self):
self.main_window.show()
self.main_window.raise_()
self.main_window.activateWindow()
def toggle_main_window_visibility(self):
if self.main_window.isVisible():
self.main_window.close()
else:
self.open_main_window_action()
def backup_started_event_response(self):
self.tray.set_tray_icon(active=True)
def backup_finished_event_response(self):
self.tray.set_tray_icon()
def backup_cancelled_event_response(self):
self.tray.set_tray_icon()
def message_received_event_response(self, message):
if message == "open main window":
self.open_main_window_action()
elif message.startswith("create"):
message = message[7:] # Remove create
if BorgThread.is_running():
logger.warning("Cannot run while backups are already running")
else:
self.create_backups_cmdline(message)
def set_borg_details_action(self):
params = BorgVersionThread.prepare()
if not params['ok']:
self._alert_missing_borg()
return
thread = BorgVersionThread(params['cmd'], params, parent=self)
thread.result.connect(self.set_borg_details_result)
thread.start()
def set_borg_details_result(self, result):
"""
Receive result from BorgVersionThread.
If no valid version was found, display an error.
"""
if 'version' in result['data']:
borg_compat.set_version(result['data']['version'],
result['data']['path'])
self.main_window.miscTab.set_borg_details(borg_compat.version,
borg_compat.path)
self.main_window.repoTab.toggle_available_compression()
else:
self._alert_missing_borg()
def _alert_missing_borg(self):
msg = QMessageBox()
msg.setIcon(QMessageBox.Critical)
msg.setText(self.tr("No Borg Binary Found"))
msg.setInformativeText(
self.tr("Vorta was unable to locate a usable Borg Backup binary."))
msg.setStandardButtons(QMessageBox.Ok)
msg.exec()
def check_darwin_permissions(self):
"""
macOS restricts access to certain folders by default. For some folders, the user
will get a prompt (e.g. Documents, Downloads), while others will cause file access
errors.
This function tries reading a file that is known to be restricted and warn the user about
incomplete backups.
"""
test_path = os.path.expanduser('~/Library/Cookies')
if os.path.exists(test_path) and not os.access(test_path, os.R_OK):
msg = QMessageBox()
msg.setIcon(QMessageBox.Warning)
msg.setTextInteractionFlags(QtCore.Qt.LinksAccessibleByMouse)
msg.setText(
self.tr("Vorta needs Full Disk Access for complete Backups"))
msg.setInformativeText(
self.
tr("Without this, some files won't be accessible and you may end up with an incomplete "
"backup. Please set <b>Full Disk Access</b> permission for Vorta in "
"<a href='x-apple.systempreferences:com.apple.preference.security?Privacy'>"
"System Preferences > Security & Privacy</a>."))
msg.setStandardButtons(QMessageBox.Ok)
msg.exec()
def react_to_log(self, mgs, context):
"""
Trigger Vorta actions based on Borg logs. E.g. repo lock.
"""
msgid = context.get('msgid')
if msgid == 'LockTimeout':
profile = BackupProfileModel.get(name=context['profile_name'])
repo_url = context.get('repo_url')
msg = QMessageBox()
msg.setWindowTitle(self.tr("Repository In Use"))
msg.setIcon(QMessageBox.Critical)
abortButton = msg.addButton(self.tr("Abort"),
QMessageBox.RejectRole)
msg.addButton(self.tr("Continue"), QMessageBox.AcceptRole)
msg.setDefaultButton(abortButton)
msg.setText(
self.
tr(f"The repository at {repo_url} might be in use elsewhere."))
msg.setInformativeText(
self.
tr("Only break the lock if you are certain no other Borg process "
"on any machine is accessing the repository. Abort or break the lock?"
))
msg.accepted.connect(lambda: self.break_lock(profile))
self._msg = msg
msg.show()
elif msgid == 'LockFailed':
repo_url = context.get('repo_url')
msg = QMessageBox()
msg.setText(
self.
tr(f"You do not have permission to access the repository at {repo_url}. Gain access and try again."
)) # noqa: E501
msg.setWindowTitle(self.tr("No Repository Permissions"))
self._msg = msg
msg.show()
def break_lock(self, profile):
params = BorgBreakThread.prepare(profile)
if not params['ok']:
self.backup_progress_event.emit(params['message'])
return
thread = BorgBreakThread(params['cmd'], params, parent=self)
thread.start()
def bootstrap_profile(self, bootstrap_file=PROFILE_BOOTSTRAP_FILE):
"""
Make sure there is at least one profile when first starting Vorta.
Will either import a profile placed in ~/.vorta-init.json
or add an empty "Default" profile.
"""
if bootstrap_file.is_file():
profile_export = ProfileExport.from_json(bootstrap_file)
profile = profile_export.to_db(overwrite_profile=True,
overwrite_settings=True)
bootstrap_file.unlink()
notifier = VortaNotifications.pick()
notifier.deliver(self.tr('Profile import successful!'),
self.tr('Profile {} imported.').format(
profile.name),
level='info')
logger.info('Profile {} imported.'.format(profile.name))
if BackupProfileModel.select().count() == 0:
default_profile = BackupProfileModel(name='Default')
default_profile.save()