Collaboration diagram for ilCertificateTemplateImportAction:

Public Member Functions
	__construct (int $objectId, string $certificatePath, ilCertificatePlaceholderDescription $placeholderDescriptionObject, ilLogger $logger, Filesystem $filesystem, ?ilCertificateTemplateRepository $templateRepository=null, ?ilCertificateObjectHelper $objectHelper=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilDBInterface $database=null, ?ilCertificateBackgroundImageFileService $fileService=null, ?SVGBlacklistPreProcessor $svg_blacklist_processor=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 ()

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

      {
        $this->objectId = $objectId;
        $this->certificatePath = $certificatePath;
 
        $this->logger = $logger;
        if (null === $database) {
            global $DIC;
            $database = $DIC->database();
        }
 
        $this->filesystem = $filesystem;
 
        $this->placeholderDescriptionObject = $placeholderDescriptionObject;
 
        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;
        if (null === $svg_blacklist_processor) {
            $svg_blacklist_processor = new SVGBlacklistPreProcessor();
        }
        $this->svg_blacklist_processor = $svg_blacklist_processor;
    }

References $certificatePath, $DIC, $fileService, $filesystem, $logger, $objectHelper, $objectId, $placeholderDescriptionObject, $svg_blacklist_processor, $templateRepository, $utilHelper, ILIAS\Repository\filesystem(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

◆ createArchiveDirectory()

ilCertificateTemplateImportAction::createArchiveDirectory ( string $installationID )

private

Creates a directory for a zip archive containing multiple certificates.

Parameters

string $installationID

Returns: string The created archive directory

Exceptions

IOException

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

                                                                   : string
    {
        $type = $this->objectHelper->lookupType($this->objectId);
        $certificateId = $this->objectId;
 
        $dir = $this->certificatePath . time() . '__' . $installationID . '__' . $type . '__' . $certificateId . '__certificate/';
        $this->filesystem->createDir($dir);
 
        return $dir;
    }

References $installationID, $objectId, $type, and ILIAS\Repository\filesystem().

Referenced by import().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBackgroundImageThumbnailPath()

ilCertificateTemplateImportAction::getBackgroundImageThumbnailPath ( )

private

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

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

Referenced by import().

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`
	)

Parameters

string	$zipFile
string	$filename
string	$rootDir
string	$iliasVerision
string \| false	$installationID

Returns: bool

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException
ilDatabaseException
ilException

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

     : bool {
        $importPath = $this->createArchiveDirectory($installationID);
 
        try {
            $result = $this->utilHelper->moveUploadedFile($zipFile, $filename, $rootDir . $importPath . $filename);
 
            if (!$result) {
                return false;
            }
 
            $this->utilHelper->unzip(
                $rootDir . $importPath . $filename,
                true
            );
 
            $subDirectoryName = str_replace('.zip', '', strtolower($filename)) . '/';
            $subDirectoryAbsolutePath = $rootDir . $importPath . $subDirectoryName;
 
            $copyDirectory = $rootDir . $importPath;
            if (is_dir($subDirectoryAbsolutePath)) {
                $copyDirectory = $subDirectoryAbsolutePath;
            }
 
            $directoryInformation = $this->utilHelper->getDir($copyDirectory);
 
            $xmlFiles = 0;
            foreach ($directoryInformation as $file) {
                if (strcmp($file['type'], 'file') === 0) {
                    if (strpos($file['entry'], '.xml') !== false) {
                        $xmlFiles++;
                    }
 
                    if (strpos($file['entry'], '.svg') !== false) {
                        $filePath = $importPath . $file['entry'];
 
                        $stream = $this->filesystem->readStream($filePath);
                        $file_metadata = $stream->getMetadata();
                        $absolute_file_path = $file_metadata['uri'];
 
                        $metadata = new Metadata(
                            pathinfo($absolute_file_path)['basename'],
                            filesize($absolute_file_path),
                            mime_content_type($absolute_file_path)
                        );
 
                        $processing_result = $this->svg_blacklist_processor->process($stream, $metadata);
                        if ($processing_result->getCode() !== ProcessingStatus::OK) {
                            return false;
                        }
                    }
                }
            }
 
            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 ($directoryInformation as $file) {
                if (strcmp($file['type'], 'file') === 0) {
                    $filePath = $importPath . $file['entry'];
                    if (strpos($file['entry'], '.xml') !== false) {
                        $xsl = $this->filesystem->read($filePath);
                        // 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 (strpos($file['entry'], '.jpg') !== false) {
                        $newBackgroundImageName = 'background_' . $newVersion . '.jpg';
                        $newPath = $this->certificatePath . $newBackgroundImageName;
                        $this->filesystem->copy($filePath, $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,
                            'JPEG',
                            "100"
                        );
                    } elseif (strpos($file['entry'], '.svg') !== false) {
                        $newCardThumbnailName = 'thumbnail_' . $newVersion . '.svg';
                        $newPath = $this->certificatePath . $newCardThumbnailName;
 
                        $this->filesystem->copy($filePath, $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(),
                true,
                $backgroundImagePath,
                $cardThumbnailImagePath
            );
 
            $this->templateRepository->save($template);
 
            return true;
        } catch (Throwable $e) {
            $this->logger->error(sprintf('Error during certificate import: %s', $e->getMessage()));
            $this->logger->error($e->getTraceAsString());
 
            return false;
        } finally {
            $this->filesystem->deleteDir($importPath);
        }
    }

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

Here is the call graph for this function:

Field Documentation

◆ $certificatePath

string ilCertificateTemplateImportAction::$certificatePath

private

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

Referenced by __construct().

◆ $fileService

ilCertificateBackgroundImageFileService ilCertificateTemplateImportAction::$fileService

private

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

Referenced by __construct().

◆ $filesystem

Filesystem ilCertificateTemplateImportAction::$filesystem

private

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

Referenced by __construct().

◆ $installationID

string ilCertificateTemplateImportAction::$installationID

private

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

Referenced by createArchiveDirectory().

◆ $logger

ilLogger ilCertificateTemplateImportAction::$logger

private

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

Referenced by __construct().

◆ $objectHelper

ilCertificateObjectHelper ilCertificateTemplateImportAction::$objectHelper

private

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

Referenced by __construct().

◆ $objectId

int ilCertificateTemplateImportAction::$objectId

private

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

Referenced by __construct(), and createArchiveDirectory().

◆ $placeholderDescriptionObject

ilCertificatePlaceholderDescription ilCertificateTemplateImportAction::$placeholderDescriptionObject

private

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

Referenced by __construct().

◆ $svg_blacklist_processor

SVGBlacklistPreProcessor ilCertificateTemplateImportAction::$svg_blacklist_processor

private

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

Referenced by __construct().

◆ $templateRepository

ilCertificateTemplateRepository ilCertificateTemplateImportAction::$templateRepository

private

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

Referenced by __construct().

◆ $utilHelper

ilCertificateUtilHelper ilCertificateTemplateImportAction::$utilHelper

private

Definition at line 41 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

Private Attributes
int	$objectId

string	$certificatePath

ilCertificateTemplateRepository	$templateRepository

ilCertificatePlaceholderDescription	$placeholderDescriptionObject

ilLogger	$logger

Filesystem	$filesystem

ilCertificateObjectHelper	$objectHelper

ilCertificateUtilHelper	$utilHelper

string	$installationID

ilCertificateBackgroundImageFileService	$fileService

SVGBlacklistPreProcessor	$svg_blacklist_processor

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createArchiveDirectory()

◆ getBackgroundImageThumbnailPath()

◆ import()

Field Documentation

◆ $certificatePath

◆ $fileService

◆ $filesystem

◆ $installationID

◆ $logger

◆ $objectHelper

◆ $objectId

◆ $placeholderDescriptionObject

◆ $svg_blacklist_processor

◆ $templateRepository

◆ $utilHelper