class.ilStyleDataSet.php

Go to the documentation of this file.

<?php
 
use ILIAS\Style\Content\Access;
use ILIAS\Style\Content;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\Dataset\IRSSContainerExportConfig;
 
class ilStyleDataSet extends ilDataSet
{
    protected Content\DomainService $content_style_domain;
    protected Content\InternalDomainService $style_domain;
    protected ?ilObjStyleSheet $current_obj = null;
    protected Content\InternalRepoService $repo;
    protected ilLogger $log;
    protected ilRbacSystem $rbacsystem;
    protected \ilObjUser $user;
 
    public function __construct()
    {
        global $DIC;
 
        $this->db = $DIC->database();
        parent::__construct();
        $this->log = ilLoggerFactory::getLogger('styl');
        $this->log->debug("constructed");
        $this->rbacsystem = $DIC->rbac()->system();
        $this->user = $DIC->user();
        $this->style_domain = $DIC->contentStyle()->internal()->domain();
        $this->content_style_domain = $DIC->contentStyle()->domain();
        $this->repo = $DIC->contentStyle()->internal()->repo();
    }
 
 
    public function getSupportedVersions(): array
    {
        return array("10.0", "8.0", "5.1.0");
    }
 
    public function getXmlNamespace(string $a_entity, string $a_schema_version): string
    {
        return "http://www.ilias.de/xml/Services/Style/" . $a_entity;
    }
 
    protected function getTypes(string $a_entity, string $a_version): array
    {
        if ($a_entity == "sty") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "ImagesDir" => "directory"
                    );
                case "10.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "StyleContainer" => "rscontainer"
                    );
            }
        }
 
        if ($a_entity == "object_style") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    return array(
                            "ObjectId" => "integer"
                        );
            }
        }
 
        if ($a_entity == "sty_setting") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    return array(
                        "StyleId" => "integer",
                        "Name" => "test",
                        "Value" => "text"
                    );
            }
        }
 
        if ($a_entity == "sty_char") {
            switch ($a_version) {
                case "5.1.0":
                    return array(
                        "StyleId" => "integer",
                        "Type" => "text",
                        "Characteristic" => "text",
                        "Hide" => "integer"
                    );
                case "8.0":
                case "10.0":
                    return array(
                        "StyleId" => "integer",
                        "Type" => "text",
                        "Characteristic" => "text",
                        "Hide" => "integer",
                        "OrderNr" => "integer",
                        "Outdate" => "integer"
                    );
            }
        }
 
        if ($a_entity == "sty_char_title") {
            switch ($a_version) {
                case "8.0":
                case "10.0":
                    return array(
                        "StyleId" => "integer",
                        "Type" => "text",
                        "Characteristic" => "text",
                        "Lang" => "text",
                        "Title" => "text"
                    );
            }
        }
 
        if ($a_entity == "sty_parameter") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    return array(
                        "StyleId" => "integer",
                        "Tag" => "text",
                        "Class" => "text",
                        "Parameter" => "text",
                        "Value" => "text",
                        "Type" => "text",
                        "MqId" => "integer",
                        "Custom" => "integer"
                    );
            }
        }
 
        if ($a_entity == "sty_color") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    return array(
                        "StyleId" => "integer",
                        "ColorName" => "text",
                        "ColorCode" => "text"
                    );
            }
        }
 
        if ($a_entity == "sty_media_query") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    return array(
                        "Id" => "integer",
                        "StyleId" => "integer",
                        "OrderNr" => "integer",
                        "MQuery" => "text"
                    );
            }
        }
 
        if ($a_entity == "sty_template") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    return array(
                        "Id" => "integer",
                        "StyleId" => "integer",
                        "Name" => "text",
                        "Preview" => "text",
                        "TempType" => "text"
                    );
            }
        }
 
        if ($a_entity == "sty_template_class") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    return array(
                        "TemplateId" => "integer",
                        "ClassType" => "text",
                        "Class" => "text"
                    );
            }
        }
 
        if ($a_entity == "sty_usage") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    return array(
                        "ObjId" => "integer",
                        "StyleId" => "integer"
                    );
            }
        }
    }
 
    public function getXmlRecord(string $a_entity, string $a_version, array $a_set): array
    {
        if ($a_entity == "sty") {
            $a_set["StyleContainer"] = serialize($this->style_domain->style((int) $a_set["Id"])->getResourceIdentification());
        }
 
        return $a_set;
    }
 
    public function readData(string $a_entity, string $a_version, array $a_ids): void
    {
        $ilDB = $this->db;
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
 
        if ($a_entity == "object_style") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    foreach ($a_ids as $id) {
                        $this->data[] = array("ObjectId" => $id);
                    }
                    break;
            }
        }
 
        if ($a_entity == "sty") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT o.title, o.description, o.obj_id id" .
                        " FROM object_data o " .
                        " WHERE " . $ilDB->in("o.obj_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "sty_setting") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT style_id, name, value" .
                        " FROM style_setting " .
                        " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "sty_char") {
            switch ($a_version) {
                case "5.1.0":
                    $this->getDirectDataFromQuery("SELECT style_id, type, characteristic, hide" .
                        " FROM style_char " .
                        " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                    // no break
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT style_id, type, characteristic, hide, order_nr, outdated" .
                        " FROM style_char " .
                        " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "sty_char_title") {
            switch ($a_version) {
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT style_id, type, characteristic, lang, title" .
                        " FROM style_char_title " .
                        " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "sty_parameter") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT style_id, tag, class, parameter, value, type, mq_id, custom" .
                        " FROM style_parameter " .
                        " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "sty_color") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT style_id, color_name, color_code" .
                        " FROM style_color " .
                        " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "sty_media_query") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT id, style_id, order_nr, mquery m_query" .
                        " FROM sty_media_query " .
                        " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "sty_template") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT id, style_id, name, preview, temp_type" .
                        " FROM style_template " .
                        " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "sty_template_class") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT template_id, class_type, class" .
                        " FROM style_template_class " .
                        " WHERE " . $ilDB->in("template_id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "sty_usage") {
            switch ($a_version) {
                case "5.1.0":
                case "8.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT obj_id, style_id" .
                        " FROM style_usage " .
                        " WHERE " . $ilDB->in("style_id", $a_ids, false, "integer"));
                    break;
            }
        }
    }
 
    public function getContainerExportConfig(
        array $record,
        string $entity,
        string $schema_version,
        string $field,
        string $value
    ): ?IRSSContainerExportConfig {
        if ($entity === "sty" && $field === "StyleContainer") {
            $rid = $this->style_domain->style((int) $record["Id"])->getResourceIdentification();
            if ($rid) {
                $container = $this->irss->manageContainer()->getResource($rid);
                return
                    $this->getIRSSContainerExportConfig(
                        $container,
                        "images"
                    );
            }
        }
        return null;
    }
 
 
    protected function getDependencies(
        string $a_entity,
        string $a_version,
        ?array $a_rec = null,
        ?array $a_ids = null
    ): array {
        $this->ds_log->debug("entity: " . $a_entity . ", rec: " . print_r($a_rec, true));
        switch ($a_entity) {
            case "object_style":
                $this->ds_log->debug("object id: " . ($a_rec["ObjectId"] ?? null));
                $style_id = $this->content_style_domain->styleForObjId($a_rec["ObjectId"] ?? 0)->getExportStyleId();
                $this->ds_log->debug("style id: " . $style_id);
                //if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id))
                if ($style_id > 0 && ilObject::_lookupType($style_id) == "sty") {                       // #0019337 always export style, if valid
                    return array(
                        "sty" => array("ids" => $style_id));
                }
                return array();
                break;
 
            case "sty":
                return array(
                    "sty_setting" => array("ids" => $a_rec["Id"] ?? null),
                    "sty_media_query" => array("ids" => $a_rec["Id"] ?? null),
                    "sty_char" => array("ids" => $a_rec["Id"] ?? null),
                    "sty_char_title" => array("ids" => $a_rec["Id"] ?? null),
                    "sty_color" => array("ids" => $a_rec["Id"] ?? null),
                    "sty_parameter" => array("ids" => $a_rec["Id"] ?? null),
                    "sty_template" => array("ids" => $a_rec["Id"] ?? null),
                    "sty_usage" => array("ids" => $a_rec["Id"] ?? null)
                );
 
            case "sty_template":
                return array(
                    "sty_template_class" => array("ids" => $a_rec["Id"] ?? null)
                );
        }
 
        return [];
    }
 
 
    public function importRecord(string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version): void
    {
        global $DIC;
        $service = $DIC->contentStyle()->internal();
        $access_manager = $service->domain()->access(
            0,
            $this->user->getId()
        );
        $access_manager->enableWrite(true);
 
        $style_id = (isset($this->current_obj))
            ? $this->current_obj->getId()
            : 0;
        $characteristic_manager = $service->domain()->characteristic(
            $style_id,
            $access_manager
        );
 
        $color_manager = $service->domain()->color(
            $style_id,
            $access_manager
        );
 
        $a_rec = $this->stripTags($a_rec);
        switch ($a_entity) {
            case "sty":
                $this->log->debug("Entity: " . $a_entity);
                if ($new_id = $a_mapping->getMapping('components/ILIAS/Container', 'objs', $a_rec['Id'])) {
                    $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                } else {
                    $newObj = new ilObjStyleSheet();
                    $newObj->create(0, true);
                }
 
                $newObj->setTitle($a_rec["Title"]);
                $newObj->setDescription($a_rec["Description"]);
                $newObj->update(true);
 
                $this->current_obj = $newObj;
                $a_mapping->addMapping("components/ILIAS/Style", "sty", $a_rec["Id"], $newObj->getId());
                $a_mapping->addMapping("components/ILIAS/ILIASObject", "obj", $a_rec["Id"], $newObj->getId());
                $this->log->debug("Added mapping Services/Style sty  " . $a_rec["Id"] . " > " . $newObj->getId());
 
                // up to 9
                $dir = str_replace("..", "", $a_rec["ImagesDir"] ?? "");
                if ($dir != "" && $this->getImportDirectory() != "") {
                    $source_dir = $this->getImportDirectory() . "/" . $dir;
                    $sm = $this->style_domain->style($newObj->getId());
                    $sm->createContainerFromLocalDir($source_dir, "images", false);
                }
 
                $dir = str_replace("..", "", ($a_rec["StyleContainer"] ?? ""));
                if ($dir != "" && $this->getImportDirectory() != "") {
                    $source_dir = $this->getImportDirectory() . "/" . $dir;
                    if (is_dir($source_dir)) {
                        $sm = $this->style_domain->style($newObj->getId());
                        $sm->createContainerFromLocalDir($source_dir, "images", false);
                    }
                }
                break;
 
            case "sty_setting":
                $this->current_obj->writeStyleSetting($a_rec["Name"], $a_rec["Value"]);
                break;
 
            case "sty_char":
                $this->current_obj->addCharacteristic($a_rec["Type"], $a_rec["Characteristic"], $a_rec["Hide"], (int) ($a_rec["OrderNr"] ?? 0), (bool) ($a_rec["Outdated"] ?? false));
                break;
 
            case "sty_char_title":
                $char_repo = $this->repo->characteristic();
                $char_repo->addTitle(
                    $this->current_obj->getId(),
                    $a_rec["Type"],
                    $a_rec["Characteristic"],
                    $a_rec["Lang"],
                    $a_rec["Title"],
                );
                break;
 
            case "sty_parameter":
                $mq_id = (int) $a_mapping->getMapping("components/ILIAS/Style", "media_query", $a_rec["MqId"]);
                $characteristic_manager->replaceParameter($a_rec["Tag"], $a_rec["Class"], $a_rec["Parameter"], $a_rec["Value"], $a_rec["Type"], $mq_id, $a_rec["Custom"]);
                break;
 
            case "sty_color":
                $color_manager->addColor($a_rec["ColorName"], $a_rec["ColorCode"]);
                break;
 
            case "sty_media_query":
                $mq_id = $this->current_obj->addMediaQuery($a_rec["MQuery"], $a_rec["OrderNr"]);
                $a_mapping->addMapping("components/ILIAS/Style", "media_query", $a_rec["Id"], $mq_id);
                break;
 
            case "sty_template":
                $tid = $this->current_obj->addTemplate($a_rec["TempType"], $a_rec["Name"], array());
                $a_mapping->addMapping("components/ILIAS/Style", "template", $a_rec["Id"], $tid);
                break;
 
            case "sty_template_class":
                $tid = (int) $a_mapping->getMapping("components/ILIAS/Style", "template", $a_rec["TemplateId"]);
                $this->current_obj->addTemplateClass($tid, $a_rec["ClassType"], $a_rec["Class"]);
                break;
 
            case "sty_usage":
                $obj_id = (int) $a_mapping->getMapping("components/ILIAS/ILIASObject", "obj", $a_rec["ObjId"]);
                $style_id = (int) $a_mapping->getMapping("components/ILIAS/Style", "sty", $a_rec["StyleId"]);
                if ($obj_id > 0 && $style_id > 0) {
                    ilObjStyleSheet::writeStyleUsage($obj_id, $style_id);
                    ilObjStyleSheet::writeOwner($obj_id, $style_id);
                }
                break;
        }
    }
}