dar-backup 0.6.15__py3-none-any.whl → 0.6.16__py3-none-any.whl

dar_backup/__about__.py

@@ -1 +1 @@
-__version__ = "0.6.15"
+__version__ = "0.6.16"

dar_backup/cleanup.py

@@ -21,6 +21,7 @@ import subprocess
 import sys
 
 from datetime import datetime, timedelta
+from inputimeout import inputimeout, TimeoutOccurred
 from time import time
 from typing import Dict, List, NamedTuple
 
@@ -156,6 +157,7 @@ def show_version():
 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 main():
     global logger
 
@@ -164,11 +166,12 @@ 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-archives', type=str, help="Commas separated list of archives to cleanup") 
+    parser.add_argument('--cleanup-specific-archives', type=str, help="Comma 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')
+    parser.add_argument('--test-mode', action='store_true', help='Read envvars in order to run some pytest cases')
     args = parser.parse_args()
 
     args.config_file = os.path.expanduser(os.path.expandvars(args.config_file))
@@ -232,6 +235,33 @@ def main():
         logger.info(f"Cleaning up specific archives: {args.cleanup_specific_archives}")
         archive_names = args.cleanup_specific_archives.split(',')
         for archive_name in archive_names:
+            if "_FULL_" in archive_name:
+                try:
+                    try:
+                        # used for pytest cases
+                        if args.test_mode:
+                            confirmation = os.environ.get("CLEANUP_TEST_DELETE_FULL")
+                            if confirmation == None:
+                                raise RuntimeError("envvar 'CLEANUP_TEST_DELETE_FULL' not set")
+                            
+                        else:
+                            confirmation = inputimeout(
+                                prompt=f"Are you sure you want to delete the FULL archive '{archive_name}'? (yes/no): ",
+                                timeout=30)
+                        if confirmation == None:
+                            continue
+                        else:
+                            confirmation = confirmation.strip().lower()
+                    except TimeoutOccurred:
+                        logger.info(f"Timeout waiting for confirmation for FULL archive: {archive_name}. Skipping deletion.")
+                        continue
+                except KeyboardInterrupt:
+                    logger.info(f"User interrupted confirmation for FULL archive: {archive_name}. Skipping deletion.")
+                    continue
+
+                if confirmation != 'yes':
+                    logger.info(f"User did not answer 'yes' to confirm deletion of FULL archive: {archive_name}. Skipping deletion.")
+                    continue
             logger.info(f"Deleting archive: {archive_name}")
             delete_archive(config_settings.backup_dir, archive_name.strip(), args)
     elif args.list:

dar_backup/dar_backup.py

@@ -797,10 +797,10 @@ 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 args.darrc.startswith("filtered_darrc_"):
-                os.remove(args.darrc)
-                logger.debug(f"Removed filtered .darrc: {args.darrc}")
+        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}")
 
 
     # Determine exit code 

{dar_backup-0.6.15.dist-info → dar_backup-0.6.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dar-backup
-Version: 0.6.15
+Version: 0.6.16
 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
@@ -688,8 +688,10 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: System :: Archiving :: Backup
 Requires-Python: >=3.9
+Requires-Dist: inputimeout>=1.0.4
 Description-Content-Type: text/markdown
 
+<!-- markdownlint-disable MD024 -->
 # Full, differential or incremental backups using 'dar'
 
 The wonderful 'dar' [Disk Archiver](https://github.com/Edrusb/DAR) is used for
@@ -706,17 +708,20 @@ This is the `Python` based **version 2** of `dar-backup`.
   - [Breaking change in version 0.6.0](#breaking-change-in-version-060)
 - [Homepage - Github](#homepage---github)
 - [Requirements](#requirements)
-- [Config file](#config-file)
+- [Principles](#dar-backup-principles)
 - [How to run](#how-to-run)
   - [1 - installation](#1---installation)
   - [2 - configuration](#2---configuration)
   - [3 - generate catalog databases](#3---generate-catalog-databases)
   - [4 - do FULL backups](#4---do-full-backups)
   - [5 - deactivate venv](#5---deactivate-venv)
-- [.darrc](#darrc)
-- [Systemctl examples](#systemctl-examples)
-  - [Service: dar-back --incremental-backup](#service-dar-back---incremental-backup)
-  - [Timer: dar-back --incremental-backup](#timer-dar-back---incremental-backup)
+- [Config](#config)
+  - [Config file](#config-file)
+  - [.darrc](#darrc)
+  - [Backup definition](#backup-definition-example)
+- [Systemd examples](#systemctl-examples)
+  - [Service: dar-back --incremental-backup](#service-dar-backup---incremental-backup)
+  - [Timer: dar-back --incremental-backup](#timer-dar-backup---incremental-backup)
 - [List contents of an archive](#list-contents-of-an-archive)
 - [dar file selection examples](#dar-file-selection-examples)
   - [Select a directory](#select-a-directory)
@@ -782,9 +787,9 @@ Version 0.6.0 and forwards requires the config variable *COMMAND_TIMEOUT_SECS* i
 
 ## Homepage - Github
 
-This 'dar-backup' package lives at: [Github - dar-backup](https://github.com/per2jensen/dar-backup/tree/main/v2)
+'dar-backup' package lives here: [Github - dar-backup](https://github.com/per2jensen/dar-backup/tree/main/v2)
 
-This python version is v2 of dar-backup, the first is made in bash.
+This python version is v2 of dar-backup, v1 is made in bash.
 
 ## Requirements
 
@@ -798,9 +803,25 @@ On Ubuntu, install the requirements this way:
     sudo apt install dar par2 python3
 ````
 
-## Config file
+## dar-backup principles
 
-The default configuration is expected here: ~/.config/dar-backup/dar-backup.conf
+### dar-backup
+
+`dar-backup` is built in a way that emphasizes getting backups. It loops over the backup definitions, and in the event of a failure while backing up a backup definition, dar-backup shall log an error and start working on the next backup definition.
+
+There are 3 levels of backups, FULL, DIFF and INCR.
+
+- The author does a FULL yearly backup once a year. This includes all files in all directories as defined in the backup definition(s).
+- The author makes a DIFF once a month. The DIFF backs up new and changed files compared to the FULL backup.
+- The author takes an INCR backup every 3 days. An INCR backup includes new and changed files compared to the DIFF backup.
+--  So, a set of INCR's will contain duplicates (this might change as I become more used to use the catalog databases)
+--  No INCR backups will taken until a DIFF backup has been taken.
+
+### cleanup
+
+The `cleanup` application deletes DIFF and INCR if the archives are older than the thresholds set up in the configuration file.
+
+`cleanup` will only remove FULL archives if the option  `--cleanup-specific-archives` is used. It requires the user to confirm deletion of FULL archives.
 
 ## How to run
 
@@ -814,6 +835,11 @@ Installation is currently in a venv. These commands are installed in the venv:
 - clean-log
 - installer
 
+Note:
+
+The module `inputimeout` is installed into the venv and used for the confirmation input (with a 30 second timeout)
+
+
 To install, create a venv and run pip:
 
 ```` bash
@@ -875,16 +901,18 @@ manager --create-db
 
 ### 4 - do FULL backups
 
-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)
+Prereq:
+Backup definitions are in place in BACKUP.D_DIR (see config file)
+
+You are ready to do backups of all your backup definitions.
 
 ```` bash
 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 to see dar-backup's log entries in the terminal, use the `--log-stdout` option. This can be useful if dar-backup is started by systemd.
 
-If you want more log messages, use the `--log-level debug` option.
+If you want more log messages, use the `--verbose` or `--log-level debug` for even more.
 
 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.
 
@@ -900,7 +928,52 @@ Deactivate the virtual environment (venv)
 deactivate
 ````
 
-## .darrc
+## Config
+
+### Config file
+
+The configuration file's default location is: ~/.config/dar-backup/dar-backup.conf
+
+If you have your config file somewhere else, use the `--config` option to point to it.
+
+Tilde `~` and environment variables can be used in the paths for various file locations.
+
+```` code
+[MISC]
+LOGFILE_LOCATION=~/.dar-backup.log
+MAX_SIZE_VERIFICATION_MB = 20
+MIN_SIZE_VERIFICATION_MB = 1
+NO_FILES_VERIFICATION = 5
+# 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 util.run_command(), a default timeout of 30 secs is used.
+COMMAND_TIMEOUT_SECS = 86400
+
+[DIRECTORIES]
+BACKUP_DIR = /some/where/dar-backup/backups/
+BACKUP.D_DIR = /some/where/dar-backup/backup.d
+TEST_RESTORE_DIR = /tmp/dar-backup/restore/
+
+[AGE]
+# age settings are in days
+DIFF_AGE = 100
+INCR_AGE = 40
+
+[PAR2]
+ERROR_CORRECTION_PERCENT = 5
+ENABLED = True
+
+# scripts to run before the backup to setup the environment
+[PREREQ]
+SCRIPT_1 = ls -l /tmp
+#SCRIPT_2 = another_script.sh
+
+[POSTREQ]
+SCRIPT_1 = df -h
+#SCRIPT_2 = another_script.sh
+````
+
+### .darrc
 
 The package includes a default `.darrc` file which configures `dar`.
 
@@ -1031,6 +1104,48 @@ compress-exclusion:
 -acase
 ````
 
+### Backup definition example
+
+This piece of configuration is a `backup definition`. It is placed in the BACKUP.D_DIR (see config file description).
+The name of the file is the name of the backup definition.
+
+You can use as many backup definitions as you need.
+
+```` code
+ # Switch to ordered selection mode, which means that the following
+ # options will be considered top to bottom
+ -am
+
+# Backup Root Dir
+# This is the top directory, where the backups start.
+#Directories mentioned below, are relative to the Root Dir.
+ -R /home/user/
+
+# Directories to backup below the Root dir
+# uncomment the next line to backup only the Documents directory
+# -g Documents
+
+# Directories to exclude below the Root dir
+ -P mnt
+ -P tmp
+ -P .cache
+ -P .config/Code/CachedData
+ 
+# compression level
+ -z5
+
+# no overwrite, if you rerun a backup, 'dar' halts and asks what to do
+# due to the -Q option given to `dar`, the program will terminate and give en error.
+ -n
+ 
+# size of each slice in the archive
+ --slice 7G
+
+# bypass directores marked as cache directories
+# http://dar.linux.free.fr/doc/Features.html
+--cache-directory-tagging
+````
+
 ## Systemctl examples
 
 I have dar-backup scheduled to run via systemd --user settings.
@@ -1051,7 +1166,7 @@ Verify your timers are set up as you want:
 systemctl --user list-timers
 ````
 
-## Service: dar-back --incremental-backup
+## Service: dar-backup --incremental-backup
 
 File:  dar-inc-backup.service
 
@@ -1067,7 +1182,7 @@ RemainAfterExit=no
 ExecStart=/bin/bash -c '. /home/user/programmer/dar-backup.py/venv/bin/activate && dar-backup --incremental-backup --verbose'
 ````
 
-## Timer: dar-back --incremental-backup
+## Timer: dar-backup --incremental-backup
 
 File:  dar-inc-backup.timer
 
@@ -1328,26 +1443,27 @@ done
 
 This makes it easier to restore to a given date when having many FULL, DIFF and INCR archives.
 
+If the manager does not add an archive to it's catalog database, `dar-backup` will log an error and continue. The important part is verify the archive is usable and continue to other backup definitions.
+
 ### Performance tip due to par2
 
 This [dar benchmark page](https://dar.sourceforge.io/doc/benchmark.html) has an interesting note on the slice size.
 
-Slice size should be smaller than available RAM, apparently a large performance hit can be avoided keeping the the par2 data in memory.
+Slice size should be smaller than available RAM, apparently a large performance hit can be avoided keeping the par2 data in memory.
 
 ### .darrc sets -vd -vf (since v0.6.4)
 
 These .darrc settings make `dar` print the current directory being processed (-vd) and some stats after (-vf)
-This is very useful in very long running jobs to get an indication that the backup is proceeding normally.
 
-if --log-stdout is used the information would be picked up by systemd and logged by journald.½
-
-The log file can get quite cluttered, if you want the clutter to be removed, run the `clean-log`script.
+This is very useful in very long running jobs to get an indication that the backup is proceeding normally.
 
 ### Separate log file for command output
 
 Dar-backup's log file is called `dar-backup.log`.
 
-In order to not clutter that log file with the output of commands being run, a new log file has been introduced `dar-backup-commands.log`.
+In order to not clutter that log file with the output of commands being run, a new secondary log file has been introduced `dar-backup-commands.log`.
+
+The secondary log file can get quite cluttered, if you want to remove the clutter, run the `clean-log`script with the `--file` option, or simply delete it.
 
 ## Todo
 
@@ -1355,7 +1471,7 @@ In order to not clutter that log file with the output of commands being run, a n
   - FULL, DIFF and INCR backups.
   - cleanup.
 
-- fix --log-stdout spams console with command output
+- Add option to dar-backup to use the `dar` option `--fsa-scope none`
 
 ## Reference
 

{dar_backup-0.6.15.dist-info → dar_backup-0.6.16.dist-info}/RECORD

@@ -1,16 +1,16 @@
 dar_backup/.darrc,sha256=-aerqivZmOsW_XBCh9IfbYTUvw0GkzDSr3Vx4GcNB1g,2113
-dar_backup/__about__.py,sha256=9pegTLVQP2o3JePGrLB6muzXif64umv9ihLnS7LsH8E,22
+dar_backup/__about__.py,sha256=iZmWvp4Ehnidf9YJv6Dpn5Sma5S84lPbQtLoYZ2OuiI,22
 dar_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dar_backup/clean_log.py,sha256=cGhtKYnQJ2ceNQfw5XcCln_WNBasbmlfhO3kRydjDNk,5196
-dar_backup/cleanup.py,sha256=1g2si9-jPEL8T4OKaiGSKFGsF6rWh-Ke1-zQHE7HaPc,11703
+dar_backup/cleanup.py,sha256=EoT_jTiJmy_HoWxxlWuRn21GoMnr5ioN8yM7qiNRPKE,13351
 dar_backup/config_settings.py,sha256=uicCq6FnpxPFzbv7xfYSXNnQf1tfLk1Z3VIO9M71fsE,4659
 dar_backup/dar-backup.conf,sha256=-wXqP4vj5TS7cCfMJN1nbk-1Sqkq00Tg22ySQXynUF4,902
-dar_backup/dar_backup.py,sha256=TrYMYNbQ9jWabWGc7GA5p2ezprLqMUu9O0zt6CQ1QSA,37867
+dar_backup/dar_backup.py,sha256=PI154FIXZiU36iAyLZCCxAciDeBSwoBXYQh0n5JmNEs,37895
 dar_backup/installer.py,sha256=ehp4KSgTc8D9Edsyve5v3NY2MuDbuTFYQQPgou8woV8,4331
 dar_backup/manager.py,sha256=sQl0xdWwBgui11S9Ekg0hOSC4gt89nz_Z8Bt8IPXCDw,21640
 dar_backup/util.py,sha256=F6U-e-WugxCxLPVoiWsM6_YO8VrDw1wdgGvtnGnig2I,12279
-dar_backup-0.6.15.dist-info/METADATA,sha256=JwTNDXCElF0elUKBhwjrDUASEkpLIjgdtfEML5NvXUY,72750
-dar_backup-0.6.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dar_backup-0.6.15.dist-info/entry_points.txt,sha256=Z7P5BUbhtJxo8_nB9qNIMay2eGDbsMKB3Fjwv3GMa4g,202
-dar_backup-0.6.15.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-dar_backup-0.6.15.dist-info/RECORD,,
+dar_backup-0.6.16.dist-info/METADATA,sha256=xaYjZK6XAWOc_NHsnktylhdvqWLqzmo94GT1MoR6qLw,76678
+dar_backup-0.6.16.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dar_backup-0.6.16.dist-info/entry_points.txt,sha256=Z7P5BUbhtJxo8_nB9qNIMay2eGDbsMKB3Fjwv3GMa4g,202
+dar_backup-0.6.16.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+dar_backup-0.6.16.dist-info/RECORD,,