sapiopycommons 2024.8.2a301__py3-none-any.whl → 2024.8.15a304__py3-none-any.whl

sapiopycommons/general/audit_log.py

@@ -1,200 +0,0 @@
-from enum import Enum
-from typing import Any
-
-from sapiopylib.rest.DataRecordManagerService import DataRecordManager
-from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.pojo.CustomReport import ReportColumn, RawReportTerm, CustomReportCriteria, RawTermOperation, \
-    CompositeReportTerm, CompositeTermOperation
-from sapiopylib.rest.pojo.datatype.FieldDefinition import FieldType
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
-
-from sapiopycommons.src.sapiopycommons.general.aliases import RecordIdentifier, AliasUtil
-from sapiopycommons.src.sapiopycommons.general.custom_report_util import CustomReportUtil
-
-EVENTTYPE_COLUMN = "EVENTTYPE"
-TIMESTAMP_COLUMN = "TIMESTAMP"
-DATATYPENAME_COLUMN = "DATATYPENAME"
-RECORDID_COLUMN = "RECORDID"
-DESCRIPTION_COLUMN = "DESCRIPTION"
-USERNAME_COLUMN = "USERNAME"
-USERCOMMENT_COLUMN = "USERCOMMENT"
-RECORDNAME_COLUMN = "RECORDNAME"
-DATAFIELDNAME_COLUMN = "DATAFIELDNAME"
-ORIGINALVALUE_COLUMN = "ORIGINALVALUE"
-NEWVALUE_COLUMN = "NEWVALUE"
-
-
-class EventType(Enum):
-    """An enum to represent the possible event type values with the event type column in the audit log table."""
-    ADD = 0
-    DELETE = 1
-    MODIFY = 2
-    INFO = 3
-    ERROR = 4
-    WARNING = 5
-    IMPORT = 6
-    GENERATE = 7
-    EXPORT = 8
-    ADDREF = 9
-    REMOVEREF = 10
-    ESIGNATURE = 11
-    ROLEASSIGNMENT = 12
-
-
-class AuditLogEntry:
-
-    __event_type: EventType
-    __date: int
-    __data_type_name: str
-    __record_id: int
-    __description: str
-    __users_login_name: str
-    __comment: str
-    __data_record_name: str
-    __data_field_name: str
-    __original_value: str
-    __new_value: str
-
-    @property
-    def event_type(self) -> EventType:
-        return self.__event_type
-
-    @property
-    def date(self) -> int:
-        return self.__date
-
-    @property
-    def data_type_name(self) -> str:
-        return self.__data_type_name
-
-    @property
-    def record_id(self) -> int:
-        return self.__record_id
-
-    @property
-    def description(self) -> str:
-        return self.__description
-
-    @property
-    def users_login_name(self) -> str:
-        return self.__users_login_name
-
-    @property
-    def comment(self) -> str:
-        return self.__comment
-
-    @property
-    def data_record_name(self) -> str:
-        return self.__data_record_name
-
-    @property
-    def data_field_name(self) -> str:
-        return self.__data_field_name
-
-    @property
-    def original_value(self) -> str:
-        return self.__original_value
-
-    @property
-    def new_value(self) -> str:
-        return self.__new_value
-
-    def __init__(self, report_row: dict[str, Any]):
-        self.__event_type = EventType((report_row[EVENTTYPE_COLUMN]))
-        self.__date = report_row[TIMESTAMP_COLUMN]
-        self.__data_type_name = report_row[DATATYPENAME_COLUMN]
-        self.__record_id = report_row[RECORDID_COLUMN]
-        self.__description = report_row[DESCRIPTION_COLUMN]
-        self.__users_login_name = report_row[USERNAME_COLUMN]
-        self.__comment = report_row[USERCOMMENT_COLUMN]
-        self.__data_record_name = report_row[RECORDNAME_COLUMN]
-        self.__data_field_name = report_row[DATAFIELDNAME_COLUMN]
-        self.__original_value = report_row[ORIGINALVALUE_COLUMN]
-        self.__new_value = report_row[NEWVALUE_COLUMN]
-
-
-class AuditLog:
-    AUDIT_LOG_PSEUDO_DATATYPE: str = "AUDITLOG"
-    EVENT_TYPE: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, EVENTTYPE_COLUMN, FieldType.ENUM)
-    DATE: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, TIMESTAMP_COLUMN, FieldType.DATE)
-    DATA_TYPE_NAME: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, DATATYPENAME_COLUMN, FieldType.STRING)
-    RECORD_ID: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, RECORDID_COLUMN, FieldType.LONG)
-    DESCRIPTION: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, DESCRIPTION_COLUMN, FieldType.STRING)
-    USERS_LOGIN_NAME: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, USERNAME_COLUMN, FieldType.STRING)
-    COMMENT: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, USERCOMMENT_COLUMN, FieldType.STRING)
-    DATA_RECORD_NAME: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, RECORDNAME_COLUMN, FieldType.STRING)
-    DATA_FIELD_NAME: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, DATAFIELDNAME_COLUMN, FieldType.STRING)
-    ORIGINAL_VALUE: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, ORIGINALVALUE_COLUMN, FieldType.STRING)
-    NEW_VALUE: ReportColumn = ReportColumn(AUDIT_LOG_PSEUDO_DATATYPE, NEWVALUE_COLUMN, FieldType.STRING)
-
-    AUDIT_LOG_COLUMNS = [EVENT_TYPE, DATE, DATA_TYPE_NAME, RECORD_ID, DESCRIPTION, USERS_LOGIN_NAME, COMMENT,
-                         DATA_RECORD_NAME, DATA_FIELD_NAME, ORIGINAL_VALUE, NEW_VALUE]
-    user: SapioUser
-
-    def __init__(self, context: SapioWebhookContext | SapioUser):
-        self.user = context if isinstance(context, SapioUser) else context.user
-
-    @staticmethod
-    def create_data_record_audit_log_report(records: list[RecordIdentifier], fields: list[str] | None = None) -> CustomReportCriteria:
-        """
-        This method creates a CustomReportCriteria object for running an audit log query based on data records.
-
-        Creates a CustomReportCriteria object with a query term based on the record ids/records passed into the method.
-        Optionally, the fields parameter can be populated to limit the search to particular fields. If the fields
-        parameter is not populated, the search will include results for all field changes.
-
-        :param records: The DataRecords, RecordModels, or record ids to base the search on.
-        :param fields: The data field names to include changes for.
-        :return: The constructed CustomReportCriteria object, which can be used to run a report on the audit log.
-        """
-        # We need to compile the record ids from these record identifiers as "str" variables, so they can be
-        # concatenated.
-        record_ids = AliasUtil.to_record_ids(records)
-        id_strs = [str(id_int) for id_int in record_ids]
-
-        # Next we'll build the raw report term querying for any entry with a matching record id value to the record ID's
-        # passed in
-        root_term = RawReportTerm(AuditLog.AUDIT_LOG_PSEUDO_DATATYPE, RECORDID_COLUMN,
-                                  RawTermOperation.EQUAL_TO_OPERATOR, "{" + ",".join(id_strs) + "}")
-
-        # If the user passed in any specific fields, then we should limit the query to those fields.
-        if fields:
-            field_term = RawReportTerm(AuditLog.AUDIT_LOG_PSEUDO_DATATYPE, DATAFIELDNAME_COLUMN,
-                                       RawTermOperation.EQUAL_TO_OPERATOR, "{" + ",".join(fields) + "}")
-            root_term = CompositeReportTerm(root_term, CompositeTermOperation.AND_OPERATOR, field_term)
-
-        return CustomReportCriteria(AuditLog.AUDIT_LOG_COLUMNS, root_term)
-
-    def run_data_record_audit_log_report(self, records: list[RecordIdentifier], fields: list[str] | None = None) -> dict[RecordIdentifier, list[AuditLogEntry]]:
-        """
-        This method runs a custom report for changes made to the given data records using the audit log.
-        See "create_data_record_audit_log_report" for more details about the data record audit log report.
-
-        :param records: The DataRecords, RecordModels, or record ids to base the search on.
-        :param fields: The data field names to include changes for.
-        :return: A dictionary where the keys are the record identifiers passed in, and the values are a list of
-            AuditLogEntry objects which match the record id value of those records.
-        """
-        # First, we must build our report criteria for running the Custom Report.
-        criteria = AuditLog.create_data_record_audit_log_report(records, fields)
-
-        # Then we must run the custom report using that criteria.
-        raw_report_data: list[dict[str, Any]] = CustomReportUtil.run_custom_report(self.user, criteria)
-
-        # This section will prepare a map matching the original RecordIdentifier by record id.
-        # This is because the audit log entries will have record ids, but we want the keys in our result map
-        # to match the record identifiers that the user passed in, for convenience.
-        record_identifier_mapping: dict[int, RecordIdentifier] = dict()
-        for record in records:
-            record_id = AliasUtil.to_record_id(record)
-            record_identifier_mapping[record_id] = record
-
-        # Finally, we compile our audit data into a map where the keys are the record identifiers passed in,
-        # and the value is a list of applicable audit log entries.
-        final_audit_data: dict[RecordIdentifier, list[AuditLogEntry]] = dict()
-        for audit_entry_data in raw_report_data:
-            audit_entry: AuditLogEntry = AuditLogEntry(audit_entry_data)
-            identifier: RecordIdentifier = record_identifier_mapping.get(audit_entry.record_id)
-            final_audit_data.setdefault(identifier, []).append(audit_entry)
-
-        return final_audit_data

sapiopycommons/general/sapio_links.py

@@ -1,48 +0,0 @@
-from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.pojo.webhook.WebhookContext import SapioWebhookContext
-
-from sapiopycommons.general.aliases import RecordIdentifier, ExperimentIdentifier, AliasUtil
-from sapiopycommons.general.exceptions import SapioException
-
-
-class SapioNavigationLinker:
-    """
-    Given a URL to a system's webservice API (example: https://company.exemplareln.com/webservice/api), construct
-    URLs for navigation links to various locations in the system.
-    """
-    base_url: str
-
-    def __init__(self, url: str | SapioUser | SapioWebhookContext):
-        """
-        :param url: A user or context object that is being used to send requests to a Sapio system, or a URL to a
-            system's webservice API.
-        """
-        if isinstance(url, SapioWebhookContext):
-            url = url.user.url
-        elif isinstance(url, SapioUser):
-            url = url.url
-        self.base_url = url.rstrip("/").replace('webservice/api', 'veloxClient')
-
-    def data_record(self, record_identifier: RecordIdentifier, data_type_name: str | None = None) -> str:
-        """
-        :param record_identifier: An object that can be used to identify a record in the system, be that a record ID,
-            a data record, or a record model.
-        :param data_type_name: If the provided record identifier is a record ID, then the data type name of the record
-            must be provided in this parameter. Otherwise, this parameter is ignored.
-        :return: A URL for navigating to the input record.
-        """
-        record_id: int = AliasUtil.to_record_id(record_identifier)
-        if not isinstance(record_identifier, int):
-            data_type_name = AliasUtil.to_data_type_name(record_identifier)
-        if not data_type_name:
-            raise SapioException("Unable to create a data record link without a data type name. "
-                                 "Only a record ID was provided.")
-        return self.base_url + f"/#dataType={data_type_name};recordId={record_id};view=dataRecord"
-
-    def experiment(self, experiment: ExperimentIdentifier) -> str:
-        """
-        :param experiment: An object that can be used to identify an experiment in the system, be that an experiment
-            object, experiment protocol, or a notebook ID.
-        :return: A URL for navigating to the input experiment.
-        """
-        return self.base_url + f"/#notebookExperimentId={AliasUtil.to_notebook_id(experiment)};view=eln"