dar-backup 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

dar_backup/config_settings.py

@@ -1,9 +1,11 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 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
 
@@ -44,8 +46,19 @@ class ConfigSettings:
     incr_age: int = field(init=False)
     error_correction_percent: int = field(init=False)
     par2_enabled: bool = field(init=False)
+    par2_dir: Optional[str] = field(init=False, default=None)
+    par2_layout: Optional[str] = field(init=False, default=None)
+    par2_mode: Optional[str] = field(init=False, default=None)
+    par2_ratio_full: Optional[int] = field(init=False, default=None)
+    par2_ratio_diff: Optional[int] = field(init=False, default=None)
+    par2_ratio_incr: Optional[int] = field(init=False, default=None)
+    par2_run_verify: Optional[bool] = field(init=False, default=None)
     logfile_max_bytes: int = field(init=False)
     logfile_no_count: int = field(init=False)    
+    dar_backup_discord_webhook_url: Optional[str] = field(init=False, default=None)
+    restoretest_exclude_prefixes: list[str] = field(init=False, default_factory=list)
+    restoretest_exclude_suffixes: list[str] = field(init=False, default_factory=list)
+    restoretest_exclude_regex: Optional[Pattern[str]] = field(init=False, default=None)
 
 
     OPTIONAL_CONFIG_FIELDS = [
@@ -70,6 +83,13 @@ class ConfigSettings:
             "type": int,
             "default": 5,
         },
+        {
+            "section": "MISC",
+            "key": "DAR_BACKUP_DISCORD_WEBHOOK_URL",
+            "attr": "dar_backup_discord_webhook_url",
+            "type": str,
+            "default": None,
+        },
         # Add more optional fields here
     ]
 
@@ -103,6 +123,29 @@ class ConfigSettings:
             else:
                 raise ConfigSettingsError(f"Invalid boolean value for 'ENABLED' in [PAR2]: '{val}'")
 
+            self.par2_dir = self._get_optional_str("PAR2", "PAR2_DIR", default=None)
+            self.par2_layout = self._get_optional_str("PAR2", "PAR2_LAYOUT", default="by-backup")
+            self.par2_mode = self._get_optional_str("PAR2", "PAR2_MODE", default=None)
+            self.par2_ratio_full = self._get_optional_int("PAR2", "PAR2_RATIO_FULL", default=None)
+            self.par2_ratio_diff = self._get_optional_int("PAR2", "PAR2_RATIO_DIFF", default=None)
+            self.par2_ratio_incr = self._get_optional_int("PAR2", "PAR2_RATIO_INCR", default=None)
+            self.par2_run_verify = self._get_optional_bool("PAR2", "PAR2_RUN_VERIFY", default=None)
+            self.restoretest_exclude_prefixes = self._get_optional_csv_list(
+                "MISC",
+                "RESTORETEST_EXCLUDE_PREFIXES",
+                default=[]
+            )
+            self.restoretest_exclude_suffixes = self._get_optional_csv_list(
+                "MISC",
+                "RESTORETEST_EXCLUDE_SUFFIXES",
+                default=[]
+            )
+            self.restoretest_exclude_regex = self._get_optional_regex(
+                "MISC",
+                "RESTORETEST_EXCLUDE_REGEX",
+                default=None
+            )
+
             # Load optional fields
             for opt in self.OPTIONAL_CONFIG_FIELDS:
                 if self.config.has_option(opt['section'], opt['key']):
@@ -144,4 +187,104 @@ class ConfigSettings:
         ]
         return f"<ConfigSettings({', '.join(safe_fields)})>"
 
+    def _get_optional_str(self, section: str, key: str, default: Optional[str] = None) -> Optional[str]:
+        if self.config.has_option(section, key):
+            return self.config.get(section, key).strip()
+        return default
+
+    def _get_optional_int(self, section: str, key: str, default: Optional[int] = None) -> Optional[int]:
+        if self.config.has_option(section, key):
+            raw = self.config.get(section, key).strip()
+            return int(raw)
+        return default
+
+    def _get_optional_bool(self, section: str, key: str, default: Optional[bool] = None) -> Optional[bool]:
+        if not self.config.has_option(section, key):
+            return default
+        val = self.config.get(section, key).strip().lower()
+        if val in ('true', '1', 'yes'):
+            return True
+        if val in ('false', '0', 'no'):
+            return False
+        raise ConfigSettingsError(f"Invalid boolean value for '{key}' in [{section}]: '{val}'")
+
+    def _get_optional_csv_list(self, section: str, key: str, default: Optional[list[str]] = None) -> list[str]:
+        if not self.config.has_option(section, key):
+            return default if default is not None else []
+        raw = self.config.get(section, key).strip()
+        if not raw:
+            return default if default is not None else []
+        return [item.strip() for item in raw.split(",") if item.strip()]
+
+    def _get_optional_regex(
+        self,
+        section: str,
+        key: str,
+        default: Optional[Pattern[str]] = None
+    ) -> Optional[Pattern[str]]:
+        if not self.config.has_option(section, key):
+            return default
+        raw = self.config.get(section, key).strip()
+        if not raw:
+            return default
+        try:
+            return re.compile(raw, re.IGNORECASE)
+        except re.error as exc:
+            raise ConfigSettingsError(
+                f"Invalid regex for '{key}' in [{section}]: {exc}"
+            ) from exc
+
+    def get_par2_config(self, backup_definition: Optional[str] = None) -> dict:
+        """
+        Return PAR2 settings, applying per-backup overrides when present.
+        """
+        par2_config = {
+            "par2_dir": self.par2_dir,
+            "par2_layout": self.par2_layout,
+            "par2_mode": self.par2_mode,
+            "par2_ratio_full": self.par2_ratio_full,
+            "par2_ratio_diff": self.par2_ratio_diff,
+            "par2_ratio_incr": self.par2_ratio_incr,
+            "par2_run_verify": self.par2_run_verify,
+            "par2_enabled": self.par2_enabled,
+        }
+
+        if not backup_definition or not self.config.has_section(backup_definition):
+            return par2_config
+
+        section = self.config[backup_definition]
+        for raw_key, raw_value in section.items():
+            key = raw_key.upper()
+            value = raw_value.strip()
+            if not key.startswith("PAR2_"):
+                continue
+            if key == "PAR2_DIR":
+                par2_config["par2_dir"] = value
+            elif key == "PAR2_LAYOUT":
+                par2_config["par2_layout"] = value
+            elif key == "PAR2_MODE":
+                par2_config["par2_mode"] = value
+            elif key == "PAR2_RATIO_FULL":
+                par2_config["par2_ratio_full"] = int(value)
+            elif key == "PAR2_RATIO_DIFF":
+                par2_config["par2_ratio_diff"] = int(value)
+            elif key == "PAR2_RATIO_INCR":
+                par2_config["par2_ratio_incr"] = int(value)
+            elif key == "PAR2_RUN_VERIFY":
+                val = value.lower()
+                if val in ('true', '1', 'yes'):
+                    par2_config["par2_run_verify"] = True
+                elif val in ('false', '0', 'no'):
+                    par2_config["par2_run_verify"] = False
+                else:
+                    raise ConfigSettingsError(f"Invalid boolean value for 'PAR2_RUN_VERIFY' in [{backup_definition}]: '{value}'")
+            elif key == "PAR2_ENABLED":
+                val = value.lower()
+                if val in ('true', '1', 'yes'):
+                    par2_config["par2_enabled"] = True
+                elif val in ('false', '0', 'no'):
+                    par2_config["par2_enabled"] = False
+                else:
+                    raise ConfigSettingsError(f"Invalid boolean value for 'PAR2_ENABLED' in [{backup_definition}]: '{value}'")
 
+        return par2_config

dar_backup/dar-backup.conf

@@ -9,10 +9,15 @@ LOGFILE_LOCATION = ~/dar-backup/dar-backup.log
 MAX_SIZE_VERIFICATION_MB = 20
 MIN_SIZE_VERIFICATION_MB = 1
 NO_FILES_VERIFICATION = 5
+# Optional restore test filters (case-insensitive)
+# RESTORETEST_EXCLUDE_PREFIXES = .cache/, .local/share/Trash/, .mozilla/
+# RESTORETEST_EXCLUDE_SUFFIXES = .sqlite-wal, .sqlite-shm, .log, .tmp, .lock, .journal
+# RESTORETEST_EXCLUDE_REGEX = (^|/)(Cache|Logs)/   # optional extra noise
 # timeout in seconds for backup, test, restore and par2 operations
 # The author has such `dar` tasks running for 10-15 hours on the yearly backups, so a value of 24 hours is used.
 # If a timeout is not specified when using the CommandRunner, a default timeout of 30 secs is used.
 COMMAND_TIMEOUT_SECS = 86400
+#DAR_BACKUP_DISCORD_WEBHOOK_URL = https://discord.com/api/webhooks/<id>/<token>
 
 [DIRECTORIES]
 BACKUP_DIR = @@BACKUP_DIR@@
@@ -31,6 +36,12 @@ INCR_AGE = 40
 [PAR2]
 ERROR_CORRECTION_PERCENT = 5
 ENABLED = True
+# Optional PAR2 configuration
+# PAR2_DIR = /path/to/par2-store
+# PAR2_RATIO_FULL = 10
+# PAR2_RATIO_DIFF = 5
+# PAR2_RATIO_INCR = 5
+# PAR2_RUN_VERIFY = false
 
 [PREREQ]
 #SCRIPT_1 = <pre-script 1>

dar_backup/dar-backup.conf.j2

@@ -29,10 +29,16 @@ LOGFILE_LOCATION = {{ vars_map.DAR_BACKUP_DIR -}}/dar-backup.log
 # optional parameters
 # LOGFILE_MAX_BYTES = 26214400  # 25 MB default, change as neeeded
 # LOGFILE_BACKUP_COUNT = 5      # default, change as needed
+# DAR_BACKUP_DISCORD_WEBHOOK_URL **should really** be given as an environment variable for security reasons
+# DAR_BACKUP_DISCORD_WEBHOOK_URL = https://discord.com/api/webhooks/<id>/<token>
 
 MAX_SIZE_VERIFICATION_MB = 2
 MIN_SIZE_VERIFICATION_MB = 0
 NO_FILES_VERIFICATION = 1
+# Optional restore test filters (case-insensitive)
+# RESTORETEST_EXCLUDE_PREFIXES = .cache/, .local/share/Trash/, .mozilla/
+# RESTORETEST_EXCLUDE_SUFFIXES = .sqlite-wal, .sqlite-shm, .log, .tmp, .lock, .journal
+# RESTORETEST_EXCLUDE_REGEX = (^|/)(Cache|Logs)/
 # timeout in seconds for backup, test, restore and par2 operations
 # The author has such `dar` tasks running for 10-15 hours on the yearly backups, so a value of 24 hours is used.
 # If a timeout is not specified when using the CommandRunner, a default timeout of 30 secs is used.
@@ -54,7 +60,16 @@ INCR_AGE = 40
 
 [PAR2]
 ERROR_CORRECTION_PERCENT = 5
+# Enable or disable PAR2 generation globally
 ENABLED = True
+# Optional PAR2 configuration
+# PAR2_DIR = /path/to/par2-store
+# PAR2_LAYOUT = by-backup
+# PAR2_RATIOs are meuasured as percentages. Same function as ERROR_CORRECTION_PERCENT
+# PAR2_RATIO_FULL = 10
+# PAR2_RATIO_DIFF = 5
+# PAR2_RATIO_INCR = 5
+# PAR2_RUN_VERIFY = false
 
 [PREREQ]
 #SCRIPT_1 = <pre-script 1>
@@ -62,3 +77,30 @@ ENABLED = True
 [POSTREQ]
 #SCRIPT_1 = <post-script 1>
 
+#######################################################################
+## Per-backup configuration example overrides
+#######################################################################
+#
+## --------------------------------------------------------------------
+## Per-backup overrides (section name must match backup.d filename stem)
+## Example: backup.d/home.conf  ->  [home]
+## --------------------------------------------------------------------
+#
+##[home]
+## Disable PAR2 entirely for this backup definition
+#PAR2_ENABLED = false
+##
+##[media]
+## Store PAR2 files in a separate location for this backup definition
+##PAR2_DIR = /samba/par2/media
+## Raise redundancy only for FULL
+##
+#[documents]
+## Run verify par2 sets after creation
+#PAR2_RUN_VERIFY = true
+##
+##[etc]
+## Keep global PAR2 settings but tweak ratios for this backup definition
+##PAR2_RATIO_FULL = 15
+##PAR2_RATIO_DIFF = 8
+##PAR2_RATIO_INCR = 8