Add audit log

Author: jekuaitk

composer.json

@@ -19,10 +19,10 @@
     ],
     "require": {
         "itk-dev/getorganized-api-client-php": "^1.2",
-        "drupal/webform": "^6.1",
-        "drupal/advancedqueue": "^1.0",
-        "symfony/options-resolver": "^5.4",
-        "os2forms/os2forms": "^3.13"
+        "drupal/webform": "^6.2",
+        "drupal/advancedqueue": "^1.2",
+        "symfony/options-resolver": "^5.4 || ^6.0",
+        "os2forms/os2forms": "^3.17"
     },
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0",

os2forms_get_organized.info.yml

@@ -8,4 +8,5 @@ dependencies:
   - drupal:advancedqueue
   - drupal:webform_entity_print_attachment
   - os2forms:os2forms_attachment
+  - os2web:os2web_audit
 configure: os2forms_get_organized.admin.settings

os2forms_get_organized.services.yml

@@ -8,3 +8,4 @@ services:
       - '@entity_type.manager'
       - '@event_dispatcher'
       - '@Drupal\os2forms_get_organized\Helper\Settings'
+      - '@os2web_audit.logger'

src/Helper/ArchiveHelper.php

@@ -9,6 +9,7 @@
 use Drupal\os2forms_get_organized\Exception\ArchivingMethodException;
 use Drupal\os2forms_get_organized\Exception\CitizenArchivingException;
 use Drupal\os2forms_get_organized\Exception\GetOrganizedCaseIdException;
+use Drupal\os2web_audit\Service\Logger;
 use Drupal\webform\Entity\WebformSubmission;
 use Drupal\webform_attachment\Element\WebformAttachmentBase;
 use ItkDev\GetOrganized\Client;
@@ -44,27 +45,6 @@ class ArchiveHelper {
    */
   private ?Cases $caseService = NULL;
 
-  /**
-   * The EntityTypeManagerInterface.
-   *
-   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
-   */
-  private EntityTypeManagerInterface $entityTypeManager;
-
-  /**
-   * The EventDispatcherInterface.
-   *
-   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
-   */
-  private EventDispatcherInterface $eventDispatcher;
-
-  /**
-   * The settings.
-   *
-   * @var \Drupal\os2forms_get_organized\Helper\Settings
-   */
-  private Settings $settings;
-
   /**
    * File element types.
    */
@@ -79,10 +59,12 @@ class ArchiveHelper {
   /**
    * Constructs an ArchiveHelper object.
    */
-  public function __construct(EntityTypeManagerInterface $entityTypeManager, EventDispatcherInterface $eventDispatcher, Settings $settings) {
-    $this->entityTypeManager = $entityTypeManager;
-    $this->eventDispatcher = $eventDispatcher;
-    $this->settings = $settings;
+  public function __construct(
+    private readonly EntityTypeManagerInterface $entityTypeManager,
+    private readonly EventDispatcherInterface $eventDispatcher,
+    private readonly Settings $settings,
+    private readonly Logger $auditLogger,
+  ) {
   }
 
   /**
@@ -303,9 +285,15 @@ private function createCitizenCase(string $cprElementValue, string $cprNameEleme
     if (empty($response)) {
       throw new CitizenArchivingException('Could not create citizen case');
     }
+
     // Example response.
     // {"CaseID":"BOR-2022-000046","CaseRelativeUrl":"\/cases\/BOR12\/BOR-2022-000046",...}.
-    return $response['CaseID'];
+    $caseId = $response['CaseID'];
+
+    $msg = sprintf('Created GetOrganized case %s', $caseId);
+    $this->auditLogger->info('GetOrganized', $msg);
+
+    return $caseId;
   }
 
   /**
@@ -325,7 +313,12 @@ private function createSubCase(string $caseId, string $caseName): string {
 
     // Example response.
     // {"CaseID":"BOR-2022-000046-001","CaseRelativeUrl":"\/cases\/BOR12\/BOR-2022-000046",...}.
-    return $response['CaseID'];
+    $caseId = $response['CaseID'];
+
+    $msg = sprintf('Created GetOrganized case %s', $caseId);
+    $this->auditLogger->info('GetOrganized', $msg);
+
+    return $caseId;
   }
 
   /**
@@ -382,11 +375,19 @@ private function uploadDocumentToCase(string $caseId, string $webformAttachmentE
 
       $documentIdsForFinalizing = array_merge($documentIdsForFinalizing, $childDocumentIds);
 
-      $this->documentService->RelateDocuments($parentDocumentId, $childDocumentIds, 1);
+      if (!empty($childDocumentIds)) {
+        $this->documentService->RelateDocuments($parentDocumentId, $childDocumentIds, 1);
+
+        $msg = sprintf('Added relation between document %s and documents %s', $parentDocumentId, implode(', ', $childDocumentIds));
+        $this->auditLogger->info('GetOrganized', $msg);
+      }
     }
 
     if ($shouldBeFinalized) {
       $this->documentService->FinalizeMultiple($documentIdsForFinalizing);
+
+      $msg = sprintf('Finalized documents %s', implode(', ', $documentIdsForFinalizing));
+      $this->auditLogger->info('GetOrganized', $msg);
     }
   }
 
@@ -427,6 +428,9 @@ private function archiveDocumentToGetOrganizedCase(string $caseId, string $getOr
       unlink($tempFile);
     }
 
+    $msg = sprintf('Archived document %s to GetOrganized case %s', $getOrganizedFileName, $caseId);
+    $this->auditLogger->info('GetOrganized', $msg);
+
     return (int) $documentId;
   }