Add no-syslog option

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

.gitignore

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

PKGBUILD

@@ -1,30 +0,0 @@
-#Arch Linux PKGBUILD
-#
-#Maintainer: Daniele Fucini <dfucini@gmail.com>
-#
-
-pkgname=simple-backup
-pkgver=2.0.0.r3.gc61c704
-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')
-depends=('python3'
-         'rsync')
-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'
-}
-
-package()
-{
-   install -Dm755 "${srcdir}/${pkgname}/${pkgname}.py" "${pkgdir}/usr/bin/${pkgname}"
-   install -Dm644 "${srcdir}/${pkgname}/config" "${pkgdir}/etc/${pkgname}/config"
-}

README.md

@@ -1,10 +1,51 @@
-# simple-backup
+simple_backup
+============
 A simple backup script
 
 ## Description
-simple-backup is a Python script that allows you to backup your files.
-It reads from a configuration file the files/directories that must be copied,
-the destination directory for the backup and a few other options.
+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:
+
+```bash
+simple_backup -h
+```
+
+to print all possible command line options.
 
 ## Dependencies
-rsync is used to perform the backup.  
+The script uses rsync to actually run the backup, so you will have to install it on your system. For example on Arch Linux:
+
+```bash
+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:
+
+```bash
+git clone https://github.com/Fuxino/simple_backup.git
+```
+
+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 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
+

man/simple_backup.1

@@ -0,0 +1,70 @@
+.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
+.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

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ['setuptools']
+build-backend = 'setuptools.build_meta'

setup.cfg

@@ -0,0 +1,38 @@
+[metadata]
+name = simple_backup
+version = attr: simple_backup.__version__
+description = Simple backup script using rsync
+long_description = file: README.md
+author = Daniele Fucini
+author_email = dfucini@gmail.com
+license = GPL3
+url = https://github.com/Fuxino/simple_backup
+classifiers =
+   Development Status :: 5 - Production/Stable
+   Environment :: Console
+   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
+   Topic :: System :: Archiving :: Backup
+
+[options]
+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 = simple_backup.simple_backup:simple_backup
+

simple-backup.install

@@ -1,7 +0,0 @@
-post_install() {
-   echo "An example configuration file is found in /etc/simple_backup/config."
-}
-
-post_upgrade() {
-   post_install
-}

simple-backup.py

@@ -1,856 +0,0 @@
-#!/usr/bin/python3
-
-# Import libraries
-from sys import exit, argv
-
-import os
-from os.path import expanduser, isfile, isdir, islink, exists, abspath
-from shutil import move, rmtree
-
-import subprocess
-
-from datetime import datetime
-from tempfile import mkstemp
-
-class Backup():
-
-    def __init__(self, *args, **kwargs):
-        super(Backup, self).__init__(*args, **kwargs)
-        
-        self.log_path = ''
-        self.logfile = None
-        self.err_path = ''
-        self.errfile = None
-        self.warn_path = ''
-        self.warnfile = None
-        self.homedir = ''
-        self.backup_dev = ''
-        self.backup_dir = ''
-        self.last_backup = ''
-        self.inputs = ''
-        self.inputs_path = ''
-        self.exclude_path = ''
-        self.exclude = ''
-        self.options = ''
-        self.keep = -1
-        self.n_in = 0
-
-    # Help function
-    def help_function(self):
-        print('simple_backup, version 2.0.0')
-        print('')
-        print('Usage: {} [OPTIONS]'.format(argv[0]))
-        print('')
-        print('Options:')
-        print('-h, --help                             Print this help and exit.')
-        print('-c, --config      CONFIG_FILE          Use the specified configuration file')
-        print('                                       instead of the default one.')
-        print('                                       All other options are ignored.')
-        print('-i, --input       INPUT [INPUT...]     Specify a file/dir to include in the backup.')
-        print('-d, --directory   DIR                  Specify the output directory for the backup.')
-        print('-e, --exclude     PATTERN [PATTERN...] Specify a file/dir/pattern to exclude from')
-        print('                                       the backup.')
-        print('-k, --keep        NUMBER               Specify the number of old backups to keep.')
-        print('                                       Default: keep all.')
-        print('-s, --checksum                         Use the checksum rsync option to compare files')
-        print('                                       (MUCH slower).')
-        print('')
-        print('If no option is given, the program uses the default')
-        print('configuration file: $HOMEDIR/.simple_backup/config.')
-        print('')
-        print('Report bugs to dfucini@gmail.com')
-
-        exit(0)
-
-    # Function to read configuration file
-    def read_conf(self, config=None):
-        if config is None:
-            config = self.homedir + '/.simple_backup/config'
-
-            if not isfile(config):
-            # If default config file doesn't exist, exit
-                log_message = str(datetime.now()) + ': Backup failed (see errors.log)'
-                self.logfile.write(log_message)
-                self.logfile.write('\n')
-                print('Backup failed')
-                err_message = 'Error: Configuration file not found'
-                print(err_message)
-                self.errfile.write(err_message)
-                self.errfile.write('\n')
-
-                self.logfile.close()
-                self.errfile.close()
-                self.warnfile.close()
-
-                try:
-                    move(self.log_path, self.homedir + '/.simple_backup/simple_backup.log')
-                    move(self.err_path, self.homedir + '/.simple_backup/errors.log')
-                except:
-                    print('Failed to create logs in {}'.format(self.homedir))
-
-                try:
-                    os.remove(self.warn_path)
-                except:
-                    print('Failed to remove temporary file')
-
-                exit(1)
-        else:
-            if not isfile(config):
-                # If the provided configuration file doesn't exist, exit
-                log_message = str(datetime.now()) + ': Backup failed (see errors.log)'
-                self.logfile.write(log_message)
-                self.logfile.write('\n')
-                print('Backup failed')
-                err_message = 'Error: Configuration file not found'
-                print(err_message)
-                self.errfile.write(err_message)
-                self.errfile.write('\n')
-
-                self.logfile.close()
-                self.errfile.close()
-                self.warnfile.close()
-
-                try:
-                    move(self.log_path, self.homedir + '/.simple_backup/simple_backup.log')
-                    move(self.err_path, self.homedir + '/.simple_backup/errors.log')
-                except:
-                    print('Failed to create logs in {}'.format(self.homedir))
-
-                try:
-                    os.remove(self.warn_path)
-                except:
-                    print('Failed to remove temporary file')
-
-                exit(1)
-
-        # Create temporary files
-        inputs_handle, self.inputs_path = mkstemp(prefix='tmp_inputs', text=True)
-        exclude_handle, self.exclude_path = mkstemp(prefix='tmp_exclude', text=True)
-
-        # Open temporary files
-        self.inputs = open(self.inputs_path, 'w')
-        self.exclude = open(self.exclude_path, 'w')
-
-        # Parse the configuration file
-        with open(config, 'r') as fp:
-            line = fp.readline()
-
-            while line:
-                if line[:7] == 'inputs=':
-                    line = line[7:].rstrip()
-                    input_values = line.split(',')
-                    n_in = 0
-                    for i in input_values:
-                        if not exists(i):
-                            warn_message = 'Warning: input "' + i + '" not found. Skipping'
-                            print(warn_message)
-                            self.warnfile.write(warn_message)
-                            self.warnfile.write('\n')
-                        else:
-                            self.inputs.write(i)
-                            self.inputs.write('\n')
-                            self.n_in = self.n_in + 1
-                elif line[:11] == 'backup_dir=':
-                    line = line[11:].rstrip()
-                    self.backup_dev = line
-                elif line[:8] == 'exclude=':
-                    line = line[8:].rstrip()
-                    exclude_values = line.split(',')
-                    for i in exclude_values:
-                        self.exclude.write(i)
-                        self.exclude.write('\n')
-                elif line[:5] == 'keep=':
-                    line = line[5:].rstrip()
-                    self.keep = int(line)
-
-                line = fp.readline()
-
-            fp.close()
-            self.inputs.close()
-            self.exclude.close()
-
-        # If the backup directory is not set or doesn't exist, exit
-        if self.backup_dev == '' or not isdir(self.backup_dev):
-            log_message = str(datetime.now()) + ': Backup failed (see errors.log)'
-            self.logfile.write(log_message)
-            self.logfile.write('\n')
-            print('Backup failed')
-            err_message = 'Error: Output folder "' + self.backup_dev + '" not found'
-            print(err_message)
-            self.errfile.write(err_message)
-            self.errfile.write('\n')
-
-            self.logfile.close()
-            self.errfile.close()
-            self.warnfile.close()
-
-            try:
-                move(self.log_path, self.homedir + '/.simple_backup/simple_backup.log')
-                move(self.err_path, self.homedir + '/.simple_backup/errors.log')
-            except:
-                print('Failed to create logs in {}'.format(self.homedir))
-
-            try:
-                os.remove(self.warn_path)
-                os.remove(self.inputs_path)
-                os.remove(self.exclude_path)
-            except:
-                print('Failed to remove temporary files')
-
-            exit(1)
-
-        self.backup_dir = self.backup_dev + '/simple_backup'
-        date = str(datetime.now())
-
-        # Create the backup subdirectory using date
-        if isdir(self.backup_dir):
-            # If previous backups exist, save link to the last backup
-            self.last_backup = self.backup_dir + '/last_backup'
-            if islink(self.last_backup):
-                try:
-                    self.last_backup = os.readlink(self.last_backup)
-                except:
-                    self.last_backup = ''
-                    err_message = 'An error occurred when reading the last_backup link. Continuing anyway'
-                    print(err_message)
-                    self.errfile.write(err_message)
-                    self.errfile.write('\n')
-
-            else:
-                self.last_backup = ''
-
-        self.backup_dir = self.backup_dir + '/' + date
-
-        try:
-            os.makedirs(self.backup_dir)
-        except PermissionError as e:
-            log_message = str(datetime.now()) + 'Backup failed (see errors.log)'
-            self.logfile.write(log_message)
-            self.logfile.write('\n')
-            print('Backup failed')
-            print(str(e))
-            self.errfile.write(str(e))
-            self.errfile.write('\n')
-
-            self.logfile.close()
-            self.errfile.close()
-            self.warnfile.close()
-
-            try:
-                move(self.log_path, self.homedir + '/.simple_backup/simple_backup.log')
-                move(self.err_path, self.homedir + '/.simple_backup/errors.log')
-            except:
-                print('Failed to create logs in {}'.format(self.homedir))
-
-            try:
-                os.remove(self.warn_path)
-                os.remove(self.inputs_path)
-                os.remove(self.exclude_path)
-            except:
-                print('Failed to remove temporary files')
-
-            exit(1)
-        except:
-            log_message = str(datetime.now()) + 'Backup failed (see errors.log)'
-            self.logfile.write(log_message)
-            self.logfile.write('\n')
-            print(log_message)
-            err_message = 'Failed to create backup directory'
-            self.errfile.write(err_message)
-            self.errfile.write('\n')
-
-            self.logfile.close()
-            self.errfile.close()
-            self.warnfile.close()
-
-            try:
-                move(self.log_path, self.homedir + '/.simple_backup/simple_backup.log')
-                move(self.err_path, self.homedir + '/.simple_backup/errors.log')
-            except:
-                print('Failed to create logs in {}'.format(self.homedir))
-
-            try:
-                os.remove(self.warn_path)
-                os.remove(self.inputs_path)
-                os.remove(self.exclude_path)
-            except:
-                print('Failed to remove temporary files')
-
-            exit(1)
-
-        return
-
-    # Function to parse options
-    def parse_options(self):
-        # Create temporary files
-        inputs_handle, self.inputs_path = mkstemp(prefix='tmp_inputs', text=True)
-        exclude_handle, self.exclude_path = mkstemp(prefix='tmp_exclude', text=True)
-
-        # Open temporary files
-        self.inputs = open(self.inputs_path, 'w')
-        self.exclude = open(self.exclude_path, 'w')
-
-        i = 1
-        while i < len(argv):
-            var = argv[i]
-
-            if var == '-h' or var == '--help':
-                self.help_function()
-            elif var == '-i' or var == '--input':
-                val = argv[i+1]
-                while i < len(argv) - 1 and val[0] != '-':
-                    inp = val
-
-                    if not exists(inp):
-                        warn_message = 'Warning: input "' + inp + '" not found. Skipping'
-                        print(warn_message)
-                        self.warnfile.write(warn_message)
-                        self.warnfile.write('\n')
-                    else:
-                        self.n_in = self.n_in + 1
-                        self.inputs.write(inp)
-                        self.inputs.write('\n')
-
-                    i = i + 1
-                    val = argv[i+1]
-            elif var == '-d' or var == '--directory':
-                self.backup_dev = argv[i+1]
-                self.backup_dev = abspath(self.backup_dev)
-
-                if not exists(self.backup_dev) or not isdir(self.backup_dev):
-                    log_message = str(datetime.now()) + ': Backup failed (see errors.log)'
-                    self.logfile.write(log_message)
-                    self.logfile.write('\n')
-                    print('Backup failed')
-                    err_message = 'Error: output folder "' + self.backup_dev + '" not found'
-                    print(err_message)
-                    self.errfile.write(err_message)
-                    self.errfile.write('\n')
-
-                    self.logfile.close()
-                    self.errfile.close()
-                    self.warnfile.close()
-                    self.inputs.close()
-                    self.exclude.close()
-
-                    try:
-                        move(self.log_path, self.homedir + '/.simple_backup/simple_backup.log')
-                        move(self.err_path, self.homedir + '/.simple_backup/errors.log')
-                    except:
-                        print('Failed to create logs in {}'.format(self.homedir))
-
-                    try:
-                        os.remove(self.warn_path)
-                        os.remove(self.inputs_path)
-                        os.remove(self.exclude_path)
-                    except:
-                        print('Failed to remove temporary files')
-
-                    exit(1)
-
-                self.backup_dir = self.backup_dev + '/simple_backup'
-                date = str(datetime.now())
-
-                # Create the backup subdirectory using date
-                if isdir(self.backup_dir):
-                    #If previous backups exist, save link to the last backup
-                    self.last_backup = self.backup_dir + '/last_backup'
-                    if islink(self.last_backup):
-                        try:
-                            self.last_backup = os.readlink(self.last_backup)
-                        except:
-                            self.last_backup = ''
-                            err_message = 'An error occurred when reading the last_backup link. Continuing anyway'
-                            print(err_message)
-                            self.errfile.write(err_message)
-                            self.errfile.write('\n')
-
-                    else:
-                        self.last_backup = ''
-
-                self.backup_dir = self.backup_dir + '/' + date
-
-                try:
-                    os.makedirs(self.backup_dir)
-                except PermissionError as e:
-                    log_message = str(datetime.now()) + 'Backup failed (see errors.log)'
-                    self.logfile.write(log_message)
-                    self.logfile.write('\n')
-                    print('Backup failed')
-                    print(str(e))
-                    self.errfile.write(str(e))
-                    self.errfile.write('\n')
-
-                    self.logfile.close()
-                    self.errfile.close()
-                    self.warnfile.close()
-                    self.inputs.close()
-                    self.exclude.close()
-
-                    try:
-                        move(self.log_path, self.homedir + '/.simple_backup/simple_backup.log')
-                        move(self.err_path, self.homedir + '/.simple_backup/errors.log')
-                    except:
-                        print('Failed to create logs in {}'.format(self.homedir))
-
-                    try:
-                        os.remove(self.warn_path)
-                        os.remove(self.inputs_path)
-                        os.remove(self.exclude_path)
-                    except:
-                        print('Failed to remove temporary files')
-
-                    exit(1)
-                except:
-                    log_message = str(datetime.now()) + 'Backup failed (see errors.log)'
-                    self.logfile.write(log_message)
-                    self.logfile.write('\n')
-                    print('Backup failed')
-                    err_message = 'Failed to create backup directory'
-                    print(err_message)
-                    self.errfile.write(err_message)
-                    self.errfile.write('\n')
-
-                    self.logfile.close()
-                    self.errfile.close()
-                    self.warnfile.close()
-                    self.inputs.close()
-                    self.exclude.close()
-
-                    try:
-                        move(self.log_path, self.homedir + '/.simple_backup/simple_backup.log')
-                        move(self.err_path, self.homedir + '/.simple_backup/errors.log')
-                    except:
-                        print('Failed to create logs in {}'.format(self.homedir))
-
-                    try:
-                        os.remove(self.warn_path)
-                        os.remove(self.inputs_path)
-                        os.remove(self.exclude_path)
-                    except:
-                        print('Failed to remove temporary files')
-
-                    exit(1)
-
-                i = i + 1
-            elif var == '-e' or var == '--exclude':
-                val = argv[i+1]
-                while i < len(argv) - 1 and val[0] != '-':
-                    exc = val
-                    self.exclude.write(exc)
-                    self.exclude.write('\n')
-
-                    i = i + 1
-                    val = argv[i+1]
-            elif var == '-k' or var == '--keep':
-                self.keep = int(argv[i+1])
-
-                i = i + 1
-            elif var == '-c' or var == '--config':
-                self.read_conf(argv[i+1])
-
-                i = i + 1
-            elif var == '-s' or var == '--checksum':
-                self.options = '-arcvh -H -X'
-            else:
-                log_message = str(datetime.now()) + ': Backup failed (see errors.log)'
-                self.logfile.write(log_message)
-                self.logfile.write('\n')
-                print('Backup failed')
-                err_message = 'Error: Option "' + var + '" not recognised. Use "simple-backup -h" to see available options'
-                print(err_message)
-                self.errfile.write(err_message)
-                self.errfile.write('\n')
-
-                self.logfile.close()
-                self.errfile.close()
-                self.warnfile.close()
-                self.inputs.close()
-                self.exclude.close()
-
-                try:
-                    move(self.log_path, self.homedir + '/.simple_backup/simple_backup.log')
-                    move(self.err_path, self.homedir + '/.simple_backup/errors.log')
-                except:
-                    print('Failed to create logs in {}'.format(self.homedir))
-
-                try:
-                    os.remove(self.warn_path)
-                    os.remove(self.inputs_path)
-                    os.remove(self.exclude_path)
-                except:
-                    print('Failed to remove temporary files')
-
-                exit(1)
-
-            i = i + 1
-
-        self.inputs.close()
-        self.exclude.close()
-
-        return
-
-    def exec_(self):
-        print('Copying files. This may take a long time...')
-
-        if self.last_backup == '':
-            rsync = 'rsync ' + self.options + ' --exclude-from=' + self.exclude_path +\
-                    ' --files-from=' + self.inputs_path + ' / "' + self.backup_dir +\
-                    '" --ignore-missing-args >> ' + self.log_path + ' 2>> ' + self.err_path
-        else:
-            rsync = 'rsync ' + self.options + ' --link-dest="' + self.last_backup + '" --exclude-from=' +\
-                    self.exclude_path + ' --files-from=' + self.inputs_path + ' / "' + self.backup_dir +\
-                    '" --ignore-missing-args >> ' + self.log_path + ' 2>> ' + self.err_path
-
-        subprocess.run(rsync, shell=True)
-
-        return
-
-def main():
-
-    backup = Backup()
-
-    # Create temporary log files
-    log_handle, backup.log_path = mkstemp(prefix='tmp_log', text=True)
-    err_handle, backup.err_path = mkstemp(prefix='tmp_err', text=True)
-    warn_handle, backup.warn_path = mkstemp(prefix='tmp_warn', text=True)
-
-    # Open log files
-    backup.logfile = open(backup.log_path, 'w')
-    backup.errfile = open(backup.err_path, 'w')
-    backup.warnfile = open(backup.warn_path, 'w')
-
-    # Set homedir and default options
-    try:
-        backup.homedir = '/home/' + os.environ['SUDO_USER']
-    except:
-        backup.homedir = expanduser('~')
-
-    backup.options = '-arvh -H -X'
-
-    # Check number of parameters
-    if len(argv) == 1:
-        # If simple backup directory doesn't exist, create it and exit
-        if not isdir(backup.homedir + '/.simple_backup'):
-            try:
-                os.makedir(backup.homedir + '/.simple_backup')
-                log_message = 'Created directory "' + backup.homedir + '/.simple_backup".\n' +\
-                        'Copy there the sample configuration and edit it\n' +\
-                        'to your needs before running the backup,\n' +\
-                        'or pass options directly on the command line.'
-                backup.logfile.write(log_message)
-                backup.logfile.write('\n')
-                print(log_message)
-
-                backup.logfile.close()
-                backup.errfile.close()
-                backup.warnfile.close()
-
-                try:
-                    move(backup.log_path, backup.homedir + '/.simple_backup/simple_backup.log')
-                except:
-                    print('Failed to create logs in {}'.format(backup.homedir))
-
-                try:
-                    os.remove(backup.err_path)
-                    os.remove(backup.warn_path)
-                except:
-                    print('Failed to remove temporary files')
-            except:
-                print('Failed to create .simple_backup directory in {}'.format(backup.homedir))
-
-                backup.logfile.close()
-                backup.errfile.close()
-                backup.warnfile.close()
-
-                try:
-                    os.remove(backup.log_path)
-                    os.remove(backup.err_path)
-                    os.remove(backup.warn_path)
-                except:
-                    print('Failed to remove temporary files')
-
-            exit(1)
-
-        # Read configuration file
-        backup.read_conf()
-    else:
-        # Parse command line options
-        backup.parse_options()
-
-        if backup.n_in > 0 and (backup.backup_dir == '' or 
-                not isdir(backup.backup_dir)):
-            #If the backup directory is not set or doesn't exist, exit
-            log_message = str(datetime.now()) + ': Backup failed (see errors.log)'
-            backup.logfile.write(log_message)
-            backup.logfile.write('\n')
-            print('Backup failed')
-            err_message = 'Error: Output folder "' + backup.backup_dev.getBackupDev + '" not found'
-            print(err_message)
-            backup.errfile.write(err_message)
-            backup.errfile.write('\n')
-
-            backup.logfile.close()
-            backup.errfile.close()
-            backup.warnfile.close()
-
-            try:
-                move(backup.log_path, backup.homedir + '/.simple_backup/simple_backup.log')
-                move(backup.err_path, backup.homedir + '/.simple_backup/errors.log')
-            except:
-                print('Failed to create logs in {}'.format(backup.homedir))
-
-            try:
-                os.remove(backup.warn_path)
-                os.remove(backup.inputs_path)
-                os.remove(backup.exclude_path)
-            except:
-                print('Failed to remove temporary files')
-
-            exit(1)
-        elif backup.n_in == 0 and backup.backup_dir == '':
-            if not isdir(backup.homedir + '/.simple_backup'):
-                try:
-                    os.makedir(backup.homedir + '/.simple_backup')
-                    log_message = 'Created directory "' + backup.homedir + '/.simple_backup".\n' +\
-                            'Copy there the sample configuration and edit it\n' +\
-                            'to your needs before running the backup,\n' +\
-                            'or pass options directly on the command line.'
-                    backup.logfile.write(log_message)
-                    backup.logfile.write('\n')
-                    print(log_message)
-
-                    backup.logfile.close()
-                    backup.errfile.close()
-                    backup.warnfile.close()
-
-                    try:
-                        move(backup.log_path, backup.homedir + '/.simple_backup/simple_backup.log')
-                    except:
-                        print('Failed to create logs in {}'.format(backup.homedir))
-
-                    try:
-                        os.remove(backup.err_path)
-                        os.remove(backup.warn_path)
-                        os.remove(backup.inputs_path)
-                        os.remove(backup.exclude_path)
-                    except:
-                        print('Failed to remove temporary files')
-                except:
-                    print('Failed to create .simple_backup directory in {}'.format(backup.homedir))
-
-                    backup.logfile.close()
-                    backup.errfile.close()
-                    backup.warnfile.close()
-
-                    try:
-                        os.remove(backup.log_path)
-                        os.remove(backup.err_path)
-                        os.remove(backup.warn_path)
-                        os.remove(backup.inputs_path)
-                        os.remove(backup.exclude_path)
-                    except:
-                        print('Failed to remove temporary files')
-
-                exit(1)
-
-            try:
-                os.remove(backup.inputs_path)
-                os.remove(backup.exclude_path)
-            except:
-                print('Failed to remove temporary files')
-
-            backup.read_conf(backup.homedir + '/.simple_backup/config')
-
-    if backup.n_in == 0:
-        log_message = str(datetime.now()) + ': Backup finished (no files copied)'
-        backup.logfile.write(log_message)
-        backup.logfile.write('\n')
-        print('Backup finished (no files copied')
-        warn_message = 'Warning: no valid input selected. Nothing to do'
-        print(warn_message)
-        backup.warnfile.write(warn_message)
-        backup.warnfile.write('\n')
-
-        backup.logfile.close()
-        backup.errfile.close()
-        backup.warnfile.close()
-
-        try:
-            move(backup.log_path, backup.homedir + '/.simple_backup/simple_backup.log')
-            move(backup.warn_path, backup.homedir + '/.simple_backup/warnings.log')
-        except:
-            print('Failed to create logs in {}'.format(backup.homedir))
-
-        try:
-            os.remove(backup.err_path)
-            os.remove(backup.inputs_path)
-            os.remove(backup.exclude_path)
-        except:
-            print('Failed to remove temporary files')
-
-        exit(0)
-
-    log_message = str(datetime.now()) + ': Starting backup'
-    backup.logfile.write(log_message)
-    backup.logfile.write('\n')
-    print('Starting backup...')
-
-    #If specified, keep the last n backups and remove the others. Default: keep all
-    if backup.keep > -1:
-        try:
-            dirs = os.listdir(backup.backup_dev + '/simple_backup')
-        except:
-            err_message = 'Failed to access backup directory'
-            backup.errfile.write(err_message)
-            backup.errfile.write('\n')
-            print(err_message)
-
-            backup.logfile.close()
-            backup.errfile.close()
-            backup.warnfile.close()
-
-            try:
-                move(backup.log_path, backup.homedir + '/.simple_backup/simple_backup.log')
-                move(backup.err_path, backup.homedir + '.simple_backup/errors.log')
-            except:
-                print('Failed to create logs in {}'.format(backup.homedir))
-
-            try:
-                os.remove(backup.warn_path)
-                os.remove(backup.inputs_path)
-                os.remove(backup.exclude_path)
-            except:
-                print('Failed to remove temporary files')
-
-            exit(1)
-        if dirs.count('last_backup') > 0:
-            dirs.remove('last_backup')
-        n_backup = len(dirs) - 1
-
-        if n_backup > backup.keep:
-            log_message = str(datetime.now()) + ': Removing old backups'
-            backup.logfile.write(log_message)
-            backup.logfile.write('\n')
-            print('Removing old backups...')
-            dirs.sort()
-
-            for i in range(n_backup-backup.keep):
-                try:
-                    rmtree(backup.backup_dev + '/simple_backup/' + dirs[i])
-                    log_message = 'Removed backup: ' + dirs[i]
-                    backup.logfile.write(log_message)
-                    backup.logfile.write('\n')
-                except:
-                    err_message = 'Error while removing backup ' + dirs[i]
-                    backup.errfile.write(err_message)
-                    backup.errfile.write('\n')
-                    print(err_message)
-
-    backup.logfile.close()
-    backup.errfile.close()
-    backup.warnfile.close()
-
-    backup.exec_()
-
-    backup.logfile = open(backup.log_path, 'a')
-    backup.errfile = open(backup.err_path, 'a')
-
-    if islink(backup.backup_dev + '/simple_backup/last_backup'):
-        try:
-            os.remove(backup.backup_dev + '/simple_backup/last_backup')
-        except:
-            err_message = 'Failed to remove last_backup link'
-            backup.errfile.write(err_message)
-            backup.errfile.write('\n')
-            print(err_message)
-
-    try:
-        os.symlink(backup.backup_dir, backup.backup_dev + '/simple_backup/last_backup')
-    except:
-        err_message = 'Failed to create last_backup link'
-        backup.errfile.write(err_message)
-        backup.errfile.write('\n')
-        print(err_message)
-
-    backup.errfile.close()
-
-    # Update the logs
-    if os.stat(backup.err_path).st_size > 0:
-        log_message = str(datetime.now()) + ': Backup finished with errors (see errors.log)'
-        backup.logfile.write(log_message)
-        backup.logfile.write('\n')
-        print('Backup finished with errors')
-
-        try:
-            move(backup.err_path, backup.homedir + '/.simple_backup/errors.log')
-        except:
-            print('Failed to create logs in {}'.format(backup.homedir))
-
-        try:
-            os.remove(backup.warn_path)
-        except:
-            print('Failed to remove temporary file')
-    elif os.stat(backup.warn_path).st_size > 0:
-        log_message = str(datetime.now()) + ': Backup finished with warnings (see warnings.log)'
-        backup.logfile.write(log_message)
-        backup.logfile.write('\n')
-        print('Backup finished (warnings)')
-
-        try:
-            move(backup.warn_path, backup.homedir + '/.simple_backup/warnings.log')
-        except:
-            print('Failed to create logs in {}'.format(backup.homedir))
-
-        try:
-            os.remove(backup.err_path)
-        except:
-            print('Failed to remove temporary file')
-
-        if isfile(backup.homedir + '/.simple_backup/errors.log'):
-            try:
-                os.remove(backup.homedir + '/.simple_backup/errors.log')
-            except:
-                print('Failed to remove old logs')
-    else:
-        log_message = str(datetime.now()) + ': Backup finished'
-        backup.logfile.write(log_message)
-        backup.logfile.write('\n')
-        print('Backup finished')
-
-        try:
-            os.remove(backup.err_path)
-            os.remove(backup.warn_path)
-        except:
-            print('Failed to remove temporary files')
-
-        if isfile(backup.homedir + '/.simple_backup/errors.log'):
-            try:
-                os.remove(backup.homedir + '/.simple_backup/errors.log')
-            except:
-                print('Failed to remove old logs')
-        if isfile(backup.homedir + '/.simple_backup/warnings.log'):
-            try:
-                os.remove(backup.homedir + '/.simple_backup/warnings.log')
-            except:
-                print('Failed to remove old logs')
-
-    backup.logfile.close()
-
-    # Copy log files in home directory
-    try:
-        move(backup.log_path, backup.homedir + '/.simple_backup/simple_backup.log')
-    except:
-        print('Failed to create logs in {}'.format(backup.homedir))
-
-    # Delete temporary files
-    try:
-        os.remove(backup.inputs_path)
-        os.remove(backup.exclude_path)
-    except:
-        print('Failed to remove temporary files')
-
-    exit(0)
-
-if __name__ == '__main__':
-    main()

simple_backup/__init__.py

@@ -0,0 +1,3 @@
+"""Init."""
+
+__version__ = '3.3.0'

simple_backup/simple_backup.conf

@@ -1,7 +1,6 @@
-#Example config file for my_backup
-
-# WARNING: Values should NOT be quoted, e.g. use inputs=/some/dir instead of inputs="/some/dir"
+#Example config file for simple_backup
 
+[default]
 #Input directories. Use a comma to separate items
 inputs=/home/my_home,/etc
 
@@ -9,7 +8,7 @@ inputs=/home/my_home,/etc
 backup_dir=/media/Backup
 
 #Exclude patterns. Use a comma to separate items
-exclude=.gvfs,.cache*,[Cc]ache*,.thumbnails*,[Tt]rash*,*.backup*,*~,.dropbox*
+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
+keep=-1

simple_backup/simple_backup.py

@@ -0,0 +1,338 @@
+#!/usr/bin/python3
+
+# Import libraries
+import os
+from functools import wraps
+from shutil import rmtree
+import argparse
+import configparser
+import logging
+from logging import StreamHandler
+from timeit import default_timer
+from subprocess import Popen, PIPE, STDOUT
+from datetime import datetime
+from tempfile import mkstemp
+from dotenv import load_dotenv
+
+try:
+    from systemd import journal
+except ImportError:
+    journal = None
+
+try:
+    import dbus
+except ImportError:
+    pass
+
+
+load_dotenv()
+euid = os.geteuid()
+
+if euid == 0:
+    user = os.getenv('SUDO_USER')
+    homedir = os.path.expanduser(f'~{user}')
+else:
+    homedir = os.getenv('HOME')
+
+logging.getLogger().setLevel(logging.DEBUG)
+logger = logging.getLogger(os.path.basename(__file__))
+c_handler = StreamHandler()
+
+c_handler.setLevel(logging.INFO)
+c_format = logging.Formatter('%(name)s - %(levelname)s - %(message)s')
+c_handler.setFormatter(c_format)
+logger.addHandler(c_handler)
+
+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)
+
+
+def timing(_logger):
+    def decorator_timing(func):
+        @wraps(func)
+        def wrapper_timing(*args, **kwargs):
+            start = default_timer()
+
+            value = func(*args, **kwargs)
+
+            end = default_timer()
+
+            _logger.info(f'Elapsed time: {end - start:.3f} seconds')
+
+            return value
+
+        return wrapper_timing
+
+    return decorator_timing
+
+
+class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
+    pass
+
+
+class Backup:
+
+    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 = ''
+        self._exclude_path = ''
+        self._err_flag = False
+
+    def check_params(self):
+        if self.inputs is None or len(self.inputs) == 0:
+            logger.info('No files or directory specified for backup.')
+
+            return False
+
+        if self.output is None:
+            logger.critical('No output path specified. Use -o argument or specify output path in configuration file')
+
+            return False
+
+        if not os.path.isdir(self.output):
+            logger.critical('Output path for backup does not exist')
+
+            return False
+
+        self.output = os.path.abspath(self.output)
+
+        if self.keep is None:
+            self.keep = -1
+
+        return True
+
+    # Function to create the actual backup directory
+    def create_backup_dir(self):
+        now = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
+        self._output_dir = f'{self.output}/simple_backup/{now}'
+
+        os.makedirs(self._output_dir, exist_ok=True)
+
+    def remove_old_backups(self):
+        try:
+            dirs = os.listdir(f'{self.output}/simple_backup')
+        except FileNotFoundError:
+            return
+
+        n_backup = len(dirs) - 1
+        count = 0
+
+        if n_backup > self.keep:
+            logger.info('Removing old backups...')
+            dirs.sort()
+
+            for i in range(n_backup - self.keep):
+                try:
+                    rmtree(f'{self.output}/simple_backup/{dirs[i]}')
+                    count += 1
+                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')
+            else:
+                logger.info(f'Removed {count} backups')
+
+    def find_last_backup(self):
+        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')
+
+            return
+
+        try:
+            self._last_backup = dirs[-1]
+        except IndexError:
+            logger.info('No previous backups available')
+
+    # Function to read configuration file
+    @timing(logger)
+    def run(self):
+        logger.info('Starting backup...')
+
+        try:
+            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)
+
+        with open(self._inputs_path, 'w') as fp:
+            for i in self.inputs:
+                if not os.path.exists(i):
+                    logger.warning(f'Input {i} not found. Skipping')
+                else:
+                    fp.write(i)
+                    fp.write('\n')
+
+        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 == '':
+            rsync = f'rsync {self.options} --exclude-from={self._exclude_path} ' +\
+                    f'--files-from={self._inputs_path} / "{self._output_dir}" ' +\
+                    '--ignore-missing-args'
+        else:
+            rsync = f'rsync {self.options} --link-dest="{self._last_backup}" --exclude-from=' +\
+                    f'{self._exclude_path} --files-from={self._inputs_path} / "{self._output_dir}" ' +\
+                    '--ignore-missing-args'
+
+        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 self.keep != -1 and not self.remove_before:
+            self.remove_old_backups()
+
+        os.remove(self._inputs_path)
+        os.remove(self._exclude_path)
+
+        logger.info('Backup completed')
+
+        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
+        else:
+            try:
+                notify('Backup finished')
+            except NameError:
+                pass
+
+
+def _parse_arguments():
+    parser = argparse.ArgumentParser(prog='simple_backup',
+                                     description='Simple backup script written in Python that uses rsync to copy files',
+                                     epilog='Report bugs to dfucini<at>gmail<dot>com',
+                                     formatter_class=MyFormatter)
+
+    parser.add_argument('-c', '--config', default=f'{homedir}/.config/simple_backup/simple_backup.conf',
+                        help='Specify location of configuration file')
+    parser.add_argument('-i', '--input', 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('-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')
+
+    args = parser.parse_args()
+
+    return args
+
+
+def _read_config(config_file):
+    if not os.path.isfile(config_file):
+        logger.warning(f'Config file {config_file} does not exist')
+
+        return None, None, None, None
+
+    config = configparser.ConfigParser()
+    config.read(config_file)
+
+    inputs = config.get('default', 'inputs')
+    inputs = inputs.split(',')
+    output = config.get('default', 'backup_dir')
+    exclude = config.get('default', 'exclude')
+    exclude = exclude.split(',')
+    keep = config.getint('default', 'keep')
+
+    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:
+        inputs = args.input
+
+    if args.output is not None:
+        output = args.output
+
+    if args.exclude is not None:
+        exclude = args.exclude
+
+    if args.keep is not None:
+        keep = args.keep
+
+    if args.checksum:
+        backup_options = '-arcvh -H -X'
+    else:
+        backup_options = '-arvh -H -X'
+
+    backup = Backup(inputs, output, exclude, keep, backup_options, remove_before=args.remove_before_backup)
+
+    if backup.check_params():
+        backup.run()
+
+        return 0
+
+    return 1
+
+
+if __name__ == '__main__':
+    simple_backup()