Split retention and missing range

unifi_protect_backup/cli.py

@@ -30,8 +30,11 @@ def _parse_detection_types(ctx, param, value):
     return types
 
 
-def parse_rclone_retention(ctx, param, retention) -> relativedelta:
+def parse_rclone_retention(ctx, param, retention) -> relativedelta | None:
     """Parse the rclone `retention` parameter into a relativedelta which can then be used to calculate datetimes."""
+    if retention is None:
+        return None
+
     matches = {k: int(v) for v, k in re.findall(r"([\d]+)(ms|s|m|h|d|w|M|y)", retention)}
 
     # Check that we matched the whole string
@@ -79,6 +82,15 @@ def parse_rclone_retention(ctx, param, retention) -> relativedelta:
     "(https://rclone.org/filtering/#max-age-don-t-transfer-any-file-older-than-this)",
     callback=parse_rclone_retention,
 )
+@click.option(
+    "--missing-range",
+    default=None,
+    envvar="MISSING_RANGE",
+    help="How far back should missing events be checked for. Defaults to the same as the retention time. "
+    "Format as per the `--max-age` argument of `rclone` "
+    "(https://rclone.org/filtering/#max-age-don-t-transfer-any-file-older-than-this)",
+    callback=parse_rclone_retention,
+)
 @click.option(
     "--rclone-args",
     default="",
@@ -261,6 +273,9 @@ def main(**kwargs):
             )
             raise SystemExit(200)  # throw 200 = arg error, service will not be restarted (docker)
 
+        if kwargs.get("missing_range") is None:
+            kwargs["missing_range"] = kwargs.get("retention")
+
         # Only create the event listener and run if validation passes
         event_listener = UnifiProtectBackup(**kwargs)
         run(event_listener.start(), stop_on_unhandled_errors=True)

unifi_protect_backup/unifi_protect_backup_core.py

@@ -68,6 +68,7 @@ class UnifiProtectBackup:
         verify_ssl: bool,
         rclone_destination: str,
         retention: relativedelta,
+        missing_range: relativedelta,
         rclone_args: str,
         rclone_purge_args: str,
         detection_types: List[str],
@@ -98,9 +99,13 @@ class UnifiProtectBackup:
             rclone_destination (str): `rclone` destination path in the format
                                     {rclone remote}:{path on remote}. E.g.
                                     `gdrive:/backups/unifi_protect`
-            retention (str): How long should event clips be backed up for. Format as per the
+            retention (relativedelta): How long should event clips be backed up for. Format as per the
                             `--max-age` argument of `rclone`
                             (https://rclone.org/filtering/#max-age-don-t-transfer-any-file-older-than-this)
+            missing_range (relativedelta): How far back should missing events be checked for. Defaults to
+                                 the same as the retention time. Format as per the
+                                `--max-age` argument of `rclone`
+                                (https://rclone.org/filtering/#max-age-don-t-transfer-any-file-older-than-this)
             rclone_args (str): A bandwidth limit which is passed to the `--bwlimit` argument of
                                    `rclone` (https://rclone.org/docs/#bwlimit-bandwidth-spec)
             rclone_purge_args (str): Optional extra arguments to pass to `rclone delete` directly.
@@ -144,6 +149,7 @@ class UnifiProtectBackup:
         logger.debug(f"  {verify_ssl=}")
         logger.debug(f"  {rclone_destination=}")
         logger.debug(f"  {retention=}")
+        logger.debug(f"  {missing_range=}")
         logger.debug(f"  {rclone_args=}")
         logger.debug(f"  {rclone_purge_args=}")
         logger.debug(f"  {ignore_cameras=}")
@@ -163,6 +169,7 @@ class UnifiProtectBackup:
 
         self.rclone_destination = rclone_destination
         self.retention = retention
+        self.missing_range = missing_range
         self.rclone_args = rclone_args
         self.rclone_purge_args = rclone_purge_args
         self.file_structure_format = file_structure_format
@@ -314,15 +321,15 @@ class UnifiProtectBackup:
             tasks.append(purge.start())
 
             # Create missing event task
-            #   This will check all the events within the retention period, if any have been missed and not backed up
-            #   they will be added to the event queue
+            #   This will check all the events within the missing_range period, if any have been missed and not
+            #   backed up. they will be added to the event queue
             missing = MissingEventChecker(
                 self._protect,
                 self._db,
                 download_queue,
                 downloader,
                 uploaders,
-                self.retention,
+                self.missing_range,
                 self.detection_types,
                 self.ignore_cameras,
                 self.cameras,