ilCertificateTemplateImportAction Class Reference

Collaboration diagram for ilCertificateTemplateImportAction:

Public Member Functions
	__construct (private readonly int $objectId, private readonly string $certificatePath, private readonly ilCertificatePlaceholderDescription $placeholderDescriptionObject, private readonly ilLogger $logger, private readonly Filesystem $filesystem, ?ilCertificateTemplateRepository $templateRepository=null, ?ilCertificateObjectHelper $objectHelper=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilDBInterface $database=null, ?ilCertificateBackgroundImageFileService $fileService=null)
	import (string $zipFile, string $filename, string $rootDir=CLIENT_WEB_DIR, string $iliasVerision=ILIAS_VERSION_NUMERIC, string $installationID=IL_INST_ID)

Private Member Functions
	createArchiveDirectory (string $installationID)
	Creates a directory for a zip archive containing multiple certificates. More...
	getBackgroundImageThumbnailPath ()

Private Attributes
readonly ilCertificateTemplateRepository	$templateRepository
readonly ilCertificateObjectHelper	$objectHelper
readonly ilCertificateUtilHelper	$utilHelper
readonly ilCertificateBackgroundImageFileService	$fileService

Detailed Description

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 29 of file class.ilCertificateTemplateImportAction.php.

Constructor & Destructor Documentation

__construct()

ilCertificateTemplateImportAction::__construct	(	private readonly int	$objectId,
		private readonly string	$certificatePath,
		private readonly ilCertificatePlaceholderDescription	$placeholderDescriptionObject,
		private readonly ilLogger	$logger,
		private readonly Filesystem	$filesystem,
		?ilCertificateTemplateRepository	$templateRepository = null,
		?ilCertificateObjectHelper	$objectHelper = null,
		?ilCertificateUtilHelper	$utilHelper = null,
		?ilDBInterface	$database = null,
		?ilCertificateBackgroundImageFileService	$fileService = null
	)

Definition at line 36 of file class.ilCertificateTemplateImportAction.php.

References $DIC, $fileService, $objectHelper, $templateRepository, and $utilHelper.

      {
        if (null === $database) {
            global $DIC;
            $database = $DIC->database();
        }

        if (null === $templateRepository) {
            $templateRepository = new ilCertificateTemplateDatabaseRepository($database, $logger);
        }
        $this->templateRepository = $templateRepository;

        if (null === $objectHelper) {
            $objectHelper = new ilCertificateObjectHelper();
        }
        $this->objectHelper = $objectHelper;

        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;

        if (null === $fileService) {
            $fileService = new ilCertificateBackgroundImageFileService(
                $certificatePath,
                $filesystem
            );
        }
        $this->fileService = $fileService;
    }

Member Function Documentation

createArchiveDirectory()

ilCertificateTemplateImportAction::createArchiveDirectory ( string  $installationID )

private

Creates a directory for a zip archive containing multiple certificates.

Returns

string The created archive directory

Exceptions

IOException

Definition at line 245 of file class.ilCertificateTemplateImportAction.php.

References ILIAS\Repository\filesystem().

Referenced by import().

                                                                   : string
    {
        $type = $this->objectHelper->lookupType($this->objectId);
        $certificateId = $this->objectId;

        $dir = $this->certificatePath . time() . '__' . $installationID . '__' . $type . '__' . $certificateId . '__certificate/';
        if ($this->filesystem->hasDir($dir)) {
            $this->filesystem->deleteDir($dir);
        }
        $this->filesystem->createDir($dir);

        return $dir;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBackgroundImageThumbnailPath()

ilCertificateTemplateImportAction::getBackgroundImageThumbnailPath ( )

private

Definition at line 259 of file class.ilCertificateTemplateImportAction.php.

Referenced by import().

                                                      : string
    {
        return $this->certificatePath . 'background.jpg.thumb.jpg';
    }

Here is the caller graph for this function:

import()

ilCertificateTemplateImportAction::import	(	string	$zipFile,
		string	$filename,
		string	$rootDir = CLIENT_WEB_DIR,
		string	$iliasVerision = ILIAS_VERSION_NUMERIC,
		string	$installationID = IL_INST_ID
	)

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException

Definition at line 84 of file class.ilCertificateTemplateImportAction.php.

References Vendor\Package\$e, createArchiveDirectory(), ILIAS\Repository\filesystem(), getBackgroundImageThumbnailPath(), and ILIAS\Repository\logger().

     : bool {
        $importPath = $this->createArchiveDirectory($installationID);

        $clean_up_import_dir = function () use (&$importPath) {
            try {
                if ($this->filesystem->hasDir($importPath)) {
                    $this->filesystem->deleteDir($importPath);
                }
            } catch (Throwable $e) {
                $this->logger->error(sprintf("Can't clean up import directory: %s", $e->getMessage()));
                $this->logger->error($e->getTraceAsString());
            }
        };

        $result = $this->utilHelper->moveUploadedFile($zipFile, $filename, $rootDir . $importPath . $filename);
        if (!$result) {
            $clean_up_import_dir();
            return false;
        }

        $destination_dir = $rootDir . $importPath;
        $unzip = $this->utilHelper->unzip(
            $rootDir . $importPath . $filename,
            $destination_dir,
            true
        );

        $unzipped = $unzip->extract();

        // Cleanup memory, otherwise there will be issues with NFS-based file systems after `listContents` has been called
        unset($unzip);

        if (!$unzipped) {
            $clean_up_import_dir();
            return false;
        }

        if ($this->filesystem->has($importPath . $filename)) {
            $this->filesystem->delete($importPath . $filename);
        }

        $xmlFiles = 0;
        $contents = $this->filesystem->listContents($importPath);
        foreach ($contents as $file) {
            if ($file->isFile() && str_contains($file->getPath(), '.xml')) {
                $xmlFiles++;
            }
        }

        if (0 === $xmlFiles) {
            return false;
        }

        $certificate = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);

        $currentVersion = $certificate->getVersion();
        $newVersion = $currentVersion + 1;
        $backgroundImagePath = $certificate->getBackgroundImagePath();
        $cardThumbnailImagePath = $certificate->getThumbnailImagePath();
        $xsl = $certificate->getCertificateContent();

        foreach ($contents as $file) {
            if (!$file->isFile()) {
                continue;
            }

            if (str_contains($file->getPath(), '.xml')) {
                $xsl = $this->filesystem->read($file->getPath());
                // as long as we cannot make RPC calls in a given directory, we have
                // to add the complete path to every url
                $xsl = preg_replace_callback(
                    "/url\([']{0,1}(.*?)[']{0,1}\)/",
                    function (array $matches) use ($rootDir): string {
                        $basePath = rtrim(dirname($this->fileService->getBackgroundImageDirectory($rootDir)), '/');
                        $fileName = basename($matches[1]);

                        if ('[BACKGROUND_IMAGE]' === $fileName) {
                            $basePath = '';
                        } elseif ($basePath !== '') {
                            $basePath .= '/';
                        }

                        return 'url(' . $basePath . $fileName . ')';
                    },
                    $xsl
                );
            } elseif (str_contains($file->getPath(), '.jpg')) {
                $newBackgroundImageName = 'background_' . $newVersion . '.jpg';
                $newPath = $this->certificatePath . $newBackgroundImageName;
                $this->filesystem->copy($file->getPath(), $newPath);

                $backgroundImagePath = $this->certificatePath . $newBackgroundImageName;
                // upload of the background image, create a thumbnail

                $backgroundImageThumbPath = $this->getBackgroundImageThumbnailPath();

                $thumbnailImagePath = $rootDir . $backgroundImageThumbPath;

                $originalImagePath = $rootDir . $newPath;
                $this->utilHelper->convertImage(
                    $originalImagePath,
                    $thumbnailImagePath,
                    '100'
                );
            } elseif (str_contains($file->getPath(), '.svg')) {
                $newCardThumbnailName = 'thumbnail_' . $newVersion . '.svg';
                $newPath = $this->certificatePath . $newCardThumbnailName;

                $this->filesystem->copy($file->getPath(), $newPath);

                $cardThumbnailImagePath = $this->certificatePath . $newCardThumbnailName;
            }
        }

        $jsonEncodedTemplateValues = json_encode(
            $this->placeholderDescriptionObject->getPlaceholderDescriptions(),
            JSON_THROW_ON_ERROR
        );

        $newHashValue = hash(
            'sha256',
            implode('', [
                $xsl,
                $backgroundImagePath,
                $jsonEncodedTemplateValues,
                $cardThumbnailImagePath
            ])
        );

        $template = new ilCertificateTemplate(
            $this->objectId,
            $this->objectHelper->lookupType($this->objectId),
            $xsl,
            $newHashValue,
            $jsonEncodedTemplateValues,
            $newVersion,
            $iliasVerision,
            time(),
            false,
            $backgroundImagePath,
            $cardThumbnailImagePath
        );

        $this->templateRepository->save($template);

        $clean_up_import_dir();

        return true;
    }

Here is the call graph for this function:

Field Documentation

$fileService

readonly ilCertificateBackgroundImageFileService ilCertificateTemplateImportAction::$fileService

private

Definition at line 34 of file class.ilCertificateTemplateImportAction.php.

Referenced by __construct().

$objectHelper

readonly ilCertificateObjectHelper ilCertificateTemplateImportAction::$objectHelper

private

Definition at line 32 of file class.ilCertificateTemplateImportAction.php.

Referenced by __construct().

$templateRepository

readonly ilCertificateTemplateRepository ilCertificateTemplateImportAction::$templateRepository

private

Definition at line 31 of file class.ilCertificateTemplateImportAction.php.

Referenced by __construct().

$utilHelper

readonly ilCertificateUtilHelper ilCertificateTemplateImportAction::$utilHelper

private

Definition at line 33 of file class.ilCertificateTemplateImportAction.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• Services/Certificate/classes/Template/Action/Import/class.ilCertificateTemplateImportAction.php