class.ilBlogDataSet.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Notes\Service;
use ILIAS\Blog\ReadingTime\ReadingTimeManager;

class ilBlogDataSet extends ilDataSet
{
    protected ReadingTimeManager $reading_time;
    protected Service $notes;
    protected ilObjBlog $current_blog;
    public static array $style_map = array();
    protected \ILIAS\Style\Content\DomainService $content_style_domain;

    public function __construct()
    {
        global $DIC;
        parent::__construct();
        $this->content_style_domain = $DIC
            ->contentStyle()
            ->domain();
        $this->notes = $DIC->notes();
        $this->reading_time = $DIC->blog()->internal()->domain()->readingTime();
    }

    public function getSupportedVersions(): array
    {
        return array("4.3.0", "5.0.0", "5.3.0", "8.0");
    }

    protected function getXmlNamespace(
        string $a_entity,
        string $a_schema_version
    ): string {

        if ($a_entity === 'blog' || $a_entity == 'blog_posting') {
            // they share the same xsd, therfore the same namespace
            return "http://www.ilias.de/xml/Modules/Blog/blog";
        }
        return "http://www.ilias.de/xml/Modules/Blog/" . $a_entity;
    }

    protected function getTypes(
        string $a_entity,
        string $a_version
    ): array {
        if ($a_entity === "blog") {
            switch ($a_version) {
                case "4.3.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Notes" => "integer",
                        "BgColor" => "text",
                        "FontColor" => "text",
                        "Img" => "text",
                        "Ppic" => "integer",
                        "RssActive" => "integer",
                        "Approval" => "integer",
                        "Dir" => "directory"
                    );

                case "5.0.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Notes" => "integer",
                        "BgColor" => "text",
                        "FontColor" => "text",
                        "Img" => "text",
                        "Ppic" => "integer",
                        "RssActive" => "integer",
                        "Approval" => "integer",
                        "Dir" => "directory",
                        "AbsShorten" => "integer",
                        "AbsShortenLen" => "integer",
                        "AbsImage" => "integer",
                        "AbsImgWidth" => "integer",
                        "AbsImgHeight" => "integer",
                        "NavMode" => "integer",
                        "NavListPost" => "integer",
                        "NavListMon" => "integer",
                        "Keywords" => "integer",
                        "Authors" => "integer",
                        "NavOrder" => "text",
                        "OvPost" => "integer",
                        "Style" => "integer"
                    );

                case "5.3.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Notes" => "integer",
                        "BgColor" => "text",
                        "FontColor" => "text",
                        "Img" => "text",
                        "Ppic" => "integer",
                        "RssActive" => "integer",
                        "Approval" => "integer",
                        "Dir" => "directory",
                        "AbsShorten" => "integer",
                        "AbsShortenLen" => "integer",
                        "AbsImage" => "integer",
                        "AbsImgWidth" => "integer",
                        "AbsImgHeight" => "integer",
                        "NavMode" => "integer",
                        "NavListMonWithPost" => "integer",
                        "NavListMon" => "integer",
                        "Keywords" => "integer",
                        "Authors" => "integer",
                        "NavOrder" => "text",
                        "OvPost" => "integer",
                        "Style" => "integer"
                    );

                case "8.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Notes" => "integer",
                        "BgColor" => "text",
                        "FontColor" => "text",
                        "Img" => "text",
                        "Ppic" => "integer",
                        "RssActive" => "integer",
                        "Approval" => "integer",
                        "Dir" => "directory",
                        "AbsShorten" => "integer",
                        "AbsShortenLen" => "integer",
                        "AbsImage" => "integer",
                        "AbsImgWidth" => "integer",
                        "AbsImgHeight" => "integer",
                        "NavMode" => "integer",
                        "NavListMonWithPost" => "integer",
                        "NavListMon" => "integer",
                        "Keywords" => "integer",
                        "Authors" => "integer",
                        "NavOrder" => "text",
                        "OvPost" => "integer",
                        "Style" => "integer",
                        "ReadingTime" => "integer"
                    );
            }
        }

        if ($a_entity === "blog_posting") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.0":
                case "5.3.0":
                case "8.0":
                    return array(
                        "Id" => "integer",
                        "BlogId" => "integer",
                        "Title" => "integer",
                        "Created" => "text",
                        "Author" => "text",
                        "Approved" => "integer",
                        "LastWithdrawn" => "text"
                    );
            }
        }
        return [];
    }

    public function readData(
        string $a_entity,
        string $a_version,
        array $a_ids
    ): void {
        $ilDB = $this->db;

        if ($a_entity === "blog") {
            switch ($a_version) {
                case "4.3.0":
                    $this->getDirectDataFromQuery(
                        "SELECT bl.id,od.title,od.description," .
                        "bl.notes,bl.bg_color,bl.font_color,bl.img,bl.ppic,bl.rss_active,bl.approval" .
                        " FROM il_blog bl" .
                        " JOIN object_data od ON (od.obj_id = bl.id)" .
                        " WHERE " . $ilDB->in("bl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("blog", "text")
                    );
                    break;

                case "5.0.0":
                    $this->getDirectDataFromQuery(
                        "SELECT bl.id,od.title,od.description," .
                        "bl.bg_color,bl.font_color,bl.img,bl.ppic,bl.rss_active,bl.approval," .
                        "bl.abs_shorten,bl.abs_shorten_len,bl.abs_image,bl.abs_img_width,bl.abs_img_height," .
                        "bl.nav_mode,bl.nav_list_post,bl.nav_list_mon,bl.keywords,bl.authors,bl.nav_order," .
                        "bl.ov_post" .
                        " FROM il_blog bl" .
                        " JOIN object_data od ON (od.obj_id = bl.id)" .
                        " WHERE " . $ilDB->in("bl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("blog", "text")
                    );
                    break;

                case "5.3.0":
                    $this->getDirectDataFromQuery(
                        "SELECT bl.id,od.title,od.description," .
                        "bl.bg_color,bl.font_color,bl.img,bl.ppic,bl.rss_active,bl.approval," .
                        "bl.abs_shorten,bl.abs_shorten_len,bl.abs_image,bl.abs_img_width,bl.abs_img_height," .
                        "bl.nav_mode,bl.nav_list_mon_with_post,bl.nav_list_mon,bl.keywords,bl.authors,bl.nav_order," .
                        "bl.ov_post" .
                        " FROM il_blog bl" .
                        " JOIN object_data od ON (od.obj_id = bl.id)" .
                        " WHERE " . $ilDB->in("bl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("blog", "text")
                    );
                    break;

                case "8.0":
                    $this->getDirectDataFromQuery(
                        "SELECT bl.id,od.title,od.description," .
                        "bl.bg_color,bl.font_color,bl.img,bl.ppic,bl.rss_active,bl.approval," .
                        "bl.abs_shorten,bl.abs_shorten_len,bl.abs_image,bl.abs_img_width,bl.abs_img_height," .
                        "bl.nav_mode,bl.nav_list_mon_with_post,bl.nav_list_mon,bl.keywords,bl.authors,bl.nav_order," .
                        "bl.ov_post" .
                        " FROM il_blog bl" .
                        " JOIN object_data od ON (od.obj_id = bl.id)" .
                        " WHERE " . $ilDB->in("bl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("blog", "text")
                    );
                    foreach ($this->data as $idx => $item) {
                        $this->data[$idx]["ReadingTime"] = (int) $this->reading_time->isActivated((int) $item["Id"]);
                    }
                    break;
            }
        }

        if ($a_entity === "blog_posting") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.0":
                case "5.3.0":
                case "8.0":
                    $this->getDirectDataFromQuery(
                        "SELECT id,blog_id,title,created,author,approved,last_withdrawn" .
                        " FROM il_blog_posting WHERE " .
                        $ilDB->in("blog_id", $a_ids, false, "integer")
                    );
                    foreach ($this->data as $idx => $item) {
                        // create full export id
                        $this->data[$idx]["Author"] = $this->createObjectExportId("usr", (string) $item["Author"]);
                    }
                    break;
            }

            // keywords
            foreach ($this->data as $idx => $item) {
                $blog_id = ilBlogPosting::lookupBlogId($item["Id"]);
                $keywords = ilBlogPosting::getKeywords($blog_id, $item["Id"]);
                if ($keywords) {
                    foreach ($keywords as $kidx => $keyword) {
                        $this->data[$idx]["Keyword" . $kidx] = $keyword;
                    }
                }
            }
        }
    }

    protected function getDependencies(
        string $a_entity,
        string $a_version,
        ?array $a_rec = null,
        ?array $a_ids = null
    ): array {
        if ($a_entity === "blog") {
            return array(
                "blog_posting" => array("ids" => $a_rec["Id"] ?? null)
            );
        }
        return [];
    }

    public function getXmlRecord(
        string $a_entity,
        string $a_version,
        array $a_set
    ): array {
        if ($a_entity === "blog") {
            $style = $this->content_style_domain->styleForObjId((int) $a_set["Id"]);

            $dir = ilObjBlog::initStorage($a_set["Id"]);
            $a_set["Dir"] = $dir;

            $a_set["Style"] = $style->getStyleId();

            // #14734
            $a_set["Notes"] = $this->notes->domain()->commentsActive((int) $a_set["Id"]);
        }

        return $a_set;
    }

    public function importRecord(
        string $a_entity,
        array $a_types,
        array $a_rec,
        ilImportMapping $a_mapping,
        string $a_schema_version
    ): void {
        $a_rec = $this->stripTags($a_rec);
        switch ($a_entity) {
            case "blog":

                // container copy
                if ($new_id = $a_mapping->getMapping("Services/Container", "objs", $a_rec["Id"])) {
                    $newObj = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
                } else {
                    $newObj = new ilObjBlog();
                    $newObj->create();
                }

                $newObj->setTitle($a_rec["Title"] ?? "");
                $newObj->setDescription($a_rec["Description"] ?? "");
                $newObj->setNotesStatus((bool) ($a_rec["Notes"] ?? false));
                $newObj->setBackgroundColor($a_rec["BgColor"] ?? "");
                $newObj->setFontColor($a_rec["FontColor"] ?? "");
                $newObj->setProfilePicture((bool) ($a_rec["Ppic"] ?? false));
                $newObj->setRSS((bool) ($a_rec["RssActive"] ?? false));
                $newObj->setApproval((bool) ($a_rec["Approval"] ?? false));
                $newObj->setImage($a_rec["Img"] ?? "");

                $newObj->setAbstractShorten((bool) ($a_rec["AbsShorten"] ?? false));
                $newObj->setAbstractShortenLength((int) ($a_rec["AbsShortenLen"] ?? 0));
                $newObj->setAbstractImage((bool) ($a_rec["AbsImage"] ?? 0));
                $newObj->setAbstractImageWidth((int) ($a_rec["AbsImgWidth"] ?? 0));
                $newObj->setAbstractImageHeight((int) ($a_rec["AbsImgHeight"] ?? 0));
                $newObj->setNavMode((int) ($a_rec["NavMode"] ?? 0));
                if (($a_rec["NavListMonWithPost"] ?? 0) == 0) {
                    $newObj->setNavModeListMonthsWithPostings(3);
                } else {
                    $newObj->setNavModeListMonthsWithPostings((int) $a_rec["NavListMonWithPost"]);
                }
                //$newObj->setNavModeListPostings($a_rec["NavListPost"]);
                if (($nav_list_months = $a_rec["NavListMon"] ?? null) !== null) {
                    $nav_list_months = (int) $nav_list_months;
                }
                $newObj->setNavModeListMonths($nav_list_months);
                $newObj->setKeywords((bool) ($a_rec["Keywords"] ?? false));
                $newObj->setAuthors((bool) ($a_rec["Authors"] ?? false));
                $newObj->setOrder(
                    trim($a_rec["NavOrder"])
                        ? explode(";", $a_rec["NavOrder"])
                        : []
                );
                if (($ov_post = $a_rec["OvPost"] ?? null) !== null) {
                    $ov_post = (int) $ov_post;
                }
                $newObj->setOverviewPostings($ov_post);

                $newObj->update();

                // handle image(s)
                if ($a_rec["Img"] ?? false) {
                    $dir = str_replace("..", "", $a_rec["Dir"]);
                    if ($dir !== "" && $this->getImportDirectory() !== "") {
                        $source_dir = $this->getImportDirectory() . "/" . $dir;
                        $target_dir = ilObjBlog::initStorage($newObj->getId());
                        ilFileUtils::rCopy($source_dir, $target_dir);
                    }
                }

                if ($a_rec["Style"] ?? false) {
                    self::$style_map[$a_rec["Style"]][] = $newObj->getId();
                }

                // reading time
                $this->reading_time->activate($newObj->getId(), (bool) ($a_rec["ReadingTime"] ?? false));

                $a_mapping->addMapping("Modules/Blog", "blog", $a_rec["Id"], (string) $newObj->getId());
                break;

            case "blog_posting":
                $blog_id = (int) $a_mapping->getMapping("Modules/Blog", "blog", $a_rec["BlogId"]);
                if ($blog_id) {
                    $newObj = new ilBlogPosting();
                    $newObj->setBlogId($blog_id);
                    $newObj->setTitle($a_rec["Title"] ?? "");
                    $newObj->setCreated(new ilDateTime($a_rec["Created"] ?? null, IL_CAL_DATETIME));
                    $newObj->setApproved((bool) ($a_rec["Approved"] ?? null));
                    $newObj->setWithdrawn(new ilDateTime($a_rec["LastWithdrawn"] ?? null, IL_CAL_DATETIME));

                    // parse export id into local id (if possible)
                    $author = $this->parseObjectExportId($a_rec["Author"] ?? "", "-1");
                    $newObj->setAuthor((int) $author["id"]);

                    $newObj->create(true);

                    // keywords
                    $keywords = array();
                    for ($loop = 0; $loop < 1000; $loop++) {
                        $idx = "Keyword" . $loop;
                        if (isset($a_rec[$idx])) {
                            $keyword = trim($a_rec[$idx]);
                            if ($keyword !== '') {
                                $keywords[] = $keyword;
                            }
                        }
                    }
                    if (count($keywords)) {
                        $newObj->updateKeywords($keywords);
                    }

                    $a_mapping->addMapping("Services/COPage", "pg", "blp:" . $a_rec["Id"], "blp:" . $newObj->getId());
                }
                break;
        }
    }
}