Version bump

Allow using wildcards (i.e. * to match any character and ~ to match the
user's home directory) in inputs and ouput variables in config file

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,23 +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 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
 
-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.
-

man/simple_backup.1

@@ -56,9 +56,28 @@ Same as rsync option \(aq\-\-checksum\(aq, use checksums instead of mod\-time an
 .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
 .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

setup.cfg

@@ -25,7 +25,12 @@ 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.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.7'
+__version__ = '3.4.0'

simple_backup/simple_backup.conf

@@ -0,0 +1,14 @@
+# Example config file for simple_backup
+
+[default]
+# 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.
+backup_dir=/media/Backup
+
+# Files, directories and patterns to exclude from the backup. Multiple items can be separated using a comma.
+exclude=*.bak
+
+# 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:
@@ -32,6 +35,7 @@ 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)
@@ -91,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):
@@ -125,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
 
@@ -150,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'):
+        try:
-            link = os.readlink(f'{self.output}/simple_backup/last_backup')
+            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')
 
-            if os.path.isdir(link):
+            return
-                self._last_backup = link
+        except PermissionError:
-            else:
+            logger.critical('Cannot access the backup directory. Permission denied')
-                logger.info('No previous backups available')
+
-        else:
+            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
@@ -170,19 +182,16 @@ class Backup:
         except NameError:
             pass
 
-        self.create_backup_dir()
         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)
 
         with open(self._inputs_path, 'w') as fp:
             for i in self.inputs:
-                if not os.path.exists(i):
+                fp.write(i)
-                    logger.warning(f'Input {i} not found. Skipping')
+                fp.write('\n')
-                else:
-                    fp.write(i)
-                    fp.write('\n')
 
         with open(self._exclude_path, 'w') as fp:
             if self.exclude is not None:
@@ -215,25 +224,6 @@ class Backup:
         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', 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 and not self.remove_before:
             self.remove_old_backups()
 
@@ -249,8 +239,15 @@ class Backup:
                 notify('Backup finished with errors (check log for details)')
             except NameError:
                 pass
+
+            return 4
         else:
-            notify('Backup finished')
+            try:
+                notify('Backup finished')
+            except NameError:
+                pass
+
+            return 0
 
 
 def _parse_arguments():
@@ -269,12 +266,30 @@ def _parse_arguments():
                         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')
 
     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')
@@ -286,7 +301,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')
@@ -314,6 +332,13 @@ def notify(text):
 
 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:
@@ -335,12 +360,12 @@ def simple_backup():
 
     backup = Backup(inputs, output, exclude, keep, backup_options, remove_before=args.remove_before_backup)
 
-    if backup.check_params():
+    return_code = backup.check_params()
-        backup.run()
 
-        return 0
+    if return_code == 0:
+        return backup.run()
 
-    return 1
+    return return_code
 
 
 if __name__ == '__main__':