pyxecm 2.0.3__py3-none-any.whl → 2.0.4__py3-none-any.whl

pyxecm/customizer/payload.py

@@ -1063,7 +1063,7 @@ class Payload:
     - sort (list, optional, default = []) - list of fields to sort the data frame by
     - operations (list, optional, default = ["create"])
     - update_operations (list, optional, default = ["name", "description", "categories", "nickname", "version"]) - possible values:
-      "name", "description", "categories", "nickname", "version"
+      "name", "description", "categories", "nickname", "version", "purge"
     - name (str, mandatory) - can include placeholder surrounded by {...}
     - name_alt (str, optional, default = None) - can include placeholder surrounded by {...}
     - name_regex (str, optional, default = r"") - regex replacement for document names. The pattern and replacement are separated by pipe character |
@@ -1142,7 +1142,7 @@ class Payload:
     - unique (list, optional, default = []) - list of column names which values should be unique -> deduplication
     - sort (list, optional, default = []) - list of fields to sort the data frame by
     - operations (list, optional, default = ["create"])
-    - update_operations (list, optional, default = ["name", "description", "categories", "nickname", "version"]) - possible values:
+    - update_operations (list, optional, default = ["name", "description", "categories", "nickname"]) - possible values:
       "name", "description", "categories", "nickname", "url"
     - name (str, mandatory) - can include placeholder surrounded by {...}
     - name_alt (str, optional, default = None) - can include placeholder surrounded by {...}
@@ -7674,6 +7674,7 @@ class Payload:
                 group_names,
                 user_department,
             )
+
             # Go through all group names:
             for group_name in group_names:
                 # Find the group payload item to the parent group name:
@@ -7773,7 +7774,7 @@ class Payload:
                                 )
                                 success = False
 
-                # As M365 groups are flat (not nested) we also add the
+                # As M365 groups are flat (not nested), we also add the
                 # user as member to the parent groups of the current group
                 # if the parent group is enabled for M365:
                 parent_group_names = group.get("parent_groups")
@@ -7884,13 +7885,17 @@ class Payload:
                             response = self._m365.follow_sharepoint_site(site_id=group_site_id, user_id=m365_user_id)
                             if not response:
                                 self.logger.warning(
-                                    "User -> '%s' cannot follow SharePoint site -> '%s'. ",
+                                    "User -> '%s' cannot follow SharePoint site -> '%s'.",
                                     user["email"],
                                     group_site_name,
                                 )
                                 success = False
-            # end for group name
+                        # end if group_site_id:
+                    # end if group_id:
+                # end if group_name == user_department and user["m365_skus"]:
+            # end for group name in group_names:
         # end for user
+
         self.write_status_file(
             success=success,
             payload_section_name=section_name,
@@ -8410,8 +8415,18 @@ class Payload:
         by Scheduled Bots (Jobs) from OTCS via the creation of MS teams
         (each MS Team has a SharePoint site behind it)!
 
-        The are the SharePoint sites for the departmental groups such as "Sales",
+        These are the SharePoint sites for the departmental groups such as "Sales",
         "Procurement", "Enterprise Asset Management", ...
+        Only departmental group that have a top-level folder with the exact same
+        name as the Department are configured.
+
+        For each departmental group:
+        1. Determine a departmental folder in the Enterprise Workspace
+        2. Determine the M365 Group
+        3. Determine the SharePoint Site (based on the M365 group ID)
+        4. Determine the Page in the SharePoint site
+        5. Determine or create the SharePoint webpart for the OTCS browser
+        6. Create URL object pointing to SharePoint site inside top level department folder
 
         Args:
             section_name (str, optional):
@@ -8769,7 +8784,7 @@ class Payload:
             # end else
 
             #
-            # 6. Create URL object pointing to SharePoint site inside top level ddepartment folder
+            # 6. Create URL object pointing to SharePoint site inside top level department folder
             #
 
             item_name = (
@@ -13426,10 +13441,6 @@ class Payload:
                 continue
 
             workspace_id = workspace["id"]
-            self.logger.info(
-                "Workspace -> '%s' has memberships in payload - establishing...",
-                workspace_name,
-            )
 
             workspace_node_id = int(self.determine_workspace_id(workspace=workspace))
             if not workspace_node_id:
@@ -13438,6 +13449,10 @@ class Payload:
                 )
                 continue
 
+            self.logger.info(
+                "Workspace -> '%s' (%s) has memberships in payload - establishing...", workspace_name, workspace_node_id
+            )
+
             # now determine the actual node IDs of the workspaces (have been created by process_workspaces()):
             workspace_node = self._otcs.get_node(node_id=workspace_node_id)
             workspace_owner_id = self._otcs.get_result_value(
@@ -13454,21 +13469,29 @@ class Payload:
             )
             if workspace_roles is None:
                 self.logger.debug(
-                    "Workspace with ID -> %s and node Id -> %s has no roles. Skipping to next workspace...",
-                    workspace_id,
+                    "Workspace -> '%s' (%s) has no roles. Skipping to next workspace...",
+                    workspace_name,
                     workspace_node_id,
                 )
                 continue
 
             # We don't want the workspace creator to be in the leader role
             # of automatically created workspaces - this can happen because the
-            # creator gets added to the leader role automatically:
-            leader_role_id = self._otcs.lookup_result_value(
-                response=workspace_roles,
-                key="leader",
-                value=True,
-                return_key="id",
-            )
+            # creator gets added to the leader role automatically if
+            # the workspace type advanved configuration setting
+            # "Add the creator of a business workspace to the Lead role" is
+            # enabled:
+            roles_iterator = self._otcs.get_result_values_iterator(response=workspace_roles)
+            for role in roles_iterator:
+                # We can have two leader roles if in a sub-workspaces a leader
+                # roles is inherited from the parent workspace. As we want
+                # don't want to consider leader role of the parent workspace
+                # we check that 'inherited_from_id' is not set:
+                if role["leader"] and role["inherited_from_id"] is None:
+                    leader_role_id = role["id"]
+                    break
+            else:
+                leader_role_id = None
 
             if leader_role_id:
                 leader_role_name = self._otcs.lookup_result_value(
@@ -13493,6 +13516,16 @@ class Payload:
                         workspace_name,
                         workspace_node_id,
                     )
+                else:
+                    self.logger.info(
+                        "Creator user -> '%s' (%s) is not in leader role -> '%s' (%s) of workspace -> '%s' (%s). No need to remove it.",
+                        workspace_owner_name,
+                        workspace_owner_id,
+                        leader_role_name,
+                        leader_role_id,
+                        workspace_name,
+                        workspace_node_id,
+                    )
 
             self.logger.info(
                 "Adding members to workspace -> '%s' (%s) defined in payload...",
@@ -13509,7 +13542,7 @@ class Payload:
 
                 if member_role_name == "":  # role name is required
                     self.logger.error(
-                        "Members of workspace -> '%s' is missing the role name.",
+                        "Members of workspace -> '%s' is missing the role name in the payload.",
                         workspace_name,
                     )
                     success = False
@@ -13530,6 +13563,23 @@ class Payload:
                     )
                     success = False
                     continue
+                inherited_role_id = self._otcs.lookup_result_value(
+                    response=workspace_roles,
+                    key="name",
+                    value=member_role_name,
+                    return_key="inherited_from_id",
+                )
+                if inherited_role_id is not None:
+                    self.logger.error(
+                        "The role -> '%s' (%s) of workspace -> '%s' (%s) is inherited from role with ID -> %d and members cannot be set in this sub-workspace.",
+                        member_role_name,
+                        role_id,
+                        workspace_name,
+                        workspace_node_id,
+                        inherited_role_id,
+                    )
+                    success = False
+                    continue
                 self.logger.debug(
                     "Role -> '%s' has ID -> %s",
                     member_role_name,
@@ -13583,20 +13633,22 @@ class Payload:
                     )
                     if response is None:
                         self.logger.error(
-                            "Failed to add user -> '%s' (%s) as member to role -> '%s' of workspace -> '%s'",
+                            "Failed to add user -> '%s' (%s) as member to role -> '%s' of workspace -> '%s' (%s)",
                             member_user,
                             user_id,
                             member_role_name,
                             workspace_name,
+                            workspace_node_id,
                         )
                         success = False
                     else:
                         self.logger.info(
-                            "Successfully added user -> '%s' (%s) as member to role -> '%s' of workspace -> '%s'",
+                            "Successfully added user -> '%s' (%s) as member to role -> '%s' of workspace -> '%s' (%s)",
                             member_user,
                             user_id,
                             member_role_name,
                             workspace_name,
+                            workspace_node_id,
                         )
 
                 # Process groups as workspaces members:
@@ -15824,7 +15876,7 @@ class Payload:
                         success = False
                         continue
                 case self._otcs.ITEM_TYPE_SHORTCUT:  # Shortcut
-                    if original_id == 0:
+                    if not original_id:
                         self.logger.error(
                             "Item -> '%s' has type Shortcut but the original item is not in the payload. Skipping...",
                             item_name,
@@ -18481,7 +18533,7 @@ class Payload:
                 user_password=password,
                 automation_name=name,
                 take_screenshots=debug_automation,
-                headless=self._browser_headless,
+                headless=browser_automation.get("headless", self._browser_headless),
                 logger=self.logger,
                 wait_until=wait_until,
                 browser=browser_automation.get("browser"),  # None is acceptable
@@ -21822,14 +21874,9 @@ class Payload:
                 )
                 result["skipped_counter"] += 1
                 continue
-            # Workspace names for sure are not allowed to have ":":
-            workspace_name = workspace_name.replace(":", "")
-            # Workspace names for sure should not have leading or trailing spaces:
-            workspace_name = workspace_name.strip()
-            # Truncate the workspace name to 254 characters which is the maximum
-            # allowed length in Content Server
-            if len(workspace_name) > 254:
-                workspace_name = workspace_name[:254]
+
+            # Cleanse the workspace name (allowed characters, maximum length):
+            workspace_name = OTCS.cleanse_item_name(workspace_name)
 
             # Check if workspace has been created before (either in this run
             # or in a former run of the customizer):
@@ -22726,8 +22773,8 @@ class Payload:
             # If not, we load the data source on the fly:
             data_source_data: Data = data_source.get("data")
             if not data_source_data:
-                self.logger.warning(
-                    "Lookup data source -> '%s' has no data yet. Trying to reload...",
+                self.logger.info(
+                    "Lookup data source -> '%s' has no data yet. Reloading...",
                     data_source_name,
                 )
                 data_source_data = self.process_bulk_datasource(
@@ -25006,14 +25053,8 @@ class Payload:
             # We keep success = True as this is a data problem and not a config problem!
             return None, success
 
-        # Workspace names for sure are not allowed to have ":":
-        workspace_name = workspace_name.replace(":", "")
-        # Workspace names for sure should not have leading or trailing spaces:
-        workspace_name = workspace_name.strip()
-        # Truncate the workspace name to 254 characters which is
-        # the maximum allowed length in Content Server
-        if len(workspace_name) > 254:
-            workspace_name = workspace_name[:254]
+        # Cleanse the workspace name (allowed characters, maximum length):
+        workspace_name = OTCS.cleanse_item_name(workspace_name)
 
         # Check if all data conditions to create the workspace are met
         conditions = workspace.get("conditions")
@@ -25782,14 +25823,8 @@ class Payload:
                 result["skipped_counter"] += 1
                 continue
 
-            # Document names for sure are not allowed to have ":":
-            document_name = document_name.replace(":", "")
-            # Document names for sure should not have leading or trailing spaces:
-            document_name = document_name.strip()
-            # Truncate the document name to 254 characters which is
-            # the maximum allowed length in Content Server
-            if len(document_name) > 254:
-                document_name = document_name[:254]
+            # Cleanse the document name (allowed characters, maximum length):
+            document_name = OTCS.cleanse_item_name(document_name)
 
             download_name = ""
             if download_name_field:
@@ -26027,6 +26062,8 @@ class Payload:
                                 att_name,
                                 parent_id,
                             )
+                            # Keep track that we need to handle a name clash as based on the key
+                            # the document should not exist.
                             handle_name_clash = True
                     else:
                         self.logger.error(
@@ -26148,11 +26185,6 @@ class Payload:
                             categories=categories,
                             replacements=replacements,
                         )
-                        # document_category_data = self.prepare_item_create_form(
-                        #     parent_id=parent_id,
-                        #     categories=worker_categories,
-                        #     subtype=self._otcs_frontend.ITEM_TYPE_DOCUMENT,
-                        # )
                         document_category_data = self.prepare_category_data(
                             categories_payload=worker_categories,
                             source_node_id=parent_id,
@@ -26254,7 +26286,8 @@ class Payload:
                     )
                 ):
                     # get the specific update operations given in the payload
-                    # if not specified we do all 4 update operations (name, description, categories and version)
+                    # if not specified we do the following update operations.
+                    # The 'purge' operation needs to be specified explicitly.
                     update_operations = bulk_document.get(
                         "update_operations",
                         ["name", "description", "categories", "nickname", "version"],
@@ -26321,6 +26354,21 @@ class Payload:
                             )
                             success = False
                             continue
+                    if "purge" in update_operations:
+                        max_versions = bulk_document.get("max_versions", 1)
+                        response = self._otcs_frontend.purge_document_versions(
+                            node_id=document_id, versions_to_keep=max_versions
+                        )
+                        if not response:
+                            self.logger.error(
+                                "Failed to purge versions of document -> '%s' (%s) to %d version%s!",
+                                (document_old_name if document_old_name else document_name),
+                                document_id,
+                                max_versions,
+                                "s" if max_versions > 1 else "",
+                            )
+                            success = False
+                            continue
                     response = self._otcs_frontend.update_item(
                         node_id=document_id,
                         parent_id=None,  # None = do not move item
@@ -27066,14 +27114,8 @@ class Payload:
                 result["skipped_counter"] += 1
                 continue
 
-            # Document names for sure are not allowed to have ":":
-            item_name = item_name.replace(":", "")
-            # Document names for sure should not have leading or trailing spaces:
-            item_name = item_name.strip()
-            # Truncate the item name to 254 characters which is
-            # the maximum allowed length in Content Server
-            if len(item_name) > 254:
-                item_name = item_name[:254]
+            # Cleanse the item name (allowed characters, maximum length):
+            item_name = OTCS.cleanse_item_name(item_name)
 
             # This is an optimization. We check if the item was created
             # in a former run. This helps if the customizer is re-run:
@@ -28901,14 +28943,8 @@ class Payload:
                 result["skipped_counter"] += 1
                 continue
 
-            # Classification names for sure are not allowed to have ":":
-            classification_name = classification_name.replace(":", "")
-            # Classification names for sure should not have leading or trailing spaces:
-            classification_name = classification_name.strip()
-            # Truncate the classification name to 254 characters which is the maximum
-            # allowed length in Content Server
-            if len(classification_name) > 254:
-                classification_name = classification_name[:254]
+            # Cleanse the classification name (allowed characters, maximum length):
+            classification_name = OTCS.cleanse_item_name(classification_name)
 
             # Check if classification has been created before (either in this run
             # or in a former run of the customizer):

pyxecm/customizer/translate.py

@@ -149,16 +149,20 @@ class Translator:
         request_header = self._headers
         request_url = self.config()["translateUrlV3"]
 
-        response = requests.post(
-            url=request_url,
-            headers=request_header,
-            json=data,
-            timeout=REQUEST_TIMEOUT,
-        )
-
-        if response.status_code != 200:
-            self.logger.error("Failed to translate text -> %s", response.content)
-            return None
+        try:
+            response = requests.post(
+                url=request_url,
+                headers=request_header,
+                json=data,
+                timeout=REQUEST_TIMEOUT,
+            )
+
+            if response.status_code != 200:
+                self.logger.error("Failed to translate text -> %s", response.content)
+                return None
+
+        except Exception as error:
+            self.logger.error("Failed translation request; error -> %s", str(error))
 
         translated_text = response.json()["data"]["translations"][0]["translatedText"]
 

pyxecm/helper/data.py

@@ -857,6 +857,10 @@ class Data:
                 columns = existing_columns
 
             # Attempt to save the data frame to Excel:
+            if self._df is None:
+                self.logger.error(
+                    "Cannot write Excel file -> '%s' from empty / non-initialized data frame!", excel_path
+                )
             self._df.to_excel(
                 excel_path,
                 sheet_name=sheet_name,
@@ -868,29 +872,17 @@ class Data:
                 excel_path,
             )
 
-        except FileNotFoundError:
-            self.logger.error(
-                "Cannot write data frame to Excel file -> '%s'",
-                excel_path,
-            )
+        except FileNotFoundError as fnf_error:
+            self.logger.error("Cannot write data frame to Excel file -> '%s'; error -> %s", excel_path, str(fnf_error))
             return False
-        except PermissionError:
-            self.logger.error(
-                "Cannot write data frame to Excel file -> '%s'",
-                excel_path,
-            )
+        except PermissionError as pe:
+            self.logger.error("Cannot write data frame to Excel file -> '%s'; error -> %s", excel_path, str(pe))
             return False
-        except ValueError:
-            self.logger.error(
-                "Cannot write data frame to Excel file -> '%s'",
-                excel_path,
-            )
+        except ValueError as ve:
+            self.logger.error("Cannot write data frame to Excel file -> '%s'; error -> %s", excel_path, str(ve))
             return False
-        except OSError:
-            self.logger.error(
-                "Cannot write data frame to Excel file -> '%s'",
-                excel_path,
-            )
+        except OSError as ose:
+            self.logger.error("Cannot write data frame to Excel file -> '%s'; error -> %s", excel_path, str(ose))
             return False
 
         return True

pyxecm/maintenance_page/app.py

@@ -1,6 +1,7 @@
 """Maintenance Page that can be enabled by the customizer."""
 
 import os
+import threading
 from datetime import datetime
 
 import uvicorn
@@ -47,5 +48,8 @@ async def http_exception_handler(request: Request, exc: HTTPException) -> Jinja2
 
 
 def run_maintenance_page() -> None:
-    """Start the FASTAPI Webserver."""
-    uvicorn.run(app, host=settings.host, port=settings.port)
+    """Start the FASTAPI Webserver in a dedicated thread."""
+    maint_thread = threading.Thread(
+        target=uvicorn.run, name="MaintenancePage", kwargs={"app": app, "host": settings.host, "port": settings.port}
+    )
+    maint_thread.start()