Fix notifications when using doas

PKGBUILD

@@ -4,9 +4,9 @@
 
 pkgname=simple_backup
 pkgdesc='Simple backup script that uses rsync to copy files'
-pkgver=4.1.5
+pkgver=4.1.6
 pkgrel=1
-url="https://github.com/Fuxino/${pkgname}"
+url="https://git.shouldnt.work/fuxino/${pkgname}"
 arch=('any')
 license=('GPL-3.0-or-later')
 makedepends=('git'
@@ -23,7 +23,7 @@ optdepends=('python-systemd: use systemd log'
 conflicts=('simple_backup-git')
 source=(git+${url}?signed#tag=${pkgver})
 validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
-sha256sums=('4da838282fff813f82ee0408996c989078a206eabce07112b4e3ee8b057e34cf')
+sha256sums=('b3b29d9e2e1b7b949e95674d9a401e8eeb0d5f898e8450473dce94f799ee9df3')
 
 build()
 {

man/simple_backup.1

@@ -1,4 +1,4 @@
-.TH SIMPLE_BACKUP 1 2023-06-15 SIMPLE_BACKUP 3.2.6
+.TH SIMPLE_BACKUP 1 2025-03-30 SIMPLE_BACKUP 4.1.6
 .SH NAME
 simple_backup \- Backup files and folders using rsync
 .SH SYNOPSIS
@@ -187,6 +187,6 @@ Bad configuration file.
 .SH SEE ALSO
 .BR rsync (1)
 .SH AUTHORS
-.MT https://github.com/Fuxino
+.MT https://git.shouldnt.work/fuxino
 Daniele Fucini
 .ME

setup.cfg

@@ -6,7 +6,7 @@ long_description = file: README.md
 author = Daniele Fucini
 author_email = dfucini@gmail.com
 license = GPL3
-url = https://github.com/Fuxino/simple_backup
+url = https://git.shouldnt.work/fuxino
 classifiers =
    Development Status :: 4 - Beta
    Environment :: Console
@@ -16,6 +16,7 @@ classifiers =
    Programming Language :: Python :: 3.10
    Programming Language :: Python :: 3.11
    Programming Language :: Python :: 3.12
+   Programming Language :: Python :: 3.13
    Topic :: System :: Archiving :: Backup
 
 [options]

simple_backup/__init__.py

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

simple_backup/simple_backup.py

@@ -12,8 +12,10 @@ Classes:
 """
 
 # Import libraries
+import traceback
 import sys
 import os
+import pwd
 from typing import Callable, List, Optional, ParamSpec, TypeVar, Union
 import warnings
 from functools import wraps
@@ -163,12 +165,14 @@ class Backup:
         """Check if parameters for the backup are valid"""
 
         if self.inputs is None or len(self.inputs) == 0:
-            logger.info('No existing files or directories specified for backup. Nothing to do')
+            logger.info(
+                'No existing files or directories specified for backup. Nothing to do')
 
             return 1
 
         if self.output is None:
-            logger.critical('No output path specified. Use -o argument or specify output path in configuration file')
+            logger.critical(
+                'No output path specified. Use -o argument or specify output path in configuration file')
 
             return 2
 
@@ -181,7 +185,8 @@ class Backup:
             if self._ssh is None:
                 return 5
 
-            _, stdout, _ = self._ssh.exec_command(f'if [ -d "{self.output}" ]; then echo "ok"; fi')
+            _, stdout, _ = self._ssh.exec_command(
+                f'if [ -d "{self.output}" ]; then echo "ok"; fi')
 
             output = stdout.read().decode('utf-8').strip()
 
@@ -217,7 +222,8 @@ class Backup:
         if self._remote:
             assert self._ssh is not None
 
-            _, stdout, _ = self._ssh.exec_command(f'ls {self.output}/simple_backup')
+            _, stdout, _ = self._ssh.exec_command(
+                f'ls {self.output}/simple_backup')
 
             dirs = stdout.read().decode('utf-8').strip().split('\n')
 
@@ -234,14 +240,17 @@ class Backup:
 
                 for i in range(n_backup - self.keep):
                     if self.remote_sudo:
-                        _, _, stderr = self._ssh.exec_command(f'sudo rm -r "{self.output}/simple_backup/{dirs[i]}"')
+                        _, _, 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]}"')
+                        _, _, stderr = self._ssh.exec_command(
+                            f'rm -r "{self.output}/simple_backup/{dirs[i]}"')
 
                     err = stderr.read().decode('utf-8').strip().split('\n')[0]
 
                     if err != '':
-                        logger.error('Error while removing backup %s.', {dirs[i]})
+                        logger.error(
+                            'Error while removing backup %s.', {dirs[i]})
                         logger.error(err)
                     else:
                         count += 1
@@ -267,9 +276,11 @@ class Backup:
                         rmtree(f'{self.output}/simple_backup/{dirs[i]}')
                         count += 1
                     except FileNotFoundError:
-                        logger.error('Error while removing backup %s. Directory not found', dirs[i])
+                        logger.error(
+                            'Error while removing backup %s. Directory not found', dirs[i])
                     except PermissionError:
-                        logger.error('Error while removing backup %s. Permission denied', dirs[i])
+                        logger.error(
+                            'Error while removing backup %s. Permission denied', dirs[i])
 
         if count == 1:
             logger.info('Removed %d backup', count)
@@ -284,7 +295,8 @@ class Backup:
                 logger.critical('SSH connection to server failed')
                 sys.exit(5)
 
-            _, stdout, _ = self._ssh.exec_command(f'find {self.output}/simple_backup/ -mindepth 1 -maxdepth 1 -type d | sort')
+            _, stdout, _ = self._ssh.exec_command(
+                f'find {self.output}/simple_backup/ -mindepth 1 -maxdepth 1 -type d | sort')
             output = stdout.read().decode('utf-8').strip().split('\n')
 
             if output[-1] != '':
@@ -293,13 +305,15 @@ class Backup:
                 logger.info('No previous backups available')
         else:
             try:
-                dirs = sorted([f.path for f in os.scandir(f'{self.output}/simple_backup') if f.is_dir(follow_symlinks=False)])
+                dirs = sorted([f.path for f in os.scandir(
+                    f'{self.output}/simple_backup') if f.is_dir(follow_symlinks=False)])
             except FileNotFoundError:
                 logger.info('No previous backups available')
 
                 return
             except PermissionError:
-                logger.critical('Cannot access the backup directory. Permission denied')
+                logger.critical(
+                    'Cannot access the backup directory. Permission denied')
 
                 try:
                     _notify('Backup failed (check log for details)')
@@ -333,7 +347,8 @@ class Backup:
 
             return ssh
         except UserWarning:
-            k = input(f'Unknown key for host {self.ssh_host}. Continue anyway? (Y/N) ')
+            k = input(
+                f'Unknown key for host {self.ssh_host}. Continue anyway? (Y/N) ')
 
             if k[0].upper() == 'Y':
                 ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
@@ -356,8 +371,10 @@ class Backup:
 
         if self.ssh_keyfile is None:
             try:
-                password = getpass(f'{self.ssh_user}@{self.ssh_host}\'s password: ')
+                password = getpass(
-                ssh.connect(self.ssh_host, username=self.ssh_user, password=password)
+                    f'{self.ssh_user}@{self.ssh_host}\'s password: ')
+                ssh.connect(self.ssh_host, username=self.ssh_user,
+                            password=password)
 
                 self._password_auth = True
                 os.environ['SSHPASS'] = password
@@ -379,7 +396,8 @@ class Backup:
         try:
             pkey = RSAKey.from_private_key_file(self.ssh_keyfile)
         except paramiko.PasswordRequiredException:
-            password = getpass(f'Enter passwphrase for key \'{self.ssh_keyfile}\': ')
+            password = getpass(
+                f'Enter passwphrase for key \'{self.ssh_keyfile}\': ')
 
             try:
                 pkey = RSAKey.from_private_key_file(self.ssh_keyfile, password)
@@ -391,7 +409,8 @@ class Backup:
                 pkey = Ed25519Key.from_private_key_file(self.ssh_keyfile)
             except paramiko.PasswordRequiredException:
                 try:
-                    pkey = Ed25519Key.from_private_key_file(self.ssh_keyfile, password)
+                    pkey = Ed25519Key.from_private_key_file(
+                        self.ssh_keyfile, password)
                 except paramiko.SSHException:
                     pass
 
@@ -400,7 +419,8 @@ class Backup:
                 pkey = ECDSAKey.from_private_key_file(self.ssh_keyfile)
             except paramiko.PasswordRequiredException:
                 try:
-                    pkey = ECDSAKey.from_private_key_file(self.ssh_keyfile, password)
+                    pkey = ECDSAKey.from_private_key_file(
+                        self.ssh_keyfile, password)
                 except paramiko.SSHException:
                     pass
 
@@ -409,7 +429,8 @@ class Backup:
                 pkey = DSSKey.from_private_key_file(self.ssh_keyfile)
             except paramiko.PasswordRequiredException:
                 try:
-                    pkey = DSSKey.from_private_key_file(self.ssh_keyfile, password)
+                    pkey = DSSKey.from_private_key_file(
+                        self.ssh_keyfile, password)
                 except paramiko.SSHException:
                     pass
 
@@ -425,31 +446,44 @@ class Backup:
     def _returncode_log(self, returncode: int) -> None:
         match returncode:
             case 2:
-                logger.error('Rsync error (return code 2) - Protocol incompatibility')
+                logger.error(
+                    'Rsync error (return code 2) - Protocol incompatibility')
             case 3:
-                logger.error('Rsync error (return code 3) - Errors selecting input/output files, dirs')
+                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')
+                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')
+                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')
+                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')
+                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')
+                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')
+                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')
+                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')
+                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')
+                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')
+                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)
+                logger.error(
+                    'Rsync error (return code %d) - Check rsync(1) for details', returncode)
 
     # Function to read configuration file
     @timing
@@ -479,7 +513,8 @@ class Backup:
                     count += 1
 
         if count == 0:
-            logger.info('No existing files or directories specified for backup. Nothing to do')
+            logger.info(
+                'No existing files or directories specified for backup. Nothing to do')
 
             try:
                 _notify('Backup finished. No files copied')
@@ -503,10 +538,10 @@ class Backup:
 
         if self._last_backup == '':
             rsync = f'/usr/bin/rsync {self.options} --exclude-from={self._exclude_path} ' +\
-                    f'--files-from={self._inputs_path} / "{self._server}{self._output_dir}"'
+                f'--files-from={self._inputs_path} / "{self._server}{self._output_dir}"'
         else:
             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}"'
+                f'{self._exclude_path} --files-from={self._inputs_path} / "{self._server}{self._output_dir}"'
 
         euid = os.geteuid()
 
@@ -559,7 +594,8 @@ class Backup:
         if self._remote:
             assert self._ssh is not None
 
-            _, stdout, _ = self._ssh.exec_command(f'if [ -d "{self._output_dir}" ]; then echo "ok"; fi')
+            _, stdout, _ = self._ssh.exec_command(
+                f'if [ -d "{self._output_dir}" ]; then echo "ok"; fi')
 
             output = stdout.read().decode('utf-8').strip()
 
@@ -582,10 +618,12 @@ class Backup:
                 self._ssh.close()
         else:
             if returncode != 0:
-                logger.error('Some errors occurred while performing the backup')
+                logger.error(
+                    'Some errors occurred while performing the backup')
 
                 try:
-                    _notify('Some errors occurred while performing the backup. Check log for details')
+                    _notify(
+                        'Some errors occurred while performing the backup. Check log for details')
                 except NameError:
                     pass
 
@@ -601,7 +639,7 @@ class Backup:
             return 0
 
 
-def _parse_arguments():
+def _parse_arguments() -> argparse.Namespace:
     euid = os.geteuid()
 
     if euid == 0:
@@ -616,26 +654,39 @@ 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('-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('-i', '--inputs', nargs='+',
-    parser.add_argument('-o', '--output', help='Output directory for the backup')
+                        help='Paths/files to backup')
-    parser.add_argument('-e', '--exclude', nargs='+', help='Files/directories/patterns to exclude from the backup')
+    parser.add_argument(
-    parser.add_argument('-k', '--keep', type=int, help='Number of old backups to keep')
+        '-o', '--output', help='Output directory for the backup')
-    parser.add_argument('-u', '--user', help='Explicitly specify the user running the backup')
+    parser.add_argument('-e', '--exclude', nargs='+',
-    parser.add_argument('-s', '--checksum', action='store_true', help='Use checksum rsync option to compare files')
+                        help='Files/directories/patterns to exclude from the backup')
-    parser.add_argument('--ssh-host', help='Server hostname (for remote backup)')
+    parser.add_argument('-k', '--keep', type=int,
-    parser.add_argument('--ssh-user', help='Username to connect to server (for remote backup)')
+                        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('-z', '--compress', action='store_true', help='Compress data during the transfer')
+    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')
-    parser.add_argument('--no-syslog', action='store_true', help='Disable systemd journal logging')
+    parser.add_argument('--no-syslog', action='store_true',
+                        help='Disable systemd journal logging')
     parser.add_argument('--rsync-options', nargs='+',
-                        choices=['a', 'l', 'p', 't', 'g', 'o', 'c', 'h', 's', 'D', 'H', 'X'],
+                        choices=['a', 'l', 'p', 't', 'g', 'o',
+                                 'c', 'h', 's', 'D', 'H', 'X'],
                         help='Specify options for rsync')
-    parser.add_argument('--remote-sudo', action='store_true', help='Run rsync on remote server with sudo if allowed')
+    parser.add_argument('--remote-sudo', action='store_true',
+                        help='Run rsync on remote server with sudo if allowed')
     parser.add_argument('--numeric-ids', action='store_true',
                         help='Use rsync \'--numeric-ids\' option (don\'t map uid/gid values by name)')
 
@@ -644,7 +695,7 @@ def _parse_arguments():
     return args
 
 
-def _expand_inputs(inputs, user=None):
+def _expand_inputs(inputs, user: Optional[str] = None):
     expanded_inputs = []
 
     for i in inputs:
@@ -660,14 +711,15 @@ def _expand_inputs(inputs, user=None):
                 logger.warning('Cannot expand \'~\'. No user specified')
 
         if len(i_ex) == 0:
-            logger.warning('No file or directory matching input %s. Skipping...', i)
+            logger.warning(
+                'No file or directory matching input %s. Skipping...', i)
         else:
             expanded_inputs.extend(i_ex)
 
     return expanded_inputs
 
 
-def _read_config(config_file, user=None):
+def _read_config(config_file, user: Optional[str] = None):
     config_args = {'inputs': None,
                    'output': None,
                    'exclude': None,
@@ -679,7 +731,11 @@ def _read_config(config_file, user=None):
                    'numeric_ids': False}
 
     if not os.path.isfile(config_file):
-        logger.warning('Config file %s does not exist', config_file)
+        if user is not None:
+            logger.warning('Config file %s does not exist', config_file)
+        else:
+            logger.warning(
+                'User not specified. Can\'t read configuration file')
 
         return config_args
 
@@ -759,28 +815,49 @@ def _read_config(config_file, user=None):
     return config_args
 
 
-def _notify(text):
+def _target_uid() -> int | None:
     euid = os.geteuid()
 
-    if euid == 0:
+    if euid != 0:
-        uid = os.getenv('SUDO_UID')
+        return euid
-    else:
+
-        uid = euid
+    if (val := os.getenv('SUDO_UID')) is not None:
+        return int(val)
+
+    if (name := os.getenv('DOAS_USER')) is not None:
+        try:
+            return pwd.getpwnam(name).pw_uid
+        except KeyError:
+            return None
+
+    return None
+
+
+def _notify(text: str) -> None:
+    euid = os.geteuid()
+    uid = _target_uid()
 
     if uid is None:
+        print('notify: no target uid (neither SUDO_UID nor DOAS_USER set)', file=sys.stderr)
+
         return
 
-    os.seteuid(int(uid))
+    os.seteuid(uid)
-    os.environ['DBUS_SESSION_BUS_ADDRESS'] = f'unix:path=/run/user/{uid}/bus'
 
-    obj = dbus.SessionBus().get_object('org.freedesktop.Notifications', '/org/freedesktop/Notifications')
+    try:
-    obj = dbus.Interface(obj, 'org.freedesktop.Notifications')
+        os.environ['DBUS_SESSION_BUS_ADDRESS'] = f'unix:path=/run/user/{uid}/bus'
-    obj.Notify('', 0, '', 'simple_backup', text, [], {'urgency': 1}, 10000)
 
-    os.seteuid(int(euid))
+        obj = dbus.SessionBus().get_object('org.freedesktop.Notifications',
+                                           '/org/freedesktop/Notifications')
+        obj = dbus.Interface(obj, 'org.freedesktop.Notifications')
+        obj.Notify('simple_backup', 0, '', 'simple_backup', text, [], {'urgency': dbus.Byte(1)}, 10000)
+    except Exception:
+        traceback.print_exc()
+    finally:
+        os.seteuid(euid)
 
 
-def simple_backup():
+def simple_backup() -> int:
     """Main"""
 
     args = _parse_arguments()
@@ -793,7 +870,13 @@ def simple_backup():
 
         if euid == 0:
             user = os.getenv('SUDO_USER')
-            homedir = os.path.expanduser(f'~{user}')
+
+            if user is not None:
+                homedir = os.path.expanduser(f'~{user}')
+            else:
+                logger.warning(
+                    'Failed to detect user. You can use -u/--user parameter to manually specify it')
+                homedir = None
         else:
             user = os.getenv('USER')
             homedir = os.getenv('HOME')
@@ -824,7 +907,8 @@ def simple_backup():
     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']
+        rsync_options = ['-a', '-r', '-v', '-h', '-H',
+                         '-X', '-s', '--ignore-missing-args', '--mkpath']
     else:
         rsync_options = ['-r', '-v']