nl.export 1.4.0__py3-none-any.whl

nl/export/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: UTF-8 -*-
+"""Beschreibung
+##############################################################################
+#
+# Copyright (c) 2023 Verbundzentrale des GBV.
+# All Rights Reserved.
+#
+##############################################################################
+"""

nl/export/config.py

@@ -0,0 +1,62 @@
+# -*- coding: UTF-8 -*-
+"""Config
+##############################################################################
+#
+# Copyright (c) 2023 Verbundzentrale des GBV.
+# All Rights Reserved.
+#
+##############################################################################
+"""
+
+# Imports
+import configparser
+import logging
+import os
+import shutil
+from enum import Enum
+from pathlib import Path
+
+logger = logging.getLogger(__name__)
+
+_config_path = Path(os.environ["HOME"])
+
+if "XDG_CONFIG_HOME" in os.environ:
+    _config_path = _config_path / os.environ["XDG_CONFIG_HOME"]
+else:
+    _config_path = _config_path / ".config"
+    _config_path.mkdir(exist_ok=True)
+
+NLCONFIG = _config_path / "nl_export.conf"
+NLCONFIG_Deprecated = (
+    (Path(os.environ["HOME"]) / ".nl_export.conf"),
+    (_config_path / ".nl_export.conf"),
+)
+
+for cpath in NLCONFIG_Deprecated:
+    if cpath.is_file():
+        shutil.move(cpath, NLCONFIG)
+
+NLACCESS_TOKEN = None
+NLBASE_URL = None
+NLUSER_AGENT = "nl-export-bot/1.0"
+
+try:
+    config = configparser.ConfigParser()
+    config.read(NLCONFIG)
+
+    NLACCESS_TOKEN = config.get("plone", "access-token")
+    NLBASE_URL = config.get("plone", "base-url")
+except Exception:
+    pass
+
+
+class LicenceModels(Enum):
+    NLLicenceModelStandard = (
+        "Products.VDNL.content.NLLicenceModelStandard.INLLicenceModelStandard"
+    )
+    NLLicenceModelOptIn = (
+        "Products.VDNL.content.NLLicenceModelOptIn.INLLicenceModelOptIn"
+    )
+    # NLLicenceModelSingleUser = (
+    #     "Products.VDNL.content.NLLicenceModelSingleUser.INLLicenceModelSingleUser"
+    # )

nl/export/errors.py

@@ -0,0 +1,23 @@
+# -*- coding: UTF-8 -*-
+"""Errors
+##############################################################################
+#
+# Copyright (c) 2023 Verbundzentrale des GBV.
+# All Rights Reserved.
+#
+##############################################################################
+"""
+
+# Imports
+
+
+class NoConfig(OSError):
+    pass
+
+
+class NoMember(BaseException):
+    pass
+
+
+class Unauthorized(BaseException):
+    pass

nl/export/formatter/__init__.py

@@ -0,0 +1,9 @@
+"""Beschreibung
+
+##############################################################################
+#
+# Copyright (c) 2024 Verbundzentrale des GBV.
+# All Rights Reserved.
+#
+##############################################################################
+"""

nl/export/formatter/csv.py

@@ -0,0 +1,138 @@
+"""Beschreibung
+
+##############################################################################
+#
+# Copyright (c) 2024 Verbundzentrale des GBV.
+# All Rights Reserved.
+#
+##############################################################################
+"""
+
+import csv
+import typing
+from argparse import Namespace
+from contextlib import AbstractContextManager
+from types import TracebackType
+
+from nl.export.plone import LicenceModel
+from nl.export.utils import get_unique_path, get_wf_state, option_title, secure_filename
+
+
+class LFormatCSV(AbstractContextManager):
+    def __init__(self, lmodel: LicenceModel, options: Namespace) -> None:
+        self.lmodel = lmodel
+        self.options = options
+        self.destination = self.options.ablage.absolute()
+
+        self.cfh = None
+        self.csvpath = None
+        self.writer = None
+
+    def add_row(self, licence: dict | None, licencee: dict | None) -> dict:
+        match self.options.version:
+            case 2:
+                self.add_row_version_2(licence, licencee)
+            case _:
+                self.add_row_version_1(licence, licencee)
+
+    def add_row_version_1(self, licence: dict | None, licencee: dict | None) -> dict:
+        licencee = {} if licencee is None else licencee.plone_item
+
+        ipv4_allow = licencee.get("ipv4_allow", "")
+        ipv4_deny = None
+        ezb_id = licencee.get("ezb_id", "")
+
+        row = {}
+        row["user_name"] = licencee.get("uid", "")
+        row["status"] = get_wf_state(licencee)
+        row["title"] = licencee.get("title", "")
+        row["street"] = licencee.get("street", "")
+        row["zip"] = licencee.get("zip", "")
+        row["city"] = licencee.get("city", "")
+        row["county"] = option_title(licencee, "county")
+        row["country"] = option_title(licencee, "country")
+        row["telephone"] = licencee.get("telephone", "")
+        row["fax"] = licencee.get("fax", "")
+        row["email"] = licencee.get("email", "")
+        row["url"] = licencee.get("url", "")
+        row["contactperson"] = licencee.get("contactperson", "")
+        row["sigel"] = licencee.get("sigel", "")
+        row["ezb_id"] = ",".join(ezb_id) if isinstance(ezb_id, list) else ""
+        row["subscriber_group"] = option_title(licencee, "subscriper_group")
+        row["ipv4_allow"] = ",".join(ipv4_allow) if isinstance(ipv4_allow, list) else ""
+        row["ipv4_deny"] = ",".join(ipv4_deny) if isinstance(ipv4_deny, list) else ""
+        row["shib_provider_id"] = licencee.get("shib_provider_id", "")
+        row["zuid"] = licencee.get("UID", "")
+        row["mtime"] = licencee.get("modified", "")
+
+        if licence is None:
+            self.writer.writerow(row.keys())
+        else:
+            self.writer.writerow(row.values())
+
+        return row
+
+    def add_row_version_2(self, licence: dict | None, licencee: dict | None) -> dict:
+        licencee = {} if licencee is None else licencee.plone_item
+
+        ipv4_allow = licencee.get("ipv4_allow", "")
+        ipv6 = licencee.get("ipv6", "")
+        ezb_id = licencee.get("ezb_id", "")
+        foreign_keys = licencee.get("foreign_keys", "")
+
+        row = {}
+        row["user_name"] = licencee.get("uid", "")
+        row["status"] = get_wf_state(licencee)
+        row["title"] = licencee.get("title", "")
+        row["street"] = licencee.get("street", "")
+        row["zip"] = licencee.get("zip", "")
+        row["city"] = licencee.get("city", "")
+        row["county"] = option_title(licencee, "county")
+        row["country"] = option_title(licencee, "country")
+        row["telephone"] = licencee.get("telephone", "")
+        row["fax"] = licencee.get("fax", "")
+        row["email"] = licencee.get("email", "")
+        row["url"] = licencee.get("url", "")
+        row["contactperson"] = licencee.get("contactperson", "")
+        row["sigel"] = licencee.get("sigel", "")
+        row["ezb_id"] = ",".join(ezb_id) if isinstance(ezb_id, list) else ""
+        row["isni"] = licencee.get("isni", "")
+        row["foreign_keys"] = (
+            ",".join(foreign_keys) if isinstance(foreign_keys, list) else ""
+        )
+        row["subscriber_group"] = option_title(licencee, "subscriper_group")
+        row["ipv4_allow"] = ",".join(ipv4_allow) if isinstance(ipv4_allow, list) else ""
+        row["ipv6"] = ",".join(ipv6) if isinstance(ipv6, list) else ""
+        row["shib_provider_id"] = licencee.get("shib_provider_id", "")
+        row["zuid"] = licencee.get("UID", "")
+        row["mtime"] = licencee.get("modified", "")
+
+        if licence is None:
+            self.writer.writerow(row.keys())
+        else:
+            self.writer.writerow(row.values())
+
+        return row
+
+    def __enter__(self) -> typing.Any:
+        fname = secure_filename(
+            self.lmodel.getTitle(), only_ascii=self.options.only_ascii
+        )
+        self.csvpath = get_unique_path(f"{fname}.csv", self.destination)
+        self.cfh = self.csvpath.open("w")
+        self.writer = csv.writer(
+            self.cfh, delimiter=";", quotechar='"', quoting=csv.QUOTE_ALL
+        )
+
+        self.add_row(None, None)
+
+        return super().__enter__()
+
+    def __exit__(
+        self,
+        __exc_type: type[BaseException] | None,
+        __exc_value: BaseException | None,
+        __traceback: TracebackType | None,
+    ) -> bool | None:
+        self.cfh.close()
+        return super().__exit__(__exc_type, __exc_value, __traceback)

nl/export/formatter/json.py

@@ -0,0 +1,49 @@
+"""Beschreibung
+
+##############################################################################
+#
+# Copyright (c) 2024 Verbundzentrale des GBV.
+# All Rights Reserved.
+#
+##############################################################################
+"""
+
+import json
+import typing
+from argparse import Namespace
+from contextlib import AbstractContextManager
+from types import TracebackType
+
+from nl.export.plone import LicenceModel
+from nl.export.utils import get_unique_path, secure_filename
+
+
+class LFormatJSON(AbstractContextManager):
+    def __init__(self, lmodel: LicenceModel, options: Namespace) -> None:
+        self.lmodel = lmodel
+        self.options = options
+        self.destination = self.options.ablage.absolute()
+
+        self.jpath = None
+
+    def add_row(self, licence: dict | None, licencee: dict | None) -> dict:
+        fpath = self.jpath / f"{licencee.plone_item['uid']}.json"
+        with fpath.open("w") as jfh:
+            json.dump(licencee.plone_item, jfh)
+
+    def __enter__(self) -> typing.Any:
+        fname = secure_filename(
+            self.lmodel.getTitle(), only_ascii=self.options.only_ascii
+        )
+        self.jpath = get_unique_path(f"{fname}", self.destination)
+        self.jpath.mkdir(exist_ok=True)
+
+        return super().__enter__()
+
+    def __exit__(
+        self,
+        __exc_type: type[BaseException] | None,
+        __exc_value: BaseException | None,
+        __traceback: TracebackType | None,
+    ) -> bool | None:
+        return super().__exit__(__exc_type, __exc_value, __traceback)

nl/export/formatter/xml.py

@@ -0,0 +1,177 @@
+"""Beschreibung
+
+##############################################################################
+#
+# Copyright (c) 2024 Verbundzentrale des GBV.
+# All Rights Reserved.
+#
+##############################################################################
+"""
+
+import typing
+from argparse import Namespace
+from contextlib import AbstractContextManager
+from types import TracebackType
+
+from lxml import etree
+
+from nl.export.plone import LicenceModel
+from nl.export.utils import get_unique_path, get_wf_state, option_title, secure_filename
+
+
+class LFormatXML(AbstractContextManager):
+    def __init__(self, lmodel: LicenceModel, options: Namespace) -> None:
+        self.lmodel = lmodel
+        self.options = options
+        self.destination = self.options.ablage.absolute()
+
+        self.xmlpath = None
+        self.xfh = None
+        self.dom = None
+
+    def add_row(self, licence: dict | None, licencee: dict | None) -> None:
+        match self.options.version:
+            case 2:
+                self.add_row_version_2(licence, licencee)
+            case _:
+                self.add_row_version_1(licence, licencee)
+
+    def add_row_version_1(self, licence: dict | None, licencee: dict | None) -> None:
+        NL_NAMESPACE = "http://www.nationallizenzen.de/ns/nl"
+        XNL = f"{{{NL_NAMESPACE}}}"
+        NSMAP = {None: NL_NAMESPACE}
+
+        def cenc(key, data):
+            val_node = etree.Element(XNL + key, nsmap=NSMAP)
+
+            if isinstance(data, (list, tuple)):
+                for entry in data:
+                    token_node = etree.Element(XNL + "token", nsmap=NSMAP)
+                    token_node.text = entry
+
+                    val_node.append(token_node)
+            elif type(data) is dict:
+                pass
+            else:
+                val_node.text = data
+
+            return val_node
+
+        licencee = {} if licencee is None else licencee.plone_item
+
+        row = {}
+        row["user_name"] = licencee.get("uid", "")
+        row["status"] = get_wf_state(licencee)
+        row["title"] = licencee.get("title", "")
+        row["street"] = licencee.get("street", "")
+        row["zip"] = licencee.get("zip", "")
+        row["city"] = licencee.get("city", "")
+        row["county"] = option_title(licencee, "county")
+        row["country"] = option_title(licencee, "country")
+        row["telephone"] = licencee.get("telephone", "")
+        row["fax"] = licencee.get("fax", "")
+        row["email"] = licencee.get("email", "")
+        row["url"] = licencee.get("url", "")
+        row["contactperson"] = licencee.get("contactperson", "")
+        row["sigel"] = licencee.get("sigel", "")
+        row["ezb_id"] = licencee.get("ezb_id", [])
+        row["subscriber_group"] = option_title(licencee, "subscriper_group")
+        row["ipv4_allow"] = licencee.get("ipv4_allow", [])
+        row["ipv4_deny"] = []
+        row["shib_provider_id"] = licencee.get("shib_provider_id", "")
+        row["uid"] = licencee.get("UID", "")
+        row["mtime"] = licencee.get("modified", "")
+
+        inst_node = etree.Element(XNL + "institution", nsmap=NSMAP)
+        self.dom.append(inst_node)
+
+        for key, val in row.items():
+            val_node = cenc(key, val)
+            inst_node.append(val_node)
+
+    def add_row_version_2(self, licence: dict | None, licencee: dict | None) -> None:
+        NL_NAMESPACE = "http://www.nationallizenzen.de/ns/nl"
+        XNL = f"{{{NL_NAMESPACE}}}"
+        NSMAP = {None: NL_NAMESPACE}
+
+        def cenc(key, data):
+            val_node = etree.Element(XNL + key, nsmap=NSMAP)
+
+            if isinstance(data, (list, tuple)):
+                for entry in data:
+                    token_node = etree.Element(XNL + "token", nsmap=NSMAP)
+                    token_node.text = entry
+
+                    val_node.append(token_node)
+            elif type(data) is dict:
+                pass
+            else:
+                val_node.text = data
+
+            return val_node
+
+        licencee = {} if licencee is None else licencee.plone_item
+
+        row = {}
+        row["user_name"] = licencee.get("uid", "")
+        row["status"] = get_wf_state(licencee)
+        row["title"] = licencee.get("title", "")
+        row["street"] = licencee.get("street", "")
+        row["zip"] = licencee.get("zip", "")
+        row["city"] = licencee.get("city", "")
+        row["county"] = option_title(licencee, "county")
+        row["country"] = option_title(licencee, "country")
+        row["telephone"] = licencee.get("telephone", "")
+        row["fax"] = licencee.get("fax", "")
+        row["email"] = licencee.get("email", "")
+        row["url"] = licencee.get("url", "")
+        row["contactperson"] = licencee.get("contactperson", "")
+        row["sigel"] = licencee.get("sigel", "")
+        row["ezb_id"] = licencee.get("ezb_id", [])
+        row["foreign_keys"] = licencee.get("foreign_keys", [])
+        row["isni"] = licencee.get("isni", [])
+        row["subscriber_group"] = option_title(licencee, "subscriper_group")
+        row["ipv4_allow"] = licencee.get("ipv4_allow", [])
+        row["ipv6"] = licencee.get("ipv6", [])
+        row["shib_provider_id"] = licencee.get("shib_provider_id", "")
+        row["uid"] = licencee.get("UID", "")
+        row["mtime"] = licencee.get("modified", "")
+
+        inst_node = etree.Element(XNL + "institution", nsmap=NSMAP)
+        self.dom.append(inst_node)
+
+        for key, val in row.items():
+            val_node = cenc(key, val)
+            inst_node.append(val_node)
+
+    def __enter__(self) -> typing.Any:
+        fname = secure_filename(
+            self.lmodel.getTitle(), only_ascii=self.options.only_ascii
+        )
+        self.xmlpath = get_unique_path(f"{fname}.xml", self.destination)
+
+        basexml = b"""<?xml version='1.0' encoding='UTF-8'?>"""
+        basexml += b"""<nl:institutions xmlns:nl="http://www.nationallizenzen.de/ns/nl"></nl:institutions>"""
+
+        self.dom = etree.fromstring(basexml)
+
+        return super().__enter__()
+
+    def __exit__(
+        self,
+        __exc_type: type[BaseException] | None,
+        __exc_value: BaseException | None,
+        __traceback: TracebackType | None,
+    ) -> bool | None:
+        with self.xmlpath.open("wb") as xfh:
+            xfh.write(
+                etree.tostring(
+                    self.dom,
+                    xml_declaration=True,
+                    encoding="UTF-8",
+                    method="xml",
+                    pretty_print=True,
+                )
+            )
+
+        return super().__exit__(__exc_type, __exc_value, __traceback)

nl/export/gapi.py

@@ -0,0 +1,49 @@
+# -*- coding: UTF-8 -*-
+"""API
+##############################################################################
+#
+# Copyright (c) 2023 Verbundzentrale des GBV.
+# All Rights Reserved.
+#
+##############################################################################
+"""
+
+# Imports
+
+
+class TerminalColors:
+    RESET = "\033[0m"
+    BOLD = "\033[1m"
+    UNDERLINE = "\033[4m"
+
+    # Text colors
+    BLACK = "\033[30m"
+    RED = "\033[31m"
+    GREEN = "\033[32m"
+    YELLOW = "\033[33m"
+    BLUE = "\033[34m"
+    MAGENTA = "\033[35m"
+    CYAN = "\033[36m"
+    WHITE = "\033[37m"
+
+    # Background colors
+    BLACK_BG = "\033[40m"
+    RED_BG = "\033[41m"
+    GREEN_BG = "\033[42m"
+    YELLOW_BG = "\033[43m"
+    BLUE_BG = "\033[44m"
+    MAGENTA_BG = "\033[45m"
+    CYAN_BG = "\033[46m"
+    WHITE_BG = "\033[47m"
+
+    @classmethod
+    def bold(cls, msg: str) -> str:
+        return f"{cls.BOLD}{msg}{cls.RESET}"
+
+    @classmethod
+    def green(cls, msg: str) -> str:
+        return f"{cls.GREEN}{msg}{cls.RESET}"
+
+    @classmethod
+    def red(cls, msg: str) -> str:
+        return f"{cls.RED}{msg}{cls.RESET}"

nl/export/interfaces.py

@@ -0,0 +1,11 @@
+# -*- coding: UTF-8 -*-
+"""Interfaces
+##############################################################################
+#
+# Copyright (c) 2023 Verbundzentrale des GBV.
+# All Rights Reserved.
+#
+##############################################################################
+"""
+
+# Imports