Version bump

Correctly handle exception when trying to display notification if
dbus-python is not available

.gitignore

@@ -1,2 +1,3 @@
 .idea/
+__pycache__/
 test/

PKGBUILD

@@ -1,48 +0,0 @@
-# PKGBUILD
-
-# Maintainer: Daniele Fucini <dfucini@gmail.com>
-
-pkgname=simple_backup
-pkgver=3.1.2.r1.ga4c4b88
-pkgrel=1
-pkgdesc='Simple backup script that uses rsync to copy files'
-arch=('any')
-url="https://github.com/Fuxino/simple_backup.git"
-license=('GPL3')
-makedepends=('git'
-            'python-setuptools'
-            'python-build'
-            'python-installer'
-            'python-wheel')
-depends=('python'
-         'rsync'
-         'python-dotenv'
-         'python-dbus'
-         'python-systemd')
-install=${pkgname}.install
-source=(git+https://github.com/Fuxino/${pkgname}.git)
-sha256sums=('SKIP')
-
-pkgver() 
-{  
-   cd ${pkgname}
-   git describe --long --tags | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
-}
-
-prepare()
-{
-   git -C ${srcdir}/${pkgname} clean -dfx
-}
-
-build()
-{
-   cd ${srcdir}/${pkgname}
-   python -m build --wheel --no-isolation
-}
-
-package()
-{
-   cd ${srcdir}/${pkgname}
-   python -m installer --destdir=${pkgdir} dist/*.whl
-   install -Dm644 ${srcdir}/${pkgname}/${pkgname}.conf ${pkgdir}/etc/${pkgname}/${pkgname}.conf
-}

README.md

@@ -4,7 +4,8 @@ A simple backup script
 
 ## Description
 simple_backup is a Python script that allows you to backup your files.
-Parameters like input files/directories, output directory etc. can be specified in a configuration file, or on the command line. Run:
+Parameters like input files/directories, output directory etc. can be specified in a configuration file, or on the command line.
+Run:
 
 ```bash
 simple_backup -h
@@ -19,6 +20,10 @@ The script uses rsync to actually run the backup, so you will have to install it
 sudo pacman -Syu rsync
 ```
 
+It's also required to have python-dotenv
+
+Optional dependencies are systemd-python to enable using systemd journal for logging, and dbus-python for desktop notifications.
+
 ## Install
 To install the program, first clone the repository:
 
@@ -26,12 +31,21 @@ To install the program, first clone the repository:
 git clone https://github.com/Fuxino/simple_backup.git
 ```
 
-Then run:
+Then install the tools required to build the package:
+
+```bash
+pip install --upgrade build wheel
+```
+
+Finally, run:
 
 ```bash
 cd simple_backup
 python -m build --wheel
-python -m installer dist/*.whl
+python -m pip install dist/*.whl
+```
 
-For Arch Linux, a PKGBUILD that automates this process is provided.
+For Arch Linux and Arch-based distros, two packages are available in the AUR (aur.archlinux.org):
+- **simple_backup** for the release version
+- **simple_backup-git** for the git version
 

man/simple_backup.1

@@ -0,0 +1,67 @@
+.TH SIMPLE_BACKUP 1 2023-06-01 SIMPLE_BACKUP 3.2.6
+.SH NAME
+simple_backup \- Backup files and folders using rsync
+.SH SYNOPSIS
+.BR simple_backup
+\-h, \-\-help
+.PD 0
+.P
+.PD
+.BR simple_backup
+[\-c, \-\-config FILE]
+[\-i, \-\-input INPUT [INPUT...]]
+[\-o, \-\-output DIR]
+.PD 0
+.P
+.PD
+.RS 14 [\-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
+[\-k, \-\-keep N]
+[\-s, \-\-checksum]
+[\-\-remove\-before\-backup]
+.RE
+.SH DESCRIPTION
+.BR simple_backup
+is a python script for performing backup of files and folders. It uses rsync to copy the files to the specified location.
+Parameters for the backup such as input files/directories, output location and files or folders to exclude can be specified
+in a configuration file (default location $HOME/.config/simple_backup/simple_backup.conf) or directly on the command line.
+Parameters specified on the command line will override those in the configuration file.
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+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.
+.TP
+.B \-i, \-\-input INPUT [INPUT...]
+Specify the files and directories to backup. Multiple inputs can be specified, just separate them with a space.
+If filenames or paths contain spaces, don't forget to escape them, or to use single or double quotes around them.
+.TP
+.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)
+.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
+.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)
+.TP
+.B \-s, \-\-checksums
+Same as rsync option \(aq\-\-checksum\(aq, use checksums instead of mod\-time and size to skip files.
+.TP
+.B \-\-remove\-before\-backup
+Remove old backups (if necessary) before creating the new backup. Useful to free some space before performing the backup.
+Default behavior is to remove old backups after successfully completing the backup.
+.SH CONFIGURATION
+An example configuration file is provided at \(aq/etc/simple_backup/simple_backup.conf\(aq. Copy it to the default location
+($HOME/.config/simple_backup) and edit it as needed.
+.SH SEE ALSO
+.BR rsync (1)
+.SH AUTHORS
+.MT https://github.com/Fuxino
+Daniele Fucini
+.ME

setup.cfg

@@ -25,11 +25,14 @@ packages = simple_backup
 python_requires = >=3.7
 install_requires =
    python-dotenv
-   systemd-python
+
+[options.extras_require]
+JOURNAL =
+    systemd-python
+NOTIFICATIONS =
+    dbus-python
 
 [options.entry_points]
 console_scripts =
-   simple_backup = simple_backup:simple_backup
+   simple_backup = simple_backup.simple_backup:simple_backup
 
-[options.data_files]
-../etc/simple_backup = simple_backup/simple_backup.conf

simple_backup.install

@@ -1,8 +0,0 @@
-post_install() {
-   echo "An example configuration file is found in /etc/simple_backup/simple_backup.conf."
-   echo "Copy it to ~/config/simple_backup/simple_backup.conf and modify it as needed"
-}
-
-post_upgrade() {
-   post_install
-}

simple_backup/__init__.py

@@ -1,3 +1,3 @@
 """Init."""
 
-__version__ = '3.1.2'
+__version__ = '3.2.8'

simple_backup/simple_backup.conf

@@ -1,14 +0,0 @@
-#Example config file for simple_backup
-
-[default]
-#Input directories. Use a comma to separate items
-inputs=/home/my_home,/etc
-
-#Output directory
-backup_dir=/media/Backup
-
-#Exclude patterns. Use a comma to separate items
-exclude=.gvfs,.local/share/gvfs-metadata,.cache,.dbus,.Trash,.local/share/Trash,.macromedia,.adobe,.recently-used,.recently-used.xbel,.thumbnails
-
-#Number of snapshots to keep (use -1 to keep all)
-keep=-1

simple_backup/simple_backup.py

@@ -12,11 +12,15 @@ from timeit import default_timer
 from subprocess import Popen, PIPE, STDOUT
 from datetime import datetime
 from tempfile import mkstemp
-import dbus
 from dotenv import load_dotenv
 
 try:
     from systemd import journal
+except ImportError:
+    journal = None
+
+try:
+    import dbus
 except ImportError:
     pass
 
@@ -25,7 +29,7 @@ load_dotenv()
 euid = os.geteuid()
 
 if euid == 0:
-    user = os.getenv("SUDO_USER")
+    user = os.getenv('SUDO_USER')
     homedir = os.path.expanduser(f'~{user}')
 else:
     homedir = os.getenv('HOME')
@@ -39,14 +43,12 @@ c_format = logging.Formatter('%(name)s - %(levelname)s - %(message)s')
 c_handler.setFormatter(c_format)
 logger.addHandler(c_handler)
 
-try:
+if journal:
     j_handler = journal.JournalHandler()
     j_handler.setLevel(logging.INFO)
     j_format = logging.Formatter('%(levelname)s - %(message)s')
     j_handler.setFormatter(j_format)
     logger.addHandler(j_handler)
-except NameError:
-    pass
 
 
 def timing(_logger):
@@ -74,12 +76,13 @@ class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFo
 
 class Backup:
 
-    def __init__(self, inputs, output, exclude, keep, options):
+    def __init__(self, inputs, output, exclude, keep, options, remove_before=False):
         self.inputs = inputs
         self.output = output
         self.exclude = exclude
         self.options = options
         self.keep = keep
+        self.remove_before = remove_before
         self._last_backup = ''
         self._output_dir = ''
         self._inputs_path = ''
@@ -92,17 +95,6 @@ class Backup:
 
             return False
 
-        for i in self.inputs:
-            if os.path.islink(i):
-                try:
-                    i_new = os.readlink(i)
-                    logger.info(f'Input {i} is a symbolic link referencing {i_new}. Copying {i_new} instead')
-                    self.inputs.remove(i)
-                    self.inputs.append(i_new)
-                except Exception:
-                    logger.warning(f'Input {i} is a link and cannot be read. Skipping')
-                    self.inputs.remove(i)
-
         if self.output is None:
             logger.critical('No output path specified. Use -o argument or specify output path in configuration file')
 
@@ -130,9 +122,7 @@ class Backup:
     def remove_old_backups(self):
         try:
             dirs = os.listdir(f'{self.output}/simple_backup')
-        except Exception:
-            logger.info('No older backups to remove')
-
+        except FileNotFoundError:
             return
 
         if dirs.count('last_backup') > 0:
@@ -149,8 +139,10 @@ class Backup:
                 try:
                     rmtree(f'{self.output}/simple_backup/{dirs[i]}')
                     count += 1
-                except Exception:
-                    logger.error(f'Error while removing backup {dirs[i]}')
+                except FileNotFoundError:
+                    logger.error(f'Error while removing backup {dirs[i]}. Directory not found')
+                except PermissionError:
+                    logger.error(f'Error while removing backup {dirs[i]}. Permission denied')
 
             if count == 1:
                 logger.info(f'Removed {count} backup')
@@ -159,31 +151,28 @@ class Backup:
 
     def find_last_backup(self):
         if os.path.islink(f'{self.output}/simple_backup/last_backup'):
-            try:
-                self._last_backup = os.readlink(f'{self.output}/simple_backup/last_backup')
-            except Exception:
-                logger.warning('Previous backup could not be read')
+            link = os.readlink(f'{self.output}/simple_backup/last_backup')
+
+            if os.path.isdir(link):
+                self._last_backup = link
+            else:
+                logger.info('No previous backups available')
         else:
             logger.info('No previous backups available')
 
-        if not os.path.isdir(self._last_backup):
-            logger.warning('Previous backup could not be read')
-
     # Function to read configuration file
     @timing(logger)
     def run(self):
         logger.info('Starting backup...')
 
+        try:
+            notify('Starting backup...')
+        except NameError:
+            pass
+
         self.create_backup_dir()
         self.find_last_backup()
 
-        if os.path.islink(f'{self.output}/simple_backup/last_backup'):
-            try:
-                os.remove(f'{self.output}/simple_backup/last_backup')
-            except Exception:
-                logger.error('Failed to remove last_backup link')
-                self._err_flag = True
-
         _, self._inputs_path = mkstemp(prefix='tmp_inputs', text=True)
         _, self._exclude_path = mkstemp(prefix='tmp_exclude', text=True)
 
@@ -196,9 +185,13 @@ class Backup:
                     fp.write('\n')
 
         with open(self._exclude_path, 'w') as fp:
-            for e in self.exclude:
-                fp.write(e)
-                fp.write('\n')
+            if self.exclude is not None:
+                for e in self.exclude:
+                    fp.write(e)
+                    fp.write('\n')
+
+        if self.keep != -1 and self.remove_before:
+            self.remove_old_backups()
 
         logger.info('Copying files. This may take a long time...')
 
@@ -214,18 +207,34 @@ class Backup:
         p = Popen(rsync, stdout=PIPE, stderr=STDOUT, shell=True)
         output, _ = p.communicate()
 
+        if p.returncode != 0:
+            self._err_flag = True
+
         output = output.decode("utf-8").split('\n')
 
         logger.info(f'rsync: {output[-3]}')
         logger.info(f'rsync: {output[-2]}')
 
+        if os.path.islink(f'{self.output}/simple_backup/last_backup'):
+            try:
+                os.remove(f'{self.output}/simple_backup/last_backup')
+            except FileNotFoundError:
+                logger.error('Failed to remove last_backup link. File not found')
+                self._err_flag = True
+            except PermissionError:
+                logger.error('Failed to remove last_backup link. Permission denied')
+                self._err_flag = True
+
         try:
-            os.symlink(self._output_dir, f'{self.output}/simple_backup/last_backup')
-        except Exception:
-            logger.error('Failed to create last_backup link')
+            os.symlink(self._output_dir, f'{self.output}/simple_backup/last_backup', target_is_directory=True)
+        except FileExistsError:
+            logger.error('Failed to create last_backup link. Link already exists')
+            self._err_flag = True
+        except PermissionError:
+            logger.error('Failed to create last_backup link. Permission denied')
             self._err_flag = True
 
-        if self.keep != -1:
+        if self.keep != -1 and not self.remove_before:
             self.remove_old_backups()
 
         os.remove(self._inputs_path)
@@ -236,9 +245,15 @@ class Backup:
         if self._err_flag:
             logger.warning('Some errors occurred (check log for details)')
 
-            return 1
-
-        return 0
+            try:
+                notify('Backup finished with errors (check log for details)')
+            except NameError:
+                pass
+        else:
+            try:
+                notify('Backup finished')
+            except NameError:
+                pass
 
 
 def _parse_arguments():
@@ -255,6 +270,8 @@ def _parse_arguments():
     parser.add_argument('-k', '--keep', type=int, help='Number of old backups to keep')
     parser.add_argument('-s', '--checksum', action='store_true',
                         help='Use checksum rsync option to compare files (MUCH SLOWER)')
+    parser.add_argument('--remove-before-backup', action='store_true',
+                        help='Remove old backups before executing the backup, instead of after')
 
     args = parser.parse_args()
 
@@ -280,6 +297,24 @@ def _read_config(config_file):
     return inputs, output, exclude, keep
 
 
+def notify(text):
+    euid = os.geteuid()
+
+    if euid == 0:
+        uid = os.getenv('SUDO_UID')
+    else:
+        uid = os.geteuid()
+
+    os.seteuid(int(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')
+    obj = dbus.Interface(obj, 'org.freedesktop.Notifications')
+    obj.Notify('', 0, '', 'simple_backup', text, [], {'urgency': 1}, 10000)
+
+    os.seteuid(int(euid))
+
+
 def simple_backup():
     args = _parse_arguments()
     inputs, output, exclude, keep = _read_config(args.config)
@@ -301,24 +336,10 @@ def simple_backup():
     else:
         backup_options = '-arvh -H -X'
 
-    backup = Backup(inputs, output, exclude, keep, backup_options)
+    backup = Backup(inputs, output, exclude, keep, backup_options, remove_before=args.remove_before_backup)
 
     if backup.check_params():
-        try:
-            obj = dbus.SessionBus().get_object("org.freedesktop.Notifications", "/org/freedesktop/Notifications")
-            obj = dbus.Interface(obj, "org.freedesktop.Notifications")
-            obj.Notify("simple_backup", 0, "", "Starting backup...", "", [], {"urgency": 1}, 10000)
-        except dbus.exceptions.DBusException:
-            obj = None
-
-        status = backup.run()
-
-        if obj is not None:
-            if status == 0:
-                obj.Notify("simple_backup", 0, "", "Backup finished.", "", [], {"urgency": 1}, 10000)
-            else:
-                obj.Notify("simple_backup", 0, "", "Backup finished. Some errors occurred.",
-                           "", [], {"urgency": 1}, 10000)
+        backup.run()
 
         return 0