class.ilContainerImporter.php

Go to the documentation of this file.

<?php

class ilContainerImporter extends ilXmlImporter
{
    private string $structure_xml;
    protected ilLogger $cont_log;
    protected \ILIAS\Skill\Service\SkillProfileService $skill_profile_service;

    public function init(): void
    {
        global $DIC;

        $this->cont_log = ilLoggerFactory::getLogger('cont');
        $this->skill_profile_service = $DIC->skills()->profile();
    }

    public function importXmlRepresentation(string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping): void
    {
        $this->structure_xml = $a_xml;
        $this->cont_log->debug('Import xml: ' . $a_xml);
        $this->cont_log->debug('Using id: ' . $a_id);

        $parser = new ilContainerXmlParser($a_mapping, trim($a_xml));
        $parser->parse($a_id);
    }

    public function finalProcessing(ilImportMapping $a_mapping): void
    {
        $this->handleOfflineStatus($this->structure_xml, $a_mapping);
        // pages
        $page_map = $a_mapping->getMappingsOfEntity('components/ILIAS/COPage', 'pg');
        foreach ($page_map as $old_pg_id => $new_pg_id) {
            $parts = explode(':', $old_pg_id);
            $pg_type = $parts[0];
            $old_obj_id = $parts[1];
            $parts = explode(':', $new_pg_id);
            $new_pg_id = array_pop($parts);
            $new_obj_id = $a_mapping->getMapping('components/ILIAS/Container', 'objs', $old_obj_id);
            // see bug #22718, this missed a check for the pg type
            if ($new_obj_id > 0 && in_array($pg_type, ["crs", "grp", "fold", "cont"], true)) {
                ilPageObject::_writeParentId($pg_type, (int) $new_pg_id, (int) $new_obj_id);
                $this->cont_log->debug('write parent id, type: ' . $pg_type . ", page id: " . $new_pg_id . ", parent id: " . $new_obj_id);
            }
        }

        // style
        $sty_map = $a_mapping->getMappingsOfEntity('components/ILIAS/Style', 'sty');
        foreach ($sty_map as $old_sty_id => $new_sty_id) {
            if (isset(ilContainerXmlParser::$style_map[$old_sty_id])) {
                foreach (ilContainerXmlParser::$style_map[$old_sty_id] as $obj_id) {
                    ilObjStyleSheet::writeStyleUsage((int) $obj_id, (int) $new_sty_id);
                }
            }
        }

        // skills
        $crs_map = $a_mapping->getMappingsOfEntity('components/ILIAS/Course', 'crs');
        $new_crs_obj_id = end($crs_map);
        $new_crs_ref_ids = ilObject::_getAllReferences((int) $new_crs_obj_id);
        $new_crs_ref_id = end($new_crs_ref_ids);

        $skl_local_prof_map = $a_mapping->getMappingsOfEntity('components/ILIAS/Skill', 'skl_local_prof');
        foreach ($skl_local_prof_map as $old_prof_id => $new_prof_id) {
            $this->skill_profile_service->updateProfileRefIdAfterImport((int) $new_prof_id, (int) $new_crs_ref_id);
            $this->skill_profile_service->addRoleToProfile(
                (int) $new_prof_id,
                ilParticipants::getDefaultMemberRole((int) $new_crs_ref_id)
            );
        }
    }

    protected function handleOfflineStatus(string $xml, ilImportMapping $mapping): void
    {
        $use_internal_errors = libxml_use_internal_errors(true);
        $root = simplexml_load_string($xml);
        libxml_use_internal_errors($use_internal_errors);
        if ($root === false) {
            $errors = '';
            foreach (libxml_get_errors() as $err) {
                $errors .= $err->code . '<br/>';
            }
            $this->cont_log->error($xml);
            $this->cont_log->error('Cannot parse xml: ' . $errors);
        }
        foreach ($root->xpath('//Item') as $item) {
            $ref_id = 0;
            $offline = null;
            foreach ($item->attributes() as $name => $value) {
                if ((string) $name === 'Offline') {
                    $offline = $value;
                }
                if ((string) $name === 'RefId') {
                    $ref_id = (string) $value;
                }
            }
            if (is_null($offline)) {
                $this->cont_log->debug('No offline handling for ref_id: ' . $ref_id);
                continue;
            }
            $new_ref_id = $mapping->getMapping('components/ILIAS/Container', 'refs', $ref_id);
            $obj = ilObjectFactory::getInstanceByRefId((int) $new_ref_id, false);
            if (!$obj instanceof ilObject) {
                $this->cont_log->warning('Cannot create instance for ref_id: ' . $new_ref_id);
                continue;
            }
            if ($obj->supportsOfflineHandling()) {
                if ($this->isRootNode($obj->getRefId(), $mapping)) {
                    $obj->setOfflineStatus(true);
                } else {
                    // use the offline status of the imported XML file and set the offline status for the new container objects accordingly
                    $obj->setOfflineStatus(!((string) $offline === "0"));
                }
                $obj->update();
            }
        }
    }

    protected function isRootNode(int $ref_id, ilImportMapping $mapping): bool
    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        $parent_id = $tree->getParentId($ref_id);
        if ($parent_id) {
            return $parent_id === $mapping->getTargetId();
        }
        return false;
    }
}