Databases: add support for zip archiving

README.md

@@ -277,7 +277,7 @@ databases:
 
 ## Databases
 
-Right now, this app supports **MongoDB**, **PostgreSQL 13**, **MariaDB** and **Redis**. If
+Right now, this app supports **MongoDB**, **PostgreSQL 13**, **MariaDB**, **Redis** and **LocalStorage archiving**. If
 you need support for an additional database, consider opening a pull request to
 add a new database handler.
 
@@ -371,6 +371,21 @@ Identifiers can be any string of your choosing.
       port: "6379"
 ```
 
+### Local Storage
+
+- **Database type**: `localstorage`
+- **Required field**: `path`
+- **Optional field**: `compression_level`
+- The compression level must be an integer between 0 and 9.
+- The archive will contain the full structure, starting from the root folder.
+
+```yaml
+  localstorage:
+    main_localstorage:
+      path: /path/to/folder
+      compression_level: 7
+```
+
 #### To restore from the backup
 
 - Stop Redis server.

blackbox/handlers/databases/__init__.py

@@ -4,3 +4,4 @@
 from .mysql import MySQL
 from .postgres import Postgres
 from .redis import Redis
+from .localstorage import LocalStorage

blackbox/handlers/databases/localstorage.py

@@ -0,0 +1,42 @@
+import datetime
+from collections import deque
+from pathlib import Path
+from zipfile import ZIP_DEFLATED
+from zipfile import ZipFile
+
+from blackbox.exceptions import ImproperlyConfigured
+from blackbox.handlers.databases._base import BlackboxDatabase
+
+
+class LocalStorage(BlackboxDatabase):
+    """A Database handler that will zip a local folder."""
+
+    required_fields = ("path",)
+
+    def backup(self) -> Path:
+        date = datetime.date.today().strftime("%d_%m_%Y")
+
+        path = self.config["path"]
+        compression_level = self.config.get("compression_level", 5)
+
+        if compression_level < 0 or compression_level > 9:
+            raise ImproperlyConfigured(
+                f"Invalid compression level. Must be an integer between 0 and 9, got {compression_level}."
+            )
+
+        backup_path = Path.home() / f"{self.config['id']}_blackbox_{date}.zip"
+
+        with ZipFile(backup_path, "w", ZIP_DEFLATED, compresslevel=compression_level) as zipfile:
+            directories = deque((Path(path),))
+
+            while not len(directories) == 0:
+                path = directories.pop()
+
+                for file in path.iterdir():
+                    if file.is_file():
+                        zipfile.write(file)
+                    elif file.is_dir():
+                        directories.append(file)
+
+        self.success = True
+        return backup_path