Compare commits
8 Commits
dcca9c5167
...
dev
| Author | SHA1 | Date | |
|---|---|---|---|
|
7cb96fcd45
|
|||
|
22d30b4df7
|
|||
|
8733167ae3
|
|||
|
b15bb9052d
|
|||
|
ae0beac9e0
|
|||
|
072c2a26e6
|
|||
|
b0c165b8b0
|
|||
|
6b8686351a
|
@@ -1,4 +1,4 @@
|
||||
# copyright (c) 2026 paul retourné
|
||||
# Copyright (c) 2026 paul retourné
|
||||
# spdx-license-identifier: gpl-3.0-or-later
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
# Copyright (C) 2025-2026 Paul Retourné
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
from typing import NoReturn
|
||||
import sys
|
||||
|
||||
class RemoteMountedError(Exception):
|
||||
pass
|
||||
|
||||
@@ -12,3 +15,7 @@ class UnknownSSHError(Exception):
|
||||
|
||||
class FatalSyncError(Exception):
|
||||
pass
|
||||
|
||||
def unisync_exit_fatal(reason:str) -> NoReturn:
|
||||
print(reason)
|
||||
sys.exit(1)
|
||||
|
||||
+5
-1
@@ -4,6 +4,7 @@
|
||||
from pathlib import Path
|
||||
|
||||
from unisync.argparser import create_argparser
|
||||
from unisync.errors import UnknownSSHError, unisync_exit_fatal
|
||||
from unisync.runners import unisync_sync, unisync_add, unisync_mount
|
||||
from unisync.config import load_config
|
||||
from unisync.synchroniser import Synchroniser
|
||||
@@ -38,7 +39,10 @@ def main():
|
||||
|
||||
paths_manager = PathsManager(Path(config.roots.local), config.other.cache_dir_path)
|
||||
|
||||
cli_args.func(synchroniser, paths_manager, config)
|
||||
try:
|
||||
cli_args.func(synchroniser, paths_manager, config)
|
||||
except UnknownSSHError:
|
||||
unisync_exit_fatal("Connection failed quitting")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
@@ -73,9 +73,9 @@ class PathsManager:
|
||||
try:
|
||||
paths = self.user_select_files()
|
||||
break
|
||||
except subprocess.TimeoutExpired as e:
|
||||
except subprocess.TimeoutExpired:
|
||||
if input("Timeout expired do you want to retry (y/n): ") != "y":
|
||||
raise e
|
||||
raise
|
||||
self.write_new_paths(paths)
|
||||
|
||||
def get_paths_to_sync(self) -> list[str]:
|
||||
|
||||
@@ -5,11 +5,11 @@ from unisync.synchroniser import Synchroniser
|
||||
from unisync.paths import PathsManager
|
||||
from unisync.config import Config
|
||||
|
||||
|
||||
def unisync_sync(synchroniser:Synchroniser, paths_manager:PathsManager, config: Config):
|
||||
del config # The function signature must be the same for all runners
|
||||
if synchroniser.create_ssh_master_connection() != 0:
|
||||
print("Connection failed quitting")
|
||||
return 1
|
||||
|
||||
synchroniser.create_ssh_master_connection()
|
||||
print("Connected to the remote.")
|
||||
|
||||
synchroniser.sync_files(paths_manager.get_paths_to_sync())
|
||||
@@ -24,9 +24,8 @@ def unisync_sync(synchroniser:Synchroniser, paths_manager:PathsManager, config:
|
||||
|
||||
def unisync_add(synchroniser:Synchroniser, paths_manager:PathsManager, config: Config):
|
||||
del config # The function signature must be the same for all runners
|
||||
if synchroniser.create_ssh_master_connection() != 0:
|
||||
print("Connection failed quitting")
|
||||
return 1
|
||||
|
||||
synchroniser.create_ssh_master_connection()
|
||||
print("Connected to the remote.")
|
||||
|
||||
# TODO config or cli to skip this first sync
|
||||
|
||||
+48
-35
@@ -10,7 +10,6 @@ the remote.
|
||||
import subprocess
|
||||
import os
|
||||
import sys
|
||||
import time
|
||||
import logging
|
||||
|
||||
from pathlib import Path
|
||||
@@ -50,26 +49,27 @@ class Synchroniser:
|
||||
"""
|
||||
|
||||
def __init__(self, remote:str, local:str, user:str, ip:str, port:int=22,
|
||||
args_bool:list=[], args_value:dict={}, ssh_settings:dict={},
|
||||
backup:BackupConfig | None = None
|
||||
args_bool:list[str] | None = None, args_value:dict[str, str] | None = None,
|
||||
ssh_settings:dict[str, str] | None = None, backup:BackupConfig | None = None
|
||||
):
|
||||
"""Initialises an instance of Synchroniser.
|
||||
"""
|
||||
self.remote_dir:str = remote
|
||||
self.local:str = local
|
||||
self.args_bool:list[str] = args_bool
|
||||
self.args_value:dict[str, str] = args_value
|
||||
self.ssh_settings:dict[str, str] = dict()
|
||||
self.args_bool:list[str] = args_bool if args_bool is not None else []
|
||||
self.args_value:dict[str, str] = args_value if args_value is not None else {}
|
||||
self.ssh_settings:dict[str, str] = ssh_settings if ssh_settings is not None else {}
|
||||
self.remote_user:str = user
|
||||
self.remote_ip:str = ip
|
||||
self.remote_ip:str = ip
|
||||
self.remote_port:int = port
|
||||
self.files_extra:list = list()
|
||||
self.links_extra:list = list()
|
||||
self.files_extra:list = []
|
||||
self.links_extra:list = []
|
||||
self.control_path:str = ""
|
||||
|
||||
if(backup != None and backup.enabled):
|
||||
if backup is not None and backup.enabled:
|
||||
backup = cast(BackupConfig, backup)
|
||||
self.files_extra.append("-backup")
|
||||
if(backup.selection != ""):
|
||||
if backup.selection != "":
|
||||
self.files_extra.append(backup.selection)
|
||||
else:
|
||||
self.files_extra.append("Name *")
|
||||
@@ -91,8 +91,10 @@ class Synchroniser:
|
||||
"-ignore",
|
||||
f"Name {backup.backupprefix[:-1]}"
|
||||
])
|
||||
|
||||
def create_ssh_master_connection(self, control_path:str="~/.ssh/control_%C", connection_timeout:int=60) -> None:
|
||||
|
||||
def create_ssh_master_connection(self, control_path:str="~/.ssh/control_%C",
|
||||
connection_timeout:int=60
|
||||
) -> None:
|
||||
"""Creates an ssh master connection.
|
||||
|
||||
It is used so the user only has to authenticate once to the remote server.
|
||||
@@ -123,15 +125,15 @@ class Synchroniser:
|
||||
f"{self.remote_user}@{self.remote_ip}",
|
||||
"-p", str(self.remote_port)
|
||||
]
|
||||
master_ssh = subprocess.Popen(command)
|
||||
# TODO: Raise an exception instead of changing the return value
|
||||
try:
|
||||
ret_code = master_ssh.wait(timeout=connection_timeout)
|
||||
except subprocess.TimeoutExpired as e:
|
||||
print("Time to login expired", file=sys.stderr)
|
||||
raise e
|
||||
except KeyboardInterrupt as e:
|
||||
raise e
|
||||
with subprocess.Popen(command) as master_ssh:
|
||||
# TODO: Raise an exception instead of changing the return value
|
||||
try:
|
||||
ret_code = master_ssh.wait(timeout=connection_timeout)
|
||||
except subprocess.TimeoutExpired as e:
|
||||
print("Time to login expired", file=sys.stderr)
|
||||
raise e
|
||||
except KeyboardInterrupt as e:
|
||||
raise e
|
||||
|
||||
if ret_code != 0:
|
||||
print("Login to remote failed", file=sys.stderr)
|
||||
@@ -151,8 +153,10 @@ class Synchroniser:
|
||||
f"{self.remote_user}@{self.remote_ip}",
|
||||
"-p", str(self.remote_port)
|
||||
]
|
||||
close = subprocess.Popen(command)
|
||||
return close.wait()
|
||||
with subprocess.Popen(command) as close:
|
||||
retval = close.wait()
|
||||
|
||||
return retval
|
||||
|
||||
def sync_files(self, paths:list, force:bool=False) -> None:
|
||||
"""Synchronises the files.
|
||||
@@ -190,8 +194,8 @@ class Synchroniser:
|
||||
)
|
||||
|
||||
def sync(self, remote_root:str, local_root:str,
|
||||
paths:list=[], ignore:list=[], force:bool=False,
|
||||
other:list=[]
|
||||
paths:list | None=None, ignore:list | None = None, force:bool=False,
|
||||
other:list | None = None
|
||||
) -> None:
|
||||
"""Performs the synchronisation by calling unison.
|
||||
|
||||
@@ -217,6 +221,13 @@ class Synchroniser:
|
||||
was interrupted.
|
||||
If this happens propagate the error to unisync.
|
||||
"""
|
||||
if paths is None:
|
||||
paths = []
|
||||
if ignore is None:
|
||||
ignore = []
|
||||
if other is None:
|
||||
other = []
|
||||
|
||||
command = [ "/usr/bin/unison", "-root", remote_root, "-root", local_root ]
|
||||
for arg in self.args_bool:
|
||||
command.append(f"-{arg}")
|
||||
@@ -247,8 +258,10 @@ class Synchroniser:
|
||||
for arg in other:
|
||||
command.append(arg)
|
||||
|
||||
proc = subprocess.Popen(command)
|
||||
ret_code = proc.wait()
|
||||
with subprocess.Popen(command) as proc:
|
||||
ret_code = proc.wait()
|
||||
|
||||
# See unison manual section 6.11
|
||||
if ret_code == 3:
|
||||
raise FatalSyncError("Synchronisation could not be completed")
|
||||
|
||||
@@ -279,12 +292,12 @@ class Synchroniser:
|
||||
link_background_wrapper
|
||||
]
|
||||
|
||||
link_update_process = subprocess.run(command, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
|
||||
|
||||
if not background:
|
||||
print("Starting links update.")
|
||||
link_update_process.wait()
|
||||
print("Done")
|
||||
print("Updating links")
|
||||
subprocess.run(command,
|
||||
stdout=subprocess.DEVNULL,
|
||||
stderr=subprocess.DEVNULL,
|
||||
check=False
|
||||
)
|
||||
|
||||
def mount_remote_dir(self):
|
||||
"""Mounts the remote directory to make the local links work.
|
||||
@@ -311,5 +324,5 @@ class Synchroniser:
|
||||
f"{self.remote_user}@{self.remote_ip}:{self.remote_dir}/.data",
|
||||
str(path_to_mount)
|
||||
]
|
||||
completed_process = subprocess.run(command)
|
||||
completed_process = subprocess.run(command, check=True)
|
||||
completed_process.check_returncode()
|
||||
|
||||
Reference in New Issue
Block a user