class.ilObjBlog.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2019 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilObjBlog extends ilObject2
{

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

        parent::__construct($a_id, $a_reference);
        $this->rbacreview = $DIC->rbac()->review();
    }

    protected $notes; // [bool]
    protected $bg_color; // [string]
    protected $font_color; // [string]
    protected $img; // [string]
    protected $ppic; // [string]
    protected $rss; // [bool]
    protected $approval; // [bool]
    protected $style; // [bool]
    protected $abstract_shorten = false; // [bool]
    protected $abstract_shorten_length = self::ABSTRACT_DEFAULT_SHORTEN_LENGTH; // [int]
    protected $abstract_image = false; // [bool]
    protected $abstract_image_width = self::ABSTRACT_DEFAULT_IMAGE_WIDTH; // [int]
    protected $abstract_image_height = self::ABSTRACT_DEFAULT_IMAGE_HEIGHT; // [int]
    protected $keywords = true; // [bool]
    protected $nav_mode = self::NAV_MODE_LIST; // [int]
    protected $nav_mode_list_postings = self::NAV_MODE_LIST_DEFAULT_POSTINGS; // [int]
    protected $nav_mode_list_months; // [int]
    protected $overview_postings = 5; // [int]
    protected $authors = true; // [bool]
    protected $order;
    
    const NAV_MODE_LIST = 1;
    const NAV_MODE_MONTH = 2;
    
    const ABSTRACT_DEFAULT_SHORTEN_LENGTH = 500;
    const ABSTRACT_DEFAULT_IMAGE_WIDTH = 144;
    const ABSTRACT_DEFAULT_IMAGE_HEIGHT = 144;
    const NAV_MODE_LIST_DEFAULT_POSTINGS = 10;
    
    public function initType()
    {
        $this->type = "blog";
    }

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

        $set = $ilDB->query("SELECT * FROM il_blog" .
                " WHERE id = " . $ilDB->quote($this->id, "integer"));
        $row = $ilDB->fetchAssoc($set);
        $this->setProfilePicture((bool) $row["ppic"]);
        $this->setBackgroundColor($row["bg_color"]);
        $this->setFontColor($row["font_color"]);
        $this->setImage($row["img"]);
        $this->setRSS($row["rss_active"]);
        $this->setApproval($row["approval"]);
        $this->setAbstractShorten($row["abs_shorten"]);
        $this->setAbstractShortenLength($row["abs_shorten_len"]);
        $this->setAbstractImage($row["abs_image"]);
        $this->setAbstractImageWidth($row["abs_img_width"]);
        $this->setAbstractImageHeight($row["abs_img_height"]);
        $this->setKeywords($row["keywords"]);
        $this->setAuthors($row["authors"]);
        $this->setNavMode($row["nav_mode"]);
        $this->setNavModeListMonthsWithPostings($row["nav_list_mon_with_post"]);
        $this->setNavModeListMonths($row["nav_list_mon"]);
        $this->setOverviewPostings($row["ov_post"]);
        if (trim($row["nav_order"])) {
            $this->setOrder(explode(";", $row["nav_order"]));
        }
        
        // #14661
        $this->setNotesStatus(ilNote::commentsActivated($this->id, 0, "blog"));
        
        $this->setStyleSheetId(ilObjStyleSheet::lookupObjectStyle($this->id));
    }

    protected function doCreate()
    {
        $ilDB = $this->db;
        
        $ilDB->manipulate("INSERT INTO il_blog (id,ppic,rss_active,approval" .
            ",abs_shorten,abs_shorten_len,abs_image,abs_img_width,abs_img_height" .
            ",keywords,authors,nav_mode,nav_list_mon_with_post,ov_post) VALUES (" .
            $ilDB->quote($this->id, "integer") . "," .
            $ilDB->quote(true, "integer") . "," .
            $ilDB->quote(true, "integer") . "," .
            $ilDB->quote(false, "integer") . "," .
            $ilDB->quote($this->hasAbstractShorten(), "integer") . "," .
            $ilDB->quote($this->getAbstractShortenLength(), "integer") . "," .
            $ilDB->quote($this->hasAbstractImage(), "integer") . "," .
            $ilDB->quote($this->getAbstractImageWidth(), "integer") . "," .
            $ilDB->quote($this->getAbstractImageHeight(), "integer") . "," .
            $ilDB->quote($this->hasKeywords(), "integer") . "," .
            $ilDB->quote($this->hasAuthors(), "integer") . "," .
            $ilDB->quote($this->getNavMode(), "integer") . "," .
            $ilDB->quote($this->getNavModeListMonthsWithPostings(), "integer") . "," .
            $ilDB->quote($this->getOverviewPostings(), "integer") .
            ")");
        
        // #14661
        ilNote::activateComments($this->id, 0, "blog", true);
    }
    
    protected function doDelete()
    {
        $ilDB = $this->db;
        
        $this->deleteImage();

        ilBlogPosting::deleteAllBlogPostings($this->id);
        
        // remove all notifications
        ilNotification::removeForObject(ilNotification::TYPE_BLOG, $this->id);

        $ilDB->manipulate("DELETE FROM il_blog" .
            " WHERE id = " . $ilDB->quote($this->id, "integer"));
    }
    
    protected function doUpdate()
    {
        $ilDB = $this->db;
    
        if ($this->id) {
            $ilDB->manipulate("UPDATE il_blog" .
                    " SET ppic = " . $ilDB->quote($this->hasProfilePicture(), "integer") .
                    ",bg_color = " . $ilDB->quote($this->getBackgroundColor(), "text") .
                    ",font_color = " . $ilDB->quote($this->getFontcolor(), "text") .
                    ",img = " . $ilDB->quote($this->getImage(), "text") .
                    ",rss_active = " . $ilDB->quote($this->hasRSS(), "integer") .
                    ",approval = " . $ilDB->quote($this->hasApproval(), "integer") .
                    ",abs_shorten = " . $ilDB->quote($this->hasAbstractShorten(), "integer") .
                    ",abs_shorten_len = " . $ilDB->quote($this->getAbstractShortenLength(), "integer") .
                    ",abs_image = " . $ilDB->quote($this->hasAbstractImage(), "integer") .
                    ",abs_img_width = " . $ilDB->quote($this->getAbstractImageWidth(), "integer") .
                    ",abs_img_height = " . $ilDB->quote($this->getAbstractImageHeight(), "integer") .
                    ",keywords = " . $ilDB->quote($this->hasKeywords(), "integer") .
                    ",authors = " . $ilDB->quote($this->hasAuthors(), "integer") .
                    ",nav_mode = " . $ilDB->quote($this->getNavMode(), "integer") .
                    ",nav_list_mon_with_post = " . $ilDB->quote($this->getNavModeListMonthsWithPostings(), "integer") .
                    ",nav_list_mon = " . $ilDB->quote($this->getNavModeListMonths(), "integer") .
                    ",ov_post = " . $ilDB->quote($this->getOverviewPostings(), "integer") .
                    ",nav_order = " . $ilDB->quote(implode(";", $this->getOrder()), "text") .
                    " WHERE id = " . $ilDB->quote($this->id, "integer"));
                        
            // #14661
            ilNote::activateComments($this->id, 0, "blog", $this->getNotesStatus());
            
            ilObjStyleSheet::writeStyleUsage($this->id, $this->getStyleSheetId());
        }
    }

    protected function doCloneObject($new_obj, $a_target_id, $a_copy_id = null, $a_omit_tree = false)
    {
        // banner?
        $img = $this->getImage();
        if ($img) {
            $new_obj->setImage($img);
            
            $source = $this->initStorage($this->getId());
            $target = $new_obj->initStorage($new_obj->getId());
            
            copy($source . $img, $target . $img);
        }
        
        $new_obj->setNotesStatus($this->getNotesStatus());
        $new_obj->setProfilePicture($this->hasProfilePicture());
        $new_obj->setBackgroundColor($this->getBackgroundColor());
        $new_obj->setFontColor($this->getFontColor());
        $new_obj->setRSS($this->hasRSS());
        $new_obj->setApproval($this->hasApproval());
        $new_obj->setAbstractShorten($this->hasAbstractShorten());
        $new_obj->setAbstractShortenLength($this->getAbstractShortenLength());
        $new_obj->setAbstractImage($this->hasAbstractImage());
        $new_obj->setAbstractImageWidth($this->getAbstractImageWidth());
        $new_obj->setAbstractImageHeight($this->getAbstractImageHeight());
        $new_obj->update();
        
        // set/copy stylesheet
        $style_id = $this->getStyleSheetId();
        if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id)) {
            $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
            $new_id = $style_obj->ilClone();
            $new_obj->setStyleSheetId($new_id);
            $new_obj->update();
        }
    }
    
    public function getNotesStatus()
    {
        return $this->notes;
    }

    public function setNotesStatus($a_status)
    {
        $this->notes = (bool) $a_status;
    }
    
    public function hasProfilePicture()
    {
        return $this->ppic;
    }

    public function setProfilePicture($a_status)
    {
        $this->ppic = (bool) $a_status;
    }
    
    public function getBackgroundColor()
    {
        if (!$this->bg_color) {
            $this->bg_color = "ffffff";
        }
        return $this->bg_color;
    }

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

    public function setFontColor($a_value)
    {
        $this->font_color = (string) $a_value;
    }
    
    public function getImage()
    {
        return $this->img;
    }

    public function setImage($a_value)
    {
        $this->img = (string) $a_value;
    }
    
    public function getImageFullPath($a_as_thumb = false)
    {
        if ($this->img) {
            $path = $this->initStorage($this->id);
            if (!$a_as_thumb) {
                return $path . $this->img;
            } else {
                return $path . "thb_" . $this->img;
            }
        }
    }
    
    public function deleteImage()
    {
        if ($this->id) {
            $storage = new ilFSStorageBlog($this->id);
            $storage->delete();
            
            $this->setImage(null);
            
            $this->handleQuotaUpdate();
        }
    }

    public static function initStorage($a_id, $a_subdir = null)
    {
        $storage = new ilFSStorageBlog($a_id);
        $storage->create();
        
        $path = $storage->getAbsolutePath() . "/";
        
        if ($a_subdir) {
            $path .= $a_subdir . "/";
            
            if (!is_dir($path)) {
                mkdir($path);
            }
        }
                
        return $path;
    }
    
    public function uploadImage(array $a_upload)
    {
        if (!$this->id) {
            return false;
        }
        
        $this->deleteImage();
        
        // #10074
        $clean_name = preg_replace("/[^a-zA-Z0-9\_\.\-]/", "", $a_upload["name"]);
    
        $path = $this->initStorage($this->id);
        $original = "org_" . $this->id . "_" . $clean_name;
        $thumb = "thb_" . $this->id . "_" . $clean_name;
        $processed = $this->id . "_" . $clean_name;

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

            $blga_set = new ilSetting("blga");
            /* as banner height should overflow, we only handle width
            $dimensions = $blga_set->get("banner_width")."x".
                $blga_set->get("banner_height");
            */
            $dimensions = $blga_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 = ilUtil::escapeShellArg($path . $original);
            $thumb_file = ilUtil::escapeShellArg($path . $thumb);
            $processed_file = ilUtil::escapeShellArg($path . $processed);
            ilUtil::execConvert($original_file . "[0] -geometry 100x100 -quality 100 JPEG:" . $thumb_file);
            ilUtil::execConvert($original_file . "[0] -geometry " . $dimensions . " -quality 100 JPEG:" . $processed_file);
            
            $this->setImage($processed);
            
            $this->handleQuotaUpdate();
            
            return true;
        }
        return false;
    }
        
    public function hasRSS()
    {
        return $this->rss;
    }

    public function setRSS($a_status)
    {
        $this->rss = (bool) $a_status;
    }
    
    public function hasApproval()
    {
        return (bool) $this->approval;
    }

    public function setApproval($a_status)
    {
        $this->approval = (bool) $a_status;
    }
    
    public function getStyleSheetId()
    {
        return (int) $this->style;
    }

    public function setStyleSheetId($a_style)
    {
        $this->style = (int) $a_style;
    }
    
    public function hasAbstractShorten()
    {
        return $this->abstract_shorten;
    }
    
    public function setAbstractShorten($a_value)
    {
        $this->abstract_shorten = (bool) $a_value;
    }
    
    public function getAbstractShortenLength()
    {
        return $this->abstract_shorten_length;
    }
    
    public function setAbstractShortenLength($a_value)
    {
        $this->abstract_shorten_length = (int) $a_value;
    }
            
    public function hasAbstractImage()
    {
        return $this->abstract_image;
    }
    
    public function setAbstractImage($a_value)
    {
        $this->abstract_image = (bool) $a_value;
    }
    
    public function getAbstractImageWidth()
    {
        return $this->abstract_image_width;
    }
    
    public function setAbstractImageWidth($a_value)
    {
        $this->abstract_image_width = (int) $a_value;
    }
    
    public function getAbstractImageHeight()
    {
        return $this->abstract_image_height;
    }
    
    public function setAbstractImageHeight($a_value)
    {
        $this->abstract_image_height = (int) $a_value;
    }
    
    public function setKeywords($a_value)
    {
        $this->keywords = (bool) $a_value;
    }
    
    public function hasKeywords()
    {
        return $this->keywords;
    }
    
    public function setAuthors($a_value)
    {
        $this->authors = (bool) $a_value;
    }
    
    public function hasAuthors()
    {
        return $this->authors;
    }
    
    public function setNavMode($a_value)
    {
        $a_value = (int) $a_value;
        if (in_array($a_value, array(self::NAV_MODE_LIST, self::NAV_MODE_MONTH))) {
            $this->nav_mode = $a_value;
        }
    }
    
    public function getNavMode()
    {
        return $this->nav_mode;
    }
    
    public function setNavModeListMonthsWithPostings($a_value)
    {
        $this->nav_mode_list_months_with_post = (int) $a_value;
    }
    
    public function getNavModeListMonthsWithPostings()
    {
        return $this->nav_mode_list_months_with_post;
    }
    
    public function setNavModeListMonths($a_value)
    {
        if (!$a_value) {
            $a_value = null;
        } else {
            $a_value = (int) $a_value;
        }
        $this->nav_mode_list_months = $a_value;
    }
    
    public function getNavModeListMonths()
    {
        return $this->nav_mode_list_months;
    }
    
    public function setOverviewPostings($a_value)
    {
        if (!$a_value) {
            $a_value = null;
        } else {
            $a_value = (int) $a_value;
        }
        $this->overview_postings = $a_value;
    }
    
    public function getOverviewPostings()
    {
        return $this->overview_postings;
    }
    
    public function setOrder(array $a_values = null)
    {
        $this->order = $a_values;
    }
    
    public function getOrder()
    {
        return (array) $this->order;
    }
        
    public static function sendNotification($a_action, $a_in_wsp, $a_blog_node_id, $a_posting_id, $a_comment = null)
    {
        global $DIC;

        $ilUser = $DIC->user();
        
        // get blog object id (repository or workspace)
        if ($a_in_wsp) {
            $tree = new ilWorkspaceTree($ilUser->getId()); // owner of tree is irrelevant
            $blog_obj_id = $tree->lookupObjectId($a_blog_node_id);
            $access_handler = new ilWorkspaceAccessHandler($tree);
        } else {
            $blog_obj_id = ilObject::_lookupObjId($a_blog_node_id);
            $access_handler = null;
        }
        if (!$blog_obj_id) {
            return;
        }
                
        $posting = new ilBlogPosting($a_posting_id);
                                
        // #11138
        $ignore_threshold = ($a_action == "comment");
        
        $admin_only = false;
        
        // approval handling
        if (!$posting->isApproved()) {
            $blog = new self($blog_obj_id, false);
            if ($blog->hasApproval()) {
                switch ($a_action) {
                    case "update":
                        // un-approved posting was updated - no notifications
                        return;

                    case "new":
                        // un-approved posting was activated - admin-only notification
                        $admin_only = true;
                        $ignore_threshold = true;
                        $a_action = "approve";
                        break;
                }
            }
        }
        
        // create/update news item (only in repository)
        if (!$a_in_wsp &&
            in_array($a_action, array("update", "new"))) {
            $posting->handleNews(($a_action == "update"));
        }
        
        // recipients
        $users = ilNotification::getNotificationsForObject(
            ilNotification::TYPE_BLOG,
            $blog_obj_id,
            $a_posting_id,
            $ignore_threshold
        );
        if (!sizeof($users)) {
            return;
        }

        $ntf = new ilSystemNotification($a_in_wsp);
        $ntf->setLangModules(array("blog"));
        $ntf->setRefId($a_blog_node_id);
        $ntf->setChangedByUserId($ilUser->getId());
        $ntf->setSubjectLangId('blog_change_notification_subject');
        $ntf->setIntroductionLangId('blog_change_notification_body_' . $a_action);
        $ntf->addAdditionalInfo('blog_posting', $posting->getTitle());
        if ($a_comment) {
            $ntf->addAdditionalInfo('comment', $a_comment, true);
        }
        $ntf->setGotoLangId('blog_change_notification_link');
        $ntf->setReasonLangId('blog_change_notification_reason');
        
        $abstract = $posting->getNotificationAbstract();
        if ($abstract) {
            $ntf->addAdditionalInfo('content', $abstract, true);
        }
                
        $notified = $ntf->sendMail(
            $users,
            "_" . $a_posting_id,
            ($admin_only ? "write" : "read")
        );
                
        // #14387
        if (sizeof($notified)) {
            ilNotification::updateNotificationTime(ilNotification::TYPE_BLOG, $blog_obj_id, $notified, $a_posting_id);
        }
    }
            
    public static function deliverRSS($a_wsp_id)
    {
        global $DIC;

        $tpl = $DIC["tpl"];
        $ilSetting = $DIC->settings();
        
        if (!$ilSetting->get('enable_global_profiles')) {
            return;
        }
        
        // #10827
        if (substr($a_wsp_id, -4) != "_cll") {
            $wsp_id = new ilWorkspaceTree(0);
            $obj_id = $wsp_id->lookupObjectId($a_wsp_id);
            $is_wsp = "_wsp";
        } else {
            $a_wsp_id = substr($a_wsp_id, 0, -4);
            $obj_id = ilObject::_lookupObjId($a_wsp_id);
            $is_wsp = null;
        }
        if (!$obj_id) {
            return;
        }
        
        $blog = new self($obj_id, false);
        if (!$blog->hasRSS()) {
            return;
        }
                    
        $feed = new ilFeedWriter();
                
        $url = ilLink::_getStaticLink($a_wsp_id, "blog", true, $is_wsp);
        $url = str_replace("&", "&amp;", $url);
        
        // #11870
        $feed->setChannelTitle(str_replace("&", "&amp;", $blog->getTitle()));
        $feed->setChannelDescription(str_replace("&", "&amp;", $blog->getDescription()));
        $feed->setChannelLink($url);
        
        // needed for blogpostinggui / pagegui
        $tpl = new ilGlobalTemplate("tpl.main.html", true, true);
        
        foreach (ilBlogPosting::getAllPostings($obj_id) as $item) {
            $id = $item["id"];

            // only published items
            $is_active = ilBlogPosting::_lookupActive($id, "blp");
            if (!$is_active) {
                continue;
            }
                                    
            // #16434
            $snippet = strip_tags(ilBlogPostingGUI::getSnippet($id), "<br><br/><div><p>");
            $snippet = str_replace("&", "&amp;", $snippet);
            $snippet = "<![CDATA[" . $snippet . "]]>";

            $url = ilLink::_getStaticLink($a_wsp_id, "blog", true, "_" . $id . $is_wsp);
            $url = str_replace("&", "&amp;", $url);

            $feed_item = new ilFeedItem();
            $feed_item->setTitle(str_replace("&", "&amp;", $item["title"])); // #16022
            $feed_item->setDate($item["created"]->get(IL_CAL_DATETIME));
            $feed_item->setDescription($snippet);
            $feed_item->setLink($url);
            $feed_item->setAbout($url);
            $feed->addItem($feed_item);
        }
        
        $feed->showFeed();
        exit();
    }
    
    public function initDefaultRoles()
    {
        $role = ilObjRole::createDefaultRole(
            'il_blog_contributor_' . $this->getRefId(),
            "Contributor of blog obj_no." . $this->getId(),
            'il_blog_contributor',
            $this->getRefId()
        );
        
        $role = ilObjRole::createDefaultRole(
            'il_blog_editor_' . $this->getRefId(),
            "Editor of blog obj_no." . $this->getId(),
            'il_blog_editor',
            $this->getRefId()
        );
        
        return array();
    }
    
    public function getLocalContributorRole($a_node_id)
    {
        $rbacreview = $this->rbacreview;
        
        foreach ($rbacreview->getLocalRoles($a_node_id) as $role_id) {
            if (substr(ilObject::_lookupTitle($role_id), 0, 19) == "il_blog_contributor") {
                return $role_id;
            }
        }
    }
    
    public function getLocalEditorRole($a_node_id)
    {
        $rbacreview = $this->rbacreview;
        
        foreach ($rbacreview->getLocalRoles($a_node_id) as $role_id) {
            if (substr(ilObject::_lookupTitle($role_id), 0, 14) == "il_blog_editor") {
                return $role_id;
            }
        }
    }
    
    public function getAllLocalRoles($a_node_id)
    {
        $rbacreview = $this->rbacreview;
        
        $res = array();
        foreach ($rbacreview->getLocalRoles($a_node_id) as $role_id) {
            $res[$role_id] = ilObjRole::_getTranslation(ilObject::_lookupTitle($role_id));
        }
        
        asort($res);
        return $res;
    }
    
    public function getRolesWithContributeOrRedact($a_node_id)
    {
        $rbacreview = $this->rbacreview;
        
        $contr_op_id = ilRbacReview::_getOperationIdByName("contribute");
        $redact_op_id = ilRbacReview::_getOperationIdByName("redact");
        $contr_role_id = $this->getLocalContributorRole($a_node_id);
        $editor_role_id = $this->getLocalEditorRole($a_node_id);
        
        $res = array();
        foreach ($rbacreview->getParentRoleIds($a_node_id) as $role_id => $role) {
            if ($role_id != $contr_role_id &&
                $role_id != $editor_role_id) {
                $all_ops = $rbacreview->getActiveOperationsOfRole($a_node_id, $role_id);
                if (in_array($contr_op_id, $all_ops) ||
                    in_array($redact_op_id, $all_ops)) {
                    $res[$role_id] = ilObjRole:: _getTranslation($role["title"]);
                }
            }
        }
    
        return $res;
    }
    
    protected function handleQuotaUpdate()
    {
        ilDiskQuotaHandler::handleUpdatedSourceObject(
            $this->getType(),
            $this->getId(),
            ilUtil::dirsize($this->initStorage($this->getId())),
            array($this->getId())
        );
    }
}