Merge branch '74-orchestrator-automatic-archiving-based-on-supann-resource-states' into 'dev'

Resolve "[Orchestrator] - Automatic Archiving Based on SupAnn Resource States"

See merge request !82

plugins/tasks/Archive.php

@@ -8,33 +8,33 @@ class Archive implements EndpointInterface
 
   public function __construct (TaskGateway $gateway)
   {
-    $this->gateway = $gateway;
+      $this->gateway = $gateway;
   }
 
-  /**
-   * @return array
-   * Part of the interface of orchestrator plugin to treat GET method
-   */
+    /**
+     * @return array
+     * Part of the interface of orchestrator plugin to treat GET method
+     */
   public function processEndPointGet (): array
   {
-    // Retrieve tasks of type 'archive'
-    return $this->gateway->getObjectTypeTask('archive');
+      // Retrieve tasks of type 'archive'
+      return $this->gateway->getObjectTypeTask('archive');
   }
 
-  /**
-   * @param array|null $data
-   * @return array
-   * @throws Exception
-   * Note: Part of the interface of orchestrator plugin to treat PATCH method
-   */
+    /**
+     * @param array|null $data
+     * @return array
+     * @throws Exception
+     * Note: Part of the interface of orchestrator plugin to treat PATCH method
+     */
   public function processEndPointPatch (array $data = NULL): array
   {
-    $result = [];
-    $archiveTasks = $this->gateway->getObjectTypeTask('archive');
+      $result = [];
+      $archiveTasks = $this->gateway->getObjectTypeTask('archive');
 
-    // Initialize the WebServiceCall object for login
-    $webServiceCall = new WebServiceCall($_ENV['FUSION_DIRECTORY_API_URL'] . '/login', 'POST');
-    $webServiceCall->setCurlSettings(); // Perform login and set the token
+      // Initialize the WebServiceCall object for login
+      $webServiceCall = new WebServiceCall($_ENV['FUSION_DIRECTORY_API_URL'] . '/login', 'POST');
+      $webServiceCall->setCurlSettings(); // Perform login and set the token
 
     foreach ($archiveTasks as $task) {
       try {
@@ -43,95 +43,143 @@ class Archive implements EndpointInterface
             continue;
         }
 
-          // Receive null or 'toBeArchived'
-          $supannState = $this->getUserSupannAccountStatus($task['fdtasksgranulardn'][0]);
+        // Retrieve the desired supann status from the main task
+        $desiredSupannStatus = $this->getArchiveTaskBehaviorFromMainTask($task['fdtasksgranularmaster'][0]);
 
-        if ($supannState !== 'toBeArchived') {
+        // Retrieve the current supann status of the user
+        $currentSupannStatus = $this->getUserSupannAccountStatus($task['fdtasksgranulardn'][0]);
+
+        // Check if the current supann status matches the desired status
+        if (!$this->isSupannStatusMatching($desiredSupannStatus, $currentSupannStatus)) {
             // The task does not meet the criteria for archiving and can therefore be suppressed
             $result[$task['dn']]['result'] = "User does not meet the criteria for archiving.";
             $this->gateway->removeSubTask($task['dn']);
             continue;
         }
 
-          // Set the archive endpoint and method using the same WebServiceCall object
-          $archiveUrl = $_ENV['FUSION_DIRECTORY_API_URL'] . '/archive/user/' . rawurlencode($task['fdtasksgranulardn'][0]);
-          $webServiceCall->setCurlSettings($archiveUrl, NULL, 'POST'); // Update settings for the archive request
-          $response = $webServiceCall->execute();
+        // Set the archive endpoint and method using the same WebServiceCall object
+        $archiveUrl = $_ENV['FUSION_DIRECTORY_API_URL'] . '/archive/user/' . rawurlencode($task['fdtasksgranulardn'][0]);
+        $webServiceCall->setCurlSettings($archiveUrl, NULL, 'POST'); // Update settings for the archive request
+        $response = $webServiceCall->execute();
 
-          // Check if the HTTP status code is 204
+        // Check if the HTTP status code is 204
         if ($webServiceCall->getHttpStatusCode() === 204) {
-            $result[$task['dn']]['result'] = "User successfully archived.";
+            $result[$task['dn']]['result'] = "User " . $task['fdtasksgranulardn'][0] . " successfully archived.";
             $this->gateway->updateTaskStatus($task['dn'], $task['cn'][0], '2');
         } else {
             throw new Exception("Unexpected HTTP status code: " . $webServiceCall->getHttpStatusCode());
         }
       } catch (Exception $e) {
-          $result[$task['dn']]['result'] = "Error archiving user: " . $e->getMessage();
-          $this->gateway->updateTaskStatus($task['dn'], $task['cn'][0], $e->getMessage());
+            $result[$task['dn']]['result'] = "Error archiving user: " . $e->getMessage();
+            $this->gateway->updateTaskStatus($task['dn'], $task['cn'][0], $e->getMessage());
       }
     }
 
-    return $result;
+      return $result;
   }
 
-  /**
-   * @param array|null $data
-   * @return array
-   * Note: Part of the interface of orchestrator plugin to treat POST method
-   */
+    /**
+     * @param array|null $data
+     * @return array
+     * Note: Part of the interface of orchestrator plugin to treat POST method
+     */
   public function processEndPointPost (array $data = NULL): array
   {
-    return [];
+      return [];
   }
 
-  /**
-   * @param array|null $data
-   * @return array
-   * Note: Part of the interface of orchestrator plugin to treat DELETE method
-   */
+    /**
+     * @param array|null $data
+     * @return array
+     * Note: Part of the interface of orchestrator plugin to treat DELETE method
+     */
   public function processEndPointDelete (array $data = NULL): array
   {
-    return [];
+      return [];
   }
 
-  /**
-   * Retrieve the supannAccountStatus of a user
-   * @param string $userDn
-   * @return string|null
-   */
-  private function getUserSupannAccountStatus (string $userDn): ?string
+    /**
+     * Retrieve the supannAccountStatus of a user
+     * @param string $userDn
+     * @return array
+     */
+  private function getUserSupannAccountStatus (string $userDn): array
   {
-      $supannState = $this->gateway->getLdapTasks(
+      return $this->gateway->getLdapTasks(
           '(objectClass=supannPerson)',
           ['supannRessourceEtatDate'],
           '',
           $userDn
       );
+  }
 
-    if ($this->hasToBeArchived($supannState)) {
-        return 'toBeArchived';
-    }
-
-      return NULL;
+    /**
+     * @param string $taskDN
+     * @return array
+     * Note: Retrieve the desired supann status from the main task attributes.
+     */
+  private function getArchiveTaskBehaviorFromMainTask (string $taskDN): array
+  {
+      return $this->gateway->getLdapTasks(
+          '(objectClass=*)',
+          ['fdArchiveTaskResource', 'fdArchiveTaskState', 'fdArchiveTaskSubState'],
+          '',
+          $taskDN
+      );
   }
 
-  private function hasToBeArchived (array $supannState): bool
+    /**
+     * @param array $desiredStatus
+     * @param array $currentStatus
+     * @return bool
+     * Note: Compare the desired supann status with the current status to determine if they match.
+     */
+  private function isSupannStatusMatching (array $desiredStatus, array $currentStatus): bool
   {
-    if (!isset($supannState[0]['supannressourceetatdate']) || !is_array($supannState[0]['supannressourceetatdate'])) {
+    if (empty($currentStatus[0]['supannressourceetatdate'])) {
         return FALSE;
     }
 
-    foreach ($supannState[0]['supannressourceetatdate'] as $key => $value) {
-        // Skip non-numeric keys (e.g., 'count')
+      // Extract the desired attributes
+      $desiredAttributes = $this->extractDesiredAttributes($desiredStatus);
+
+    if (!$desiredAttributes['resource'] || !$desiredAttributes['state']) {
+        return FALSE;
+    }
+
+      // Check if any of the current supannressourceetatdate values match the desired attributes
+    foreach ($currentStatus[0]['supannressourceetatdate'] as $key => $resource) {
       if (!is_numeric($key)) {
           continue;
       }
 
-      if (strpos($value, '{COMPTE}I:toBeArchived') !== FALSE) {
+      if ($this->doesResourceMatch($resource, $desiredAttributes)) {
           return TRUE;
       }
     }
 
       return FALSE;
   }
+
+  private function extractDesiredAttributes (array $desiredStatus): array
+  {
+      return [
+          'resource' => $desiredStatus[0]['fdarchivetaskresource'][0] ?? NULL,
+          'state'    => $desiredStatus[0]['fdarchivetaskstate'][0] ?? NULL,
+          'substate' => $desiredStatus[0]['fdarchivetasksubstate'][0] ?? NULL,
+      ];
+  }
+
+  private function doesResourceMatch (string $resource, array $desiredAttributes): bool
+  {
+      // Extract parts from the resource string
+      $parts = explode(':', $resource);
+      $resourcePart = str_replace(['{', '}'], '', $parts[0]);
+      $substatePart = $parts[1] ?? '';
+
+      $resourceMatch = $resourcePart === $desiredAttributes['resource'] . $desiredAttributes['state'];
+      $substateMatch = empty($desiredAttributes['substate']) || $substatePart === $desiredAttributes['substate'];
+
+      return $resourceMatch && $substateMatch;
+  }
 }
\ No newline at end of file