dar-backup 0.6.21__py3-none-any.whl → 0.7.2__py3-none-any.whl

dar_backup/demo_backup_def.j2

@@ -0,0 +1,62 @@
+
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# ------------------------------------------------------------------------
+# Demo of a `dar-backup` definition file
+# This file was generated by dar-backup's `demo` program.
+# 
+{%- if opts_dict | length > 0 %}
+# Options given to the `demo` program:
+{% endif %}
+{%- if opts_dict.ROOT_DIR -%}
+# --root-dir : {{ opts_dict.ROOT_DIR }}  
+{% endif %}
+{%- if opts_dict.DIR_TO_BACKUP -%}
+# --dir-to-backup : {{ opts_dict.DIR_TO_BACKUP }}  
+{% endif -%}
+{%- if opts_dict.BACKUP_DIR -%}
+# --backup-dir : {{ opts_dict.BACKUP_DIR }}
+{% endif %}
+#
+# Variables used to generate this file:
+# =====================================
+{% for k,v in vars_map|dictsort %}# {{ k }} : {{ v }}
+{% endfor -%}
+# ------------------------------------------------------------------------
+
+# Switch to ordered selection mode, which means that the following options
+# will be considered top to bottom
+-am
+
+# Backup Root dir
+{%- if vars_map.ROOT_DIR %}
+-R {{ vars_map.ROOT_DIR }}
+{% endif -%}
+
+{% if vars_map.DIR_TO_BACKUP %}
+# Directories to backup below the Root dir
+-g {{ vars_map.DIR_TO_BACKUP }}
+
+# This is an example of exclusion of a `.private` directory inside the
+# directory that is backed up
+-P {{ vars_map.DIR_TO_BACKUP }}/.private
+{%- else %}
+# Examples of directories to exclude below the Root dir
+-P mnt
+-P .cache
+{% endif %}
+
+# compression level
+-z5
+
+# no overwrite, if you rerun a backup, 'dar' halts and asks what to do
+# as `dar-backup` gives the `-Q` option to `dar`, the net effect of `-n` and `-Q` is
+# that `dar` will quit and not overwrite the existing backup 
+-n
+ 
+# size of each slice in the archive (10G is 10 Gigabytes)
+--slice 10G
+
+# bypass directores marked as cache directories
+# http://dar.linux.free.fr/doc/Features.html
+--cache-directory-tagging

dar_backup/exceptions.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 class ConfigSettingsError(Exception):
     """Raised when ConfigSettings encounters a critical error."""
     pass

dar_backup/installer.py

@@ -1,3 +1,6 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 import argparse
 import os
 from . import __about__ as about
@@ -9,6 +12,91 @@ from dar_backup.manager import create_db
 # Always expand manager DB dir correctly, using helper function
 from dar_backup.manager import get_db_dir
 from dar_backup.util import expand_path
+from dar_backup.util import is_safe_path
+
+def install_autocompletion():
+    """Detect user shell, choose RC file, and idempotently append autocompletion."""
+    shell = Path(os.environ.get("SHELL", "")).name
+    home = Path.home()
+
+    # pick RC file based on shell
+    if shell == "zsh":
+        rc_file = home / ".zshrc"
+    elif shell == "bash":
+        # prefer ~/.bash_profile on macOS if present
+        rc_file = home / ".bash_profile" if (home / ".bash_profile").exists() else home / ".bashrc"
+    else:
+        rc_file = home / ".bashrc"
+
+    marker = "# >>> dar-backup autocompletion >>>"
+    end_marker = "# <<< dar-backup autocompletion <<<"
+
+    block = "\n".join([
+        marker,
+        'eval "$(register-python-argcomplete dar-backup)"',
+        'eval "$(register-python-argcomplete cleanup)"',
+        'eval "$(register-python-argcomplete manager)"',
+        "#complete -o nosort -C 'python -m argcomplete cleanup' cleanup",
+        "#complete -o nosort -C 'python -m argcomplete manager' manager",
+        end_marker,
+    ]) + "\n"
+
+    # ensure RC file and parent directory exist
+    rc_file.parent.mkdir(parents=True, exist_ok=True)
+    if not rc_file.exists():
+        rc_file.touch()
+
+    content = rc_file.read_text()
+    if marker in content:
+        print(f"Autocompletion already installed in {rc_file}")
+        return
+
+    # append the autocompletion block
+    rc_file.open("a").write("\n" + block)
+    print(f"✔️ Appended autocompletion block to {rc_file}")
+
+
+
+def uninstall_autocompletion() -> str:
+    """Remove previously installed autocompletion block from shell RC file."""
+    shell = Path(os.environ.get("SHELL", "")).name
+    home = Path.home()
+
+    # pick RC file based on shell
+    if shell == "zsh":
+        rc_file = home / ".zshrc"
+    elif shell == "bash":
+        rc_file = home / ".bash_profile" if (home / ".bash_profile").exists() else home / ".bashrc"
+    else:
+        rc_file = home / ".bashrc"
+
+    marker = "# >>> dar-backup autocompletion >>>"
+    end_marker = "# <<< dar-backup autocompletion <<<"
+
+    if not rc_file.exists():
+        print(f"❌ RC file not found: {rc_file}")
+        return
+
+    content = rc_file.read_text()
+    if marker not in content:
+        print(f"No autocompletion block found in {rc_file}")
+        return f"No autocompletion block found in {rc_file}"  # for unit test
+
+    lines = content.splitlines(keepends=True)
+    new_lines = []
+    skipping = False
+    for line in lines:
+        if marker in line:
+            skipping = True
+            continue
+        if end_marker in line and skipping:
+            skipping = False
+            continue
+        if not skipping:
+            new_lines.append(line)
+
+    rc_file.write_text(''.join(new_lines))
+    print(f"✔️ Removed autocompletion block from {rc_file}")
 
 
 
@@ -29,6 +117,8 @@ 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)
 
+    print(f"Using config settings: {config_settings}")
+
     # Set up logging
     command_log = config_settings.logfile_location.replace("dar-backup.log", "dar-backup-commands.log")
     logger = setup_logging(
@@ -50,6 +140,9 @@ def run_installer(config_file: str, create_db_flag: bool):
     }
 
     for name, dir_path in required_dirs.items():
+        if not is_safe_path(dir_path):
+            logger.error(f"Unsafe path detected: {dir_path} ({name})")
+            raise ValueError(f"Unsafe path detected: {dir_path} ({name})")
         expanded = Path(expand_path(dir_path))
         if not expanded.exists():
             logger.info(f"Creating directory: {expanded} ({name})")
@@ -62,22 +155,44 @@ def run_installer(config_file: str, create_db_flag: bool):
             print(f"Creating catalog for: {backup_def}")
             result = create_db(backup_def, config_settings, logger, runner)
             if result == 0:
-                print(f"✔️  Catalog created (or already existed): {backup_def}")
+                print(f"✔️  Catalog created (or already exist): {backup_def}")
             else:
                 print(f"❌ Failed to create catalog: {backup_def}")
 
 
 def main():
     parser = argparse.ArgumentParser(description="dar-backup installer")
-    parser.add_argument("--config", required=True, help="Path to config file")
+    parser.add_argument("--config", required=False, help="Path to config file")
     parser.add_argument("--create-db", action="store_true", help="Create catalog databases")
-    parser.add_argument("-v", "--version", action="version", version=f"%(prog)s version {about.__version__}, {about.__license__}"
+    group = parser.add_mutually_exclusive_group()
+    group.add_argument(
+        "--install-autocompletion", action="store_true",
+        help="Append shell-completion setup to your shell RC"
+    )
+    group.add_argument(
+        "--remove-autocompletion", action="store_true",
+        help="Remove shell-completion setup from your shell RC"
+    )
+    parser.add_argument(
+        "-v", "--version", action="version",
+        version=f"%(prog)s version {about.__version__}, {about.__license__}"
     )
 
     args = parser.parse_args()
 
-    run_installer(args.config, args.create_db)
 
+    if args.config:
+        if not os.path.exists(args.config):
+            print(f"❌ Config file does not exist: {args.config}")
+            return
+        run_installer(args.config, args.create_db)
+
+    if args.install_autocompletion:
+        install_autocompletion()
+    elif args.remove_autocompletion:
+        uninstall_autocompletion()  
+
+    
 
 if __name__ == "__main__":
     main()

dar_backup/manager.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 """
    Copyright (C) 2024  Per Jensen
@@ -39,6 +40,7 @@ from dar_backup.util import get_binary_info
 from dar_backup.util import show_version
 from dar_backup.util import get_invocation_command_line
 from dar_backup.util import print_aligned_settings
+from dar_backup.util import show_scriptname
 
 from dar_backup.command_runner import CommandRunner   
 from dar_backup.command_runner import CommandResult
@@ -543,14 +545,15 @@ def main():
         return
 
     command_output_log = config_settings.logfile_location.replace("dar-backup.log", "dar-backup-commands.log")
-    logger = setup_logging(config_settings.logfile_location, command_output_log, args.log_level, args.log_stdout)
+    logger = setup_logging(config_settings.logfile_location, command_output_log, args.log_level, args.log_stdout, logfile_max_bytes=config_settings.logfile_max_bytes, logfile_backup_count=config_settings.logfile_backup_count)
     command_logger = get_logger(command_output_logger=True)
     runner = CommandRunner(logger=logger, command_logger=command_logger)
 
     start_msgs: List[Tuple[str, str]] = []
 
     start_time = int(time())
-    start_msgs.append((f"{SCRIPTNAME}:", about.__version__))
+    
+    start_msgs.append((f"{show_scriptname()}:", about.__version__))
     logger.info(f"START TIME: {start_time}")
     logger.debug(f"Command line: {get_invocation_command_line()}")
     logger.debug(f"`args`:\n{args}")
@@ -558,13 +561,15 @@ def main():
     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(("Logfile max size (bytes):", config_settings.logfile_max_bytes))
+    args.verbose and start_msgs.append(("Logfile backup count:", config_settings.logfile_backup_count))
     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)) 
+    args.verbose and start_msgs.append(("--remove-specific-archive:", args.remove_specific_archive)) 
     dar_manager_properties = get_binary_info(command='dar_manager')
     start_msgs.append(("dar_manager:", dar_manager_properties['path']))
     start_msgs.append(("dar_manager v.:", dar_manager_properties['version']))
     
-    print_aligned_settings(start_msgs)
+    print_aligned_settings(start_msgs, quiet=not args.verbose)
 
     # --- Sanity checks ---
     if args.add_dir and not args.add_dir.strip():

dar_backup/rich_progress.py

@@ -1,3 +1,6 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 import os
 import time
 from threading import Event
@@ -99,3 +102,4 @@ def show_log_driven_bar(log_path: str, stop_event: Event, session_marker: str, m
             if stop_event.is_set():
                 break
 
+    # Rich prints a \n here, I will live with it

dar_backup/util.py

@@ -1,3 +1,5 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
 """
 util.py source code is here: https://github.com/per2jensen/dar-backup
 
@@ -10,7 +12,9 @@ See section 15 and section 16 in the supplied "LICENSE" file
 import typing
 import locale
 import configparser
+import inspect
 import logging
+
 import os
 import re
 import subprocess
@@ -19,11 +23,15 @@ import shutil
 import sys
 import threading
 import traceback
+
+import dar_backup.__about__ as about
+
+
 from argcomplete.completers import ChoicesCompleter
 from datetime import datetime
 from dar_backup.config_settings import ConfigSettings
-import dar_backup.__about__ as about
-
+from logging.handlers import RotatingFileHandler
+from pathlib import Path
 from rich.console import Console
 from rich.text import Text
 
@@ -34,7 +42,16 @@ from typing import Tuple
 logger=None
 secondary_logger=None   
 
-def setup_logging(log_file: str, command_output_log_file: str, log_level: str = "info", log_to_stdout: bool = False) -> logging.Logger:
+#def setup_logging(log_file: str, command_output_log_file: str, log_level: str = "info", log_to_stdout: bool = False) -> logging.Logger:
+def setup_logging(
+    log_file: str,
+    command_output_log_file: str,
+    log_level: str = "info",
+    log_to_stdout: bool = False,
+    logfile_max_bytes: int = 26214400,
+    logfile_backup_count: int = 5,
+) -> logging.Logger:
+
     """
     Sets up logging for the main program and a separate secondary logfile for command outputs.
 
@@ -43,9 +60,11 @@ def setup_logging(log_file: str, command_output_log_file: str, log_level: str =
         command_output_log_file (str): The path to the secondary log file for command outputs.
         log_level (str): The log level to use. Can be "info", "debug", or "trace". Defaults to "info".
         log_to_stdout (bool): If True, log messages will be printed to the console. Defaults to False.
+        logfile_max_bytes: max file size of a log file, defailt = 26214400.
+        logfile_backup_count: max numbers of logs files, default = 5.
 
     Returns:
-        None
+        a RotatingFileHandler logger instance.
 
     Raises:
         Exception: If an error occurs during logging initialization
@@ -61,20 +80,34 @@ def setup_logging(log_file: str, command_output_log_file: str, log_level: str =
 
         logging.Logger.trace = trace
 
+        file_handler = RotatingFileHandler(
+            log_file,
+            maxBytes=logfile_max_bytes,
+            backupCount=logfile_backup_count,
+            encoding="utf-8",
+        )
+
+        command_handler = RotatingFileHandler(
+            command_output_log_file,
+            maxBytes=logfile_max_bytes,
+            backupCount=logfile_backup_count,
+            encoding="utf-8",
+        )
+
+        formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+        file_handler.setFormatter(formatter)
+        command_handler.setFormatter(formatter)
+
+
         # Setup main logger
         logger = logging.getLogger("main_logger")
         logger.setLevel(logging.DEBUG if log_level == "debug" else TRACE_LEVEL_NUM if log_level == "trace" else logging.INFO)
-        formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
-        file_handler = logging.FileHandler(log_file)
-        file_handler.setFormatter(formatter)
         logger.addHandler(file_handler)
 
         # Setup secondary logger for command outputs
         secondary_logger = logging.getLogger("command_output_logger")
         secondary_logger.setLevel(logging.DEBUG if log_level == "debug" else TRACE_LEVEL_NUM if log_level == "trace" else logging.INFO)
-        sec_file_handler = logging.FileHandler(command_output_log_file)
-        sec_file_handler.setFormatter(formatter)
-        secondary_logger.addHandler(sec_file_handler)
+        secondary_logger.addHandler(command_handler)
 
         if log_to_stdout:
             stdout_handler = logging.StreamHandler(sys.stdout)
@@ -119,6 +152,15 @@ completer_logger = _setup_completer_logger()
 completer_logger.debug("Completer logger initialized.")
 
 
+def print_debug(msg):
+    """
+    Print a debug message with the filename and line number of the caller.    
+    """
+    frame = inspect.currentframe().f_back
+    print(f"[DEBUG] {frame.f_code.co_filename}:{frame.f_lineno} - {repr(msg)}")
+
+
+
 def get_invocation_command_line() -> str:
     """
     Safely retrieves the exact command line used to invoke the current Python process.
@@ -141,6 +183,17 @@ def get_invocation_command_line() -> str:
         return f"[error: could not read /proc/[pid]/cmdline: {e}]"
 
 
+def show_scriptname()  -> str:
+    """
+    Return script name, useful in start banner for example
+    """
+    try:
+        scriptname = os.path.basename(sys.argv[0])
+    except:
+        scriptname = "unknown"
+    return scriptname
+
+
 def show_version():
     script_name = os.path.basename(sys.argv[0])
     print(f"{script_name} {about.__version__}")
@@ -606,6 +659,7 @@ def print_aligned_settings(
     settings: List[Tuple[str, str]],
     log: bool = True,
     header: str = "Startup Settings",
+    quiet: bool = True,
     highlight_keywords: List[str] = None
 ) -> None:
     """
@@ -624,7 +678,7 @@ def print_aligned_settings(
     header_line = f"========== {header} =========="
     footer_line = "=" * len(header_line)
 
-    console.print(f"[bold cyan]{header_line}[/bold cyan]")
+    not quiet and console.print(f"[bold cyan]{header_line}[/bold cyan]")
     if log and logger:
         logger.info(header_line)
 
@@ -654,13 +708,53 @@ def print_aligned_settings(
 
         line_text.append(text, style="white")
 
-        console.print(line_text)
+        not quiet and console.print(line_text)
 
         # Always log clean text (no [!] in log)
         final_line_for_log = f"{padded_label} {text}"
         if log and logger:
             logger.info(final_line_for_log)
 
-    console.print(f"[bold cyan]{footer_line}[/bold cyan]")
+    not quiet and console.print(f"[bold cyan]{footer_line}[/bold cyan]")
     if log and logger:
         logger.info(footer_line)
+
+
+
+
+def normalize_dir(path: str) -> str:
+    """
+    Strip any trailing slash/backslash but leave root (“/” or “C:\\”) intact.
+    """
+    p = Path(path)
+    # Path(__str__) drops any trailing separators
+    normalized = str(p)
+    return normalized
+
+
+
+# Reusable pattern for archive file naming
+archive_pattern = re.compile(
+    r'^.+?_(FULL|DIFF|INCR)_(\d{4}-\d{2}-\d{2})\.\d+\.dar'
+    r'(?:\.vol\d+(?:\+\d+)?\.par2|\.par2)?$'
+)
+
+def is_safe_filename(filename: str) -> bool:
+    """
+    Validates that the filename matches acceptable dar/par2 naming convention.
+    """
+    return archive_pattern.match(filename) is not None
+
+def is_safe_path(path: str) -> bool:
+    """
+    Validates that the full path is absolute, has no '..'.
+    """
+    normalized = os.path.normpath(path)
+    filename = os.path.basename(normalized)
+
+    return (
+        os.path.isabs(normalized)
+        and '..' not in normalized.split(os.sep)
+    )
+
+