Add manual selection of rsync options

Check that the inputs specified on the command line (i.e. with the
option '-i' or '--input') exist and print a warning when they don't.
If no valid inputs are found, exit.

.gitignore

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

PKGBUILD

@@ -1,47 +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')
-optdepends=('python-systemd: use systemd log')
-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

@@ -20,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:
 
@@ -27,21 +31,21 @@ To install the program, first clone the repository:
 git clone https://github.com/Fuxino/simple_backup.git
 ```
 
-Install tools required to build and install the package:
+Then install the tools required to build the package:
 
 ```bash
-pip install --upgrade build installer wheel
+pip install --upgrade build wheel
 ```
 
-Then run:
+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.
-
-After installing, copy simple_backup.conf (if you used the PKGBUILD on Arch, it will be in /etc/simple_backup/) to $HOME/.config/simple_backup and edit is as needed.
+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,105 @@
+.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.
+.TP
+.B \-\-no\-syslog
+Don't use systemd journal for logging
+.TP
+.B \-\-rsync\-options OPTIONS [OPTION...]
+By default, the following rsync options are used:
+.RS
+.PP
+\-a \-r \-c \-v \-h \-H \-X
+.PP
+Using \-\-rsync\-options it is possible to manually select which options to use. Supported values are the following:
+.PP
+\-a, \-l, \-p, \-t, \-g, \-o, \-c, \-h, \-D, \-H, \-X
+.PP
+Options \-r and \-v are used in any case. Not that options must be specified without dash (\-), for example:
+.PP
+.EX
+simple_backup \-\-rsync\-options a l p
+.EE
+.TP
+Check rsync(1) for details about the options.
+.RE
+.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 EXIT STATUS
+.TP
+.B 0
+The backup was completed without errors
+.TP
+.B 1
+No valid inputs selected for backup
+.TP
+.B 2
+Backup failed because output directory for storing the backup does not exist
+.TP
+.B 3
+Permission denied to access the output directory
+.TP
+.B 4
+rsync error (rsync returned a non-zero value)
+.SH SEE ALSO
+.BR rsync (1)
+.SH AUTHORS
+.MT https://github.com/Fuxino
+Daniele Fucini
+.ME

setup.cfg

@@ -25,7 +25,12 @@ packages = simple_backup
 python_requires = >=3.7
 install_requires =
    python-dotenv
+
+[options.extras_require]
+JOURNAL =
     systemd-python
+NOTIFICATIONS =
+    dbus-python
 
 [options.entry_points]
 console_scripts =

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.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.2.2'
+__version__ = '3.5.0'

simple_backup/simple_backup.conf

@@ -1,14 +1,14 @@
 # Example config file for simple_backup
 
 [default]
-#Input directories. Use a comma to separate items
+# 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
 
-#Output directory
+# 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
+# Files, directories and patterns to exclude from the backup. Multiple items can be separated using a comma.
+exclude=*.bak
 
-#Number of snapshots to keep (use -1 to keep all)
+# Number of old backups (i.e. excluding the one that's being created) to keep (use -1 to keep all)
 keep=-1

simple_backup/simple_backup.py

@@ -1,6 +1,7 @@
 #!/usr/bin/python3
 
 # Import libraries
+import sys
 import os
 from functools import wraps
 from shutil import rmtree
@@ -12,6 +13,8 @@ from timeit import default_timer
 from subprocess import Popen, PIPE, STDOUT
 from datetime import datetime
 from tempfile import mkstemp
+from glob import glob
+
 from dotenv import load_dotenv
 
 try:
@@ -19,14 +22,20 @@ try:
 except ImportError:
     journal = None
 
+try:
+    import dbus
+except ImportError:
+    pass
+
 
 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:
+    user = os.getenv('USER')
     homedir = os.getenv('HOME')
 
 logging.getLogger().setLevel(logging.DEBUG)
@@ -71,12 +80,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 = ''
@@ -85,26 +95,26 @@ class Backup:
 
     def check_params(self):
         if self.inputs is None or len(self.inputs) == 0:
-            logger.info('No files or directory specified for backup.')
+            logger.info('No existing files or directories specified for backup. Nothing to do')
 
-            return False
+            return 1
 
         if self.output is None:
             logger.critical('No output path specified. Use -o argument or specify output path in configuration file')
 
-            return False
+            return 2
 
         if not os.path.isdir(self.output):
             logger.critical('Output path for backup does not exist')
 
-            return False
+            return 2
 
         self.output = os.path.abspath(self.output)
 
         if self.keep is None:
             self.keep = -1
 
-        return True
+        return 0
 
     # Function to create the actual backup directory
     def create_backup_dir(self):
@@ -119,9 +129,6 @@ class Backup:
         except FileNotFoundError:
             return
 
-        if dirs.count('last_backup') > 0:
-            dirs.remove('last_backup')
-
         n_backup = len(dirs) - 1
         count = 0
 
@@ -144,14 +151,25 @@ class Backup:
                 logger.info(f'Removed {count} backups')
 
     def find_last_backup(self):
-        if os.path.islink(f'{self.output}/simple_backup/last_backup'):
-            link = os.readlink(f'{self.output}/simple_backup/last_backup')
-
-            if os.path.isdir(link):
-                self._last_backup = link
-            else:
+        try:
+            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')
-        else:
+
+            return
+        except PermissionError:
+            logger.critical('Cannot access the backup directory. Permission denied')
+
+            try:
+                notify('Backup failed (check log for details)')
+            except NameError:
+                pass
+
+            sys.exit(3)
+
+        try:
+            self._last_backup = dirs[-1]
+        except IndexError:
             logger.info('No previous backups available')
 
     # Function to read configuration file
@@ -159,21 +177,16 @@ class Backup:
     def run(self):
         logger.info('Starting backup...')
 
-        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 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
+            notify('Starting backup...')
+        except NameError:
+            pass
+
+        self.find_last_backup()
+        self.create_backup_dir()
 
         _, self._inputs_path = mkstemp(prefix='tmp_inputs', text=True)
-        _, self._exclude_path = mkstemp(prefix='tmp_exclude', text=True)
+        count = 0
 
         with open(self._inputs_path, 'w') as fp:
             for i in self.inputs:
@@ -182,12 +195,29 @@ class Backup:
                 else:
                     fp.write(i)
                     fp.write('\n')
+                    count += 1
+
+        if count == 0:
+            logger.info('No existing files or directories specified for backup. Nothing to do')
+
+            try:
+                notify('Backup finished. No files copied')
+            except NameError:
+                pass
+
+            return 1
+
+        _, self._exclude_path = mkstemp(prefix='tmp_exclude', text=True)
 
         with open(self._exclude_path, 'w') as fp:
+            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...')
 
         if self._last_backup == '':
@@ -202,21 +232,15 @@ 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]}')
 
-        try:
-            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)
@@ -227,6 +251,20 @@ class Backup:
         if self._err_flag:
             logger.warning('Some errors occurred (check log for details)')
 
+            try:
+                notify('Backup finished with errors (check log for details)')
+            except NameError:
+                pass
+
+            return 4
+        else:
+            try:
+                notify('Backup finished')
+            except NameError:
+                pass
+
+            return 0
+
 
 def _parse_arguments():
     parser = argparse.ArgumentParser(prog='simple_backup',
@@ -242,12 +280,35 @@ 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')
+    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', 'D', 'H', 'X'],
+                        help='Specify options for rsync')
 
     args = parser.parse_args()
 
     return args
 
 
+def _expand_inputs(inputs):
+    expanded_inputs = []
+
+    for i in inputs:
+        if i == '':
+            continue
+
+        i_ex = glob(os.path.expanduser(i.replace('~', f'~{user}')))
+
+        if len(i_ex) == 0:
+            logger.warning(f'No file or directory matching input {i}. Skipping...')
+        else:
+            expanded_inputs.extend(i_ex)
+
+    return expanded_inputs
+
+
 def _read_config(config_file):
     if not os.path.isfile(config_file):
         logger.warning(f'Config file {config_file} does not exist')
@@ -259,7 +320,10 @@ def _read_config(config_file):
 
     inputs = config.get('default', 'inputs')
     inputs = inputs.split(',')
+    inputs = _expand_inputs(inputs)
+    inputs = list(set(inputs))
     output = config.get('default', 'backup_dir')
+    output = os.path.expanduser(output.replace('~', f'~{user}'))
     exclude = config.get('default', 'exclude')
     exclude = exclude.split(',')
     keep = config.getint('default', 'keep')
@@ -267,8 +331,33 @@ 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()
+
+    if args.no_syslog:
+        try:
+            logger.removeHandler(j_handler)
+        except NameError:
+            pass
+
     inputs, output, exclude, keep = _read_config(args.config)
 
     if args.input is not None:
@@ -283,19 +372,28 @@ def simple_backup():
     if args.keep is not None:
         keep = args.keep
 
+    if args.rsync_options is None:
         if args.checksum:
-        backup_options = '-arcvh -H -X'
+            rsync_options = '-arcvh -H -X'
         else:
-        backup_options = '-arvh -H -X'
+            rsync_options = '-arvh -H -X'
+    else:
+        rsync_options = '-r -v '
 
-    backup = Backup(inputs, output, exclude, keep, backup_options)
+        for ro in args.rsync_options:
+            rsync_options = rsync_options + f'-{ro} '
 
-    if backup.check_params():
-        backup.run()
+        if '-c ' not in rsync_options and args.checksum:
+            rsync_options = rsync_options + '-c'
 
-        return 0
+    backup = Backup(inputs, output, exclude, keep, rsync_options, remove_before=args.remove_before_backup)
 
-    return 1
+    return_code = backup.check_params()
+
+    if return_code == 0:
+        return backup.run()
+
+    return return_code
 
 
 if __name__ == '__main__':