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

dar_backup/__about__.py

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

dar_backup/cleanup.py

@@ -22,17 +22,22 @@ import sys
 
 from datetime import datetime, timedelta
 from time import time
+from typing import Dict, List, NamedTuple
 
 from . import __about__ as about
 from dar_backup.config_settings import ConfigSettings
 from dar_backup.util import extract_error_lines
 from dar_backup.util import list_backups
+from dar_backup.util import run_command
 from dar_backup.util import setup_logging
 
+from dar_backup.util import CommandResult   
+
+
 
 logger = None 
 
-def delete_old_backups(backup_dir, age, backup_type, backup_definition=None):
+def delete_old_backups(backup_dir, age, backup_type, args, backup_definition=None):
     """
     Delete backups older than the specified age in days.
     Only .dar and .par2 files are considered for deletion.
@@ -46,6 +51,8 @@ def delete_old_backups(backup_dir, age, backup_type, backup_definition=None):
     now = datetime.now()
     cutoff_date = now - timedelta(days=age)
 
+    archives_deleted = {}
+
     for filename in sorted(os.listdir(backup_dir)):
         if not (filename.endswith('.dar') or filename.endswith('.par2')):
             continue
@@ -64,11 +71,18 @@ def delete_old_backups(backup_dir, age, backup_type, backup_definition=None):
                 try:
                     os.remove(file_path)
                     logger.info(f"Deleted {backup_type} backup: {file_path}")
+                    archive_name = filename.split('.')[0]
+                    if not archive_name in archives_deleted:
+                        logger.debug(f"Archive name: '{archive_name}' added to catalog deletion list")
+                    archives_deleted[archive_name] = True
                 except Exception as e:
                     logger.error(f"Error deleting file {file_path}: {e}")
 
+    for archive_name in archives_deleted.keys():
+        delete_catalog(archive_name, args)
+
 
-def delete_archive(backup_dir, archive_name):
+def delete_archive(backup_dir, archive_name, args):
     """
     Delete all .dar and .par2 files in the backup directory for the given archive name.
 
@@ -90,7 +104,9 @@ def delete_archive(backup_dir, archive_name):
             except Exception as e:
                 logger.error(f"Error deleting archive slice {file_path}: {e}")
     
-    if not files_deleted:
+    if files_deleted:
+            delete_catalog(archive_name, args)
+    else:
         logger.info("No .dar files matched the regex for deletion.")
 
     # Delete associated .par2 files
@@ -110,6 +126,29 @@ def delete_archive(backup_dir, archive_name):
         logger.info("No .par2 matched the regex for deletion.")
 
 
+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']
+    logger.info(f"Deleting catalog '{catalog_name}' using config file: '{args.config_file}'")
+    try:
+        result:CommandResult = run_command(command)
+        if result.returncode == 0:
+            logger.info(f"Deleted catalog '{catalog_name}', using config file: '{args.config_file}'")
+            logger.debug(f"Stdout: manager.py --remove-specific-archive output:\n{result.stdout}")
+            return True
+        elif result.returncode == 2:
+            logger.warning(f"catalog '{catalog_name}' not found in the database, skipping deletion")
+            return True
+        else:
+            logger.error(f"Error deleting catalog {catalog_name}: {result.stderr}")
+            return False
+    except Exception as e:
+        logger.error(f"Error deleting catalog {catalog_name}: {e}")
+        return False
+
+
 def show_version():
     script_name = os.path.basename(sys.argv[0])
     print(f"{script_name} {about.__version__}")
@@ -118,8 +157,6 @@ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW,
 See section 15 and section 16 in the supplied "LICENSE" file.''')
 
 def main():
-
-    
     global logger
 
     parser = argparse.ArgumentParser(description="Cleanup old archives according to AGE configuration.")
@@ -127,9 +164,11 @@ def main():
     parser.add_argument('-c', '--config-file', '-c', type=str, help="Path to 'dar-backup.conf'", default='~/.config/dar-backup/dar-backup.conf')
     parser.add_argument('-v', '--version', action='store_true', help="Show version information.")
     parser.add_argument('--alternate-archive-dir', type=str, help="Cleanup in this directory instead of the default one.")
-    parser.add_argument('--cleanup-specific-archive', type=str, help="List of archives to cleanup") 
+    parser.add_argument('--cleanup-specific-archives', type=str, help="Commas separated list of archives to cleanup") 
     parser.add_argument('-l', '--list', action='store_true', help="List available archives.")
     parser.add_argument('--verbose', action='store_true', help="Print various status messages to screen")
+    parser.add_argument('--log-level', type=str, help="`debug` or `trace`, default is `info`", default="info")
+    parser.add_argument('--log-stdout', action='store_true', help='also print log messages to stdout')
     args = parser.parse_args()
 
     args.config_file = os.path.expanduser(args.config_file)
@@ -142,7 +181,8 @@ def main():
     config_settings = ConfigSettings(args.config_file)
 
     start_time=int(time())
-    logger = setup_logging(config_settings.logfile_location, logging.INFO)
+    logger = setup_logging(config_settings.logfile_location, args.log_level, args.log_stdout)
+
     logger.info(f"=====================================")
     logger.info(f"cleanup.py started, version: {about.__version__}")
 
@@ -156,7 +196,7 @@ def main():
     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-archive: {args.cleanup_specific_archive}")) 
+    args.verbose and (print(f"--cleanup-specific-archives:{args.cleanup_specific_archives}")) 
 
     # run PREREQ scripts
     if 'PREREQ' in config_settings.config:
@@ -175,15 +215,21 @@ def main():
 
 
     if args.alternate_archive_dir:
+        if not os.path.exists(args.alternate_archive_dir):
+            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")
+            sys.exit(1) 
         config_settings.backup_dir = args.alternate_archive_dir
 
 
-    if args.cleanup_specific_archive:
-        print(f"Cleaning up specific archives: {args.cleanup_specific_archive}")
-        archive_names = args.cleanup_specific_archive.split(',')
+    if args.cleanup_specific_archives:
+        logger.info(f"Cleaning up specific archives: {args.cleanup_specific_archives}")
+        archive_names = args.cleanup_specific_archives.split(',')
         for archive_name in archive_names:
-            print(f"Deleting archive: {archive_name}")
-            delete_archive(config_settings.backup_dir, archive_name.strip())
+            logger.info(f"Deleting archive: {archive_name}")
+            delete_archive(config_settings.backup_dir, archive_name.strip(), args)
     elif args.list:
         list_backups(config_settings.backup_dir, args.backup_definition)
     else:
@@ -196,22 +242,22 @@ def main():
                     backup_definitions.append(file.split('.')[0])
 
         for definition in backup_definitions:
-            delete_old_backups(config_settings.backup_dir, config_settings.diff_age, 'DIFF', definition)
-            delete_old_backups(config_settings.backup_dir, config_settings.incr_age, 'INCR', definition)
+            delete_old_backups(config_settings.backup_dir, config_settings.diff_age, 'DIFF', args, definition)
+            delete_old_backups(config_settings.backup_dir, config_settings.incr_age, 'INCR', args, definition)
 
 
     end_time=int(time())
     logger.info(f"END TIME: {end_time}")
 
-    error_lines = extract_error_lines(config_settings.logfile_location, start_time, end_time)
-    if len(error_lines) > 0:
-        args.verbose and print("\033[1m\033[31mErrors\033[0m encountered")
-        for line in error_lines:
-            args.verbose and print(line)
-        sys.exit(1)
-    else:
-        args.verbose and print("\033[1m\033[32mSUCCESS\033[0m No errors encountered")
-        sys.exit(0)
+#    error_lines = extract_error_lines(config_settings.logfile_location, start_time, end_time)
+#    if len(error_lines) > 0:
+#        args.verbose and print("\033[1m\033[31mErrors\033[0m encountered")
+#        for line in error_lines:
+#            args.verbose and print(line)
+#        sys.exit(1)
+#    else:
+#        args.verbose and print("\033[1m\033[32mSUCCESS\033[0m No errors encountered")
+#        sys.exit(0)
 
 if __name__ == "__main__":
     main()

dar_backup/dar_backup.py

@@ -30,7 +30,7 @@ from dar_backup.util import RestoreError
 
 logger = None
 
-def generic_backup(type: str, command: List[str], backup_file: str, backup_definition: str, darrc: str,  config_settings: ConfigSettings):
+def generic_backup(type: str, command: List[str], backup_file: str, backup_definition: str, darrc: str,  config_settings: ConfigSettings, args: argparse.Namespace):
     """
     Performs a backup using the 'dar' command.
 
@@ -64,6 +64,15 @@ def generic_backup(type: str, command: List[str], backup_file: str, backup_defin
             logger.warning("Backup completed with some files not backed up, this can happen if files are changed/deleted during the backup.")
         else:
             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"]
+            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.")
+            else:
+                logger.error(f"Catalog for archive '{backup_file}' not added.")
+
     except subprocess.CalledProcessError as e:
         logger.error(f"Backup command failed: {e}")
         raise BackupError(f"Backup command failed: {e}") from e
@@ -409,19 +418,22 @@ def perform_backup(args: argparse.Namespace, config_settings: ConfigSettings, ba
             command = create_backup_command(backup_type, backup_file, args.darrc, backup_definition_path, latest_base_backup)
 
             # Perform backup
-            generic_backup(backup_type, command, backup_file, backup_definition_path, args.darrc, config_settings)
+            generic_backup(backup_type, command, backup_file, backup_definition_path, args.darrc, config_settings, args)
 
             logger.info("Starting verification...")
-            result = verify(args, backup_file, backup_definition_path, config_settings)
-            if result:
+            verify_result = verify(args, backup_file, backup_definition_path, config_settings)
+            if verify_result:   
                 logger.info("Verification completed successfully.")
             else:
                 logger.error("Verification failed.")
 
-            if config_settings.par2_enabled:
+            
+            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.")
+            
+
         except Exception as e:
             logger.exception(f"Error during {backup_type} backup process, continuing to next backup definition.")
 
@@ -461,16 +473,14 @@ def generate_par2_files(backup_file: str, config_settings: ConfigSettings, args)
     for slice_file in dar_slices:
         file_path = os.path.join(config_settings.backup_dir, slice_file)
     
-        if args.verbose or args.log_level == "debug" or args.log_level == "trace":
-            logger.info(f"{counter}/{number_of_slices}: Now generating par2 files for {file_path}")
+        logger.info(f"{counter}/{number_of_slices}: Now generating par2 files for {file_path}")
 
         # Run the par2 command to generate redundancy files with error correction
         command = ['par2', 'create', f'-r{config_settings.error_correction_percent}', '-q', '-q', file_path]
         process = run_command(command, config_settings.command_timeout_secs)
 
         if process.returncode == 0:
-            if args.verbose or args.log_level == "debug" or args.log_level == "trace":
-                logger.info(f"{counter}/{number_of_slices}: Done")
+            logger.info(f"{counter}/{number_of_slices}: Done")
         else:
             logger.error(f"Error generating par2 files for {file_path}")
             raise subprocess.CalledProcessError(process.returncode, command)

dar_backup/manager.py

@@ -31,6 +31,8 @@ from . import __about__ as about
 from dar_backup.config_settings import ConfigSettings
 from dar_backup.util import run_command
 from dar_backup.util import setup_logging
+from dar_backup.util import CommandResult
+
 from datetime import datetime
 from time import time
 from typing import Dict, List, NamedTuple
@@ -60,6 +62,7 @@ def create_db(backup_def: str, config_settings: ConfigSettings):
 
     if os.path.exists(database_path):
         logger.warning(f'"{database_path}" already exists, skipping creation')
+        return 0
     else:
         logger.info(f'Create catalog database: "{database_path}"')
         command = ['dar_manager', '--create' , database_path]
@@ -90,8 +93,16 @@ def list_catalogs(backup_def: str, config_settings: ConfigSettings) -> NamedTupl
     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
+        error_msg = f'Database not found: "{database_path}"'
+        logger.error(error_msg)
+        commandResult = CommandResult(
+        process=None,
+        stdout='',
+        stderr=error_msg,
+        returncode=1,
+        timeout=1,
+        command=[])
+        return commandResult
     command = ['dar_manager', '--base', database_path, '--list']
     process = run_command(command)
     stdout, stderr = process.stdout, process.stderr 
@@ -277,32 +288,44 @@ def backup_def_from_archive(archive: str) -> str:
     """
     return the backup definition from archive name
     """
+    logger.debug(f"Get backup definition from archive: '{archive}'")
     search = re.search("(.*?)_", archive)
-    backup_def = search.group(1)
-    logger.debug(f"backup definition: '{backup_def}' from given archive '{archive}'")
-    return backup_def
+    if search:
+        backup_def = search.group(1)
+        logger.debug(f"backup definition: '{backup_def}' from given archive '{archive}'")
+        return backup_def
+    logger.error(f"Could not find backup definition from archive name: '{archive}'")
+    return None
 
 
 
 def remove_specific_archive(archive: str, config_settings: ConfigSettings) -> int:
+    """
+    
+    Returns:
+        - 0 if the archive was removed from it's catalog
+        - 1 if there was an error removing the archive
+        - 2 if the archive was not found in the catalog  
+
+    """
     backup_def = backup_def_from_archive(archive)
     database_path = os.path.join(config_settings.backup_dir, f"{backup_def}{DB_SUFFIX}")
     cat_no = cat_no_for_name(archive, config_settings)
     if cat_no >= 0:
         command = ['dar_manager', '--base', database_path, "--delete", str(cat_no)]
-        process = run_command(command)
+        process: CommandResult = run_command(command)
+        logger.info(f"CommandResult: {process}")
     else:
-        logger.error(f"archive: '{archive}' not found in in't catalog database: {database_path}")
-        return cat_no
+        logger.warning(f"archive: '{archive}' not found in it's catalog database: {database_path}")
+        return 2
 
     if process.returncode == 0:
         logger.info(f"'{archive}' removed from it's catalog")
+        return 0
     else:
         logger.error(process.stdout)
         logger.error(process.sterr)
-
-    return process.returncode
-
+        return 1    
 
 
 
@@ -322,7 +345,7 @@ def main():
     parser.add_argument('-d', '--backup-def', type=str, help='Restrict to work only on this backup definition')
     parser.add_argument('--add-specific-archive', type=str, help='Add this archive to catalog database')
     parser.add_argument('--remove-specific-archive', type=str, help='Remove this archive from catalog database')
-    parser.add_argument('--list-catalog', action='store_true', help='List catalogs in databases for all backup definitions')
+    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('--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')
@@ -430,15 +453,11 @@ See section 15 and section 16 in the supplied "LICENSE" file.''')
 
 
     if args.remove_specific_archive:
-        
-        if remove_specific_archive(args.remove_specific_archive, config_settings) == 0:
-            sys.exit(0)
-        else:  
-            sys.exit(1)
+        return remove_specific_archive(args.remove_specific_archive, config_settings)
 
 
 
-    if args.list_catalog:
+    if args.list_catalogs:
         if args.backup_def:
             process = list_catalogs(args.backup_def, config_settings)
             result = process.returncode

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

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: dar-backup
-Version: 0.6.5
+Version: 0.6.7
 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
+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
 Project-URL: Issues, https://github.com/per2jensen/dar-backup/issues
 Author-email: dar-backup <per2jensen@gmail.com>
@@ -845,6 +845,7 @@ Example of backup definition for a home directory
 Installation is currently in a venv. These commands are installed in the venv:
 - dar-back
 - cleanup
+- manager
 
 To install, create a venv and run pip:
 ````    
@@ -911,22 +912,36 @@ options:
   --log-stdout          also print log messages to stdout
   --do-not-compare      do not compare restores to file system
   -v, --version         Show version and license information.
-
 ````    
 
 ## 4
+Generate the archive catalog database(s). 
+`dar-backup` expects the catalog databases to be in place, it does not automatically create them (by design)
+
+````    
+manager --create-db --config-file <path to config file> --log-level debug --log-stdout
+````    
+
+
+
+
+## 5
 You are ready to do backups of all your backup definitions, if your backup definitions are 
 in place in BACKUP.D_DIR (see config file)
 ````    
 dar-backup --full-backup 
 ````    
+If you want to see dar-backup's log entries in the terminal, use the `--log-stdout` option. This is also useful if dar-backup is started by systemd.
+
+If you want more log messages, use the `--log-level debug` option.
+
 
-or a backup of a single definition
+If you want a backup of a single definition, use the `-d <backup definition>` option. The definition's name is the filename of the definition in the `backup.d` config directory.
 ````    
 dar-backup --full-backup -d <your backup definition>
 ````
 
-## 5 
+## 6 
 
 Deactivate the virtual environment
 ````

dar_backup-0.6.7.dist-info/RECORD

@@ -0,0 +1,13 @@
+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,,

dar_backup-0.6.5.dist-info/RECORD

@@ -1,13 +0,0 @@
-dar_backup/.darrc,sha256=3d9opAnnZGU9XLyQpTDsLtgo6hqsvZ3JU-yMLz-7_f0,2110
-dar_backup/__about__.py,sha256=_f8whmZJ36ZCTk0Zldzy3KONxDBm0bxyKt7pCSHC3cE,21
-dar_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dar_backup/cleanup.py,sha256=DgmxSUwKrLLIQuYSIY_yTRhIuOMgI6ivjlQuH4u3wX4,9057
-dar_backup/config_settings.py,sha256=CBMUhLOOZ-x7CRdS3vBDk4TYaGqC4N1Ot8IMH-qPaI0,3617
-dar_backup/dar_backup.py,sha256=YZoVu9NJX3_WIkQIG8EMLSK3-VWdslI0c2XKrM2Un38,32214
-dar_backup/manager.py,sha256=2qTcn1HiDrejc6S7dLpkylURGzMQ0QqTaSl2KQQ58Uw,19198
-dar_backup/util.py,sha256=SSSJYM9lQZfubhTUBlX1xDGWmCpYEF3ePARmlY544xM,11283
-dar_backup-0.6.5.dist-info/METADATA,sha256=z0xQGBCg2sGMi93gtNCK0DXINE1ZgsohQbQh0zutlD4,63802
-dar_backup-0.6.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dar_backup-0.6.5.dist-info/entry_points.txt,sha256=x9vnW-JEl8mpDJC69f_XBcn0mBSkV1U0cyvFV-NAP1g,126
-dar_backup-0.6.5.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-dar_backup-0.6.5.dist-info/RECORD,,