dar-backup 0.6.18__py3-none-any.whl → 0.6.20__py3-none-any.whl

dar_backup/dar_backup.py

@@ -14,6 +14,8 @@ This script can be used to control `dar` to backup parts of or the whole system.
 """
 
 
+
+import argcomplete
 import argparse
 import filecmp
 
@@ -35,8 +37,10 @@ from sys import stderr
 from sys import argv
 from sys import version_info
 from time import time
+from rich.console import Console
+from rich.text import Text
 from threading import Event
-from typing import List
+from typing import List, Tuple
 
 from . import __about__ as about
 from dar_backup.config_settings import ConfigSettings
@@ -46,12 +50,17 @@ from dar_backup.util import get_logger
 from dar_backup.util import BackupError
 from dar_backup.util import RestoreError
 from dar_backup.util import requirements
+from dar_backup.util import show_version
+from dar_backup.util import get_binary_info
+from dar_backup.util import print_aligned_settings
+from dar_backup.util import backup_definition_completer, list_archive_completer
 
 from dar_backup.command_runner import CommandRunner   
 from dar_backup.command_runner import CommandResult
 
 from dar_backup.rich_progress import show_log_driven_bar
 
+from argcomplete.completers import FilesCompleter
 
 logger = None
 runner = None
@@ -312,7 +321,8 @@ def verify(args: argparse.Namespace, backup_file: str, backup_definition: str, c
             if filecmp.cmp(os.path.join(config_settings.test_restore_dir, restored_file_path.lstrip("/")), os.path.join(root_path, restored_file_path.lstrip("/")), shallow=False):
                 args.verbose and logger.info(f"Success: file '{restored_file_path}' matches the original")
             else:
-                raise BackupError(f"Failure: file '{restored_file_path}' did not match the original")
+                result = False
+                logger.error(f"Failure: file '{restored_file_path}' did not match the original")
         except PermissionError:
             result = False
             logger.exception(f"Permission error while comparing files, continuing....")
@@ -523,6 +533,10 @@ def perform_backup(args: argparse.Namespace, config_settings: ConfigSettings, ba
 
             # Perform backup
             backup_result = generic_backup(backup_type, command, backup_file, backup_definition_path, args.darrc, config_settings, args)
+            if not isinstance(backup_result, list) or not all(isinstance(i, tuple) and len(i) == 2 for i in backup_result):
+                logger.error("Unexpected return format from generic_backup")
+                backup_result = [("Unexpected return format from generic_backup", 1)]
+
             results.extend(backup_result)
 
             logger.info("Starting verification...")
@@ -637,14 +651,6 @@ def filter_darrc_file(darrc_path):
 
 
 
-def show_version():
-    script_name = os.path.basename(argv[0])
-    print(f"{script_name} {about.__version__}") 
-    print(f"dar-backup.py source code is here: https://github.com/per2jensen/dar-backup")
-    print('''Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-See section 15 and section 16 in the supplied "LICENSE" file.''')
-
 
 def show_examples():
     examples = """
@@ -752,15 +758,15 @@ def main():
     parser.add_argument('-F', '--full-backup', action='store_true', help="Perform a full backup.")
     parser.add_argument('-D', '--differential-backup', action='store_true', help="Perform differential backup.")
     parser.add_argument('-I', '--incremental-backup', action='store_true', help="Perform incremental backup.")
-    parser.add_argument('-d', '--backup-definition', help="Specific 'recipe' to select directories and files.")
-    parser.add_argument('--alternate-reference-archive', help="DIFF or INCR compared to specified archive.")
+    parser.add_argument('-d', '--backup-definition', help="Specific 'recipe' to select directories and files.").completer = backup_definition_completer
+    parser.add_argument('--alternate-reference-archive', help="DIFF or INCR compared to specified archive.").completer = list_archive_completer
     parser.add_argument('-c', '--config-file', type=str, help="Path to 'dar-backup.conf'", default='~/.config/dar-backup/dar-backup.conf')
     parser.add_argument('--darrc', type=str, help='Optional path to .darrc')
-    parser.add_argument('-l', '--list', action='store_true', help="List available archives.")
-    parser.add_argument('--list-contents', help="List the contents of the specified archive.")
+    parser.add_argument('-l', '--list', action='store_true', help="List available archives.").completer = list_archive_completer
+    parser.add_argument('--list-contents', help="List the contents of the specified archive.").completer = list_archive_completer
     parser.add_argument('--selection', help="dar file selection for listing/restoring specific files/directories.")
 #    parser.add_argument('-r', '--restore', nargs=1, type=str, help="Restore specified archive.")
-    parser.add_argument('-r', '--restore', type=str, help="Restore specified archive.")
+    parser.add_argument('-r', '--restore', type=str, help="Restore specified archive.").completer = list_archive_completer
     parser.add_argument('--restore-dir',   type=str, help="Directory to restore files to.")
     parser.add_argument('--verbose', action='store_true', help="Print various status messages to screen")
     parser.add_argument('--suppress-dar-msg', action='store_true', help="cancel dar options in .darrc: -vt, -vs, -vd, -vf and -va")
@@ -773,6 +779,8 @@ def main():
     parser.add_argument("--changelog", action="store_true", help="Print Changelog.md to stdout and exit.")
     parser.add_argument("--changelog-pretty", action="store_true", help="Print Changelog.md to stdout with Markdown styling and exit.")
     parser.add_argument('-v', '--version', action='store_true', help="Show version and license information.")
+    
+    argcomplete.autocomplete(parser)
     args = parser.parse_args()
 
     if args.version:
@@ -834,32 +842,40 @@ def main():
             args.darrc = filter_darrc_file(args.darrc)
             logger.debug(f"Filtered .darrc file: {args.darrc}")
 
+        start_msgs: List[Tuple[str, str]] = []
+
         start_time=int(time())
-        logger.info(f"=====================================")
-        logger.info(f"dar-backup.py started, version: {about.__version__}")
+        start_msgs.append(('dar-backup.py:', about.__version__))
         logger.info(f"START TIME: {start_time}")
-        logger.debug(f"`args`:\n{args}")
-        logger.debug(f"`config_settings`:\n{config_settings}")
+        logger.debug(f"{'`Args`:\n'}{args}")
+        logger.debug(f"{'`Config_settings`:\n'}{config_settings}")
+        dar_properties = get_binary_info(command='dar')
+        start_msgs.append(('dar path:', dar_properties['path']))
+        start_msgs.append(('dar version:', dar_properties['version']))
 
         file_dir =  os.path.normpath(os.path.dirname(__file__))
-        args.verbose and (print(f"Script directory:  {file_dir}"))
-        args.verbose and (print(f"Config file:       {args.config_file}"))
-        args.verbose and args.full_backup         and (print(f"Type of backup:    FULL"))
-        args.verbose and args.differential_backup and (print(f"Type of backup:    DIFF"))
-        args.verbose and args.incremental_backup  and (print(f"Type of backup:    INCR"))
-        args.verbose and args.backup_definition   and (print(f"Backup definition: '{args.backup_definition}'"))
+        start_msgs.append(('Script directory:', os.path.abspath(file_dir)))
+        start_msgs.append(('Config file:', os.path.abspath(args.config_file)))
+        start_msgs.append((".darrc location:", args.darrc))
+
+        args.verbose and args.full_backup         and start_msgs.append(("Type of backup:", "FULL"))
+        args.verbose and args.differential_backup and start_msgs.append(("Type of backup:", "DIFF"))
+        args.verbose and args.incremental_backup  and start_msgs.append(("Type of backup:", "INCR"))
+        args.verbose and args.backup_definition   and start_msgs.append(("Backup definition:", args.backup_definition))
         if args.alternate_reference_archive:
-            args.verbose and (print(f"Alternate ref archive: {args.alternate_reference_archive}"))
-        args.verbose and (print(f"Backup.d dir:      {config_settings.backup_d_dir}"))
-        args.verbose and (print(f"Backup dir:        {config_settings.backup_dir}"))
+            args.verbose and start_msgs.append(("Alternate ref archive:", args.alternate_reference_archive))
+        args.verbose and start_msgs.append(("Backup.d dir:", config_settings.backup_d_dir))
+        args.verbose and start_msgs.append(("Backup dir:", config_settings.backup_dir))
 
         restore_dir = args.restore_dir if args.restore_dir else config_settings.test_restore_dir
-        args.verbose and (print(f"Restore dir:       {restore_dir}"))
+        args.verbose and start_msgs.append(("Restore dir:", restore_dir))
+
+        args.verbose and start_msgs.append(("Logfile location:", config_settings.logfile_location))
+        args.verbose and start_msgs.append(("PAR2 enabled:", config_settings.par2_enabled))
+        args.verbose and start_msgs.append(("--do-not-compare:", args.do_not_compare))
 
-        args.verbose and (print(f"Logfile location:  {config_settings.logfile_location}"))
-        args.verbose and (print(f".darrc location:   {args.darrc}"))
-        args.verbose and (print(f"PAR2 enabled:      {config_settings.par2_enabled}"))
-        args.verbose and (print(f"--do-not-compare:  {args.do_not_compare}"))
+        dangerous_keywords = ["--do-not", "alternate"] # TODO: add more dangerous keywords
+        print_aligned_settings(start_msgs)
 
         # sanity check
         if args.backup_definition and not os.path.exists(os.path.join(config_settings.backup_d_dir, args.backup_definition)):
@@ -921,12 +937,17 @@ def main():
             else:
                 logger.error(f"not correct result type: {result}, which must be a tuple (<msg>, <exit_code>)")
             i=i+1
+            
+    console = Console()
     if error:
-        args.verbose and print("\033[1m\033[31mErrors\033[0m encountered")
+        if args.verbose:
+            console.print(Text("Errors encountered", style="bold red"))
         exit(1)
     else:
-        args.verbose and print("\033[1m\033[32mSuccess\033[0m all backups completed") 
+        if args.verbose:
+            console.print(Text("Success: all backups completed", style="bold green"))
         exit(0)
+
     
 if __name__ == "__main__":
     main()

dar_backup/demo.py

@@ -0,0 +1,138 @@
+#!/usr/bin/env python3
+"""
+installer.py source code is here: https://github.com/per2jensen/dar-backup/tree/main/v2/src/dar_backup/installer.py
+This script is part of dar-backup, a backup solution for Linux using dar and systemd.
+
+Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, 
+not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See section 15 and section 16 in the supplied "LICENSE" file
+
+This script can be used to configure dar-backup on your system.
+It is non-destructive and will not overwrite any existing files or directories.
+"""
+
+import argparse
+import os
+import shutil
+import sys 
+
+from . import __about__ as about
+from pathlib import Path
+
+LICENSE = '''Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See section 15 and section 16 in the supplied "LICENSE" file.'''
+
+CONFIG_DIR = os.path.expanduser("~/.config/dar-backup")
+DAR_BACKUP_DIR = os.path.expanduser("~/dar-backup/")
+
+BACKUP_DEFINITION = '''
+# Demo of a `dar-backup` definition file
+# This back definition file configures a backup of ~/.config/dar-backup
+# `dar-backup` puts the backups in ~/dar-backup/backups
+# ------------------------------------------------------------------------
+
+# Switch to ordered selection mode, which means that the following options
+# will be considered top to bottom
+-am
+
+# Backup Root dir
+-R @@HOME_DIR@@
+
+# Directories to backup below the Root dir
+-g .config/dar-backup
+
+# Examples of directories to exclude below the Root dir
+ -P mnt
+ -P .private
+ -P .cache   
+
+# compression level
+ -z5
+
+ # no overwrite, if you rerun a backup, 'dar' halts and asks what to do
+ -n
+ 
+ # size of each slice in the archive
+ --slice 10G
+
+# bypass directores marked as cache directories
+# http://dar.linux.free.fr/doc/Features.html
+--cache-directory-tagging
+'''
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Set up `dar-backup` on your system.",
+    )
+    parser.add_argument(
+        "-i", "--install",
+        action="store_true",
+        help="Deploy a simple config file, use ~/dar-backup/ for log file, archives and restore tests."
+    )
+    parser.add_argument(
+        "-v", "--version",
+        action="version",
+        version=f"%(prog)s version {about.__version__}, {LICENSE}"
+    )
+
+    args = parser.parse_args()
+
+    if args.install:
+        errors = []
+        if os.path.exists(CONFIG_DIR):
+            errors.append(f"Config directory '{CONFIG_DIR}' already exists.")
+        if os.path.exists(DAR_BACKUP_DIR):
+            errors.append(f"Directory '{DAR_BACKUP_DIR}' already exists.")
+
+        if errors:
+            for error in errors:
+                print(f"Error: {error}")
+            sys.exit(1)
+
+        try:
+            os.makedirs(DAR_BACKUP_DIR, exist_ok=False)
+            os.makedirs(os.path.join(DAR_BACKUP_DIR, "backups"), exist_ok=False)
+            os.makedirs(os.path.join(DAR_BACKUP_DIR, "restore"), exist_ok=False)
+            os.makedirs(CONFIG_DIR, exist_ok=False)
+            os.makedirs(os.path.join(CONFIG_DIR, "backup.d"), exist_ok=False)
+            print(f"Directories created: `{DAR_BACKUP_DIR}` and `{CONFIG_DIR}`")
+
+            script_dir = Path(__file__).parent
+            source_file = script_dir / "dar-backup.conf"
+            destination_file = Path(CONFIG_DIR) / "dar-backup.conf"
+
+            try:
+                shutil.copy2(source_file, destination_file)
+                print(f"Config file deployed to {destination_file}")
+            except Exception as e:
+                print(f"Error: Could not copy config file: {e}")
+                sys.exit(1)
+
+
+            backup_definition = BACKUP_DEFINITION.replace("@@HOME_DIR@@", os.path.expanduser("~"))
+
+            try:
+                with open(os.path.join(CONFIG_DIR, "backup.d", "default"), "w") as f:
+                    f.write(backup_definition)
+                print(f"Default backup definition file deployed to {os.path.join(CONFIG_DIR, 'backup.d', 'default')}")
+            except Exception as e:
+                print(f"Error: Could not write default backup definition: {e}")
+                sys.exit(1)
+        except Exception as e:
+            print(f"Installation failed: {e}")
+            sys.exit(1)
+
+        print("1. Now run `manager --create` to create the catalog database.")
+        print("2. Then you can run `dar-backup --full-backup` to create a backup.")
+        print("3. List backups with `dar-backup --list`")
+        print("4. List contents of a backup with `dar-backup --list-contents <backup-name>`")
+
+    sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()

dar_backup/exceptions.py

@@ -0,0 +1,3 @@
+class ConfigSettingsError(Exception):
+    """Raised when ConfigSettings encounters a critical error."""
+    pass

dar_backup/installer.py

@@ -1,138 +1,58 @@
-#!/usr/bin/env python3
-"""
-installer.py source code is here: https://github.com/per2jensen/dar-backup/tree/main/v2/src/dar_backup/installer.py
-This script is part of dar-backup, a backup solution for Linux using dar and systemd.
-
-Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
-
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, 
-not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-See section 15 and section 16 in the supplied "LICENSE" file
-
-This script can be used to configure dar-backup on your system.
-It is non-destructive and will not overwrite any existing files or directories.
-"""
-
 import argparse
 import os
-import shutil
-import sys 
-
-from . import __about__ as about
 from pathlib import Path
-
-LICENSE = '''Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-See section 15 and section 16 in the supplied "LICENSE" file.'''
-
-CONFIG_DIR = os.path.expanduser("~/.config/dar-backup")
-DAR_BACKUP_DIR = os.path.expanduser("~/dar-backup/")
-
-BACKUP_DEFINITION = '''
-# Demo of a `dar-backup` definition file
-# This back definition file configures a backup of ~/.config/dar-backup
-# `dar-backup` puts the backups in ~/dar-backup/backups
-# ------------------------------------------------------------------------
-
-# Switch to ordered selection mode, which means that the following options
-# will be considered top to bottom
--am
-
-# Backup Root dir
--R @@HOME_DIR@@
-
-# Directories to backup below the Root dir
--g .config/dar-backup
-
-# Examples of directories to exclude below the Root dir
- -P mnt
- -P .private
- -P .cache   
-
-# compression level
- -z5
-
- # no overwrite, if you rerun a backup, 'dar' halts and asks what to do
- -n
- 
- # size of each slice in the archive
- --slice 10G
-
-# bypass directores marked as cache directories
-# http://dar.linux.free.fr/doc/Features.html
---cache-directory-tagging
-'''
-
-
-def main():
-    parser = argparse.ArgumentParser(
-        description="Set up `dar-backup` on your system.",
-    )
-    parser.add_argument(
-        "-i", "--install",
-        action="store_true",
-        help="Deploy a simple config file, use ~/dar-backup/ for log file, archives and restore tests."
-    )
-    parser.add_argument(
-        "-v", "--version",
-        action="version",
-        version=f"%(prog)s version {about.__version__}, {LICENSE}"
+from dar_backup.config_settings import ConfigSettings
+from dar_backup.util import setup_logging, get_logger
+from dar_backup.command_runner import CommandRunner
+from dar_backup.manager import create_db
+
+
+def run_installer(config_file: str, create_db_flag: bool):
+    config_file = os.path.expanduser(os.path.expandvars(config_file))
+    config_settings = ConfigSettings(config_file)
+
+    # Set up logging based on the config's specified log file
+    command_log = config_settings.logfile_location.replace("dar-backup.log", "dar-backup-commands.log")
+    logger = setup_logging(
+        config_settings.logfile_location,
+        command_log,
+        log_level="info",
+        log_stdout=True,
     )
-
+    command_logger = get_logger(command_output_logger=True)
+    runner = CommandRunner(logger=logger, command_logger=command_logger)
+
+    # Create directories listed in config
+    for attr in ["backup_dir", "test_restore_dir", "backup_d_dir", "manager_db_dir"]:
+        path = getattr(config_settings, attr, None)
+        if path:
+            dir_path = Path(path).expanduser()
+            if not dir_path.exists():
+                dir_path.mkdir(parents=True, exist_ok=True)
+                print(f"Created directory: {dir_path}")
+            else:
+                print(f"Directory already exists: {dir_path}")
+
+    # Optionally create databases
+    if create_db_flag:
+        for file in os.listdir(config_settings.backup_d_dir):
+            backup_def = os.path.basename(file)
+            print(f"Creating catalog for: {backup_def}")
+            result = create_db(backup_def, config_settings, logger)
+            if result == 0:
+                print(f"✔️  Catalog created (or already existed): {backup_def}")
+            else:
+                print(f"❌ Failed to create catalog: {backup_def}")
+
+
+def installer_main():
+    parser = argparse.ArgumentParser(description="dar-backup installer")
+    parser.add_argument("--config", required=True, help="Path to config file")
+    parser.add_argument("--create-db", action="store_true", help="Create catalog databases")
     args = parser.parse_args()
 
-    if args.install:
-        errors = []
-        if os.path.exists(CONFIG_DIR):
-            errors.append(f"Config directory '{CONFIG_DIR}' already exists.")
-        if os.path.exists(DAR_BACKUP_DIR):
-            errors.append(f"Directory '{DAR_BACKUP_DIR}' already exists.")
-
-        if errors:
-            for error in errors:
-                print(f"Error: {error}")
-            sys.exit(1)
-
-        try:
-            os.makedirs(DAR_BACKUP_DIR, exist_ok=False)
-            os.makedirs(os.path.join(DAR_BACKUP_DIR, "backups"), exist_ok=False)
-            os.makedirs(os.path.join(DAR_BACKUP_DIR, "restore"), exist_ok=False)
-            os.makedirs(CONFIG_DIR, exist_ok=False)
-            os.makedirs(os.path.join(CONFIG_DIR, "backup.d"), exist_ok=False)
-            print(f"Directories created: `{DAR_BACKUP_DIR}` and `{CONFIG_DIR}`")
-
-            script_dir = Path(__file__).parent
-            source_file = script_dir / "dar-backup.conf"
-            destination_file = Path(CONFIG_DIR) / "dar-backup.conf"
-
-            try:
-                shutil.copy2(source_file, destination_file)
-                print(f"Config file deployed to {destination_file}")
-            except Exception as e:
-                print(f"Error: Could not copy config file: {e}")
-                sys.exit(1)
-
-
-            backup_definition = BACKUP_DEFINITION.replace("@@HOME_DIR@@", os.path.expanduser("~"))
-
-            try:
-                with open(os.path.join(CONFIG_DIR, "backup.d", "default"), "w") as f:
-                    f.write(backup_definition)
-                print(f"Default backup definition file deployed to {os.path.join(CONFIG_DIR, 'backup.d', 'default')}")
-            except Exception as e:
-                print(f"Error: Could not write default backup definition: {e}")
-                sys.exit(1)
-        except Exception as e:
-            print(f"Installation failed: {e}")
-            sys.exit(1)
-
-        print("1. Now run `manager --create` to create the catalog database.")
-        print("2. Then you can run `dar-backup --full-backup` to create a backup.")
-        print("3. List backups with `dar-backup --list`")
-        print("4. List contents of a backup with `dar-backup --list-contents <backup-name>`")
-
-    sys.exit(0)
+    run_installer(args.config, args.create_db)
 
 
 if __name__ == "__main__":
-    main()
+    installer_main()