CertificateExport.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Test\ExportImport;

use ILIAS\Language\Language;
use ILIAS\Test\Logging\TestLogger;
use ILIAS\FileDelivery\Services as FileDeliveryServices;

class CertificateExport implements Exporter
{
    public function __construct(
        private readonly Language $lng,
        private readonly \ilDBInterface $db,
        private readonly TestLogger $logger,
        private \ilGlobalTemplateInterface $tpl,
        private FileDeliveryServices $file_delivery,
        private readonly \ilObjTest $object
    ) {
    }

    public function deliver(): void
    {
        if (($path = $this->write()) === null) {
            return;
        }
        $this->file_delivery->legacyDelivery()->attached(
            $path,
            null,
            null,
            true
        );
    }

    public function write(): ?string
    {
        $global_certificate_prerequisites = new \ilCertificateActiveValidator();
        if (!$global_certificate_prerequisites->validate()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'));
            return null;
        }

        $path_factory = new \ilCertificatePathFactory();
        $obj_id = $this->object->getId();
        $zip_action = new \ilUserCertificateZip(
            $obj_id,
            $path_factory->create($this->object)
        );

        $archive_dir = $zip_action->createArchiveDirectory();

        $this->object->setAccessFilteredParticipantList(
            $this->object->buildStatisticsAccessFilteredParticipantList()
        );

        $certificate_repo = new \ilUserCertificateRepository($this->db);
        $pdf_generator = new \ilPdfGenerator($certificate_repo);

        $total_users = $this->object->evalTotalPersonsArray();
        if (count($total_users) === 0) {
            $this->tpl->setOnScreenMessage(
                'info',
                $this->lng->txt('export_cert_no_users'),
                true
            );
            return null;
        }

        $cert_validator = new \ilCertificateDownloadValidator();

        $num_pdfs = 0;
        $ignored_usr_ids = [];
        $failed_pdf_generation_usr_ids = [];
        foreach ($total_users as $active_id => $name) {
            $user_id = \ilObjTest::_getUserIdFromActiveId($active_id);

            if (!$cert_validator->isCertificateDownloadable($user_id, $obj_id)) {
                $this->logger->debug(
                    sprintf(
                        'No certificate available for user %s in test %s ' .
                        '(Check if: \ilServer is enabled / Certificates are enabled globally / ' .
                        'A Certificate is issued for the user)',
                        $user_id,
                        $obj_id
                    )
                );
                $ignored_usr_ids[] = $user_id;
                continue;
            }

            $pdf_action = new \ilCertificatePdfAction(
                $pdf_generator,
                new \ilCertificateUtilHelper(),
                $this->lng->txt('error_creating_certificate_pdf')
            );

            $pdf = $pdf_action->createPDF($user_id, $obj_id);
            if ($pdf !== '') {
                $zip_action->addPDFtoArchiveDirectory(
                    $pdf,
                    $archive_dir,
                    $user_id . '_' . str_replace(' ', '_', \ilFileUtils::getASCIIFilename($name)) . '.pdf'
                );
                ++$num_pdfs;
            } else {
                $this->logger->error(
                    sprintf(
                        'The certificate service could not create a PDF for user %s and test %s',
                        $user_id,
                        $obj_id
                    )
                );
                $failed_pdf_generation_usr_ids[] = $user_id;
            }
        }

        $zip_file_dir = null;
        if ($num_pdfs > 0) {
            try {
                $zip_file_dir = $zip_action->zipCertificatesInArchiveDirectory($archive_dir, false);
            } catch (\ILIAS\Filesystem\Exception\IOException $e) {
                $this->logger->error($e->getMessage());
                $this->logger->error($e->getTraceAsString());
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('error_creating_certificate_zip_empty'),
                    true
                );
            }
        }

        $components = [];
        if ($ignored_usr_ids !== []) {
            $components[] = $this->buildIgnoredUsersMessage($ignored_usr_ids);
        }
        if ($failed_pdf_generation_usr_ids !== []) {
            $components[] = $this->buildFailedGenerationMessage($failed_pdf_generation_usr_ids);
        }
        if ($components !== []) {
            $this->tpl->setOnScreenMessage('info', implode('<br>', $components), true);
        }

        return $zip_file_dir;
    }

    private function buildIgnoredUsersMessage(array $ignored_user_ids): string
    {
        $ignored_user_logins = $this->getLoginsForIds($ignored_user_ids);
        $nr_ignored_users = count($ignored_user_ids);
        if ($nr_ignored_users === 1) {
            return sprintf(
                $this->lng->txt('export_cert_ignored_for_users_s'),
                $ignored_user_logins[0]
            );
        }
        return sprintf(
            $this->lng->txt('export_cert_ignored_for_users_p'),
            $nr_ignored_users,
            implode(', ', $ignored_user_logins)
        );
    }

    private function buildFailedGenerationMessage(array $failed_pdf_generation_ids): string
    {
        $failed_pdf_generation_logins = $this->getLoginsForIds($failed_pdf_generation_ids);
        $nr_failed_pdf_generation = count($failed_pdf_generation_ids);
        if ($nr_failed_pdf_generation === 1) {
            return sprintf(
                $this->lng->txt('export_cert_failed_for_users_s'),
                $failed_pdf_generation_logins[0]
            );
        }

        return sprintf(
            $this->lng->txt('export_cert_failed_for_users_p'),
            $nr_failed_pdf_generation,
            implode(', ', $failed_pdf_generation_logins)
        );
    }

    private function getLoginsForIds(array $user_ids): array
    {
        return array_map(
            function ($usr_id): string {
                $login = \ilObjUser::_lookupLogin((int) $usr_id);
                if ($login !== '') {
                    return $login;
                }
                return $this->lng->txt('deleted_user');
            },
            $user_ids
        );
    }
}