ILIAS 10: Add Unique Certificate ID for Certificate Editor

components/ILIAS/Certificate/Overview/CertificateOverviewTable.php

@@ -0,0 +1,262 @@
+<?php
+
+/**
+ * This file is part of ILIAS, a powerful learning management system
+ * published by ILIAS open source e-Learning e.V.
+ *
+ * ILIAS is licensed with the GPL-3.0,
+ * see https://www.gnu.org/licenses/gpl-3.0.en.html
+ * You should have received a copy of said license along with the
+ * source code, too.
+ *
+ * If this is not the case or you just want to try ILIAS, you'll find
+ * us at:
+ * https://www.ilias.de
+ * https://github.com/ILIAS-eLearning
+ *
+ *********************************************************************/
+
+declare(strict_types=1);
+
+namespace ILIAS\Certificate\Overview;
+
+use DateTime;
+use DateTimeImmutable;
+use Exception;
+use Generator;
+use ilAccessHandler;
+use ilCtrl;
+use ilCtrlInterface;
+use ILIAS\Data\Order;
+use ILIAS\Data\Range;
+use ILIAS\UI\Component\Table\Data;
+use ILIAS\UI\Component\Table\DataRetrieval;
+use ILIAS\UI\Component\Table\DataRowBuilder;
+use ILIAS\UI\Factory;
+use ILIAS\UI\Implementation\Component\Input\Container\Filter\Standard;
+use ILIAS\UI\Renderer;
+use ILIAS\UI\URLBuilder;
+use ILIAS\UI\URLBuilderToken;
+use ilLanguage;
+use ilLink;
+use ilObjCertificateSettingsGUI;
+use ilObject;
+use ilObjUser;
+use ilUIService;
+use ilUserCertificate;
+use ilUserCertificateRepository;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+class CertificateOverviewTable implements DataRetrieval
+{
+    private ilUserCertificateRepository $repo;
+    private ilUIService $ui_service;
+    private Factory $ui_factory;
+    private ilLanguage $lng;
+    private ServerRequestInterface|RequestInterface $request;
+    private \ILIAS\Data\Factory $data_factory;
+    private ilCtrl|ilCtrlInterface $ctrl;
+    private Standard $filter;
+    private Data $table;
+    private Renderer $ui_renderer;
+    private ilAccessHandler $access;
+    private ilObjUser $user;
+
+    public function __construct(
+        ?Factory $ui_factory = null,
+        ?ilUserCertificateRepository $repo = null,
+        ?ilUIService $ui_service = null,
+        ?ilLanguage $lng = null,
+        ServerRequestInterface|RequestInterface|null $request = null,
+        ?\ILIAS\Data\Factory $data_factory = null,
+        ?ilCtrl $ctrl = null,
+        ?Renderer $ui_renderer = null,
+        ?ilAccessHandler $access = null,
+        ?ilObjUser $user = null
+    ) {
+        global $DIC;
+        $this->ui_factory = $ui_factory ?: $DIC->ui()->factory();
+        $this->repo = $repo ?: new ilUserCertificateRepository();
+        $this->ui_service = $ui_service ?: $DIC->uiService();
+        $this->lng = $lng ?: $DIC->language();
+        $this->request = $request ?: $DIC->http()->request();
+        $this->data_factory = $data_factory ?: new \ILIAS\Data\Factory();
+        $this->ctrl = $ctrl ?: $DIC->ctrl();
+        $this->ui_renderer = $ui_renderer ?: $DIC->ui()->renderer();
+        $this->access = $access ?: $DIC->access();
+        $this->user = $user ?: $DIC->user();
+
+        $this->filter = $this->buildFilter();
+        $this->table = $this->buildTable();
+    }
+
+    public function getRows(
+        DataRowBuilder $row_builder,
+        array $visible_column_ids,
+        Range $range,
+        Order $order,
+        ?array $filter_data,
+        ?array $additional_parameters
+    ): Generator {
+        /**
+         * @var array{certificate_id: null|string, issue_date: null|DateTime, object: null|string, owner: null|string} $filter_data
+         */
+        $filter_data = $this->ui_service->filter()->getData($this->filter);
+        [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
+
+        if (isset($filter_data['issue_date']) && $filter_data['issue_date'] !== '') {
+            try {
+                $filter_data['issue_date'] = new DateTime($filter_data['issue_date']);
+            } catch (Exception $e) {
+                $filter_data['issue_date'] = null;
+            }
+        } else {
+            $filter_data['issue_date'] = null;
+        }
+
+        $table_rows = $this->buildTableRows($this->repo->fetchCertificatesForOverview($this->user->getLanguage(), $filter_data, $range));
+        $colum_to_order = array_column($table_rows, $order_field);
+        array_multisort($colum_to_order, $order_direction === 'ASC' ? SORT_ASC : SORT_DESC, $table_rows);
+
+        foreach ($table_rows as $row) {
+            $row['issue_date'] = DateTimeImmutable::createFromMutable((new DateTime())->setTimestamp($row['issue_date']));
+            yield $row_builder->buildDataRow((string) $row['id'], $row);
+        }
+    }
+
+    public function getTotalRowCount(?array $filter_data, ?array $additional_parameters): ?int
+    {
+        /**
+         * @var array{certificate_id: null|string, issue_date: null|DateTime, object: null|string, owner: null|string} $filter_data
+         */
+        $filter_data = $this->ui_service->filter()->getData($this->filter);
+
+        if (isset($filter_data['issue_date']) && $filter_data['issue_date'] !== '') {
+            try {
+                $filter_data['issue_date'] = new DateTime($filter_data['issue_date']);
+            } catch (Exception $e) {
+                $filter_data['issue_date'] = null;
+            }
+        } else {
+            $filter_data['issue_date'] = null;
+        }
+
+        return $this->repo->fetchCertificatesForOverviewCount($filter_data);
+    }
+
+
+    private function buildFilter(): Standard
+    {
+        return $this->ui_service->filter()->standard(
+            'certificates_overview_filter',
+            $this->ctrl->getLinkTargetByClass(
+                ilObjCertificateSettingsGUI::class,
+                ilObjCertificateSettingsGUI::CMD_CERTIFICATES_OVERVIEW
+            ),
+            [
+                'certificate_id' => $this->ui_factory->input()->field()->text($this->lng->txt('certificate_id')),
+                'issue_date' => $this->ui_factory->input()->field()->text($this->lng->txt('certificate_issue_date')),
+                'object' => $this->ui_factory->input()->field()->text($this->lng->txt('obj')),
+                'obj_id' => $this->ui_factory->input()->field()->text($this->lng->txt('object_id')),
+                'owner' => $this->ui_factory->input()->field()->text($this->lng->txt('owner')),
+            ],
+            [true, true, true, true, true],
+            true,
+            true
+        );
+    }
+
+    private function buildTable(): Data
+    {
+        $uiTable = $this->ui_factory->table();
+        return $uiTable->data(
+            $this->lng->txt('certificates'),
+            [
+                'certificate_id' => $uiTable->column()->text($this->lng->txt('certificate_id')),
+                'issue_date' => $uiTable->column()->date(
+                    $this->lng->txt('certificate_issue_date'),
+                    $this->data_factory->dateFormat()->withTime24($this->data_factory->dateFormat()->standard())
+                ),
+                'object' => $uiTable->column()->text($this->lng->txt('obj')),
+                'obj_id' => $uiTable->column()->text($this->lng->txt('object_id')),
+                'owner' => $uiTable->column()->text($this->lng->txt('owner')),
+            ],
+            $this
+        )
+            ->withOrder(new Order('issue_date', Order::DESC))
+            ->withId('certificateOverviewTable')
+            ->withRequest($this->request)
+            ->withActions($this->buildTableActions());
+    }
+
+    private function buildTableActions(): array
+    {
+        $uri_download = $this->data_factory->uri(
+            ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
+                ilObjCertificateSettingsGUI::class,
+                ilObjCertificateSettingsGUI::CMD_DOWNLOAD_CERTIFICATE
+            )
+        );
+
+        /**
+         * @var URLBuilder $url_builder_download
+         * @var URLBuilderToken $action_parameter_token_download ,
+         * @var URLBuilderToken $row_id_token_download
+         */
+        [
+            $url_builder_download,
+            $action_parameter_token_download,
+            $row_id_token_download
+        ] =
+            (new URLBuilder($uri_download))->acquireParameters(
+                ['cert_overview'],
+                'action',
+                'id'
+            );
+
+        return [
+            'download' => $this->ui_factory->table()->action()->single(
+                $this->lng->txt('download'),
+                $url_builder_download->withParameter($action_parameter_token_download, 'download'),
+                $row_id_token_download
+            )
+        ];
+    }
+
+    /**
+     * @param ilUserCertificate[] $certificates
+     */
+    private function buildTableRows(array $certificates): array
+    {
+        $table_rows = [];
+
+        foreach ($certificates as $certificate) {
+            $refIds = ilObject::_getAllReferences($certificate->getObjId());
+            $objectTitle = ilObject::_lookupTitle($certificate->getObjId());
+            foreach ($refIds as $refId) {
+                if ($this->access->checkAccess('read', '', $refId)) {
+                    $objectTitle = $this->ui_renderer->render(
+                        $this->ui_factory->link()->standard($objectTitle, ilLink::_getLink($refId))
+                    );
+                    break;
+                }
+            }
+
+            $table_rows[] = [
+                'id' => $certificate->getId(),
+                'certificate_id' => $certificate->getCertificateId()->asString(),
+                'issue_date' => $certificate->getAcquiredTimestamp(),
+                'object' => $objectTitle,
+                'obj_id' => (string) $certificate->getObjId(),
+                'owner' => ilObjUser::_lookupLogin($certificate->getUserId()),
+            ];
+        }
+        return $table_rows;
+    }
+
+    public function render(): string
+    {
+        return $this->ui_renderer->render([$this->filter, $this->table]);
+    }
+}

components/ILIAS/Certificate/PRIVACY.md

@@ -37,6 +37,7 @@ For each issued persisting user certificate, the ID of the user account is store
 
     Stored Data (if used as a placeholder in a certificate template):
 
+      - Certificate ID (globally unique id)
       - Username
       - Fullname Presentation
       - Firstname
@@ -62,14 +63,17 @@ For each issued persisting user certificate, the ID of the user account is store
   "PRIVACY.md" of those object types to see presentation of certificate data in that very object type.
   For example the course object presents certificate download links in the "Member" tab to user accounts with
   "Manage Member" permission.
+- Furthermore, certificates are presented to users in "Administration > Achievements > Certificates" in the **Certificates** tab   
+  if the user has **read** permission on the certificate settings.
 
 ## Data being deleted
 
 - If a user account is deleted, all it's certificates will be completely deleted from the database.
   There is no trash for users.
 
-## Data being exported 
+## Data being exported
 
 - Certificate owners can export PDF documents of their certificates at "Achievements > Certificates".
   No other exports of user related data is provided by the "Certificate Service" itself. Exports may be possible
-  in the object types listed above. Please refer to the respective "PRIVACY.md" files.
+  in the object types listed above. Please refer to the respective "PRIVACY.md" files.
+- Users with **read** permission on the certificate settings can export PDF documents of certificates at "Administration > Achievements > Certificates" in the **Certificates** tab.

components/ILIAS/Certificate/README.md

@@ -259,7 +259,7 @@ Example:
 
 ```php
 // Refers to already used certificate template
-$patternCertificateId = 10;
+use ILIAS\Certificate\ValueObject\CertificateId;$patternCertificateId = 10;
 
 // Object ID of the Module/Service (e.g. Course, Test)
 $objId                = 200;
@@ -294,6 +294,9 @@ $iliasVersion         = 'v5.4.0';
 // Determines if the current certifcate is the newest and visible certificate
 $currentlyActive      = true;
 
+// Unique UUID for the certificate
+$cert_id = new CertificateId('unique-uuid');
+
 $certificate = new ilUserCertificate(
 	$patternCertificateId,
 	$objId,
@@ -307,6 +310,7 @@ $certificate = new ilUserCertificate(
 	$version,
 	$iliasVersion,
 	$currentlyActive,
+	$cert_id
 );
 
 $repository = new ilUserCertificateRepository($database, $logger);

components/ILIAS/Certificate/classes/Placeholder/Description/class.ilDefaultPlaceholderDescription.php

@@ -40,6 +40,7 @@ public function __construct(
         $this->language = $language;
 
         $this->placeholder = [
+            'CERTIFICATE_ID' => $language->txt('certificate_ph_cert_id'),
             'USER_LOGIN' => $language->txt('certificate_ph_login'),
             'USER_FULLNAME' => $language->txt('certificate_ph_fullname'),
             'USER_FIRSTNAME' => $language->txt('certificate_ph_firstname'),

components/ILIAS/Certificate/classes/Placeholder/Values/class.ilDefaultPlaceholderValues.php

@@ -18,6 +18,8 @@
 
 declare(strict_types=1);
 
+use ILIAS\Data\UUID\Factory;
+
 require_once 'components/ILIAS/Calendar/classes/class.ilDateTime.php'; // Required because of global contant IL_CAL_DATE
 
 /**
@@ -33,16 +35,19 @@ class ilDefaultPlaceholderValues implements ilCertificatePlaceholderValues
     private readonly ilLanguage $language;
     private readonly ilCertificateUtilHelper $utilHelper;
     private readonly ilUserDefinedFieldsPlaceholderValues $userDefinedFieldsPlaceholderValues;
+    private readonly Factory $uuid_factory;
     private readonly ilLanguage $user_language;
 
+
     public function __construct(
         ?ilCertificateObjectHelper $objectHelper = null,
         ?ilCertificateDateHelper $dateHelper = null,
         ?int $dateFormat = null,
         ?ilLanguage $language = null,
         ?ilCertificateUtilHelper $utilHelper = null,
         ?ilUserDefinedFieldsPlaceholderValues $userDefinedFieldsPlaceholderValues = null,
-        private readonly int $birthdayDateFormat = IL_CAL_DATE
+        ?ILIAS\Data\UUID\Factory $uuid_factory = null,
+        private readonly int $birthdayDateFormat = IL_CAL_DATE,
     ) {
         if (null === $objectHelper) {
             $objectHelper = new ilCertificateObjectHelper();
@@ -76,7 +81,13 @@ public function __construct(
         }
         $this->userDefinedFieldsPlaceholderValues = $userDefinedFieldsPlaceholderValues;
 
+        if (!$uuid_factory) {
+            $uuid_factory = new ILIAS\Data\UUID\Factory();
+        }
+        $this->uuid_factory = $uuid_factory;
+
         $this->placeholder = [
+            'CERTIFICATE_ID' => '',
             'USER_LOGIN' => '',
             'USER_FULLNAME' => '',
             'USER_FIRSTNAME' => '',
@@ -170,6 +181,7 @@ public function getPlaceholderValues(int $userId, int $objId): array
     public function getPlaceholderValuesForPreview(int $userId, int $objId): array
     {
         $previewPlacholderValues = [
+            'CERTIFICATE_ID' => $this->utilHelper->prepareFormOutput($this->uuid_factory->uuid4AsString()),
             "USER_LOGIN" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_login")),
             "USER_FULLNAME" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_fullname")),
             "USER_FIRSTNAME" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_firstname")),