dar-backup 0.6.7__py3-none-any.whl → 0.6.9__py3-none-any.whl

dar_backup/.darrc

@@ -26,19 +26,22 @@ verbose:
 # -va
 
 
-extract:
+restore-options:
 # don't restore File Specific Attributes
 #--fsa-scope none
 
 # ignore owner, useful when used by a non-privileged user
 --comparison-field=ignore-owner
 
+
+
+# Exclude specific file types from compression
+compress-exclusion:
+
 # First setting case insensitive mode on:
 -an
 -ag
 
-# Exclude specific file types from compression
-compress-exclusion:
 -Z    "*.gz"
 -Z    "*.bz2"
 -Z    "*.xz"
@@ -105,6 +108,5 @@ compress-exclusion:
 -Z    "*.dar"
 
 # Now we swap back to case sensitive mode for masks which is the default
-# mode:
 -acase
 

dar_backup/__about__.py

@@ -1 +1 @@
-__version__ = "0.6.7"
+__version__ = "0.6.9"

dar_backup/clean_log.py

@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+"""
+clean-log.py source code is here: https://github.com/per2jensen/dar-backup/tree/main/v2/src/dar_backup/clean-log.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 remove (much of) the logged output from `dar`.
+When `dar` verbose options are enabled, quite a lot of information is emitted.
+"""
+
+
+import argparse
+import re
+import os
+import sys 
+
+from . import __about__ as about
+from dar_backup.config_settings import ConfigSettings
+
+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.'''
+
+def clean_log_file(log_file_path, dry_run=False):
+    """Removes specific log lines from the given file using a memory-efficient streaming approach."""
+
+
+    if not os.path.isfile(log_file_path):
+        print(f"File '{log_file_path}' not found!")
+        sys.exit(1)
+
+    if not os.access(log_file_path, os.R_OK):
+        print(f"No read permission for '{log_file_path}'")
+        sys.exit(1)
+
+    if not os.access(log_file_path, os.W_OK):
+        print(f"Error: No write permission for '{log_file_path}'")
+        sys.exit(1)
+
+
+    if dry_run:
+        print(f"Performing a dry run on: {log_file_path}")
+
+    temp_file_path = log_file_path + ".tmp"
+    
+    patterns = [
+        r"INFO\s*-\s*<File",
+        r"INFO\s*-\s*<Attributes",
+        r"INFO\s*-\s*</Directory",
+        r"INFO\s*-\s*<Directory",
+        r"INFO\s*-\s*</File",
+        r"INFO\s*-\s*Inspecting\s*directory",
+        r"INFO\s*-\s*Finished\s*Inspecting"
+    ]
+
+    try:
+        with open(log_file_path, "r", errors="ignore") as infile, open(temp_file_path, "w") as outfile:
+
+            for line in infile:
+                original_line = line  # Store the original line before modifying it
+                matched = False  # Track if a pattern is matched
+
+                for pattern in patterns:
+                    if re.search(pattern, line):  # Check if the pattern matches
+                        if dry_run:
+                            print(f"Would remove: {original_line.strip()}")  # Print full line for dry-run
+                        matched = True  # Mark that a pattern matched
+                        line = re.sub(pattern, "", line).strip()  # Remove only matched part
+
+                if not dry_run and line:  # In normal mode, only write non-empty lines
+                    outfile.write(line.rstrip() + "\n")
+
+                if dry_run and matched:
+                    continue  # In dry-run mode, skip writing (since we’re just showing)
+
+        
+        # Ensure the temp file exists before renaming
+        if not os.path.exists(temp_file_path):
+            open(temp_file_path, "w").close()  # Create an empty file if nothing was written
+
+        os.replace(temp_file_path, log_file_path)
+        print(f"Successfully cleaned log file: {log_file_path}")
+
+    except Exception as e:
+        print(f"Error processing file: {e}")
+        sys.exit(1)
+
+
+    
+def main():
+    parser = argparse.ArgumentParser(
+        description="Clean dar-backup log file for `dar` output"
+    )
+    parser.add_argument(
+        "-f", "--file",
+        nargs="+",
+        type=str, help="Path(s) to the log file(s) that needs cleaning. Default is the log file specified in the configuration file."
+    )
+
+    parser.add_argument(
+        '-c', '--config-file',
+        type=str, help="Path to 'dar-backup.conf'",
+        default='~/.config/dar-backup/dar-backup.conf')
+
+    parser.add_argument(
+        "--dry-run",
+        action="store_true",
+        help="Show which lines would be removed without modifying the file."
+    )
+
+
+    parser.add_argument(
+        "-v", "--version",
+        action="version",
+        version=f"%(prog)s version {about.__version__}, {LICENSE}"
+    )
+
+    args = parser.parse_args()
+
+    config_settings = ConfigSettings(os.path.expanduser(args.config_file))
+
+    if not args.file:
+        args.file = [config_settings.logfile_location]
+
+    for file_path in args.file:
+        if not isinstance(file_path, (str, bytes, os.PathLike)):
+            print(f"Error: Invalid file path type: {file_path}")
+            sys.exit(1)
+
+        if not os.path.exists(file_path):
+            print(f"Error: Log file '{file_path}' does not exist.")
+            sys.exit(1)
+
+        if file_path.strip() == "":
+            print(f"Error: Invalid empty filename '{file_path}'.")
+            sys.exit(1)
+
+
+    # Run the log file cleaning function
+    for log_file in args.file:
+        clean_log_file(log_file, dry_run=args.dry_run)
+    print(f"Log file '{args.file}' has been cleaned successfully.")
+
+
+if __name__ == "__main__":
+    main()

dar_backup/dar_backup.py

@@ -66,7 +66,7 @@ def generic_backup(type: str, command: List[str], backup_file: str, backup_defin
             raise Exception(str(process))
 
         if process.returncode == 0 or process.returncode == 5:
-            add_catalog_command = ['manager', '--add-specific-archive' ,backup_file, '--config-file', args.config_file, '--log-level', "debug", "--log-stdout"]
+            add_catalog_command = ['manager', '--add-specific-archive' ,backup_file, '--config-file', args.config_file]
             command_result = run_command(add_catalog_command, config_settings.command_timeout_secs)
             if command_result.returncode == 0:
                 logger.info(f"Catalog for archive '{backup_file}' added successfully to its manager.")
@@ -209,7 +209,7 @@ def verify(args: argparse.Namespace, backup_file: str, backup_definition: str, c
     for restored_file_path in random_files:
         try:
             logger.info(f"Restoring file: '{restored_file_path}' from backup to: '{config_settings.test_restore_dir}' for file comparing")
-            command = ['dar', '-x', backup_file, '-g', restored_file_path.lstrip("/"), '-R', config_settings.test_restore_dir, '-O', '-Q']
+            command = ['dar', '-x', backup_file, '-g', restored_file_path.lstrip("/"), '-R', config_settings.test_restore_dir, '-Q', '-B', args.darrc, 'restore-options']
             logger.info(f"Running command: {' '.join(map(shlex.quote, command))}")
             process = run_command(command, config_settings.command_timeout_secs)    
             if process.returncode != 0:
@@ -228,7 +228,7 @@ def verify(args: argparse.Namespace, backup_file: str, backup_definition: str, c
 
 
 
-def restore_backup(backup_name: str, config_settings: ConfigSettings, restore_dir: str, selection: str =None):
+def restore_backup(backup_name: str, config_settings: ConfigSettings, restore_dir: str, darrc: str, selection: str =None):
     """
     Restores a backup file to a specified directory.
 
@@ -239,7 +239,7 @@ def restore_backup(backup_name: str, config_settings: ConfigSettings, restore_di
         selection (str, optional): A selection criteria to restore specific files or directories. Defaults to None.
     """
     backup_file = os.path.join(config_settings.backup_dir, backup_name)
-    command = ['dar', '-x', backup_file, '-O', '-Q', '-D']
+    command = ['dar', '-x', backup_file, '-Q', '-D']
     if restore_dir:
         if not os.path.exists(restore_dir):
             os.makedirs(restore_dir)
@@ -249,6 +249,7 @@ def restore_backup(backup_name: str, config_settings: ConfigSettings, restore_di
     if selection:
         selection_criteria = shlex.split(selection)
         command.extend(selection_criteria)
+    command.extend(['-B', darrc,  'restore-options'])  # the .darrc `restore-options` section
     logger.info(f"Running restore command: {' '.join(map(shlex.quote, command))}")
     try:
         process = run_command(command, config_settings.command_timeout_secs)
@@ -321,7 +322,7 @@ def list_contents(backup_name, backup_dir, selection=None):
         stdout,stderr = process.stdout, process.stderr
         if process.returncode != 0:
             logger.error(f"Error listing contents of backup: '{backup_name}'")
-            raise subprocess.CalledProcessError(str(process))
+            raise RuntimeError(str(process))
         for line in stdout.splitlines():
             if "[--- REMOVED ENTRY ----]" in line or "[Saved]" in line:
                 print(line)
@@ -428,10 +429,9 @@ def perform_backup(args: argparse.Namespace, config_settings: ConfigSettings, ba
                 logger.error("Verification failed.")
 
             
-            if verify_result and config_settings.par2_enabled:
-                logger.info("Generate par2 redundancy files.")
-                generate_par2_files(backup_file, config_settings, args)
-                logger.info("par2 files completed successfully.")
+            logger.info("Generate par2 redundancy files.")
+            generate_par2_files(backup_file, config_settings, args)
+            logger.info("par2 files completed successfully.")
             
 
         except Exception as e:
@@ -677,7 +677,7 @@ def main():
             list_contents(args.list_contents, config_settings.backup_dir, args.selection)
         elif args.restore:
             logger.debug(f"Restoring {args.restore} to {restore_dir}")
-            restore_backup(args.restore, config_settings, restore_dir, args.selection)
+            restore_backup(args.restore, config_settings, restore_dir, args.darrc, args.selection)
         else:
             parser.print_help()
 

dar_backup/manager.py

@@ -141,16 +141,41 @@ def cat_no_for_name(archive: str, config_settings: ConfigSettings) -> int:
 
 
 
+def list_archive_contents(archive: str, config_settings: ConfigSettings) -> int :
+    """
+    List the contents of a specific archive, given the archive name
+    """
+    backup_def = backup_def_from_archive(archive)
+    database = f"{backup_def}{DB_SUFFIX}"
+    database_path = os.path.join(config_settings.backup_dir, database)
+    if not os.path.exists(database_path):
+        logger.error(f'Database not found: "{database_path}"')
+        return 1
+    cat_no = cat_no_for_name(archive, config_settings)
+    if cat_no < 0:
+        logger.error(f"archive: '{archive}' not found in database: '{database_path}'")
+        return 1
+    command = ['dar_manager', '--base', database_path, '-u', f"{cat_no}"]
+    process = run_command(command)
+    stdout, stderr = process.stdout, process.stderr 
+    if process.returncode != 0:
+        logger.error(f'Error listing catalogs for: "{database_path}"')
+        logger.error(f"stderr: {stderr}")  
+        logger.error(f"stdout: {stdout}")
+    else:
+        print(stdout)
+    return process.returncode
+
 
 
-def list_catalog_contents(catalog_number: int, backup_def: str, config_settings: ConfigSettings):
+def list_catalog_contents(catalog_number: int, backup_def: str, config_settings: ConfigSettings)  -> int:
     """
     List the contents of catalog # in catalog database for given backup definition
     """
     database = f"{backup_def}{DB_SUFFIX}"
     database_path = os.path.join(config_settings.backup_dir, database)
     if not os.path.exists(database_path):
-        logger.error(f'Database not found: "{database_path}"')
+        logger.error(f'Catalog database not found: "{database_path}"')
         return 1
     command = ['dar_manager', '--base', database_path, '-u', f"{catalog_number}"]
     process = run_command(command)
@@ -347,6 +372,7 @@ def main():
     parser.add_argument('--remove-specific-archive', type=str, help='Remove this archive from catalog database')
     parser.add_argument('-l', '--list-catalogs', action='store_true', help='List catalogs in databases for all backup definitions')
     parser.add_argument('--list-catalog-contents', type=int, help="List contents of a catalog. Argument is the 'archive #', '-d <definition>' argument is also required")
+    parser.add_argument('--list-archive-contents', type=str, help="List contents of the archive's catalog.")
     parser.add_argument('--find-file', type=str, help="List catalogs containing <path>/file. '-d <definition>' argument is also required")
     parser.add_argument('--verbose', action='store_true', help='Be more verbose')
     parser.add_argument('--log-level', type=str, help="`debug` or `trace`, default is `info`", default="info")
@@ -415,6 +441,11 @@ See section 15 and section 16 in the supplied "LICENSE" file.''')
             sys.exit(1)
 
 
+    if args.list_archive_contents and not args.list_archive_contents.strip():
+        logger.error(f"--list-archive-contents <param> not given, exiting")
+        sys.exit(1)
+
+
     if args.list_catalog_contents and not args.backup_def:
         logger.error(f"--list-catalog-contents requires the --backup-def, exiting")
         sys.exit(1)
@@ -470,6 +501,11 @@ See section 15 and section 16 in the supplied "LICENSE" file.''')
                         result = 1
         sys.exit(result)
 
+
+    if args.list_archive_contents:
+        result = list_archive_contents(args.list_archive_contents, config_settings)
+        sys.exit(result)
+
     if args.list_catalog_contents:
         result = list_catalog_contents(args.list_catalog_contents, args.backup_def, config_settings)
         sys.exit(result)

{dar_backup-0.6.7.dist-info → dar_backup-0.6.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dar-backup
-Version: 0.6.7
+Version: 0.6.9
 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: Homepage, https://github.com/per2jensen/dar-backup/tree/main/v2
 Project-URL: Changelog, https://github.com/per2jensen/dar-backup/blob/main/v2/Changelog.md
@@ -681,7 +681,7 @@ License:                     GNU GENERAL PUBLIC LICENSE
         Public License instead of this License.  But first, please read
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
 License-File: LICENSE
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: POSIX :: Linux
@@ -718,9 +718,13 @@ Description-Content-Type: text/markdown
   These scripts are licensed under the GPLv3 license.
   Read more here: https://www.gnu.org/licenses/gpl-3.0.en.html, or have a look at the ["LICENSE"](https://github.com/per2jensen/dar-backup/blob/main/LICENSE) file in this repository.
 
+
 # Status
 As of August 8, 2024 I am using the alpha versions of `dar-backup` (alpha-0.5.9 onwards) in my automated backup routine.
 
+As of February 13, 2025, I have changed the status from alpha --> beta, as the featureset is in place and the alphas have worked well for a very long time.
+
+
 **Breaking change in version 0.6.0**
 
 Version 0.6.0 and forwards requires the config variable *COMMAND_TIMEOUT_SECS* in the config file.

dar_backup-0.6.9.dist-info/RECORD

@@ -0,0 +1,14 @@
+dar_backup/.darrc,sha256=-aerqivZmOsW_XBCh9IfbYTUvw0GkzDSr3Vx4GcNB1g,2113
+dar_backup/__about__.py,sha256=42fbYUSZonpHevrA9hTI2EzfgLNO9LBK95poG3HeDEQ,21
+dar_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dar_backup/clean_log.py,sha256=VXKA2BMyQmaC6R08Bq9a3wP3mczdFb_moy6HkL-mnF8,5176
+dar_backup/cleanup.py,sha256=9yEdRR84XPtEvBGc2QfwGBQl2tdTPttjetHeiSc_TsM,11419
+dar_backup/config_settings.py,sha256=CBMUhLOOZ-x7CRdS3vBDk4TYaGqC4N1Ot8IMH-qPaI0,3617
+dar_backup/dar_backup.py,sha256=hDy7aXU-XiWOtW40Pxql441liNkSYKGU76eOwy8m7fU,32714
+dar_backup/manager.py,sha256=HDa8eYF89QFhlBRR4EWRzzmswOW00S_w8ToZ5SARO_o,21359
+dar_backup/util.py,sha256=SSSJYM9lQZfubhTUBlX1xDGWmCpYEF3ePARmlY544xM,11283
+dar_backup-0.6.9.dist-info/METADATA,sha256=mqAzHZp_-X9pw8w77c4FA7QwXnKikkSodJ-oJnaFT3M,64610
+dar_backup-0.6.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dar_backup-0.6.9.dist-info/entry_points.txt,sha256=p6c4uQLjlTIVP1Od2iorGefrVUH0IWZdFRMl63mNaRg,164
+dar_backup-0.6.9.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+dar_backup-0.6.9.dist-info/RECORD,,

{dar_backup-0.6.7.dist-info → dar_backup-0.6.9.dist-info}/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
+clean-log = dar_backup.clean_log:main
 cleanup = dar_backup.cleanup:main
 dar-backup = dar_backup.dar_backup:main
 manager = dar_backup.manager:main

dar_backup-0.6.7.dist-info/RECORD

@@ -1,13 +0,0 @@
-dar_backup/.darrc,sha256=3d9opAnnZGU9XLyQpTDsLtgo6hqsvZ3JU-yMLz-7_f0,2110
-dar_backup/__about__.py,sha256=0ouks3vBIBYQpXQLGG2c_DveClXKjoOTb3ZY9LRV9Xw,21
-dar_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dar_backup/cleanup.py,sha256=9yEdRR84XPtEvBGc2QfwGBQl2tdTPttjetHeiSc_TsM,11419
-dar_backup/config_settings.py,sha256=CBMUhLOOZ-x7CRdS3vBDk4TYaGqC4N1Ot8IMH-qPaI0,3617
-dar_backup/dar_backup.py,sha256=oUlGCLeYwkJKSqn1qzKqkhpoQVTp-fCWyJcpmkSnLjc,32703
-dar_backup/manager.py,sha256=S66gC6m-xaMMZR3MtaB0VGYEaGPohAO0DNMSSXvimM4,19869
-dar_backup/util.py,sha256=SSSJYM9lQZfubhTUBlX1xDGWmCpYEF3ePARmlY544xM,11283
-dar_backup-0.6.7.dist-info/METADATA,sha256=QB3M9KzbnyRUhRBbljmYFN5rYEhvzVBB2EbOD6QWsTs,64452
-dar_backup-0.6.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dar_backup-0.6.7.dist-info/entry_points.txt,sha256=x9vnW-JEl8mpDJC69f_XBcn0mBSkV1U0cyvFV-NAP1g,126
-dar_backup-0.6.7.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-dar_backup-0.6.7.dist-info/RECORD,,