Webservice: Add rest get_audit_items - refs BT#21206

Author: christianbeeznest

main/inc/lib/events.lib.php

@@ -2818,4 +2818,71 @@ public static function logUserSubscribedInCourseSession(int $subscribedId, int $
             $sessionId
         );
     }
+
+    /**
+     * Retrieves audit items from the track_e_default table.
+     *
+     * This function fetches audit data based on various optional criteria and
+     * formats the result to remove the "default_" prefix from each field.
+     *
+     */
+    public static function getAuditItems(
+        string $defaultEventType,
+        ?int $cId = null,
+        ?int $sessionId = null,
+        ?string $afterDate = null,
+        ?string $beforeDate = null,
+        ?int $userId = null,
+        int $offset = 0,
+        int $limit = 100
+    ): array
+    {
+        $tblTrackEDefault = Database::get_main_table(TABLE_STATISTIC_TRACK_E_DEFAULT);
+
+        $whereConditions = ['default_event_type = ? ' => $defaultEventType];
+
+        if ($cId !== null) {
+            $whereConditions[' AND c_id = ? '] = $cId;
+        }
+        if ($sessionId !== null) {
+            $whereConditions[' AND session_id = ? '] = $sessionId;
+        }
+        if ($afterDate !== null) {
+            $whereConditions[' AND default_date >= ? '] = $afterDate;
+        }
+        if ($beforeDate !== null) {
+            $whereConditions[' AND default_date <= ? '] = $beforeDate;
+        }
+        if ($userId !== null) {
+            $whereConditions[' AND default_user_id = ? '] = $userId;
+        }
+
+        $conditions = [
+            'where' => $whereConditions,
+            'order' => 'default_date DESC',
+            'limit' => "$offset, $limit",
+        ];
+
+        $results = Database::select(
+            'default_user_id, c_id, default_date, default_event_type, default_value_type, default_value, session_id',
+            $tblTrackEDefault,
+            $conditions,
+            'all',
+            'ASSOC',
+            true
+        );
+
+        $formattedResults = [];
+        foreach ($results as $result) {
+            $formattedResult = [];
+            foreach ($result as $key => $value) {
+                $newKey = str_replace('default_', '', $key);
+                $formattedResult[$newKey] = $value;
+            }
+            $formattedResults[] = $formattedResult;
+        }
+
+        return $formattedResults;
+    }
+
 }

main/inc/lib/webservices/Rest.php

@@ -149,6 +149,7 @@ class Rest extends WebService
     public const DELETE_GROUP_SUB_USER = 'delete_group_sub_user';
     public const DELETE_GROUP_SUB_COURSE = 'delete_group_sub_course';
     public const DELETE_GROUP_SUB_SESSION = 'delete_group_sub_session';
+    public const GET_AUDIT_ITEMS = 'get_audit_items';
 
     /**
      * @var Session
@@ -4209,4 +4210,33 @@ private function generateUrl(array $additionalParams = []): string
         return api_get_self().'?'
             .http_build_query(array_merge($queryParams, $additionalParams));
     }
+
+    /**
+     * Get audit items from track_e_default.
+     */
+    public function getAuditItems(
+        string $defaultEventType,
+        ?int $cId = null,
+        ?int $sessionId = null,
+        ?string $afterDate = null,
+        ?string $beforeDate = null,
+        ?int $userId = null,
+        int $offset = 0,
+        int $limit = 100
+    ): array {
+        self::protectAdminEndpoint();
+
+        $auditItems = Event::getAuditItems(
+            $defaultEventType,
+            $cId,
+            $sessionId,
+            $afterDate,
+            $beforeDate,
+            $userId,
+            $offset,
+            $limit
+        );
+
+        return $auditItems;
+    }
 }

main/webservices/api/v2.php

@@ -963,6 +963,26 @@
             Event::addEvent(LOG_WS.$action, 'group_id', $groupId);
             $restResponse->setData($data);
             break;
+        case Rest::GET_AUDIT_ITEMS:
+            $defaultEventType = $httpRequest->request->get('default_event_type');
+
+            $cId = $httpRequest->request->has('c_id') ? $httpRequest->request->getInt('c_id') : null;
+            $sessionId = $httpRequest->request->has('session_id') ? $httpRequest->request->getInt('session_id') : null;
+            $userId = $httpRequest->request->has('user_id') ? $httpRequest->request->getInt('user_id') : null;
+
+            $afterDate = $httpRequest->request->get('after_date');
+            $beforeDate = $httpRequest->request->get('before_date');
+            $offset = $httpRequest->request->getInt('offset', 0);
+            $limit = $httpRequest->request->getInt('limit', 100);
+
+            if (empty($defaultEventType)) {
+                throw new Exception('default_event_type is required');
+            }
+
+            $data = $restApi->getAuditItems($defaultEventType, $cId, $sessionId, $afterDate, $beforeDate, $userId, $offset, $limit);
+            Event::addEvent(LOG_WS.$action, 'success', 'true');
+            $restResponse->setData($data);
+            break;
         default:
             throw new Exception(get_lang('InvalidAction'));
     }