Rename configuration file

.gitignore

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

PKGBUILD

@@ -13,7 +13,9 @@ license=('GPL3')
 makedepends=('git')
 depends=('python3'
          'rsync'
-         'python-dotenv')
+         'python-dotenv'
+         'python-dbus'
+         'python-systemd')
 install=${pkgname}.install
 source=(git+https://github.com/Fuxino/${pkgname}.git)
 sha256sums=('SKIP')
@@ -27,5 +29,5 @@ pkgver()
 package()
 {
    install -Dm755 "${srcdir}/${pkgname}/${pkgname}.py" "${pkgdir}/usr/bin/${pkgname}"
-   install -Dm644 "${srcdir}/${pkgname}/config" "${pkgdir}/etc/${pkgname}/config"
+   install -Dm644 "${srcdir}/${pkgname}/${pkgname}.config" "${pkgdir}/etc/${pkgname}/${pkgname}.conf"
 }

simple_backup.install

@@ -1,6 +1,6 @@
 post_install() {
-   echo "An example configuration file is found in /etc/simple_backup/config."
-   echo "Copy it to ~/.simple_backup/simple_backup.config and modify it as needed"
+   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() {

simple_backup.py

@@ -1,17 +1,71 @@
 #!/usr/bin/python3
 
 # Import libraries
-from dotenv import load_dotenv
 import os
+from functools import wraps
 from shutil import rmtree
 import argparse
 import configparser
 import logging
 from logging import StreamHandler
-from logging.handlers import RotatingFileHandler
+from timeit import default_timer
 from subprocess import Popen, PIPE, STDOUT
 from datetime import datetime
 from tempfile import mkstemp
+import dbus
+from dotenv import load_dotenv
+
+try:
+    from systemd import journal
+except ImportError:
+    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)
+
+try:
+    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):
+    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):
@@ -47,13 +101,20 @@ class Backup:
                     self.inputs.append(i_new)
                 except Exception:
                     logger.warning(f'Input {i} is a link and cannot be read. Skipping')
-                    self.inpts.remove(i)
+                    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')
+
+            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
 
@@ -78,6 +139,7 @@ class Backup:
             dirs.remove('last_backup')
 
         n_backup = len(dirs) - 1
+        count = 0
 
         if n_backup > self.keep:
             logger.info('Removing old backups...')
@@ -86,17 +148,29 @@ class Backup:
             for i in range(n_backup - self.keep):
                 try:
                     rmtree(f'{self.output}/simple_backup/{dirs[i]}')
+                    count += 1
                 except Exception:
                     logger.error(f'Error while removing backup {dirs[i]}')
 
+            if count == 1:
+                logger.info(f'Removed {count} backup')
+            else:
+                logger.info(f'Removed {count} backups')
+
     def find_last_backup(self):
         if os.path.islink(f'{self.output}/simple_backup/last_backup'):
             try:
                 self._last_backup = os.readlink(f'{self.output}/simple_backup/last_backup')
             except Exception:
-                logger.error('Previous backup could not be read')
+                logger.warning('Previous backup could not be read')
+        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...')
 
@@ -110,8 +184,8 @@ class Backup:
                 logger.error('Failed to remove last_backup link')
                 self._err_flag = True
 
-        inputs_handle, self._inputs_path = mkstemp(prefix='tmp_inputs', text=True)
-        exclude_handle, self._exclude_path = mkstemp(prefix='tmp_exclude', text=True)
+        _, 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:
@@ -140,7 +214,10 @@ class Backup:
         p = Popen(rsync, stdout=PIPE, stderr=STDOUT, shell=True)
         output, _ = p.communicate()
 
-        logger.info(f'Output of rsync command: {output.decode("utf-8")}')
+        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')
@@ -159,44 +236,18 @@ class Backup:
         if self._err_flag:
             logger.warning('Some errors occurred (check log for details)')
 
+            return 1
 
-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()
-
-try:
-    f_handler = RotatingFileHandler(f'{homedir}/.simple_backup/simple_backup.log', maxBytes=1024000, backupCount=5)
-except Exception:
-    f_handler = None
-
-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 f_handler:
-    f_handler.setLevel(logging.INFO)
-    f_format = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
-    f_handler.setFormatter(f_format)
-    logger.addHandler(f_handler)
+        return 0
 
 
 def _parse_arguments():
     parser = argparse.ArgumentParser(prog='simple_backup',
-                                     description='A simple backup script written in Python that uses rsync to copy files',
+                                     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}/.simple_backup/simple_backup.config',
+    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')
@@ -253,7 +304,25 @@ def simple_backup():
     backup = Backup(inputs, output, exclude, keep, backup_options)
 
     if backup.check_params():
-        backup.run()
+        try:
+            obj = dbus.SessionBus().get_object("org.freedesktop.Notifications", "/org/freedesktop/Notifications")
+            obj = dbus.Interface(obj, "org.freedesktop.Notifications")
+            obj.Notify("simple_backup", 0, "", "Starting backup...", "", [], {"urgency": 1}, 10000)
+        except dbus.exceptions.DBusException:
+            obj = None
+
+        status = backup.run()
+
+        if obj is not None:
+            if status == 0:
+                obj.Notify("simple_backup", 0, "", "Backup finished.", "", [], {"urgency": 1}, 10000)
+            else:
+                obj.Notify("simple_backup", 0, "", "Backup finished. Some errors occurred.",
+                           "", [], {"urgency": 1}, 10000)
+
+        return 0
+
+    return 1
 
 
 if __name__ == '__main__':