dar-backup 0.6.19__tar.gz → 0.6.20__tar.gz

{dar_backup-0.6.19/src/dar_backup → dar_backup-0.6.20}/Changelog.md

@@ -1,6 +1,22 @@
 <!-- markdownlint-disable MD024 -->
 # dar-backup Changelog
 
+## v2-beta-0.6.20 - 2025-05-03
+
+Github link: [v2-beta-0.6.20](https://github.com/per2jensen/dar-backup/tree/v2-beta-0.6.20/v2)
+
+### Added
+
+- show_version() moved to util and tests for dar-backup, manager and cleanup
+- startup informational messages now works the same across the scripts
+- Improved ConfigSettings class to handle optional configuration keys
+
+  -- test cases added
+
+- Optional config parameter: MANAGER_DB_DIR, ideally to point to another disk for safe keeping backup catalogs
+
+  -- test cases added
+
 ## v2-beta-0.6.19 - 2025-04-21
 
 Github link: [v2-beta-0.6.19](https://github.com/per2jensen/dar-backup/tree/v2-beta-0.6.19/v2)

{dar_backup-0.6.19 → dar_backup-0.6.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dar-backup
-Version: 0.6.19
+Version: 0.6.20
 Summary: A script to do full, differential and incremental backups using dar.     Some files are restored from the backups during verification, after which par2 redundancy files are created.     The script also has a cleanup feature to remove old backups and par2 files.
 Project-URL: GPG Public Key, https://keys.openpgp.org/search?q=dar-backup@pm.me
 Project-URL: Homepage, https://github.com/per2jensen/dar-backup/tree/main/v2

{dar_backup-0.6.19 → dar_backup-0.6.20}/pyproject.toml

@@ -47,7 +47,7 @@ dar-backup = "dar_backup.dar_backup:main"
 cleanup = "dar_backup.cleanup:main"
 clean-log = "dar_backup.clean_log:main"
 manager = "dar_backup.manager:main"
-installer = "dar_backup.installer:main"
+demo = "dar_backup.demo:main"
 dar-backup-systemd = "dar_backup.dar_backup_systemd:main"
 
 

{dar_backup-0.6.19 → dar_backup-0.6.20/src/dar_backup}/Changelog.md

@@ -1,6 +1,22 @@
 <!-- markdownlint-disable MD024 -->
 # dar-backup Changelog
 
+## v2-beta-0.6.20 - 2025-05-03
+
+Github link: [v2-beta-0.6.20](https://github.com/per2jensen/dar-backup/tree/v2-beta-0.6.20/v2)
+
+### Added
+
+- show_version() moved to util and tests for dar-backup, manager and cleanup
+- startup informational messages now works the same across the scripts
+- Improved ConfigSettings class to handle optional configuration keys
+
+  -- test cases added
+
+- Optional config parameter: MANAGER_DB_DIR, ideally to point to another disk for safe keeping backup catalogs
+
+  -- test cases added
+
 ## v2-beta-0.6.19 - 2025-04-21
 
 Github link: [v2-beta-0.6.19](https://github.com/per2jensen/dar-backup/tree/v2-beta-0.6.19/v2)

dar_backup-0.6.20/src/dar_backup/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.6.20"

{dar_backup-0.6.19 → dar_backup-0.6.20}/src/dar_backup/cleanup.py

@@ -20,11 +20,15 @@ import os
 import re
 import subprocess
 import sys
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..")))
+
+
 
 from datetime import datetime, timedelta
 from inputimeout import inputimeout, TimeoutOccurred
 from time import time
-from typing import Dict, List, NamedTuple
+from typing import Dict, List, NamedTuple, Tuple
+
 
 from . import __about__ as about
 from dar_backup.config_settings import ConfigSettings
@@ -32,6 +36,8 @@ from dar_backup.util import list_backups
 from dar_backup.util import setup_logging
 from dar_backup.util import get_logger
 from dar_backup.util import requirements
+from dar_backup.util import show_version
+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   
@@ -152,21 +158,12 @@ def delete_catalog(catalog_name: str, args: NamedTuple) -> bool:
         return False
 
 
-def show_version():
-    script_name = os.path.basename(sys.argv[0])
-    print(f"{script_name} {about.__version__}")
-    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 confirm_full_archive_deletion(archive_name: str, test_mode=False) -> bool:
     try:
         if test_mode:
-            confirmation = os.environ.get("CLEANUP_TEST_DELETE_FULL")
-            if confirmation is None:
-                raise RuntimeError("envvar 'CLEANUP_TEST_DELETE_FULL' not set")
-            print(f"Simulated confirmation for FULL archive: {confirmation}")
+            answer = os.getenv("CLEANUP_TEST_DELETE_FULL", "").lower()
+            print(f"Simulated confirmation for FULL archive '{archive_name}': {answer}")
+            return answer == "yes"
         else:
             confirmation = inputimeout(
                 prompt=f"Are you sure you want to delete the FULL archive '{archive_name}'? (yes/no): ",
@@ -220,21 +217,24 @@ def main():
     command_logger = get_logger(command_output_logger = True)
     runner = CommandRunner(logger=logger, command_logger=command_logger)
 
-    logger.info(f"=====================================")
-    logger.info(f"cleanup.py started, version: {about.__version__}")
+    start_msgs: List[Tuple[str, str]] = []
+
+    start_msgs.append(("cleanup.py:", about.__version__))
 
     logger.info(f"START TIME: {start_time}")
     logger.debug(f"`args`:\n{args}")
     logger.debug(f"`config_settings`:\n{config_settings}")
 
     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 (print(f"Backup dir:                 {config_settings.backup_dir}"))
-    args.verbose and (print(f"Logfile location:           {config_settings.logfile_location}"))
-    args.verbose and (print(f"--alternate-archive-dir:    {args.alternate_archive_dir}"))
-    args.verbose and (print(f"--cleanup-specific-archives:{args.cleanup_specific_archives}")) 
-
+    args.verbose and start_msgs.append(("Script directory:", file_dir))
+    start_msgs.append(("Config file:", args.config_file))
+    args.verbose and start_msgs.append(("Backup dir:", config_settings.backup_dir))
+    start_msgs.append(("Logfile:", config_settings.logfile_location))
+    args.verbose and start_msgs.append(("--alternate-archive-dir:", args.alternate_archive_dir))
+    args.verbose and start_msgs.append(("--cleanup-specific-archives:", args.cleanup_specific_archives)) 
+
+    dangerous_keywords = ["--cleanup", "_FULL_"] # TODO: add more dangerous keywords
+    print_aligned_settings(start_msgs, highlight_keywords=dangerous_keywords)
 
     # run PREREQ scripts
     requirements('PREREQ', config_settings)

dar_backup-0.6.20/src/dar_backup/config_settings.py

@@ -0,0 +1,129 @@
+import configparser
+from dataclasses import dataclass, field, fields
+from os.path import expandvars, expanduser
+from pathlib import Path
+
+from dar_backup.exceptions import ConfigSettingsError
+
+@dataclass
+class ConfigSettings:
+    """
+    Parses and holds configuration values from a dar-backup.conf file.
+
+    Required fields are defined as dataclass attributes and must be present in the config file.
+    Optional fields can be declared in the OPTIONAL_CONFIG_FIELDS list. If a key is present in the
+    config file, the field is set to its parsed value; otherwise, it defaults to None.
+
+    The __repr__ method will only include optional fields if their value is not None,
+    keeping debug output clean and focused on explicitly configured values.
+
+    OPTIONAL_CONFIG_FIELDS = [
+        {
+            "section": "DIRECTORIES",
+            "key": "MANAGER_DB_DIR",
+            "attr": "manager_db_dir",
+            "type": str,
+            "default": None,
+        }
+    ]
+    """
+
+    config_file: str
+
+    logfile_location: str = field(init=False)
+    max_size_verification_mb: int = field(init=False)
+    min_size_verification_mb: int = field(init=False)
+    no_files_verification: int = field(init=False)
+    command_timeout_secs: int = field(init=False)
+    backup_dir: str = field(init=False)
+    test_restore_dir: str = field(init=False)
+    backup_d_dir: str = field(init=False)
+    diff_age: int = field(init=False)
+    incr_age: int = field(init=False)
+    error_correction_percent: int = field(init=False)
+    par2_enabled: bool = field(init=False)
+
+
+    OPTIONAL_CONFIG_FIELDS = [
+        {
+            "section": "DIRECTORIES",
+            "key": "MANAGER_DB_DIR",
+            "attr": "manager_db_dir",
+            "type": str,
+            "default": None,
+        },
+        # Add more optional fields here
+    ]
+
+    def __post_init__(self):
+        if not self.config_file:
+            raise ConfigSettingsError("`config_file` must be specified.")
+
+        try:
+            self.config = configparser.ConfigParser()
+            loaded_files = self.config.read(self.config_file)
+            if not loaded_files:
+                raise RuntimeError(f"Configuration file not found or unreadable: '{self.config_file}'")
+
+            self.logfile_location = self.config['MISC']['LOGFILE_LOCATION']
+            self.max_size_verification_mb = int(self.config['MISC']['MAX_SIZE_VERIFICATION_MB'])
+            self.min_size_verification_mb = int(self.config['MISC']['MIN_SIZE_VERIFICATION_MB'])
+            self.no_files_verification = int(self.config['MISC']['NO_FILES_VERIFICATION'])
+            self.command_timeout_secs = int(self.config['MISC']['COMMAND_TIMEOUT_SECS'])
+            self.backup_dir = self.config['DIRECTORIES']['BACKUP_DIR']
+            self.test_restore_dir = self.config['DIRECTORIES']['TEST_RESTORE_DIR']
+            self.backup_d_dir = self.config['DIRECTORIES']['BACKUP.D_DIR']
+            self.diff_age = int(self.config['AGE']['DIFF_AGE'])
+            self.incr_age = int(self.config['AGE']['INCR_AGE'])
+            self.error_correction_percent = int(self.config['PAR2']['ERROR_CORRECTION_PERCENT'])
+
+            val = self.config['PAR2']['ENABLED'].strip().lower()
+            if val in ('true', '1', 'yes'):
+                self.par2_enabled = True
+            elif val in ('false', '0', 'no'):
+                self.par2_enabled = False
+            else:
+                raise ConfigSettingsError(f"Invalid boolean value for 'ENABLED' in [PAR2]: '{val}'")
+
+            # Load optional fields
+            for opt in self.OPTIONAL_CONFIG_FIELDS:
+                if self.config.has_option(opt['section'], opt['key']):
+                    raw_value = self.config.get(opt['section'], opt['key'])
+                    try:
+                        value = opt['type'](raw_value.strip())
+                        setattr(self, opt['attr'], value)
+                    except Exception as e:
+                        raise ConfigSettingsError(
+                            f"Failed to parse optional config '{opt['section']}::{opt['key']}': {e}"
+                        )
+                else:
+                    setattr(self, opt['attr'], opt.get('default', None))
+
+
+            # Expand paths in all string fields that exist
+            for field in fields(self):
+                if hasattr(self, field.name):
+                    value = getattr(self, field.name)
+                    if isinstance(value, str):
+                        setattr(self, field.name, expanduser(expandvars(value)))
+
+        except RuntimeError as e:
+            raise ConfigSettingsError(f"RuntimeError: {e}")
+        except KeyError as e:
+            raise ConfigSettingsError(f"Missing mandatory configuration key: {e}")
+        except ValueError as e:
+            raise ConfigSettingsError(f"Invalid value in config: {e}")
+        except Exception as e:
+            raise ConfigSettingsError(f"Unexpected error during config initialization: {e}")
+
+
+
+    def __repr__(self):
+        safe_fields = [
+            f"{field.name}={getattr(self, field.name)!r}"
+            for field in fields(self)
+            if hasattr(self, field.name) and getattr(self, field.name) is not None
+        ]
+        return f"<ConfigSettings({', '.join(safe_fields)})>"
+
+

{dar_backup-0.6.19 → dar_backup-0.6.20}/src/dar_backup/dar-backup.conf

@@ -16,8 +16,12 @@ COMMAND_TIMEOUT_SECS = 86400
 BACKUP_DIR = ~/dar-backup/backups
 BACKUP.D_DIR = ~/.config/dar-backup/backup.d/
 TEST_RESTORE_DIR = ~/dar-backup/restore/
+# Optional parameter
+# If you want to store the catalog database away from the BACKUP_DIR,  use the MANAGER_DB_DIR variable.
+#MANAGER_DB_DIR = /some/where/else/
 
 [AGE]
+# DIFF and INCR backups are kept for a configured number of days, then deleted by the `cleanuo` 
 # age settings are in days
 DIFF_AGE = 100
 INCR_AGE = 40

{dar_backup-0.6.19 → dar_backup-0.6.20}/src/dar_backup/dar_backup.py

@@ -37,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
@@ -48,7 +50,9 @@ 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   
@@ -647,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 = """
@@ -846,35 +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}")
-        dar_manager_properties = get_binary_info(command='dar')
-        logger.debug(f"dar path: {dar_manager_properties['path']}")
-        logger.debug(f"dar version: {dar_manager_properties['version']}")
+        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 (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}"))
+        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))
+
+        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)):
@@ -936,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-0.6.20/src/dar_backup/exceptions.py

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

dar_backup-0.6.20/src/dar_backup/installer.py

@@ -0,0 +1,58 @@
+import argparse
+import os
+from pathlib import Path
+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()
+
+    run_installer(args.config, args.create_db)
+
+
+if __name__ == "__main__":
+    installer_main()