-
Notifications
You must be signed in to change notification settings - Fork 140
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor BorgThread into 2 separate classes.
- Loading branch information
Showing
11 changed files
with
341 additions
and
312 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| import json | ||
| import os | ||
| import sys | ||
| import shutil | ||
| import signal | ||
| from PyQt5 import QtCore | ||
| from PyQt5.QtWidgets import QApplication | ||
| from subprocess import Popen, PIPE | ||
|
|
||
| from .models import EventLogModel | ||
|
|
||
| mutex = QtCore.QMutex() | ||
|
|
||
|
|
||
| class BorgThread(QtCore.QThread): | ||
| """ | ||
| Base class to run `borg` command line jobs. If a command needs more pre- or past-processing | ||
| it should sublass `BorgThread`. | ||
| """ | ||
|
|
||
| updated = QtCore.pyqtSignal(str) | ||
| result = QtCore.pyqtSignal(dict) | ||
|
|
||
| def __init__(self, cmd, params, parent=None): | ||
| """ | ||
| Thread to run Borg operations in. | ||
| :param cmd: Borg command line | ||
| :param params: To pass extra options that are later formatted centrally. | ||
| :param parent: Parent window. Needs `thread.wait()` if none. (scheduler) | ||
| """ | ||
|
|
||
| super().__init__(parent) | ||
| self.app = QApplication.instance() | ||
| self.app.backup_cancelled_event.connect(self.cancel) | ||
|
|
||
| # Find packaged borg binary. Prefer globally installed. | ||
| if not shutil.which('borg'): | ||
| meipass_borg = os.path.join(sys._MEIPASS, 'bin', 'borg') | ||
| if os.path.isfile(meipass_borg): | ||
| cmd[0] = meipass_borg | ||
| self.cmd = cmd | ||
|
|
||
| env = os.environ.copy() | ||
| env['BORG_HOSTNAME_IS_UNIQUE'] = '1' | ||
| if params.get('password') and params['password'] is not None: | ||
| env['BORG_PASSPHRASE'] = params['password'] | ||
|
|
||
| env['BORG_RSH'] = 'ssh -oStrictHostKeyChecking=no' | ||
| if params.get('ssh_key') and params['ssh_key']: | ||
| env['BORG_RSH'] += f' -i ~/.ssh/{params["ssh_key"]}' | ||
|
|
||
| self.env = env | ||
| self.params = params | ||
| self.process = None | ||
|
|
||
| @classmethod | ||
| def is_running(cls): | ||
| if mutex.tryLock(): | ||
| mutex.unlock() | ||
| return False | ||
| else: | ||
| return True | ||
|
|
||
| def run(self): | ||
| self.started_event() | ||
| mutex.lock() | ||
| log_entry = EventLogModel(category='borg-run', subcommand=self.cmd[1]) | ||
| log_entry.save() | ||
|
|
||
| self.process = Popen(self.cmd, stdout=PIPE, stderr=PIPE, bufsize=1, | ||
| universal_newlines=True, env=self.env, preexec_fn=os.setsid) | ||
|
|
||
| for line in iter(self.process.stderr.readline, ''): | ||
| try: | ||
| parsed = json.loads(line) | ||
| if parsed['type'] == 'log_message': | ||
| self.log_event(f'{parsed["levelname"]}: {parsed["message"]}') | ||
| elif parsed['type'] == 'file_status': | ||
| self.log_event(f'{parsed["path"]} ({parsed["status"]})') | ||
| except json.decoder.JSONDecodeError: | ||
| self.log_event(line.strip()) | ||
|
|
||
| self.process.wait() | ||
| stdout = self.process.stdout.read() | ||
| result = { | ||
| 'params': self.params, | ||
| 'returncode': self.process.returncode, | ||
| 'cmd': self.cmd | ||
| } | ||
| try: | ||
| result['data'] = json.loads(stdout) | ||
| except: | ||
| result['data'] = {} | ||
|
|
||
| log_entry.returncode = self.process.returncode | ||
| log_entry.save() | ||
|
|
||
| self.process_result(result) | ||
| self.finished_event(result) | ||
| mutex.unlock() | ||
|
|
||
| def cancel(self): | ||
| if self.isRunning(): | ||
| mutex.unlock() | ||
| os.killpg(os.getpgid(self.process.pid), signal.SIGTERM) | ||
| self.terminate() | ||
|
|
||
| def process_result(self, result): | ||
| pass | ||
|
|
||
| def log_event(self, msg): | ||
| self.updated.emit(msg) | ||
|
|
||
| def started_event(self): | ||
| self.updated.emit('Task started') | ||
|
|
||
| def finished_event(self, result): | ||
| self.result.emit(result) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.