class.ilSkinFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Stream\Streams;
use ILIAS\Filesystem\Util\Archive\Archives;
use ILIAS\Filesystem\Util\Archive\ZipOptions;
use ILIAS\Filesystem\Util\Archive\UnzipOptions;
use ILIAS\Filesystem\Util\Archive\ZipDirectoryHandling;

class ilSkinFactory
{
    private Archives $archives;
    protected ilSystemStyleConfig $config;
    protected ilLanguage $lng;

    public function __construct(ilLanguage $lng, ?ilSystemStyleConfig $config = null)
    {
        global $DIC;
        $this->lng = $lng;
        $this->archives = new Archives();

        if ($config) {
            $this->config = $config;
        } else {
            $this->config = new ilSystemStyleConfig();
        }
    }

    public function skinFromXML(string $path = ''): ilSkin
    {
        try {
            $xml = new SimpleXMLElement(file_get_contents($path));
        } catch (Exception $e) {
            throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED, $path);
        }

        $id = basename(dirname($path));
        $skin = new ilSkin($id, (string) $xml->attributes()['name']);
        $skin->setVersion((string) $xml->attributes()['version']);

        $last_style = null;

        foreach ($xml->children() as $style_xml) {
            $style = ilSkinStyle::parseFromXMLElement($style_xml);

            if ($style_xml->getName() == 'substyle') {
                if (!$last_style) {
                    throw new ilSystemStyleException(ilSystemStyleException::NO_PARENT_STYLE, $style->getId());
                }
                $style->setSubstyleOf($last_style->getId());
            } else {
                $last_style = $style;
            }
            $skin->addStyle($style);
        }
        return $skin;
    }

    public function skinStyleContainerFromId(
        string $skin_id,
        ilSystemStyleMessageStack $message_stack
    ): ilSkinStyleContainer {
        if (!$skin_id) {
            throw new ilSystemStyleException(ilSystemStyleException::NO_SKIN_ID);
        }

        if ($skin_id != 'default') {
            return new ilSkinStyleContainer(
                $this->lng,
                $this->skinFromXML($this->config->getCustomizingSkinPath() . $skin_id . '/template.xml'),
                $message_stack,
                $this->config
            );
        } else {
            return new ilSkinStyleContainer(
                $this->lng,
                $this->skinFromXML($this->config->getDefaultTemplatePath()),
                $message_stack,
                $this->config,
            );
        }
    }

    public function skinStyleContainerFromZip(
        string $import_zip_path,
        string $name,
        ilSystemStyleMessageStack $message_stack
    ): ilSkinStyleContainer {
        $original_skin_id = preg_replace('/[^A-Za-z0-9\-_]/', '', rtrim($name, '.zip'));
        $skin_id = $original_skin_id;

        while (ilStyleDefinition::skinExists($skin_id, $this->config)) {
            $skin_id .= 'Copy';
        }

        $skin_path = $this->config->getCustomizingSkinPath() . $skin_id;
        $temp_skin_path = $skin_path."temp";
        $zip_path = $temp_skin_path . ".zip";
        rename($import_zip_path, $zip_path);

        $this->archives->unzip(
            Streams::ofResource(fopen($zip_path, 'rb')),
            $this->archives->unzipOptions()
             ->withZipOutputPath($temp_skin_path)
             ->withOverwrite(false)
             ->withDirectoryHandling(ZipDirectoryHandling::KEEP_STRUCTURE)
        )->extract();
        unlink($zip_path);
        rename($temp_skin_path."/".$original_skin_id, $skin_path);
        rmdir($temp_skin_path);
        $container = $this->skinStyleContainerFromId($skin_id, $message_stack);
        $container->getSkin()->setId($skin_id);
        $container->setSkin($container->getSkin());
        $container->updateSkin();
        return $container;
    }

    public function copyFromSkinStyleContainer(
        ilSkinStyleContainer $container,
        ilFileSystemHelper $file_system,
        ilSystemStyleMessageStack $message_stack,
        string $new_skin_txt_addon = 'Copy'
    ): ilSkinStyleContainer {
        $new_skin_id_addon = '';
        $new_skin_name_addon = '';

        while (ilStyleDefinition::skinExists(
            $container->getSkin()->getId() . $new_skin_id_addon,
            $container->getSystemStylesConf()
        )) {
            $new_skin_id_addon .= $new_skin_txt_addon;
            $new_skin_name_addon .= ' ' . $new_skin_txt_addon;
        }

        $new_skin_path = rtrim($container->getSkinDirectory(), '/') . $new_skin_id_addon;

        mkdir($new_skin_path, 0775, true);
        $file_system->recursiveCopy($container->getSkinDirectory(), $new_skin_path);
        $skin_container = $this->skinStyleContainerFromId($container->getSkin()->getId() . $new_skin_id_addon, $message_stack);
        $skin_container->getSkin()->setName($skin_container->getSkin()->getName() . $new_skin_name_addon);
        $skin_container->getSkin()->setVersion('0.1');
        $skin_container->updateSkin($skin_container->getSkin());
        return $skin_container;
    }
}