4 Commits
4.1.1 ... 4.1.5

Author SHA1 Message Date
45a07205a1 Add type hints plus minor code fixes 2024-09-28 09:47:33 +02:00
9390cd2de8 Allow removing remote old backups with sudo if possible
If allowed by the remote server, try using sudo to remove
old backups (rm needs to be allowed in sudoers to run
without password)
2023-10-15 15:39:06 +02:00
77661c0964 Handle getpass exception 2023-07-16 08:22:51 +02:00
e3a970217f Improve logging 2023-06-25 11:49:02 +02:00
6 changed files with 117 additions and 61 deletions

View File

@ -68,4 +68,4 @@ sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
or by editing the sudoers file.
If SSH key authentication is not available, password authentication will be used instead.
Check the man page for more details.

View File

@ -93,19 +93,19 @@ Don't use systemd journal for logging.
.B \-\-rsync\-options OPTIONS [OPTION...]
By default, the following rsync options are used:
.RS
.PP
.P
\-a \-r \-v \-h \-s \-H \-X
.PP
.P
Using \-\-rsync\-options it is possible to manually select which options to use. Supported values are the following:
.PP
.P
\-a, \-l, \-p, \-t, \-g, \-o, \-c, \-h, \-D, \-H, \-X, \-s
.PP
.P
Options \-r and \-v are used in any case. Not that options must be specified without dash (\-), for example:
.PP
.P
.EX
simple_backup \-\-rsync\-options a l p
.EE
.TP
.P
Check
.BR rsync (1)
for details about the options.
@ -114,8 +114,12 @@ for details about the options.
.B \-\-remote\-sudo
Run rsync on the remote server with sudo. This is needed if you want to preserve the owner of the files/folders to be copied (rsync \-\-owner option). For this to work the user used to login to the server obviously need to be allowed to use sudo. In addition, the user need to be able to run rsync with sudo without a password. To do this, /etc/sudoers on the server need to be edited adding a line like this one:
.RS
.PP
.P
<username> ALL=NOPASSWD:<path/to/rsync>
.P
To be able to remove old backups generated with \-\-remote\-sudo (see \-\-keep option), also
.BR rm (1)
needs to be allowed to run without password in the same way.
.RE
.TP
.B \-\-numeric\-ids
@ -139,7 +143,7 @@ When running
.B simple_backup
with
.B sudo,
in order to connect to the user\(aq s SSH agent it is necessary to preserve the \(aq SSH_AUTH_SOCK\(aq environment variable, for example:
in order to connect to the user\(aqs SSH agent it is necessary to preserve the \(aqSSH_AUTH_SOCK\(aq environment variable, for example:
.P
.EX
sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
@ -148,8 +152,7 @@ in order to connect to the user\(aq s SSH agent it is necessary to preserve the
It is also possible to make this permanent by editing the
.B sudoers
file (see
.BR sudoers (5)
)
.BR sudoers (5))
.P
If SSH key authentication is not available, password authentication will be used instead.
Note that in this case

View File

@ -13,16 +13,14 @@ classifiers =
License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Natural Language :: English
Operating System :: POSIX :: Linux
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
Programming Language :: Python :: 3.11
Programming Language :: Python :: 3.12
Topic :: System :: Archiving :: Backup
[options]
packages = simple_backup
python_requires = >=3.7
python_requires = >=3.10
install_requires =
python-dotenv

View File

@ -1,3 +1,3 @@
"""Init."""
__version__ = '4.1.1'
__version__ = '4.1.5'

View File

@ -2,7 +2,7 @@
[backup]
# Files and directories to backup. Multiple items can be separated using a comma (','). It is possible to use wildcards (i.e. '*' to match multiple characters and '~' for the user's home directory).
inputs=/home/my_home,/etc
inputs=/home/user
# Output directory.
backup_dir=/media/Backup

View File

@ -14,6 +14,7 @@ Classes:
# Import libraries
import sys
import os
from typing import Callable, List, Optional, ParamSpec, TypeVar, Union
import warnings
from functools import wraps
from shutil import rmtree, which
@ -26,7 +27,7 @@ from timeit import default_timer
from subprocess import Popen, PIPE, STDOUT
from datetime import datetime
from tempfile import mkstemp
from getpass import getpass
from getpass import GetPassWarning, getpass
from glob import glob
from dotenv import load_dotenv
@ -67,29 +68,29 @@ if journal:
j_handler.setFormatter(j_format)
logger.addHandler(j_handler)
P = ParamSpec('P')
R = TypeVar('R')
def timing(_logger):
def timing(func: Callable[P, R]) -> Callable[P, R]:
"""Decorator to measure execution time of a function
Parameters:
_logger: Logger object
func: Function to decorate
"""
def decorator_timing(func):
@wraps(func)
def wrapper_timing(*args, **kwargs):
start = default_timer()
@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
start = default_timer()
value = func(*args, **kwargs)
value = func(*args, **kwargs)
end = default_timer()
end = default_timer()
_logger.info(f'Elapsed time: {end - start:.3f} seconds')
logger.info('Elapsed time: %.3f seconds', end - start)
return value
return value
return wrapper_timing
return decorator_timing
return wrapper
class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
@ -134,8 +135,9 @@ class Backup:
Perform the backup
"""
def __init__(self, inputs, output, exclude, keep, options, ssh_host=None, ssh_user=None,
ssh_keyfile=None, remote_sudo=False, remove_before=False):
def __init__(self, inputs: List[str], output: str, exclude: List[str], keep: int, options: str,
ssh_host: Optional[str] = None, ssh_user: Optional[str] = None, ssh_keyfile: Optional[str] = None,
remote_sudo: bool = False, remove_before: bool = False, verbose: bool = False) -> None:
self.inputs = inputs
self.output = output
self.exclude = exclude
@ -146,18 +148,18 @@ class Backup:
self.ssh_keyfile = ssh_keyfile
self.remote_sudo = remote_sudo
self._remove_before = remove_before
self._verbose = verbose
self._last_backup = ''
self._server = ''
self._output_dir = ''
self._inputs_path = ''
self._exclude_path = ''
self._remote = None
self._err_flag = False
self._remote = False
self._ssh = None
self._password_auth = False
self._password = None
def check_params(self, homedir=''):
def check_params(self, homedir: str = '') -> int:
"""Check if parameters for the backup are valid"""
if self.inputs is None or len(self.inputs) == 0:
@ -201,7 +203,7 @@ class Backup:
return 0
# Function to create the actual backup directory
def define_backup_dir(self):
def define_backup_dir(self) -> None:
"""Define the actual backup dir"""
now = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
self._output_dir = f'{self.output}/simple_backup/{now}'
@ -209,10 +211,12 @@ class Backup:
if self._remote:
self._server = f'{self.ssh_user}@{self.ssh_host}:'
def remove_old_backups(self):
def remove_old_backups(self) -> None:
"""Remove old backups if there are more than indicated by 'keep'"""
if self._remote:
assert self._ssh is not None
_, stdout, _ = self._ssh.exec_command(f'ls {self.output}/simple_backup')
dirs = stdout.read().decode('utf-8').strip().split('\n')
@ -229,7 +233,10 @@ class Backup:
dirs.sort()
for i in range(n_backup - self.keep):
_, _, stderr = self._ssh.exec_command(f'rm -r "{self.output}/simple_backup/{dirs[i]}"')
if self.remote_sudo:
_, _, stderr = self._ssh.exec_command(f'sudo rm -r "{self.output}/simple_backup/{dirs[i]}"')
else:
_, _, stderr = self._ssh.exec_command(f'rm -r "{self.output}/simple_backup/{dirs[i]}"')
err = stderr.read().decode('utf-8').strip().split('\n')[0]
@ -269,7 +276,7 @@ class Backup:
elif count > 1:
logger.info('Removed %d backups', count)
def find_last_backup(self):
def find_last_backup(self) -> None:
"""Get path of last backup (from last_backup symlink) for rsync --link-dest"""
if self._remote:
@ -295,7 +302,7 @@ class Backup:
logger.critical('Cannot access the backup directory. Permission denied')
try:
notify('Backup failed (check log for details)')
_notify('Backup failed (check log for details)')
except NameError:
pass
@ -306,17 +313,18 @@ class Backup:
except IndexError:
logger.info('No previous backups available')
def _ssh_connect(self, homedir=''):
def _ssh_connect(self, homedir: str = '') -> paramiko.client.SSHClient:
try:
ssh = paramiko.SSHClient()
except NameError:
logger.error('Install paramiko for ssh support')
return None
try:
ssh.load_host_keys(filename=f'{homedir}/.ssh/known_hosts')
except FileNotFoundError:
logger.warning(f'Cannot find file {homedir}/.ssh/known_hosts')
logger.warning('Cannot find file %s/.ssh/known_hosts', homedir)
ssh.set_missing_host_key_policy(paramiko.WarningPolicy())
@ -355,6 +363,11 @@ class Backup:
os.environ['SSHPASS'] = password
return ssh
except GetPassWarning as e:
logger.critical('Unable to get password')
logger.critical(e)
return None
except paramiko.SSHException as e:
logger.critical('Can\'t connect to the server.')
logger.critical(e)
@ -409,9 +422,38 @@ class Backup:
return ssh
def _returncode_log(self, returncode: int) -> None:
match returncode:
case 2:
logger.error('Rsync error (return code 2) - Protocol incompatibility')
case 3:
logger.error('Rsync error (return code 3) - Errors selecting input/output files, dirs')
case 4:
logger.error('Rsync error (return code 4) - Requested action not supported')
case 5:
logger.error('Rsync error (return code 5) - Error starting client-server protocol')
case 10:
logger.error('Rsync error (return code 10) - Error in socket I/O')
case 11:
logger.error('Rsync error (return code 11) - Error in file I/O')
case 12:
logger.error('Rsync error (return code 12) - Error in rsync protocol data stream')
case 22:
logger.error('Rsync error (return code 22) - Error allocating core memory buffers')
case 23:
logger.warning('Rsync error (return code 23) - Partial transfer due to error')
case 24:
logger.warning('Rsync error (return code 24) - Partial transfer due to vanished source files')
case 30:
logger.error('Rsync error (return code 30) - Timeout in data send/receive')
case 35:
logger.error('Rsync error (return code 35) - Timeout waiting for daemon connection')
case _:
logger.error('Rsync error (return code %d) - Check rsync(1) for details', returncode)
# Function to read configuration file
@timing(logger)
def run(self):
@timing
def run(self) -> int:
"""Perform the backup"""
logger.info('Starting backup...')
@ -440,7 +482,7 @@ class Backup:
logger.info('No existing files or directories specified for backup. Nothing to do')
try:
notify('Backup finished. No files copied')
_notify('Backup finished. No files copied')
except NameError:
pass
@ -481,6 +523,7 @@ class Backup:
args = shlex.split(rsync)
with Popen(args, stdin=PIPE, stdout=PIPE, stderr=STDOUT, shell=False) as p:
output: Union[bytes, List[str]]
output, _ = p.communicate()
try:
@ -488,16 +531,24 @@ class Backup:
except KeyError:
pass
if p.returncode != 0:
self._err_flag = True
returncode = p.returncode
output = output.decode("utf-8").split('\n')
if self._err_flag:
logger.error('rsync: %s', output)
if returncode == 0:
if self._verbose:
logger.info('rsync: %s', output)
else:
logger.info('rsync: %s', output[-3])
logger.info('rsync: %s', output[-2])
else:
logger.info('rsync: %s', output[-3])
logger.info('rsync: %s', output[-2])
self._returncode_log(returncode)
if self._verbose:
if returncode in [23, 24]:
logger.warning(output)
else:
logger.error(output)
if self.keep != -1 and not self._remove_before:
self.remove_old_backups()
@ -506,6 +557,8 @@ class Backup:
os.remove(self._exclude_path)
if self._remote:
assert self._ssh is not None
_, stdout, _ = self._ssh.exec_command(f'if [ -d "{self._output_dir}" ]; then echo "ok"; fi')
output = stdout.read().decode('utf-8').strip()
@ -528,7 +581,7 @@ class Backup:
if self._ssh:
self._ssh.close()
else:
if self._err_flag:
if returncode != 0:
logger.error('Some errors occurred while performing the backup')
try:
@ -537,13 +590,13 @@ class Backup:
pass
return 4
else:
logger.info('Backup completed')
try:
_notify('Backup completed')
except NameError:
pass
logger.info('Backup completed')
try:
_notify('Backup completed')
except NameError:
pass
return 0
@ -555,7 +608,7 @@ def _parse_arguments():
user = os.getenv('SUDO_USER')
else:
user = os.getenv('USER')
homedir = os.path.expanduser(f'~{user}')
parser = argparse.ArgumentParser(prog='simple_backup',
@ -563,6 +616,7 @@ def _parse_arguments():
epilog='See simple_backup(1) manpage for full documentation',
formatter_class=MyFormatter)
parser.add_argument('-v', '--verbose', action='store_true', help='More verbose output')
parser.add_argument('-c', '--config', default=f'{homedir}/.config/simple_backup/simple_backup.conf',
help='Specify location of configuration file')
parser.add_argument('-i', '--inputs', nargs='+', help='Paths/files to backup')
@ -757,6 +811,7 @@ def simple_backup():
config_args = _read_config(args.config, user)
except (configparser.NoSectionError, configparser.NoOptionError):
logger.critical('Bad configuration file')
return 6
inputs = args.inputs if args.inputs is not None else config_args['inputs']
@ -788,7 +843,7 @@ def simple_backup():
rsync_options = ' '.join(rsync_options)
backup = Backup(inputs, output, exclude, keep, rsync_options, ssh_host, ssh_user, ssh_keyfile,
remote_sudo, remove_before=args.remove_before_backup)
remote_sudo, remove_before=args.remove_before_backup, verbose=args.verbose)
return_code = backup.check_params(homedir)