Add desktop notifications

PKGBUILD

@@ -3,7 +3,7 @@
 # Maintainer: Daniele Fucini <dfucini@gmail.com>
 
 pkgname=simple_backup
-pkgver=3.1.2.r1.ga4c4b88
+pkgver=3.2.3.r1.ga42ade4
 pkgrel=1
 pkgdesc='Simple backup script that uses rsync to copy files'
 arch=('any')
@@ -17,7 +17,8 @@ makedepends=('git'
 depends=('python'
          'rsync'
          'python-dotenv')
-optdepends=('python-systemd: use systemd log')
+optdepends=('python-systemd: use systemd log'
+            'python-dbus: for desktop notifications')
 install=${pkgname}.install
 source=(git+https://github.com/Fuxino/${pkgname}.git)
 sha256sums=('SKIP')

README.md

@@ -27,12 +27,19 @@ 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:
+
+```bash
+pip install --upgrade build installer wheel
+```
+
 Then run:
 
 ```bash
 cd simple_backup
 python -m build --wheel
 python -m installer dist/*.whl
+```
 
 For Arch Linux, a PKGBUILD that automates this process is provided.
 

setup.cfg

@@ -29,5 +29,5 @@ install_requires =
 
 [options.entry_points]
 console_scripts =
-   simple_backup = simple_backup:simple_backup
+   simple_backup = simple_backup.simple_backup:simple_backup
 

simple_backup/__init__.py

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

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

@@ -16,6 +16,11 @@ from dotenv import load_dotenv
 
 try:
     from systemd import journal
+except ImportError:
+    journal = None
+
+try:
+    import dbus
 except ImportError:
     pass
 
@@ -24,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')
@@ -38,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):
@@ -73,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 = ''
@@ -91,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')
 
@@ -129,9 +122,7 @@ class Backup:
     def remove_old_backups(self):
         try:
             dirs = os.listdir(f'{self.output}/simple_backup')
-        except Exception:
+        except FileNotFoundError:
-            logger.info('No older backups to remove')
-
             return
 
         if dirs.count('last_backup') > 0:
@@ -148,8 +139,10 @@ class Backup:
                 try:
                     rmtree(f'{self.output}/simple_backup/{dirs[i]}')
                     count += 1
-                except Exception:
+                except FileNotFoundError:
-                    logger.error(f'Error while removing backup {dirs[i]}')
+                    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')
@@ -158,31 +151,28 @@ class Backup:
 
     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')
-                self._last_backup = os.readlink(f'{self.output}/simple_backup/last_backup')
+
-            except Exception:
+            if os.path.isdir(link):
-                logger.warning('Previous backup could not be read')
+                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)
 
@@ -199,6 +189,9 @@ class Backup:
                 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 == '':
@@ -213,18 +206,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.symlink(self._output_dir, f'{self.output}/simple_backup/last_backup')
+                os.remove(f'{self.output}/simple_backup/last_backup')
-        except Exception:
+            except FileNotFoundError:
-            logger.error('Failed to create last_backup link')
+                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
 
-        if self.keep != -1:
+        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()
 
         os.remove(self._inputs_path)
@@ -235,6 +244,13 @@ 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
+        else:
+            notify('Backup finished')
+
 
 def _parse_arguments():
     parser = argparse.ArgumentParser(prog='simple_backup',
@@ -250,6 +266,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()
 
@@ -275,6 +293,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)
@@ -296,7 +332,7 @@ 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():
         backup.run()