class.ilCertificateCron.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\DI\Container;
use ILIAS\Cron\Job\Schedule\JobScheduleType;
use ILIAS\Cron\Job\JobManager;
use ILIAS\Cron\Job\JobResult;
use ILIAS\Cron\CronJob;
 
class ilCertificateCron extends CronJob
{
    protected ?ilLanguage $lng;
    private ?Container $dic;
 
    public function __construct(
        private ?ilCertificateQueueRepository $queueRepository = null,
        private ?ilCertificateTemplateRepository $templateRepository = null,
        private ?ilUserCertificateRepository $userRepository = null,
        private ?ilCertificateValueReplacement $valueReplacement = null,
        private ?ilLogger $logger = null,
        ?Container $dic = null,
        ?ilLanguage $language = null,
        private ?ilCertificateObjectHelper $objectHelper = null,
        private ?ilSetting $settings = null,
        private ?JobManager $cronManager = null,
    ) {
        if (null === $dic) {
            global $DIC;
            $dic = $DIC;
        }
        $this->dic = $dic;
 
        if ($dic && isset($dic['lng'])) {
            $language = $dic->language();
            $language->loadLanguageModule('certificate');
        }
 
        $this->lng = $language;
    }
 
    public function getTitle(): string
    {
        return $this->lng->txt('cert_cron_task_title');
    }
 
    public function getDescription(): string
    {
        return $this->lng->txt('cert_cron_task_desc');
    }
 
    public function init(): void
    {
        if (null === $this->dic) {
            global $DIC;
            $this->dic = $DIC;
        }
 
        $database = $this->dic->database();
 
        if (null === $this->logger) {
            $this->logger = $this->dic->logger()->cert();
        }
 
        if (null === $this->cronManager) {
            $this->cronManager = $this->dic->cron()->manager();
        }
 
        if (null === $this->queueRepository) {
            $this->queueRepository = new ilCertificateQueueRepository($database, $this->logger);
        }
 
        if (null === $this->templateRepository) {
            $this->templateRepository = new ilCertificateTemplateDatabaseRepository($database, $this->logger);
        }
 
        if (null === $this->userRepository) {
            $this->userRepository = new ilUserCertificateRepository($database, $this->logger);
        }
 
        if (null === $this->valueReplacement) {
            $this->valueReplacement = new ilCertificateValueReplacement();
        }
 
        if (null === $this->objectHelper) {
            $this->objectHelper = new ilCertificateObjectHelper();
        }
 
        if (null === $this->settings) {
            $this->settings = new ilSetting('certificate');
        }
    }
 
    public function run(): JobResult
    {
        $this->init();
 
        $result = new JobResult();
        $result->setStatus(JobResult::STATUS_NO_ACTION);
 
        $currentMode = $this->settings->get('persistent_certificate_mode', 'persistent_certificate_mode_cron');
        if ($currentMode !== 'persistent_certificate_mode_cron') {
            $this->logger->warning(sprintf(
                'Will not start cron job, because the mode is not set as cron job. Current Mode in settings: "%s"',
                $currentMode
            ));
 
            return $result;
        }
 
        $this->logger->debug('START - Begin with cron job to create user certificates from templates');
 
        $entries = $this->queueRepository->getAllEntriesFromQueue();
 
        $status = JobResult::STATUS_OK;
 
        $entryCounter = 0;
        $succeededGenerations = [];
        foreach ($entries as $entry) {
            try {
                $succeededGenerations = $this->processEntry(
                    $entryCounter,
                    $entry,
                    $succeededGenerations
                );
 
                ++$entryCounter;
            } catch (ilInvalidCertificateException $exception) {
                $this->logger->warning($exception->getMessage());
                $this->logger->warning('The user MAY not be able to achieve the certificate based on the adapters settings');
                $this->logger->warning('Due the error, the entry will now be removed from the queue.');
 
                $this->queueRepository->removeFromQueue($entry->getId());
 
                continue;
            } catch (ilException $exception) {
                $this->logger->warning($exception->getMessage());
                $this->logger->warning('Due the error, the entry will now be removed from the queue.');
 
                $this->queueRepository->removeFromQueue($entry->getId());
 
                continue;
            }
        }
 
        $result->setStatus($status);
        if ($succeededGenerations !== []) {
            $message = sprintf(
                'Generated %s certificate(s) in run. Result: %s',
                count($succeededGenerations),
                implode(' | ', $succeededGenerations)
            );
            $this->logger->info($message);
            $result->setMessage(ilStr::subStr($message, 0, 400));
        } else {
            $result->setMessage('0 certificates generated in current run.');
        }
 
        return $result;
    }
 
    public function getId(): string
    {
        return 'certificate';
    }
 
    public function hasAutoActivation(): bool
    {
        return true;
    }
 
    public function hasFlexibleSchedule(): bool
    {
        return true;
    }
 
    public function getDefaultScheduleType(): JobScheduleType
    {
        return JobScheduleType::IN_MINUTES;
    }
 
    public function getDefaultScheduleValue(): ?int
    {
        return 1;
    }
 
    public function processEntry(int $entryCounter, ilCertificateQueueEntry $entry, array $succeededGenerations): array
    {
        if ($entryCounter > 0 && $entryCounter % 10 === 0) {
            $this->cronManager->ping($this->getId());
        }
 
        $this->logger->debug('Entry found will start of processing the entry');
 
        $class = $entry->getAdapterClass();
        $this->logger->debug('Adapter class to be executed "' . $class . '"');
 
        $placeholderValueObject = new $class();
        if (!$placeholderValueObject instanceof ilCertificatePlaceholderValues) {
            throw new ilInvalidCertificateException(
                'The given class ' . $class . ' must be an instance of ilCertificateCronAdapter and must ' .
                'have an accessible namespace. The composer class map should be reloaded.'
            );
        }
 
        $objId = $entry->getObjId();
        $userId = $entry->getUserId();
        $templateId = $entry->getTemplateId();
 
        $this->logger->debug(sprintf(
            'Fetch certificate template for user id: "%s" and object id: "%s" and template id: "%s"',
            $userId,
            $objId,
            $templateId
        ));
 
        $template = $this->templateRepository->fetchTemplate($templateId);
 
        $object = $this->objectHelper->getInstanceByObjId($objId, false);
        if (!$object instanceof ilObject) {
            throw new ilCertificateIssuingObjectNotFound(sprintf(
                'The given object id: "%s"  could not be referred to an actual object',
                $objId
            ));
        }
 
        $type = $object->getType();
 
        $userObject = $this->objectHelper->getInstanceByObjId($userId, false);
        if (!$userObject instanceof ilObjUser) {
            throw new ilCertificateOwnerNotFound('The given user id"' . $userId . '" could not be referred to an actual user');
        }
 
        $this->logger->debug(sprintf(
            'Object type: "%s"',
            $type
        ));
 
        $cert_id = $this->userRepository->requestIdentity();
        $certificateContent = $template->getCertificateContent();
 
        $placeholderValues = $placeholderValueObject->getPlaceholderValues($userId, $objId);
        $placeholderValues['CERTIFICATE_ID'] = $cert_id->asString();
 
        $this->logger->debug(sprintf(
            'Values for placeholders: "%s"',
            json_encode($placeholderValues, JSON_THROW_ON_ERROR)
        ));
 
        $certificateContent = $this->valueReplacement->replace(
            $placeholderValues,
            $certificateContent,
        );
 
        $userCertificate = new ilUserCertificate(
            $template->getId(),
            $objId,
            $type,
            $userId,
            $userObject->getFullname(),
            $entry->getStartedTimestamp(),
            $certificateContent,
            json_encode($placeholderValues, JSON_THROW_ON_ERROR),
            null,
            $template->getVersion(),
            ILIAS_VERSION_NUMERIC,
            true,
            $cert_id,
            $template->getBackgroundImagePath(),
            $template->getTileImagePath(),
            $template->getBackgroundImageIdentification(),
            $template->getTileImageIdentification(),
            null,
        );
 
        $persistedUserCertificate = $this->userRepository->save($userCertificate);
 
        $succeededGenerations[] = implode('/', [
            'obj_id: ' . $objId,
            'usr_id: ' . $userId
        ]);
 
        if ($entry->getId() !== null) {
            $this->queueRepository->removeFromQueue($entry->getId());
        }
 
        $this->dic->event()->raise(
            'components/ILIAS/Certificate',
            'certificateIssued',
            ['certificate' => $persistedUserCertificate]
        );
 
        return $succeededGenerations;
    }
}