unifi-backup 0.1.0__tar.gz

unifi_backup-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Stanislav Meduna
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

unifi_backup-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: unifi_backup
+Version: 0.1.0
+Summary: A simple tool to fetch backups from the UniFi Network Application
+Author-email: Stanislav Meduna <stano@meduna.org>
+Project-URL: Homepage, https://github.com/numo68/unifi-backup
+Project-URL: Bug Tracker, https://github.com/numo68/unifi-backup/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: PyYAML
+Requires-Dist: schema
+Requires-Dist: pyunifi
+
+Usage
+=====
+
+**unifi-backup** is a simple tool to fetch configuration backups from
+the UniFi Network Application.
+
+Arguments
+----------------
+
+``-h``, ``--help``
+   show the help message and exit.
+
+``-c FILE``, ``--config FILE``
+   the configuration file (default: ``~/.config/unifi-backup/config.yml``)
+
+``-o FILE``, ``--output FILE``
+   the output file. The file name can contain ``strftime`` directives. If the argument
+   is specified, ``directory``, ``name`` and ``keep`` fields of the configuration
+   are ignored.
+
+Configuration file
+==================
+
+The ``unifi-backup`` needs a configuration file
+(default ``~/.config/unifi-backup/config.yml``). As the file contains secrets,
+take care to set reasonable permissions. The file is in
+the `YAML <https://yaml.org/>`_ format.
+
+Configuration file
+------------------
+
+.. code-block:: yaml
+
+      controller:
+         host: unifi
+         port: 8443
+         user: admin
+         password: ...
+         site: default
+         ssl_verify: true|false|/path/to/custom_cert.pem
+      output:
+         directory: .
+         name: "unifi-%Y%m%d-%H%M.unf"
+         keep: 12
+
+All fields except ``password`` are optional.
+
+``host`` is a host name or an IP address. The host has to be the same
+as the network application is configured for; using ``unifi`` here
+and ``unifi.domain.lan`` won't work.
+
+``name`` specifies the name of the output file. ``strftime`` directives
+are allowed.
+
+``keep`` removes all but the most recent ``*.unf`` files from the ``directory``,
+that in this case has to be specified and has to be an absolute path.
+
+``directory`` has to already exist. As the backup is not encrypted
+and contains secrets the permissions should be set accordingly.

unifi_backup-0.1.0/README.rst

@@ -0,0 +1,59 @@
+Usage
+=====
+
+**unifi-backup** is a simple tool to fetch configuration backups from
+the UniFi Network Application.
+
+Arguments
+----------------
+
+``-h``, ``--help``
+   show the help message and exit.
+
+``-c FILE``, ``--config FILE``
+   the configuration file (default: ``~/.config/unifi-backup/config.yml``)
+
+``-o FILE``, ``--output FILE``
+   the output file. The file name can contain ``strftime`` directives. If the argument
+   is specified, ``directory``, ``name`` and ``keep`` fields of the configuration
+   are ignored.
+
+Configuration file
+==================
+
+The ``unifi-backup`` needs a configuration file
+(default ``~/.config/unifi-backup/config.yml``). As the file contains secrets,
+take care to set reasonable permissions. The file is in
+the `YAML <https://yaml.org/>`_ format.
+
+Configuration file
+------------------
+
+.. code-block:: yaml
+
+      controller:
+         host: unifi
+         port: 8443
+         user: admin
+         password: ...
+         site: default
+         ssl_verify: true|false|/path/to/custom_cert.pem
+      output:
+         directory: .
+         name: "unifi-%Y%m%d-%H%M.unf"
+         keep: 12
+
+All fields except ``password`` are optional.
+
+``host`` is a host name or an IP address. The host has to be the same
+as the network application is configured for; using ``unifi`` here
+and ``unifi.domain.lan`` won't work.
+
+``name`` specifies the name of the output file. ``strftime`` directives
+are allowed.
+
+``keep`` removes all but the most recent ``*.unf`` files from the ``directory``,
+that in this case has to be specified and has to be an absolute path.
+
+``directory`` has to already exist. As the backup is not encrypted
+and contains secrets the permissions should be set accordingly.

unifi_backup-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=62.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "unifi_backup"
+version = "0.1.0"
+authors = [
+  { name="Stanislav Meduna", email="stano@meduna.org" },
+]
+description = "A simple tool to fetch backups from the UniFi Network Application"
+readme = "README.rst"
+requires-python = ">=3.7"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "PyYAML",
+    "schema",
+    "pyunifi"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/numo68/unifi-backup"
+"Bug Tracker" = "https://github.com/numo68/unifi-backup/issues"
+
+[project.scripts]
+unifi-backup = "unifi_backup.cli:main"
+
+[tool.setuptools]
+packages = ["unifi_backup"]
+package-dir = {"" = "src"}
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "src",
+]
+testpaths = [
+    "tests",
+]

unifi_backup-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

unifi_backup-0.1.0/src/unifi_backup/__main__.py

@@ -0,0 +1,7 @@
+"""Allows to run the tool as ``python -m unifi_backup ...``
+"""
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()

unifi_backup-0.1.0/src/unifi_backup/cli.py

@@ -0,0 +1,197 @@
+"""Parse the arguments, read the configuration file and fetch the backup
+from the UniFi network application
+"""
+
+import shutil
+import argparse
+import logging
+import re
+from os import environ, path, scandir, remove
+from datetime import datetime as dt
+from yaml import safe_load
+from schema import Schema, SchemaError, And, Or, Optional, Use
+
+from pyunifi.controller import APIError
+from pyunifi.controller import Controller
+
+DEFAULT_CONFIGURATION_FILE = path.join(
+    environ["HOME"], ".config", "unifi-backup", "config.yml"
+)
+
+SCHEMA = Schema(
+    {
+        "controller": Schema(
+            {
+                Optional("host", default="unifi"): And(str, lambda s: len(s) > 0),
+                Optional("port", default=8443): Use(int),
+                Optional("user", default="admin"): And(str, lambda s: len(s) > 0),
+                "password": And(str, lambda s: len(s) > 0),
+                Optional("site", default="default"): And(str, lambda s: len(s) > 0),
+                Optional("ssl_verify", default=True): Or(
+                    bool, And(str, lambda s: len(s) > 0)
+                ),
+            },
+        ),
+        Optional(
+            "output", default={"directory": ".", "name": "unifi-%Y%m%d%H%M.unf"}
+        ): Schema(
+            {
+                Optional("directory"): And(str, lambda s: len(s) > 0),
+                Optional("name", default="unifi-%Y%m%d%H%M.unf"): And(
+                    str, lambda s: len(s) > 0
+                ),
+                Optional("keep"): And(Use(int), lambda x: x > 0),
+            },
+        ),
+    }
+)
+
+
+def parse_arguments():
+    """Parse the arguments
+
+    Returns
+    -------
+    dict
+        parsed arguments
+    """
+
+    parser = argparse.ArgumentParser(
+        prog="unifi-backup",
+        description="A tool to fetch backups from the UniFi network application",
+    )
+
+    parser.add_argument(
+        "-c",
+        "--config",
+        default=DEFAULT_CONFIGURATION_FILE,
+        metavar="FILE",
+        type=argparse.FileType("r"),
+        help="the configuration file (default: %(default)s)",
+    )
+
+    parser.add_argument(
+        "-o",
+        "--output",
+        metavar="FILE",
+        help="the output file (default is specified in the configuration file)",
+    )
+
+    return vars(parser.parse_args())
+
+
+def parse_configuration(stream):
+    """Parse the configuration file
+
+    Parameters
+    ----------
+    stream : io.IOBase | str
+        Stream to read the configuration from.
+
+    Returns
+    -------
+    dict
+        Parsed and validated configuration
+    """
+    config = SCHEMA.validate(safe_load(stream))
+
+    return config
+
+
+def fetch_backup(controller_config: dict, out_file: str):
+    """Fetch the backup from the controller
+
+    Parameters
+    ----------
+    controller_config : dict
+        Controller configuration
+    out_file : str
+        Path to the output file
+    """
+    controller = Controller(
+        host=controller_config["host"],
+        port=controller_config["port"],
+        username=controller_config["user"],
+        password=controller_config["password"],
+        site_id=controller_config["site"],
+        ssl_verify=controller_config["ssl_verify"],
+    )
+
+    # PR https://github.com/finish06/pyunifi/pull/76 fixing get_backup is not merged yet
+    # controller.get_backup(target_file=out_file)
+    dl_url = controller._run_command("backup", mgr="backup", params={"days": 0})[0][
+        "url"
+    ]
+    # This is what the web UI does: controller._run_command("async-backup", mgr="backup", params={"days": 0})
+    response = controller.session.get(controller.url + dl_url, stream=True)
+
+    if response.status_code != 200:
+        raise APIError(f"API backup failed: {response.status_code}")
+
+    with open(out_file, "wb") as _backfh:
+        return shutil.copyfileobj(response.raw, _backfh)
+
+
+def rotate_files(output_config: dict):
+    """Rotate the files
+
+    Parameters
+    ----------
+    output_config : dict
+        Configuration
+    """
+    files = sorted(
+        [
+            f.name
+            for f in scandir(output_config["directory"])
+            if f.is_file and re.search(r"\.unf$", f.name)
+        ]
+    )
+
+    while len(files) > output_config["keep"]:
+        remove(path.join(output_config["directory"], files.pop(0)))
+
+
+def main():
+    """_summary_
+
+    Raises
+    ------
+    ValueError
+        Configuration is invalid
+    ValueError
+        Output directory does not exist
+    """
+    arguments = parse_arguments()
+
+    try:
+        config = parse_configuration(arguments["config"])
+    except SchemaError as ex:
+        raise ValueError(
+            "configuration invalid\n" + str(ex.with_traceback(None))
+        ) from None
+
+    arguments["config"].close()
+
+    # If the file was given through an argument, use that and skip the rotation
+    # If not, use the configuration to construct the file name and do the rotation
+    # if requested and the directory was provided as an absolute path
+    if arguments["output"] is not None:
+        out_file = arguments["output"]
+        rotate = False
+    else:
+        if not path.isdir(config["output"]["directory"]):
+            raise ValueError(
+                f"Target directory {config['output']['directory']} does not exist or is not a directory"
+            )
+        rotate = (
+            path.isabs(config["output"]["directory"]) and "keep" in config["output"]
+        )
+        out_file = path.join(
+            config["output"]["directory"], dt.now().strftime(config["output"]["name"])
+        )
+
+    fetch_backup(config["controller"], out_file)
+
+    if rotate:
+        rotate_files(config["output"])

unifi_backup-0.1.0/src/unifi_backup.egg-info/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: unifi_backup
+Version: 0.1.0
+Summary: A simple tool to fetch backups from the UniFi Network Application
+Author-email: Stanislav Meduna <stano@meduna.org>
+Project-URL: Homepage, https://github.com/numo68/unifi-backup
+Project-URL: Bug Tracker, https://github.com/numo68/unifi-backup/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: PyYAML
+Requires-Dist: schema
+Requires-Dist: pyunifi
+
+Usage
+=====
+
+**unifi-backup** is a simple tool to fetch configuration backups from
+the UniFi Network Application.
+
+Arguments
+----------------
+
+``-h``, ``--help``
+   show the help message and exit.
+
+``-c FILE``, ``--config FILE``
+   the configuration file (default: ``~/.config/unifi-backup/config.yml``)
+
+``-o FILE``, ``--output FILE``
+   the output file. The file name can contain ``strftime`` directives. If the argument
+   is specified, ``directory``, ``name`` and ``keep`` fields of the configuration
+   are ignored.
+
+Configuration file
+==================
+
+The ``unifi-backup`` needs a configuration file
+(default ``~/.config/unifi-backup/config.yml``). As the file contains secrets,
+take care to set reasonable permissions. The file is in
+the `YAML <https://yaml.org/>`_ format.
+
+Configuration file
+------------------
+
+.. code-block:: yaml
+
+      controller:
+         host: unifi
+         port: 8443
+         user: admin
+         password: ...
+         site: default
+         ssl_verify: true|false|/path/to/custom_cert.pem
+      output:
+         directory: .
+         name: "unifi-%Y%m%d-%H%M.unf"
+         keep: 12
+
+All fields except ``password`` are optional.
+
+``host`` is a host name or an IP address. The host has to be the same
+as the network application is configured for; using ``unifi`` here
+and ``unifi.domain.lan`` won't work.
+
+``name`` specifies the name of the output file. ``strftime`` directives
+are allowed.
+
+``keep`` removes all but the most recent ``*.unf`` files from the ``directory``,
+that in this case has to be specified and has to be an absolute path.
+
+``directory`` has to already exist. As the backup is not encrypted
+and contains secrets the permissions should be set accordingly.

unifi_backup-0.1.0/src/unifi_backup.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.rst
+pyproject.toml
+src/unifi_backup/__init__.py
+src/unifi_backup/__main__.py
+src/unifi_backup/cli.py
+src/unifi_backup.egg-info/PKG-INFO
+src/unifi_backup.egg-info/SOURCES.txt
+src/unifi_backup.egg-info/dependency_links.txt
+src/unifi_backup.egg-info/entry_points.txt
+src/unifi_backup.egg-info/requires.txt
+src/unifi_backup.egg-info/top_level.txt

unifi_backup-0.1.0/src/unifi_backup.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

unifi_backup-0.1.0/src/unifi_backup.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+unifi-backup = unifi_backup.cli:main

unifi_backup-0.1.0/src/unifi_backup.egg-info/requires.txt

@@ -0,0 +1,3 @@
+PyYAML
+schema
+pyunifi

unifi_backup-0.1.0/src/unifi_backup.egg-info/top_level.txt

@@ -0,0 +1 @@
+unifi_backup