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)

README.md

@@ -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.

man/simple_backup.1

@@ -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

setup.cfg

@@ -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
 

simple_backup/__init__.py

@@ -1,3 +1,3 @@
 """Init."""
 
-__version__ = '4.0.0'
+__version__ = '4.1.2'

simple_backup/simple_backup.py

@@ -26,7 +26,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
@@ -135,7 +135,7 @@ class Backup:
     """
 
     def __init__(self, inputs, output, exclude, keep, options, ssh_host=None, ssh_user=None,
-                 ssh_keyfile=None, remote_sudo=False, remove_before=False):
+                 ssh_keyfile=None, remote_sudo=False, remove_before=False, verbose=False):
         self.inputs = inputs
         self.output = output
         self.exclude = exclude
@@ -146,13 +146,13 @@ 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._ssh = None
         self._password_auth = False
         self._password = None
@@ -229,7 +229,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]
 
@@ -355,6 +358,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,6 +417,35 @@ class Backup:
 
         return ssh
 
+    def _returncode_log(self, returncode):
+        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):
@@ -488,16 +525,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()
@@ -528,7 +573,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 +582,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
 
@@ -563,6 +608,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')
@@ -766,7 +812,7 @@ def simple_backup():
     ssh_host = args.ssh_host if args.ssh_host is not None else config_args['ssh_host']
     ssh_user = args.ssh_user if args.ssh_user is not None else config_args['ssh_user']
     ssh_keyfile = args.keyfile if args.keyfile is not None else config_args['ssh_keyfile']
-    remote_sudo = args.remote_sudo if args.remote_sudo is not None else config_args['remote_sudo']
+    remote_sudo = args.remote_sudo or config_args['remote_sudo']
 
     if args.rsync_options is None:
         rsync_options = ['-a', '-r', '-v', '-h', '-H', '-X', '-s', '--ignore-missing-args', '--mkpath']
@@ -788,7 +834,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)