pyxecm 3.8.2__tar.gz → 3.9.0__tar.gz

{pyxecm-3.8.2 → pyxecm-3.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyxecm
-Version: 3.8.2
+Version: 3.9.0
 Summary: A Python library to interact with Opentext Content Management Rest API
 Project-URL: Homepage, https://github.com/opentext/pyxecm
 Author-email: Kai Gatzweiler <kgatzweiler@opentext.com>, "Dr. Marc Diefenbruch" <mdiefenb@opentext.com>
@@ -27,6 +27,7 @@ Requires-Dist: xmltodict>=0.14.2
 Requires-Dist: zeep>=4.2.0
 Provides-Extra: api
 Requires-Dist: asyncio>=3.4.3; extra == 'api'
+Requires-Dist: cryptography>=44.0.0; extra == 'api'
 Requires-Dist: fastapi>=0.116.0; extra == 'api'
 Requires-Dist: jinja2>=3.1.6; extra == 'api'
 Requires-Dist: opentelemetry-api>=1.34.1; extra == 'api'
@@ -42,6 +43,8 @@ Requires-Dist: openpyxl>=3.1.5; extra == 'customizer'
 Requires-Dist: playwright>=1.53.0; extra == 'customizer'
 Requires-Dist: pydantic>=2.12.0; extra == 'customizer'
 Requires-Dist: python-hcl2==7.3.1; extra == 'customizer'
+Provides-Extra: forms
+Requires-Dist: reportlab>=4.0; extra == 'forms'
 Provides-Extra: magic
 Requires-Dist: python-magic; extra == 'magic'
 Provides-Extra: saml

{pyxecm-3.8.2 → pyxecm-3.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyxecm"
-version = "3.8.2"
+version = "3.9.0"
 description = 'A Python library to interact with Opentext Content Management Rest API'
 keywords = [
   'opentext',
@@ -44,6 +44,7 @@ classifiers = [
 magic = ['python-magic']
 sap = ['pyrfc==3.3.1']
 saml = ['signxml>=5.1.0']
+forms = ['reportlab>=4.0']
 customizer = [
   "kubernetes>=33.1.0",
   "playwright>=1.53.0",
@@ -53,6 +54,7 @@ customizer = [
 ]
 api = [
   "asyncio>=3.4.3",
+  "cryptography>=44.0.0",
   "fastapi>=0.116.0",
   "jinja2>=3.1.6",
   "opentelemetry-api>=1.34.1",

{pyxecm-3.8.2 → pyxecm-3.9.0}/src/pyxecm/otcs.py

@@ -9333,7 +9333,8 @@ class OTCS:
 
         elif os.path.exists(path_or_url):
             self.logger.debug("Uploading local file -> '%s'", path_or_url)
-            file_content = open(file=path_or_url, mode="rb")  # noqa: SIM115
+            with open(file=path_or_url, mode="rb") as local_file:
+                file_content = local_file.read()
 
         else:
             self.logger.warning("Cannot access file -> '%s'", path_or_url)
@@ -9502,14 +9503,15 @@ class OTCS:
                 If True, automatically extract ZIP files and upload extracted directory. If False,
                 upload the unchanged Zip file.
             replace_existing (bool, optional):
-                If True, replaces an existing file with the same name in the target folder. If False,
-                the upload will fail if a file with the same name already exists.
+                If True, an existing document with the same name in the target folder gets the file
+                as a new version. If False, the upload will fail if a file with the same name already exists.
             show_error (bool, optional):
                 If True, treats the upload failure as an error. If False, no error is shown (useful if the file already exists).
 
         Returns:
             dict | None:
-                The response from the upload operation or None if the upload fails.
+                The response from the upload operation (or from add_document_version() if a new
+                version of an existing document has been added) or None if the upload fails.
 
         """
 
@@ -9604,7 +9606,8 @@ class OTCS:
 
             elif os.path.exists(file_url):
                 self.logger.debug("Uploading local file -> %s", file_url)
-                file_content = open(file=file_url, mode="rb")  # noqa: SIM115
+                with open(file=file_url, mode="rb") as local_file:
+                    file_content = local_file.read()
 
             else:
                 self.logger.warning("Cannot access file -> '%s'", file_url)
@@ -9652,6 +9655,27 @@ class OTCS:
         if not mime_type:
             mime_type = "application/octet-stream"  # Default to binary stream if mime type cannot be determined
 
+        # If a document with the same name exists already we add a new version instead
+        # (categories, classifications and external dates only apply to new documents):
+        if replace_existing:
+            response = self.get_node_by_parent_and_name(
+                parent_id=parent_id, name=file_name, fields="properties{id,name}"
+            )
+            existing_document_id = self.get_result_value(response=response, key="id")
+            if existing_document_id:
+                self.logger.debug(
+                    "Document -> '%s' does already exist in parent with ID -> %d. Adding a new version...",
+                    file_name,
+                    parent_id,
+                )
+                return self.add_document_version(
+                    node_id=int(existing_document_id),
+                    file_name=file_name,
+                    mime_type=mime_type,
+                    file_content=file_content if isinstance(file_content, bytes) else file_content.read(),
+                    description=description,
+                )
+
         upload_post_files = [("file", (f"{file_name}", file_content, mime_type))]
 
         request_url = self.config()["nodesUrlv2"]
@@ -9997,7 +10021,8 @@ class OTCS:
 
             elif os.path.exists(file_url):
                 self.logger.debug("Upload local file -> '%s' as new version.", file_url)
-                file_content = open(file=file_url, mode="rb")  # noqa: SIM115
+                with open(file=file_url, mode="rb") as local_file:
+                    file_content = local_file.read()
 
             else:
                 self.logger.warning("Cannot access file -> '%s'", file_url)
@@ -10007,7 +10032,7 @@ class OTCS:
         upload_post_data = {"description": description}
 
         if not mime_type:
-            mime_type, _ = mimetypes.guess_type(file_url)
+            mime_type, _ = mimetypes.guess_type(file_name)
 
         if not mime_type and magic_installed and file_url:
             try:

{pyxecm-3.8.2 → pyxecm-3.9.0}/src/pyxecm_api/app.py

@@ -24,6 +24,7 @@ from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
 from prometheus_fastapi_instrumentator import Instrumentator
+from pyxecm_customizer.log import LOG_DATE_FORMAT, LOG_FORMAT
 from pyxecm_customizer.version import customizer_version
 from pyxecm_maintenance_page import run_maintenance_page
 
@@ -31,6 +32,9 @@ from .auth.router import router as auth_router
 from .common.functions import PAYLOAD_LIST
 from .common.metrics import payload_logs_by_payload, payload_logs_total
 from .common.router import router as common_router
+from .config.router import router as config_router
+from .pods.router import LOG_SPOOL
+from .pods.router import router as pods_router
 from .settings import api_settings
 from .terminal.router import router as terminal_router
 from .v1_maintenance.router import router as v1_maintenance_router
@@ -95,6 +99,7 @@ async def lifespan(
 
     logger.info("Shutdown")
     PAYLOAD_LIST.stop_payload_processing()
+    LOG_SPOOL.close()
 
 
 # end function lifespan
@@ -124,6 +129,11 @@ app = FastAPI(
             "name": "maintenance",
             "description": "Enable, disable or alter the maintenance mode.",
         },
+        {
+            "name": "pods",
+            "description": "List the pods of the namespace, browse, download and upload their files and read their "
+            "logs. Only available when pod_access is on (it follows ws_terminal).",
+        },
     ],
 )
 
@@ -152,6 +162,10 @@ app.include_router(router=v1_payload_router)
 if api_settings.ws_terminal:
     app.include_router(router=terminal_router)
 
+if api_settings.pod_access:
+    app.include_router(router=pods_router)
+    app.include_router(router=config_router)
+
 ## Add Prometheus Instrumentator for /metrics,
 if api_settings.metrics:
     # Add Prometheus Instrumentator for /metricsf
@@ -183,15 +197,16 @@ def run_api() -> None:
     # Stdout
     log_config["formatters"]["standard"] = {
         "()": "uvicorn.logging.DefaultFormatter",
-        "fmt": "%(asctime)s %(levelprefix)s [%(name)s] [%(threadName)s] %(message)s",
-        "datefmt": "%d-%b-%Y %H:%M:%S",
+        # The log format with uvicorn's colored level name.
+        "fmt": LOG_FORMAT.replace("%(levelname)s", "%(levelprefix)s"),
+        "datefmt": LOG_DATE_FORMAT,
         "use_colors": True,
     }
 
     log_config["formatters"]["logfile"] = {
         "()": "uvicorn.logging.DefaultFormatter",
-        "fmt": "%(asctime)s %(levelname)s [%(name)s] [%(threadName)s] %(message)s",
-        "datefmt": "%d-%b-%Y %H:%M:%S",
+        "fmt": LOG_FORMAT,
+        "datefmt": LOG_DATE_FORMAT,
         "use_colors": True,
     }
 
@@ -205,7 +220,7 @@ def run_api() -> None:
     log_config["formatters"]["default"] = {
         "()": "uvicorn.logging.DefaultFormatter",
         "fmt": "%(asctime)s %(levelprefix)s %(message)s",
-        "datefmt": "%d-%b-%Y %H:%M:%S",
+        "datefmt": LOG_DATE_FORMAT,
         "use_colors": False,
     }
 

pyxecm-3.9.0/src/pyxecm_api/config/__init__.py

@@ -0,0 +1,7 @@
+"""ConfigMaps and Secrets of the namespace: show and change them, and restart what uses them."""
+
+__author__ = "Dr. Marc Diefenbruch"
+__copyright__ = "Copyright (C) 2024-2025, OpenText"
+__credits__ = ["Kai-Philip Gatzweiler"]
+__maintainer__ = "Dr. Marc Diefenbruch"
+__email__ = "mdiefenb@opentext.com"