class.ilDidacticTemplateImport.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Export\ImportHandler\Factory as ilImportHandlerFactory;
use ILIAS\Export\ImportStatus\ilFactory as ilImportStatusFactory;
use ILIAS\Export\ImportStatus\StatusType;
use ILIAS\Export\ImportStatus\I\ilCollectionInterface as ilImportStatusCollectionInterface;

class ilDidacticTemplateImport
{
    protected const XML_ELEMENT_NAME_LOCAL_ROLE_ACTION = 'localRoleAction';
    protected const XML_ELEMENT_NAME_BLOCK_ROLE_ACIONE = 'blockRoleAction';
    protected const XML_ELEMENT_NAME_LOCAL_POLICY_ACTION = 'localPolicyAction';
    public const IMPORT_FILE = 1;
    protected const SCHEMA_TYPE = 'otpl';

    protected int $type = 0;
    protected string $xmlfile = '';
    protected ilLogger $logger;
    protected ilObjectDefinition $objDefinition;
    protected ilSetting $settings;

    public function __construct(int $a_type)
    {
        global $DIC;
        $this->logger = $DIC->logger()->otpl();
        $this->type = $a_type;
        $this->objDefinition = $DIC['objDefinition'];
        $this->settings = $DIC->settings();
    }

    public function setInputFile(string $a_file): void
    {
        $this->xmlfile = $a_file;
    }

    public function getInputFile(): string
    {
        return $this->xmlfile;
    }

    public function getInputType(): int
    {
        return $this->type;
    }

    public function import(int $a_dtpl_id = 0): ilDidacticTemplateSetting
    {
        $root = null;
        $use_internal_errors = libxml_use_internal_errors(true);
        switch ($this->getInputType()) {
            case self::IMPORT_FILE:
                $root = simplexml_load_string(file_get_contents($this->getInputFile()));
                break;
        }
        libxml_use_internal_errors($use_internal_errors);
        if (!$root instanceof SimpleXMLElement) {
            throw new ilDidacticTemplateImportException(
                $this->parseXmlErrors()
            );
        }
        $settings = $this->parseSettings($root);
        $this->parseActions($settings, $root->didacticTemplate->actions);
        return $settings;
    }

    public function validateImportFile(): ilImportStatusCollectionInterface
    {
        $status = new ilImportStatusFactory();
        if ($this->getInputType() !== self::IMPORT_FILE) {
            return $status->collection()->withAddedStatus($status->handler()
                ->withType(StatusType::FAILED)
                ->withContent($status->content()->builder()->string()
                    ->withString("Invalid import status, import status 'IMPORT_FILE' expected.")));
        }
        $import = new ilImportHandlerFactory();
        $xml_spl_info = new SplFileInfo($this->getInputFile());
        $xsd_schema_info = $import->schemaFolder()->handler()->getLatest(self::SCHEMA_TYPE);
        $xml_file_handler = $import->file()->xml()->handler()->withFileInfo($xml_spl_info);
        $xsd_file_handler = $import->file()->xsd()->handler()->withFileInfo($xsd_schema_info->getFile());
        return $import->validation()->handler()->validateXMLFile($xml_file_handler, $xsd_file_handler);
    }

    protected function parseSettings(SimpleXMLElement $root): ilDidacticTemplateSetting
    {
        $icon = '';
        $setting = new ilDidacticTemplateSetting();
        foreach ($root->didacticTemplate as $tpl) {
            switch ((string) $tpl->attributes()->type) {
                case 'creation':
                default:
                    $setting->setType(ilDidacticTemplateSetting::TYPE_CREATION);
                    break;
            }
            $setting->setTitle(trim((string) $tpl->title));
            $setting->setDescription(trim((string) $tpl->description));

            $icon = (string) $tpl->icon;

            $info = '';
            foreach ((array) $tpl->info->p as $paragraph) {
                if ($info !== '') {
                    $info .= "\n";
                }
                $info .= trim((string) $paragraph);
            }
            $setting->setInfo($info);

            if (isset($tpl->effectiveFrom) && (string) $tpl->effectiveFrom["nic_id"] == $this->settings->get('inst_id')) {
                $node = array();
                foreach ($tpl->effectiveFrom->node as $element) {
                    $node[] = (int) $element;
                }

                $setting->setEffectiveFrom($node);
            }

            if (isset($tpl->exclusive)) {
                $setting->setExclusive(true);
            }

            foreach ($tpl->assignments->assignment as $element) {
                $setting->addAssignment(trim((string) $element));
            }
        }
        $setting->save();

        if ($icon !== '' && $this->canUseIcons($setting)) {
            $setting->getIconHandler()->writeSvg($icon);
        }
        $trans = ilMultilingualism::getInstance($setting->getId(), "dtpl");
        if (isset($root->didacticTemplate->translations)) {
            $trans->fromXML($root->didacticTemplate->translations);
        }
        $trans->save();

        return $setting;
    }

    protected function canUseIcons(ilDidacticTemplateSetting $setting): bool
    {
        foreach ($setting->getAssignments() as $assignment) {
            if (!$this->objDefinition->isContainer($assignment)) {
                return false;
            }
        }

        return true;
    }

    protected function parseLocalRoleAction(
        ilDidacticTemplateSetting $didactic_template_setting,
        SimpleXMLElement $local_role_action
    ): void {
        $act = new ilDidacticTemplateLocalRoleAction();
        $act->setTemplateId($didactic_template_setting->getId());

        foreach ($local_role_action->roleTemplate as $tpl) {
            // extract role
            foreach ($tpl->role as $roleDef) {
                $rimporter = new ilRoleXmlImporter(ROLE_FOLDER_ID);
                $role_id = $rimporter->importSimpleXml($roleDef);
                $act->setRoleTemplateId($role_id);
            }
            $act->save();
        }
    }

    protected function parseBlockRoleAction(
        ilDidacticTemplateSetting $didactic_template_setting,
        SimpleXMLElement $block_role_action
    ): void {
        $act = new ilDidacticTemplateBlockRoleAction();
        $act->setTemplateId($didactic_template_setting->getId());
        // Role filter
        foreach ($block_role_action->roleFilter as $rfi) {
            switch ((string) $rfi->attributes()->source) {
                case 'title':
                    $act->setFilterType(\ilDidacticTemplateAction::FILTER_SOURCE_TITLE);
                    break;

                case 'objId':
                    $act->setFilterType(\ilDidacticTemplateAction::FILTER_SOURCE_OBJ_ID);
                    break;
                case 'parentRoles':
                    $act->setFilterType(\ilDidacticTemplateAction::FILTER_PARENT_ROLES);
                    break;
            }
            foreach ($rfi->includePattern as $pat) {
                // @TODO other subtypes
                $pattern = new ilDidacticTemplateIncludeFilterPattern();
                $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                $pattern->setPattern((string) $pat->attributes()->preg);
                $act->addFilterPattern($pattern);
            }
            foreach ($rfi->excludePattern as $pat) {
                // @TODO other subtypes
                $pattern = new ilDidacticTemplateExcludeFilterPattern();
                $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                $pattern->setPattern((string) $pat->attributes()->preg);
                $act->addFilterPattern($pattern);
            }
        }
        $act->save();
    }

    protected function parseLocalPolicyAction(
        ilDidacticTemplateSetting $didactic_template_setting,
        SimpleXMLElement $local_policy_action
    ): void {
        $act = new ilDidacticTemplateLocalPolicyAction();
        $act->setTemplateId($didactic_template_setting->getId());
        // Role filter
        foreach ($local_policy_action->roleFilter as $rfi) {
            $this->logger->dump($rfi->attributes(), \ilLogLevel::DEBUG);
            $this->logger->debug(
                'Current filter source: ' . $rfi->attributes()->source
            );
            switch ((string) $rfi->attributes()->source) {
                case 'title':
                    $act->setFilterType(\ilDidacticTemplateAction::FILTER_SOURCE_TITLE);
                    break;
                case 'objId':
                    $act->setFilterType(\ilDidacticTemplateAction::FILTER_SOURCE_OBJ_ID);
                    break;
                case 'parentRoles':
                    $act->setFilterType(\ilDidacticTemplateAction::FILTER_PARENT_ROLES);
                    break;
                case 'localRoles':
                    $act->setFilterType(\ilDidacticTemplateAction::FILTER_LOCAL_ROLES);
                    break;
            }
            foreach ($rfi->includePattern as $pat) {
                // @TODO other subtypes
                $pattern = new ilDidacticTemplateIncludeFilterPattern();
                $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                $pattern->setPattern((string) $pat->attributes()->preg);
                $act->addFilterPattern($pattern);
            }
            foreach ($rfi->excludePattern as $pat) {
                // @TODO other subtypes
                $pattern = new ilDidacticTemplateExcludeFilterPattern();
                $pattern->setPatternSubType(ilDidacticTemplateFilterPattern::PATTERN_SUBTYPE_REGEX);
                $pattern->setPattern((string) $pat->attributes()->preg);
                $act->addFilterPattern($pattern);
            }
        }
        // role template assignment
        foreach ($local_policy_action->localPolicyTemplate as $lpo) {
            switch ((string) $lpo->attributes()->type) {
                case 'overwrite':
                    $act->setRoleTemplateType(ilDidacticTemplateLocalPolicyAction::TPL_ACTION_OVERWRITE);
                    break;
                case 'union':
                    $act->setRoleTemplateType(ilDidacticTemplateLocalPolicyAction::TPL_ACTION_UNION);
                    break;
                case 'intersect':
                    $act->setRoleTemplateType(ilDidacticTemplateLocalPolicyAction::TPL_ACTION_INTERSECT);
                    break;
            }
            // extract role
            foreach ($lpo->role as $roleDef) {
                try {
                    $rimporter = new ilRoleXmlImporter(ROLE_FOLDER_ID);
                    $role_id = $rimporter->importSimpleXml($roleDef);
                    $act->setRoleTemplateId($role_id);
                } catch (ilRoleImporterException $e) {
                    // delete half-imported template
                    $didactic_template_setting->delete();
                    throw new ilDidacticTemplateImportException($e->getMessage());
                }
            }
        }
        // Save action including all filter patterns
        $act->save();
    }

    protected function parseActions(ilDidacticTemplateSetting $set, ?SimpleXMLElement $actions = null): void
    {
        if ($actions === null) {
            return;
        }
        foreach ($actions->children() as $action) {
            if ($action->getName() === self::XML_ELEMENT_NAME_LOCAL_ROLE_ACTION) {
                $this->parseLocalRoleAction($set, $action);
                continue;
            }
            if ($action->getName() === self::XML_ELEMENT_NAME_BLOCK_ROLE_ACIONE) {
                $this->parseBlockRoleAction($set, $action);
                continue;
            }
            if ($action->getName() === self::XML_ELEMENT_NAME_LOCAL_POLICY_ACTION) {
                $this->parseLocalPolicyAction($set, $action);
                continue;
            }
        }
    }

    protected function parseXmlErrors(): string
    {
        $errors = '';
        foreach (libxml_get_errors() as $err) {
            $errors .= $err->code . '<br/>';
        }
        return $errors;
    }
}