class.ilObjPortfolioBase.php

Go to the documentation of this file.

<?php

abstract class ilObjPortfolioBase extends ilObject2
{
    protected \ILIAS\Notes\Service $notes;
    protected ilSetting $setting;
    protected bool $online = false;
    protected bool $comments = false;
    protected string $bg_color = "";
    protected string $font_color = "";
    protected string $img = "";
    protected string $ppic = "";
    protected bool $style = false;

    public function __construct(
        int $a_id = 0,
        bool $a_reference = true
    ) {
        global $DIC;

        $this->notes = $DIC->notes();

        parent::__construct($a_id, $a_reference);

        $this->setting = $DIC->settings();

        $this->db = $DIC->database();
    }


    //
    // PROPERTIES
    //

    public function setOnline(bool $a_value): void
    {
        $this->online = $a_value;
    }

    public function isOnline(): bool
    {
        return $this->online;
    }

    public static function lookupOnline(int $a_id): bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query("SELECT is_online" .
            " FROM usr_portfolio" .
            " WHERE id = " . $ilDB->quote($a_id, "integer"));
        $row = $ilDB->fetchAssoc($set);
        return  (bool) $row["is_online"];
    }

    public function setPublicComments(bool $a_value): void
    {
        $this->comments = $a_value;
    }

    public function hasPublicComments(): bool
    {
        return $this->comments;
    }

    public function hasProfilePicture(): bool
    {
        return $this->ppic;
    }

    public function setProfilePicture(bool $a_status): void
    {
        $this->ppic = $a_status;
    }

    public function getBackgroundColor(): string
    {
        if (!$this->bg_color) {
            $this->bg_color = "ffffff";
        }
        return $this->bg_color;
    }

    public function setBackgroundColor(string $a_value): void
    {
        $this->bg_color = $a_value;
    }

    public function getFontColor(): string
    {
        if (!$this->font_color) {
            $this->font_color = "505050";
        }
        return $this->font_color;
    }

    public function setFontColor(string $a_value): void
    {
        $this->font_color = $a_value;
    }

    public function getImage(): string
    {
        return $this->img;
    }

    public function setImage(string $a_value): void
    {
        $this->img = $a_value;
    }

    //
    // CRUD
    //

    protected function doRead(): void
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT * FROM usr_portfolio" .
                " WHERE id = " . $ilDB->quote($this->id, "integer"));
        $row = $ilDB->fetchAssoc($set);

        $this->setOnline((bool) $row["is_online"]);
        $this->setProfilePicture((bool) $row["ppic"]);
        $this->setBackgroundColor((string) $row["bg_color"]);
        $this->setFontColor((string) $row["font_color"]);
        $this->setImage((string) $row["img"]);

        // #14661
        $this->setPublicComments($this->notes->domain()->commentsActive($this->id));

        $this->doReadCustom($row);
    }

    protected function doReadCustom(array $a_row): void
    {
    }

    protected function doCreate(bool $clone_mode = false): void
    {
        $ilDB = $this->db;

        $ilDB->manipulate("INSERT INTO usr_portfolio (id,is_online)" .
            " VALUES (" . $ilDB->quote($this->id, "integer") . "," .
            $ilDB->quote(0, "integer") . ")");
    }

    protected function doUpdate(): void
    {
        $ilDB = $this->db;

        $fields = array(
            "is_online" => array("integer", $this->isOnline()),
            "ppic" => array("integer", $this->hasProfilePicture()),
            "bg_color" => array("text", $this->getBackgroundColor()),
            "font_color" => array("text", $this->getFontColor()),
            "img" => array("text", $this->getImage())
        );
        $this->doUpdateCustom($fields);

        // #14661
        $this->notes->domain()->activateComments($this->id, $this->hasPublicComments());

        $ilDB->update(
            "usr_portfolio",
            $fields,
            array("id" => array("integer", $this->id))
        );
    }

    protected function doUpdateCustom(array &$a_fields): void
    {
    }

    protected function doDelete(): void
    {
        $ilDB = $this->db;

        $this->deleteAllPages();
        $this->deleteImage();

        $ilDB->manipulate("DELETE FROM usr_portfolio" .
            " WHERE id = " . $ilDB->quote($this->id, "integer"));
    }

    abstract protected function deleteAllPages(): void;


    //
    // IMAGES
    //

    public function getImageFullPath(
        bool $a_as_thumb = false
    ): string {
        if ($this->img) {
            $path = self::initStorage($this->id);
            if (!$a_as_thumb) {
                return $path . $this->img;
            }

            return $path . "thb_" . $this->img;
        }
        return "";
    }

    public function deleteImage(): void
    {
        if ($this->id) {
            $storage = new ilFSStoragePortfolio($this->id);
            $storage->delete();

            $this->setImage("");
        }
    }

    public static function initStorage(
        int $a_id,
        string $a_subdir = null
    ): string {
        $storage = new ilFSStoragePortfolio($a_id);
        $storage->create();

        $path = $storage->getAbsolutePath() . "/";

        if ($a_subdir) {
            $path .= $a_subdir . "/";

            if (!is_dir($path) && !mkdir($path) && !is_dir($path)) {
                throw new \RuntimeException(sprintf('Directory "%s" was not created', $path));
            }
        }

        return $path;
    }

    public function uploadImage(
        array $a_upload
    ): bool {
        if (!$this->id) {
            return false;
        }

        $this->deleteImage();

        // #10074
        $clean_name = preg_replace("/[^a-zA-Z0-9\_\.\-]/", "", $a_upload["name"]);

        $path = self::initStorage($this->id);
        $original = "org_" . $this->id . "_" . $clean_name;
        $thumb = "thb_" . $this->id . "_" . $clean_name;
        $processed = $this->id . "_" . $clean_name;

        if (ilFileUtils::moveUploadedFile($a_upload["tmp_name"], $original, $path . $original)) {
            chmod($path . $original, 0770);

            $prfa_set = new ilSetting("prfa");
            /* as banner height should overflow, we only handle width
            $dimensions = $prfa_set->get("banner_width")."x".
                $prfa_set->get("banner_height");
            */
            $dimensions = $prfa_set->get("banner_width");

            // take quality 100 to avoid jpeg artefacts when uploading jpeg files
            // taking only frame [0] to avoid problems with animated gifs
            $original_file = ilShellUtil::escapeShellArg($path . $original);
            $thumb_file = ilShellUtil::escapeShellArg($path . $thumb);
            $processed_file = ilShellUtil::escapeShellArg($path . $processed);
            ilShellUtil::execConvert($original_file . "[0] -geometry 100x100 -quality 100 JPEG:" . $thumb_file);
            ilShellUtil::execConvert(
                $original_file . "[0] -geometry " . $dimensions . " -quality 100 JPEG:" . $processed_file
            );

            $this->setImage($processed);

            return true;
        }
        return false;
    }


    //
    // TRANSMOGRIFIER
    //

    protected static function cloneBasics(
        ilObjPortfolioBase $a_source,
        ilObjPortfolioBase $a_target
    ): void {
        global $DIC;

        // copy portfolio properties
        $a_target->setPublicComments($a_source->hasPublicComments());
        $a_target->setProfilePicture($a_source->hasProfilePicture());
        $a_target->setFontColor($a_source->getFontColor());
        $a_target->setBackgroundColor($a_source->getBackgroundColor());
        $a_target->setImage($a_source->getImage());
        $a_target->update();

        // banner/images
        $source_dir = $a_source->initStorage($a_source->getId());
        $target_dir = $a_target->initStorage($a_target->getId());
        ilFSStoragePortfolio::_copyDirectory($source_dir, $target_dir);

        // container settings
        foreach (ilContainer::_getContainerSettings($a_source->getId()) as $keyword => $value) {
            ilContainer::_writeContainerSetting($a_target->getId(), $keyword, $value);
        }

        // style
        $content_style_domain = $DIC
            ->contentStyle()
            ->domain()
            ->styleForObjId($a_source->getId());
        $content_style_domain->cloneTo($a_target->getId());
    }

    public static function clonePagesAndSettings(
        ilObjPortfolioBase $a_source,
        ilObjPortfolioBase $a_target,
        ?array $a_recipe = null,
        bool $copy_all = false
    ): void {
        global $DIC;

        $lng = $DIC->language();
        $ilUser = $DIC->user();

        $source_id = $a_source->getId();
        $target_id = $a_target->getId();

        if ($a_source instanceof ilObjPortfolioTemplate &&
            $a_target instanceof ilObjPortfolio) {
            $direction = "t2p";
        } elseif ($a_source instanceof ilObjPortfolio &&
            $a_target instanceof ilObjPortfolioTemplate) {
            $direction = "p2t";
        } else {
            return;
        }

        self::cloneBasics($a_source, $a_target);

        // copy advanced metadata
        $copy_id = ilCopyWizardOptions::_allocateCopyId();
        ilAdvancedMDValues::_cloneValues($copy_id, $a_source->getId(), $a_target->getId());

        // copy selection of global optional sets
        ilAdvancedMDRecord::saveObjRecSelection(
            $a_target->getId(),
            'pfpg',
            ilAdvancedMDRecord::getObjRecSelection($a_source->getId(), 'pfpg')
        );

        // fix metadata record type assignment
        // e.g. if portfolio is created from template
        // we need to change this from prtt to prtf
        foreach (\ilAdvancedMDRecord::_getSelectedRecordsByObject(
            ilObject::_lookupType($a_source->getId()),
            $a_target->getId(),
            "pfpg",
            false
        ) as $rec) {
            /*
             * BT 35494: reset assignement of the newly cloned local records,
             * and only append what's needed to global ones
             */
            $target_type = ilObject::_lookupType($a_target->getId());
            if ($rec->getParentObject() == $a_target->getId()) {
                $rec->setAssignedObjectTypes(
                    [[
                         "obj_type" => $target_type,
                         "sub_type" => "pfpg",
                         "optional" => 0
                     ]
                    ]
                );
            } elseif (!$rec->isAssignedObjectType($target_type, 'pfpg')) {
                $rec->appendAssignedObjectType(
                    $target_type,
                    "pfpg"
                );
            }
            $rec->update();
        }

        // personal skills
        $pskills = array_keys(ilPersonalSkill::getSelectedUserSkills($ilUser->getId()));

        // copy pages
        $blog_count = 0;
        $page_map = array();
        foreach (ilPortfolioPage::getAllPortfolioPages($source_id) as $page) {
            $page_id = $page["id"];

            if ($direction === "t2p") {
                $source_page = new ilPortfolioTemplatePage($page_id);
                $target_page = new ilPortfolioPage();
            } else {
                $source_page = new ilPortfolioPage($page_id);
                $target_page = new ilPortfolioTemplatePage();
            }
            $source_page->setPortfolioId($source_id);
            $target_page->setPortfolioId($target_id);

            $page_type = $source_page->getType();
            $page_title = $source_page->getTitle();




            $page_recipe = null;
            if (isset($a_recipe)) {
                $page_recipe = $a_recipe[$page_id] ?? null;
            }

            $valid = false;
            switch ($page_type) {
                // blog => blog template
                case ilPortfolioPage::TYPE_BLOG:
                    if ($direction === "p2t") {
                        $page_type = ilPortfolioTemplatePage::TYPE_BLOG_TEMPLATE;
                        $page_title = $lng->txt("obj_blog") . " " . (++$blog_count);
                        $valid = true;
                    }
                    break;

                // blog template => blog (needs recipe)
                case ilPortfolioTemplatePage::TYPE_BLOG_TEMPLATE:
                    if ($direction === "t2p" && (is_array($page_recipe) || $copy_all)) {
                        $page_type = ilPortfolioPage::TYPE_BLOG;
                        if ($copy_all) {
                            $page_title = self::createBlogInPersonalWorkspace($page_title);
                            $valid = true;
                        } elseif ($page_recipe[0] == "blog") {
                            switch ($page_recipe[1]) {
                                case "create":
                                    $page_title = self::createBlogInPersonalWorkspace($page_recipe[2]);
                                    $valid = true;
                                    break;

                                case "reuse":
                                    $page_title = $page_recipe[2];
                                    $valid = true;
                                    break;

                                case "ignore":
                                    // do nothing
                                    break;
                            }
                        }
                    }
                    break;

                // page editor
                default:
                    $target_page->setXMLContent(
                        $source_page->copyXmlContent(
                            true,
                            $a_target->getId(),
                            $copy_id
                        )
                    );
                    $target_page->buildDom(true);

                    // parse content / blocks

                    if ($direction === "t2p") {
                        $dom = $target_page->getDom();
                        if ($dom instanceof php4DOMDocument) {
                            $dom = $dom->myDOMDocument;
                        }

                        // update profile/consultation hours user id
                        self::updateDomNodes($dom, "//PageContent/Profile", "User", $ilUser->getId());
                        self::updateDomNodes($dom, "//PageContent/ConsultationHours", "User", $ilUser->getId());
                        self::updateDomNodes($dom, "//PageContent/MyCourses", "User", $ilUser->getId());

                        // skills
                        $xpath = new DOMXPath($dom);
                        $nodes = $xpath->query("//PageContent/Skills");
                        foreach ($nodes as $node) {
                            $skill_id = $node->getAttribute("Id");

                            // existing personal skills
                            if (in_array($skill_id, $pskills)) {
                                $node->setAttribute("User", $ilUser->getId());
                            }
                            // new skill
                            elseif ($copy_all || in_array($skill_id, $a_recipe["skills"])) {
                                ilPersonalSkill::addPersonalSkill($ilUser->getId(), $skill_id);

                                $node->setAttribute("User", $ilUser->getId());
                            }
                            // remove skill
                            else {
                                $page_element = $node->parentNode;
                                $page_element->parentNode->removeChild($page_element);
                            }
                        }
                    }

                    $valid = true;
                    break;
            }

            if ($valid) {
                // #12038 - update xml from dom
                $target_page->setXMLContent($target_page->getXMLFromDom());

                $target_page->setType($page_type);
                $target_page->setTitle($page_title);
                $target_page->create(false);

                if ($page_type === ilPortfolioPage::TYPE_PAGE) {
                    $target_page->update();     // handle mob usages!
                }
                $page_map[$source_page->getId()] = $target_page->getId();
            }
        }
        ilPortfolioPage::updateInternalLinks($page_map, $a_target);
    }

    protected static function updateDomNodes(
        DOMDocument $a_dom,
        string $a_xpath,
        string $a_attr_id,
        string $a_attr_value
    ): void {
        $xpath_temp = new DOMXPath($a_dom);
        $nodes = $xpath_temp->query($a_xpath);
        foreach ($nodes as $node) {
            $node->setAttribute($a_attr_id, $a_attr_value);
        }
    }

    protected static function createBlogInPersonalWorkspace(string $a_title): int
    {
        global $DIC;

        $ilUser = $DIC->user();

        static $ws_access = null;

        $blog = new ilObjBlog();
        $blog->setType("blog");
        $blog->setTitle($a_title);
        $blog->create();

        if (!$ws_access) {
            $tree = new ilWorkspaceTree($ilUser->getId());

            // #13235
            if (!$tree->getRootId()) {
                $tree->createTreeForUser($ilUser->getId());
            }

            $ws_access = new ilWorkspaceAccessHandler($tree);
        }

        $tree = $ws_access->getTree();
        $node_id = $tree->insertObject($tree->getRootId(), $blog->getId());
        $ws_access->setPermissions($tree->getRootId(), $node_id);

        return $blog->getId();
    }

    public function fixLinksOnTitleChange(array $a_title_changes): void
    {
        foreach (ilPortfolioPage::getAllPortfolioPages($this->getId()) as $port_page) {
            if ($this->getType() === "prtt") {
                $page = new ilPortfolioTemplatePage($port_page["id"]);
            } else {
                $page = new ilPortfolioPage($port_page["id"]);
            }
            if ($page->renameLinksOnTitleChange($a_title_changes)) {
                $page->update(true, true);
            }
        }
    }
}