From 164739c09897f20c213173f91acc7e614f2fc81d Mon Sep 17 00:00:00 2001
From: Thibault Dockx <thibault.dockx@fusiondirectory.org>
Date: Mon, 24 Mar 2025 15:21:23 +0000
Subject: [PATCH] :sparkles: feat(archive) - implement Archive endpoint with
GET, PATCH, POST, and DELETE methods
---
plugins/tasks/Archive.php | 98 +++++++++++++++++++++++++++++++++++++++
1 file changed, 98 insertions(+)
create mode 100644 plugins/tasks/Archive.php
diff --git a/plugins/tasks/Archive.php b/plugins/tasks/Archive.php
new file mode 100644
index 0000000..e7838f8
--- /dev/null
+++ b/plugins/tasks/Archive.php
@@ -0,0 +1,98 @@
+<?php
+
+class Archive implements EndpointInterface
+{
+ private TaskGateway $gateway;
+
+ public function __construct(TaskGateway $gateway)
+ {
+ $this->gateway = $gateway;
+ }
+
+ /**
+ * @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');
+ }
+
+ /**
+ * @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');
+
+ // Initialize the webservice object
+ // TODO
+ $webservice = new FusionDirectory\Rest\WebServiceCall($_ENV['FUSION_DIRECTORY_API_URL'] . '/archive', 'POST');
+ $webservice->setCurlSettings();
+
+ foreach ($archiveTasks as $task) {
+ // Verify the task status and schedule
+ if ($this->gateway->statusAndScheduleCheck($task)) {
+ // Retrieve the user's supannAccountStatus
+ $userStatus = $this->getUserSupannAccountStatus($task['fdtasksgranulardn'][0]);
+
+ // Check if the user meets the "toBeArchived" condition
+ // TODO
+ if ($userStatus === 'toBeArchived') {
+ // Trigger the archive method via the webservice
+ $archiveResult = $webservice->triggerArchive($task['fdtasksgranulardn'][0]);
+
+ // Update the task status based on the result
+ if ($archiveResult === TRUE) {
+ $result[$task['dn']]['result'] = "User successfully archived.";
+ $this->gateway->updateTaskStatus($task['dn'], $task['cn'][0], '2'); // Mark task as completed
+ } else {
+ $result[$task['dn']]['result'] = "Error archiving user.";
+ $this->gateway->updateTaskStatus($task['dn'], $task['cn'][0], '3'); // Mark task as failed
+ }
+ } else {
+ $result[$task['dn']]['result'] = "User does not meet the criteria for archiving.";
+ }
+ }
+ }
+
+ return $result;
+ }
+
+ /**
+ * @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 [];
+ }
+
+ /**
+ * @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 [];
+ }
+
+ /**
+ * Retrieve the supannAccountStatus of a user
+ * @param string $userDn
+ * @return string|null
+ */
+ private function getUserSupannAccountStatus(string $userDn): ?string
+ {
+ // Logic to retrieve the supannAccountStatus attribute of the user
+ $user = $this->gateway->getLdapEntry($userDn, ['supannAccountStatus']);
+ return $user['supannAccountStatus'][0] ?? NULL;
+ }
+}
\ No newline at end of file
--
GitLab