dar-backup 1.0.2__py3-none-any.whl → 1.1.0__py3-none-any.whl

dar_backup/__about__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.2"
+__version__ = "1.1.0"
 
 __author__ = "Per Jensen"
 

dar_backup/cleanup.py

@@ -16,10 +16,8 @@ This script removes old DIFF and INCR archives + accompanying .par2 files accord
 
 import argcomplete
 import argparse
-import logging
 import os
 import re
-import subprocess
 import sys
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..")))
 
@@ -29,7 +27,7 @@ from inputimeout import inputimeout, TimeoutOccurred
 from pathlib import Path
 from sys import stderr
 from time import time
-from typing import Dict, List, NamedTuple, Tuple
+from typing import List, NamedTuple, Tuple
 import glob
 
 
@@ -147,7 +145,7 @@ def delete_old_backups(backup_dir, age, backup_type, args, backup_definition=Non
                         safe_remove_file(file_path, base_dir=Path(backup_dir))
                         logger.info(f"Deleted {backup_type} backup: {file_path}")
                     archive_name = filename.split('.')[0]
-                    if not archive_name in archives_deleted:
+                    if archive_name not in archives_deleted:
                         logger.debug(f"Archive name: '{archive_name}' added to catalog deletion list")
                     archives_deleted[archive_name] = True
                 except Exception as e:
@@ -209,7 +207,7 @@ def delete_catalog(catalog_name: str, args: NamedTuple) -> bool:
     """
     Call `manager.py` to delete the specified catalog in it's database
     """
-    command = [f"manager", "--remove-specific-archive", catalog_name, "--config-file", args.config_file, '--log-level', 'debug', '--log-stdout']
+    command = ["manager", "--remove-specific-archive", catalog_name, "--config-file", args.config_file, '--log-level', 'debug', '--log-stdout']
     logger.info(f"Deleting catalog '{catalog_name}' using config file: '{args.config_file}'")
     try:
         result:CommandResult = runner.run(command)
@@ -366,7 +364,7 @@ def main():
                 logger.error(f"Alternate archive directory does not exist: {args.alternate_archive_dir}, exiting")
                 sys.exit(1) 
             if  not os.path.isdir(args.alternate_archive_dir):
-                logger.error(f"Alternate archive directory is not a directory, exiting")
+                logger.error("Alternate archive directory is not a directory, exiting")
                 sys.exit(1) 
             config_settings.backup_dir = args.alternate_archive_dir
 

dar_backup/command_runner.py

@@ -13,6 +13,7 @@ try:
 except ImportError:
     termios = None
 import tempfile
+import time
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../src")))
 from typing import List, Optional, Union
 from dar_backup.util import get_logger
@@ -89,12 +90,21 @@ class CommandRunner:
     ):
         self.logger = logger or get_logger()
         self.command_logger = command_logger or get_logger(command_output_logger=True)
+        if default_timeout is not None:
+            try:
+                default_timeout = int(default_timeout)
+            except (TypeError, ValueError):
+                default_timeout = 30
+            if not isinstance(default_timeout, int):
+                default_timeout = 30
         self.default_timeout = default_timeout
         self.default_capture_limit_bytes = default_capture_limit_bytes
 
         if not self.logger or not self.command_logger:
             self.logger_fallback()
 
+        if self.default_timeout is not None and self.default_timeout <= 0:
+            self.default_timeout = None
 
     def logger_fallback(self):
         """
@@ -138,7 +148,10 @@ class CommandRunner:
         stdin: Optional[int] = subprocess.DEVNULL
     ) -> CommandResult:
         self._text_mode = text
-        timeout = timeout or self.default_timeout
+        if timeout is None:
+            timeout = self.default_timeout
+        if timeout is not None and timeout <= 0:
+            timeout = None
         if capture_output_limit_bytes is None:
             capture_output_limit_bytes = self.default_capture_limit_bytes
         if capture_output_limit_bytes is not None and capture_output_limit_bytes < 0:
@@ -199,6 +212,7 @@ class CommandRunner:
             truncated_stderr = {"value": False}
 
             try:
+                start_time = time.monotonic()
                 use_pipes = capture_output or log_output
                 process = subprocess.Popen(
                     cmd,
@@ -209,6 +223,18 @@ class CommandRunner:
                     bufsize=-1,
                     cwd=cwd
                 )
+                pid = getattr(process, "pid", None)
+                if log_output:
+                    self.command_logger.debug(
+                        "Process started pid=%s cwd=%s",
+                        pid if pid is not None else "unknown",
+                        cwd or os.getcwd(),
+                    )
+                self.logger.debug(
+                    "Process started pid=%s cwd=%s",
+                    pid if pid is not None else "unknown",
+                    cwd or os.getcwd(),
+                )
             except Exception as e:
                 stack = traceback.format_exc()
                 return CommandResult(
@@ -287,7 +313,12 @@ class CommandRunner:
                 process.wait(timeout=timeout)
             except subprocess.TimeoutExpired:
                 process.kill()
-                log_msg = f"Command timed out after {timeout} seconds: {' '.join(cmd)}:\n"
+                duration = time.monotonic() - start_time
+                pid = getattr(process, "pid", None)
+                log_msg = (
+                    f"Command timed out after {timeout} seconds: {' '.join(cmd)} "
+                    f"(pid={pid if pid is not None else 'unknown'}, elapsed={duration:.2f}s):\n"
+                )
                 self.logger.error(log_msg)
                 return CommandResult(-1, ''.join(stdout_lines), log_msg.join(stderr_lines))
             except Exception as e:
@@ -298,6 +329,21 @@ class CommandRunner:
 
             for t in threads:
                 t.join()
+            duration = time.monotonic() - start_time
+            pid = getattr(process, "pid", None)
+            if log_output:
+                self.command_logger.debug(
+                    "Process finished pid=%s returncode=%s elapsed=%.2fs",
+                    pid if pid is not None else "unknown",
+                    process.returncode,
+                    duration,
+                )
+            self.logger.debug(
+                "Process finished pid=%s returncode=%s elapsed=%.2fs",
+                pid if pid is not None else "unknown",
+                process.returncode,
+                duration,
+            )
 
             if self._text_mode:
                 stdout_combined = ''.join(stdout_lines)

dar_backup/config_settings.py

@@ -4,7 +4,6 @@ import configparser
 import re
 from dataclasses import dataclass, field, fields
 from os.path import expandvars, expanduser
-from pathlib import Path
 from typing import Optional, Pattern
 
 from dar_backup.exceptions import ConfigSettingsError

dar_backup/dar_backup.py

@@ -27,12 +27,10 @@ import xml.etree.ElementTree as ET
 import tempfile
 import threading
 
-from argparse import ArgumentParser
 from datetime import datetime
 from pathlib import Path
 from sys import exit
 from sys import stderr
-from sys import argv
 from sys import version_info
 from time import time
 from rich.console import Console
@@ -43,6 +41,7 @@ from . import __about__ as about
 from dar_backup.config_settings import ConfigSettings
 from dar_backup.util import list_backups
 from dar_backup.util import setup_logging
+from dar_backup.util import derive_trace_log_path
 from dar_backup.util import get_logger
 from dar_backup.util import BackupError
 from dar_backup.util import RestoreError
@@ -54,14 +53,11 @@ 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.util import show_scriptname
-from dar_backup.util import print_debug
 from dar_backup.util import send_discord_message
 
 from dar_backup.command_runner import CommandRunner   
-from dar_backup.command_runner import CommandResult
 
 
-from argcomplete.completers import FilesCompleter
 
 logger = None
 runner = None
@@ -126,7 +122,7 @@ def generic_backup(type: str, command: List[str], backup_file: str, backup_defin
         logger.error(f"Backup command failed: {e}")
         raise BackupError(f"Backup command failed: {e}") from e
     except Exception as e:
-        logger.exception(f"Unexpected error during backup")
+        logger.exception("Unexpected error during backup")
         raise BackupError(f"Unexpected error during backup: {e}") from e
     
 
@@ -164,12 +160,37 @@ def find_files_with_paths(xml_doc: str):
     return files_list
 
 
+class DoctypeStripper:
+    """
+    File-like wrapper that strips DOCTYPE lines to prevent XXE.
+    """
+    def __init__(self, path):
+        self.f = open(path, "r", encoding="utf-8")
+        self.buf = ""
+    def read(self, n=-1):
+        if n is None or n < 0:
+            out = []
+            for line in self.f:
+                if "<!DOCTYPE" not in line:
+                    out.append(line)
+            return "".join(out)
+        while len(self.buf) < n:
+            line = self.f.readline()
+            if not line:
+                break
+            if "<!DOCTYPE" not in line:
+                self.buf += line
+        result, self.buf = self.buf[:n], self.buf[n:]
+        return result
+
+
 def iter_files_with_paths_from_xml(xml_path: str) -> Iterator[Tuple[str, str]]:
     """
     Stream file paths and sizes from a DAR XML listing to keep memory usage low.
     """
     path_stack: List[str] = []
-    context = ET.iterparse(xml_path, events=("start", "end"))
+    # Disable XXE by stripping DOCTYPE
+    context = ET.iterparse(DoctypeStripper(xml_path), events=("start", "end"))
     for event, elem in context:
         if event == "start" and elem.tag == "Directory":
             dir_name = elem.get("name")
@@ -433,7 +454,7 @@ def verify(args: argparse.Namespace, backup_file: str, backup_definition: str, c
                 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....")
+            logger.exception("Permission error while comparing files, continuing....")
             logger.error("Exception details:", exc_info=True)
         except FileNotFoundError as exc:
             result = False
@@ -1118,7 +1139,8 @@ def generate_par2_files(backup_file: str, config_settings: ConfigSettings, args,
 def filter_darrc_file(darrc_path):
     """
     Filters the .darrc file to remove lines containing the options: -vt, -vs, -vd, -vf, and -va.
-    The filtered version is stored in a uniquely named file in the home directory of the user running the script.
+    The filtered version is stored in a uniquely named file alongside the source .darrc
+    (or a writable temp directory if needed).
     The file permissions are set to 440.
     
     Params:
@@ -1133,29 +1155,36 @@ def filter_darrc_file(darrc_path):
     # Define options to filter out
     options_to_remove = {"-vt", "-vs", "-vd", "-vf", "-va"}
 
-    # Get the user's home directory
-    home_dir = os.path.expanduser("~")
+    candidate_dirs = [
+        os.path.dirname(os.path.abspath(darrc_path)),
+        os.path.expanduser("~"),
+        tempfile.gettempdir(),
+    ]
+    last_error = None
 
-    # Create a unique file name in the home directory
-    filtered_darrc_path = os.path.join(home_dir, f"filtered_darrc_{next(tempfile._get_candidate_names())}.darrc")
+    for candidate_dir in candidate_dirs:
+        filtered_darrc_path = os.path.join(
+            candidate_dir,
+            f"filtered_darrc_{next(tempfile._get_candidate_names())}.darrc",
+        )
+        try:
+            with open(darrc_path, "r") as infile, open(filtered_darrc_path, "w") as outfile:
+                for line in infile:
+                    # Check if any unwanted option is in the line
+                    if not any(option in line for option in options_to_remove):
+                        outfile.write(line)
 
-    try:
-        with open(darrc_path, "r") as infile, open(filtered_darrc_path, "w") as outfile:
-            for line in infile:
-                # Check if any unwanted option is in the line
-                if not any(option in line for option in options_to_remove):
-                    outfile.write(line)
-        
-        # Set file permissions to 440 (read-only for owner and group, no permissions for others)
-        os.chmod(filtered_darrc_path, 0o440)
+            # Set file permissions to 440 (read-only for owner and group, no permissions for others)
+            os.chmod(filtered_darrc_path, 0o440)
 
-        return filtered_darrc_path
+            return filtered_darrc_path
 
-    except Exception as e:
-        # If anything goes wrong, clean up the temp file if it was created
-        if os.path.exists(filtered_darrc_path):
-            os.remove(filtered_darrc_path)
-        raise RuntimeError(f"Error filtering .darrc file: {e}")
+        except Exception as e:
+            last_error = e
+            if os.path.exists(filtered_darrc_path):
+                os.remove(filtered_darrc_path)
+
+    raise RuntimeError(f"Error filtering .darrc file: {last_error}")
 
 
 
@@ -1257,16 +1286,35 @@ def print_markdown(source: str, from_string: bool = False, pretty: bool = True):
 
 
 
+def _resolve_doc_path(path: Optional[str], filename: str) -> Path:
+    if path:
+        return Path(path)
+
+    candidates = [
+        Path.cwd() / "src" / "dar_backup" / filename,
+        Path(__file__).parent / filename,
+    ]
+
+    try:
+        candidates.append(Path(__file__).resolve().parents[2] / filename)
+    except IndexError:
+        pass
+
+    for candidate in candidates:
+        if candidate.exists():
+            return candidate
+
+    return candidates[0]
+
+
 def print_changelog(path: str = None, pretty: bool = True):
-    if path is None:
-        path = Path(__file__).parent / "Changelog.md"
-    print_markdown(str(path), pretty=pretty)
+    resolved_path = _resolve_doc_path(path, "Changelog.md")
+    print_markdown(str(resolved_path), pretty=pretty)
 
 
 def print_readme(path: str = None, pretty: bool = True):
-    if path is None:
-        path = Path(__file__).parent / "README.md"
-    print_markdown(str(path), pretty=pretty)
+    resolved_path = _resolve_doc_path(path, "README.md")
+    print_markdown(str(resolved_path), pretty=pretty)
 
 def list_definitions(backup_d_dir: str) -> List[str]:
     """
@@ -1454,6 +1502,7 @@ def main():
     if command_output_log == config_settings.logfile_location:
         print(f"Error: logfile_location in {args.config_file} does not end at 'dar-backup.log', exiting", file=stderr)
 
+    trace_log_file = derive_trace_log_path(config_settings.logfile_location)
     logger = setup_logging(
         config_settings.logfile_location,
         command_output_log,
@@ -1461,6 +1510,7 @@ def main():
         args.log_stdout,
         logfile_max_bytes=config_settings.logfile_max_bytes,
         logfile_backup_count=config_settings.logfile_backup_count,
+        trace_log_file=trace_log_file,
         trace_log_max_bytes=getattr(config_settings, "trace_log_max_bytes", 10485760),
         trace_log_backup_count=getattr(config_settings, "trace_log_backup_count", 1)
     )
@@ -1474,6 +1524,8 @@ def main():
     clean_restore_test_directory(config_settings)
 
 
+    filtered_darrc_path = None
+
     try:
         if not args.darrc:
             current_script_dir = os.path.dirname(os.path.abspath(__file__))
@@ -1488,7 +1540,8 @@ def main():
 
         if args.suppress_dar_msg:
             logger.info("Suppressing dar messages, do not use options: -vt, -vs, -vd, -vf, -va")
-            args.darrc = filter_darrc_file(args.darrc)
+            filtered_darrc_path = filter_darrc_file(args.darrc)
+            args.darrc = filtered_darrc_path
             logger.debug(f"Filtered .darrc file: {args.darrc}")
 
         start_msgs: List[Tuple[str, str]] = []
@@ -1522,6 +1575,7 @@ def main():
         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(("Trace log:", trace_log_file))
         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))
 
@@ -1611,10 +1665,9 @@ def main():
         end_time=int(time())
         logger.info(f"END TIME: {end_time}")
         # Clean up
-        if os.path.exists(args.darrc) and (os.path.dirname(args.darrc) == os.path.expanduser("~")):
-            if os.path.basename(args.darrc).startswith("filtered_darrc_"):
-                if os.remove(args.darrc):
-                    logger.debug(f"Removed filtered .darrc: {args.darrc}")
+        if filtered_darrc_path and os.path.exists(filtered_darrc_path):
+            os.remove(filtered_darrc_path)
+            logger.debug(f"Removed filtered .darrc: {filtered_darrc_path}")
 
 
     # Determine exit code 

dar_backup/dar_backup_systemd.py

@@ -100,7 +100,7 @@ def write_unit_files(venv, dar_path, install=False):
 
     write_unit_file(output_path, "dar-cleanup.service", generate_cleanup_service(venv, dar_path))
     write_unit_file(output_path, "dar-cleanup.timer", CLEANUP_TIMER)
-    print(f"  → Fires on: *-*-* 21:07:00")
+    print("  → Fires on: *-*-* 21:07:00")
 
     if install:
         for mode in FLAGS:

dar_backup/demo.py

@@ -19,7 +19,6 @@ User can set ROOT_DIR, DIR_TO_BACKUP and BACKUP_DIR (destination for backups) vi
 
 import argparse
 import os
-import shutil
 import sys 
 
 from . import __about__ as about
@@ -201,7 +200,7 @@ def main():
         Path(vars_map["TEST_RESTORE_DIR"]).mkdir(parents=True, exist_ok=True)
         Path(vars_map["CONFIG_DIR"]).mkdir(parents=True, exist_ok=True)
         Path(vars_map["BACKUP_D_DIR"]).mkdir(parents=True, exist_ok=True)
-        print(f"Directories created.")
+        print("Directories created.")
 
         generate_file(args, "demo_backup_def.j2", Path(vars_map["BACKUP_D_DIR"]).joinpath("demo"), vars_map, opts_dict)
         generate_file(args, "dar-backup.conf.j2", Path(vars_map["CONFIG_DIR"]).joinpath("dar-backup.conf"), vars_map, opts_dict)