Handle getpass exception

man/simple_backup.1

@@ -39,7 +39,7 @@ Parameters specified on the command line will override those in the configuratio
 .SH OPTIONS
 .TP
 .B \-h, \-\-help
-Print a short help message and exit
+Print a short help message and exit.
 .TP
 .B \-c, \-\-config FILE
 Specify the configuration file, useful to specify a different one from the default.
@@ -52,21 +52,24 @@ or to use single or double quotes around them.
 .B \-o, \-\-output DIR
 Specify the directory where the files will be copied. The program will automatically
 create a subdirectory called \(aqsimple_backup\(aq (if it does not already exist) and
-inside this directory the actual backup directory (using the current date and time)
+inside this directory the actual backup directory (using the current date and time).
 .TP
 .B \-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
 Specify files, directories or patterns to exclude from the backup. Matching files and directories
-will not be copied. Multiple elements can be specified, in the same way as for the \-\-input option
+will not be copied. Multiple elements can be specified, in the same way as for the \-\-input option.
 .TP
 .B \-k, \-\-keep N
 Specify how many old backups (so excluding the current one) will be kept. The default behavior
-is to keep them all (same as N=\-1)
+is to keep them all (same as N=\-1).
+.TP
+.B \-u, \-\-user USERNAME
+Explicitly specify the user running the backup (in case it is needed for home directory expansion).
 .TP
 .B \-\-ssh\-host HOSTNAME
-Hostname of the server where to copy the files in case of remote backup through SSH
+Hostname of the server where to copy the files in case of remote backup through SSH.
 .TP
 .B \-\-ssh\-user USERNAME
-Username for connecting to the server in case of remote backup
+Username for connecting to the server in case of remote backup.
 .TP
 .B \-\-keyfile FILE
 Location of the SSH key for server authentication. 
@@ -85,7 +88,7 @@ before performing the backup.
 Default behavior is to remove old backups after successfully completing the backup.
 .TP
 .B \-\-no\-syslog
-Don't use systemd journal for logging
+Don't use systemd journal for logging.
 .TP
 .B \-\-rsync\-options OPTIONS [OPTION...]
 By default, the following rsync options are used:
@@ -116,7 +119,7 @@ Run rsync on the remote server with sudo. This is needed if you want to preserve
 .RE
 .TP
 .B \-\-numeric\-ids
-Use rsync \-\-numeric\-ids option. This causes rsync to use numeric uid/gid instead of trying to map uid/gid names from the local machine to the server
+Use rsync \-\-numeric\-ids option. This causes rsync to use numeric uid/gid instead of trying to map uid/gid names from the local machine to the server.
 .SH CONFIGURATION
 An example configuration file is provided at \(aq/usr/share/doc/simple_backup/simple_backup.conf\(aq.
 Copy it to the default location ($HOME/.config/simple_backup) and edit it as needed.
@@ -159,25 +162,25 @@ for details. For this reason, use SSH key authentication if possible.
 .SH EXIT STATUS
 .TP
 .B 0
-The backup was completed without errors
+The backup was completed without errors.
 .TP
 .B 1
-No valid inputs selected for backup
+No valid inputs selected for backup.
 .TP
 .B 2
-Backup failed because output directory for storing the backup does not exist
+Backup failed because output directory for storing the backup does not exist.
 .TP
 .B 3
-Permission denied to access the output directory
+Permission denied to access the output directory.
 .TP
 .B 4
-rsync error (rsync returned a non-zero value)
+rsync error (rsync returned a non-zero value).
 .TP
 .B 5
-SSH connection failed
+SSH connection failed.
 .TP
 .B 6
-Bad configuration file
+Bad configuration file.
 .SH SEE ALSO
 .BR rsync (1)
 .SH AUTHORS

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
@@ -51,15 +51,6 @@ except ImportError:
 
 
 load_dotenv()
-euid = os.geteuid()
-
-if euid == 0:
-    user = os.getenv('SUDO_USER')
-    homedir = os.path.expanduser(f'~{user}')
-else:
-    user = os.getenv('USER')
-    homedir = os.getenv('HOME')
-
 logging.getLogger().setLevel(logging.DEBUG)
 logger = logging.getLogger(os.path.basename(__file__))
 c_handler = StreamHandler()
@@ -144,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
@@ -155,18 +146,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._ssh = None
         self._password_auth = False
         self._password = None
 
-    def check_params(self):
+    def check_params(self, homedir=''):
         """Check if parameters for the backup are valid"""
 
         if self.inputs is None or len(self.inputs) == 0:
@@ -183,10 +174,10 @@ class Backup:
             self._remote = True
 
         if self._remote:
-            self._ssh = self._ssh_connect()
+            self._ssh = self._ssh_connect(homedir)
 
             if self._ssh is None:
-                sys.exit(5)
+                return 5
 
             _, stdout, _ = self._ssh.exec_command(f'if [ -d "{self.output}" ]; then echo "ok"; fi')
 
@@ -315,7 +306,7 @@ class Backup:
             except IndexError:
                 logger.info('No previous backups available')
 
-    def _ssh_connect(self):
+    def _ssh_connect(self, homedir=''):
         try:
             ssh = paramiko.SSHClient()
         except NameError:
@@ -364,6 +355,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)
@@ -418,6 +414,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):
@@ -475,6 +500,8 @@ class Backup:
             rsync = f'/usr/bin/rsync {self.options} --link-dest="{self._last_backup}" --exclude-from=' +\
                     f'{self._exclude_path} --files-from={self._inputs_path} / "{self._server}{self._output_dir}"'
 
+        euid = os.geteuid()
+
         if euid == 0 and self.ssh_keyfile is not None:
             rsync = f'{rsync} -e \'ssh -i {self.ssh_keyfile} -o StrictHostKeyChecking=no\''
         elif self._password_auth and which('sshpass'):
@@ -495,16 +522,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:
+            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()
@@ -535,7 +570,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:
@@ -544,7 +579,7 @@ class Backup:
                     pass
 
                 return 4
-            else:
+
             logger.info('Backup completed')
 
             try:
@@ -556,22 +591,32 @@ class Backup:
 
 
 def _parse_arguments():
+    euid = os.geteuid()
+
+    if euid == 0:
+        user = os.getenv('SUDO_USER')
+    else:
+        user = os.getenv('USER')
+    
+    homedir = os.path.expanduser(f'~{user}')
+
     parser = argparse.ArgumentParser(prog='simple_backup',
                                      description='Simple backup script written in Python that uses rsync to copy files',
                                      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')
     parser.add_argument('-o', '--output', help='Output directory for the backup')
     parser.add_argument('-e', '--exclude', nargs='+', help='Files/directories/patterns to exclude from the backup')
     parser.add_argument('-k', '--keep', type=int, help='Number of old backups to keep')
+    parser.add_argument('-u', '--user', help='Explicitly specify the user running the backup')
+    parser.add_argument('-s', '--checksum', action='store_true', help='Use checksum rsync option to compare files')
     parser.add_argument('--ssh-host', help='Server hostname (for remote backup)')
     parser.add_argument('--ssh-user', help='Username to connect to server (for remote backup)')
     parser.add_argument('--keyfile', help='SSH key location')
-    parser.add_argument('-s', '--checksum', action='store_true',
-                        help='Use checksum rsync option to compare files')
     parser.add_argument('-z', '--compress', action='store_true', help='Compress data during the transfer')
     parser.add_argument('--remove-before-backup', action='store_true',
                         help='Remove old backups before executing the backup, instead of after')
@@ -588,14 +633,20 @@ def _parse_arguments():
     return args
 
 
-def _expand_inputs(inputs):
+def _expand_inputs(inputs, user=None):
     expanded_inputs = []
 
     for i in inputs:
         if i == '':
             continue
 
+        if user is not None:
             i_ex = glob(os.path.expanduser(i.replace('~', f'~{user}')))
+        else:
+            i_ex = glob(i)
+
+            if '~' in i:
+                logger.warning('Cannot expand \'~\'. No user specified')
 
         if len(i_ex) == 0:
             logger.warning('No file or directory matching input %s. Skipping...', i)
@@ -605,7 +656,7 @@ def _expand_inputs(inputs):
     return expanded_inputs
 
 
-def _read_config(config_file):
+def _read_config(config_file, user=None):
     config_args = {'inputs': None,
                    'output': None,
                    'exclude': None,
@@ -634,13 +685,17 @@ def _read_config(config_file):
         inputs = config.get(section, 'inputs')
 
     inputs = inputs.split(',')
-    inputs = _expand_inputs(inputs)
+    inputs = _expand_inputs(inputs, user)
     inputs = list(set(inputs))
 
     config_args['inputs'] = inputs
 
     output = config.get(section, 'backup_dir')
+
+    if user is not None:
         output = os.path.expanduser(output.replace('~', f'~{user}'))
+    elif user is None and '~' in output:
+        logger.warning('Cannot expand \'~\', no user specified')
 
     config_args['output'] = output
 
@@ -694,12 +749,15 @@ def _read_config(config_file):
 
 
 def _notify(text):
-    _euid = os.geteuid()
+    euid = os.geteuid()
 
-    if _euid == 0:
+    if euid == 0:
         uid = os.getenv('SUDO_UID')
     else:
-        uid = os.geteuid()
+        uid = euid
+
+    if uid is None:
+        return
 
     os.seteuid(int(uid))
     os.environ['DBUS_SESSION_BUS_ADDRESS'] = f'unix:path=/run/user/{uid}/bus'
@@ -708,7 +766,7 @@ def _notify(text):
     obj = dbus.Interface(obj, 'org.freedesktop.Notifications')
     obj.Notify('', 0, '', 'simple_backup', text, [], {'urgency': 1}, 10000)
 
-    os.seteuid(int(_euid))
+    os.seteuid(int(euid))
 
 
 def simple_backup():
@@ -716,6 +774,22 @@ def simple_backup():
 
     args = _parse_arguments()
 
+    if args.user:
+        user = args.user
+        homedir = os.path.expanduser(f'~{user}')
+    else:
+        euid = os.geteuid()
+
+        if euid == 0:
+            user = os.getenv('SUDO_USER')
+            homedir = os.path.expanduser(f'~{user}')
+        else:
+            user = os.getenv('USER')
+            homedir = os.getenv('HOME')
+
+    if homedir is None:
+        homedir = ''
+
     if args.no_syslog:
         try:
             logger.removeHandler(j_handler)
@@ -723,10 +797,10 @@ def simple_backup():
             pass
 
     try:
-        config_args = _read_config(args.config)
+        config_args = _read_config(args.config, user)
     except (configparser.NoSectionError, configparser.NoOptionError):
         logger.critical('Bad configuration file')
-        sys.exit(6)
+        return 6
 
     inputs = args.inputs if args.inputs is not None else config_args['inputs']
     output = args.output if args.output is not None else config_args['output']
@@ -735,7 +809,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']
@@ -757,9 +831,9 @@ 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()
+    return_code = backup.check_params(homedir)
 
     if return_code == 0:
         return backup.run()