class.ilObjForumNotificationDataProvider.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2015 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilObjForumNotificationDataProvider implements ilForumNotificationMailData
{
    protected $ref_id = 0;
    protected $obj_id = 0;
    protected $post_user_name = null;
    protected $update_user_name = null;
    public $pos_author_id = 0;
    protected $forum_id = 0;
    protected $closest_container = null;
    protected $forum_title = '';
    protected $thread_title = '';
    protected $attachments = [];
    public $objPost;
    private $db;
    private $access;
    private $user;
    private $tree;

    protected $is_anonymized = false;

    private $notificationCache;

    public function __construct(ilForumPost $objPost, $ref_id, \ilForumNotificationCache $notificationCache)
    {
        global $DIC;
        $this->db = $DIC->database();
        $this->access = $DIC->access();
        $this->user = $DIC->user();
        $this->tree = $DIC->repositoryTree();

        $this->notificationCache = $notificationCache;

        $this->objPost = $objPost;
        $this->ref_id = $ref_id;
        $this->obj_id = ilObject::_lookupObjId($ref_id);
        $this->read();
    }

    public function getRefId()
    {
        return $this->ref_id;
    }

    public function getObjId()
    {
        return $this->obj_id;
    }

    public function getThreadId()
    {
        return $this->objPost->getThreadId();
    }

    public function getPostId()
    {
        return $this->objPost->getId();
    }

    public function getForumId()
    {
        return $this->forum_id;
    }

    public function closestContainer() : ?ilObject
    {
        return $this->closest_container;
    }

    public function providesClosestContainer() : bool
    {
        return $this->closest_container !== null;
    }

    public function getForumTitle()
    {
        return $this->forum_title;
    }

    public function getThreadTitle()
    {
        return $this->thread_title;
    }

    public function getPostTitle()
    {
        return $this->objPost->getSubject();
    }

    public function getPostMessage()
    {
        return $this->objPost->getMessage();
    }

    public function getPosDisplayUserId()
    {
        return $this->objPost->getDisplayUserId();
    }

    public function getPostDate()
    {
        return $this->objPost->getCreateDate();
    }

    public function getPostUpdate()
    {
        return $this->objPost->getChangeDate();
    }
    public function getPostCensored()
    {
        return $this->objPost->isCensored();
    }

    public function getPostCensoredDate()
    {
        return $this->objPost->getCensoredDate();
    }

    public function getCensorshipComment()
    {
        return $this->objPost->getCensorshipComment();
    }

    public function getAttachments()
    {
        return $this->attachments;
    }

    public function getPosUserAlias()
    {
        return $this->objPost->getUserAlias();
    }

    public function isAnonymized()
    {
        return $this->is_anonymized;
    }
    public function getImportName()
    {
        return $this->objPost->getImportName();
    }

    public function getPostUpdateUserId()
    {
        return $this->objPost->getUpdateUserId();
    }

    public function getPostUserName(\ilLanguage $user_lang)
    {
        if ($this->post_user_name === null) {
            $authorinfo = new ilForumAuthorInformation(
                $this->getPosAuthorId(),
                $this->getPosDisplayUserId(),
                $this->getPosUserAlias(),
                $this->getImportName(),
                array(),
                $user_lang
            );
            $this->post_user_name = $this->getPublicUserInformation($authorinfo);
        }

        return (string) $this->post_user_name;
    }

    public function getPostUpdateUserName(\ilLanguage $user_lang)
    {
        if ($this->update_user_name === null) {
            $authorinfo = new ilForumAuthorInformation(
                $this->getPosAuthorId(),
                $this->getPostUpdateUserId(),
                $this->getPosUserAlias(),
                $this->getImportName(),
                array(),
                $user_lang
            );
            $this->update_user_name = $this->getPublicUserInformation($authorinfo);
        }

        // Possible Fix for #25432
        if ($this->objPost->getUserAlias() && $this->objPost->getDisplayUserId() == 0
            && $this->objPost->getPosAuthorId() == $this->objPost->getUpdateUserId()) {
            return (string) $this->objPost->getUserAlias();
        }
        
        return (string) $this->update_user_name;
    }
    
    public function getPublicUserInformation(ilForumAuthorInformation $authorinfo)
    {
        if ($authorinfo->hasSuffix()) {
            $public_name = $authorinfo->getAuthorName();
        } else {
            $public_name = $authorinfo->getAuthorShortName();

            if ($authorinfo->getAuthorName() && !$this->isAnonymized()) {
                $public_name = $authorinfo->getAuthorName();
            }
        }

        return $public_name;
    }
    
    protected function read()
    {
        $this->readForumData();
        $this->readThreadTitle();
        $this->readAttachments();
    }

    private function readThreadTitle()
    {
        $cacheKey = $this->notificationCache->createKeyByValues(array(
            'thread_title',
            $this->getObjId()
        ));

        if (false === $this->notificationCache->exists($cacheKey)) {
            $result = $this->db->queryf(
                '
                                SELECT thr_subject FROM frm_threads 
                                WHERE thr_pk = %s',
                array('integer'),
                array($this->objPost->getThreadId())
            );

            $row = $this->db->fetchAssoc($result);
            $this->notificationCache->store($cacheKey, $row);
        }

        $row = $this->notificationCache->fetch($cacheKey);
        $this->thread_title = $row['thr_subject'];
    }

    private function readForumData()
    {
        $cacheKey = $this->notificationCache->createKeyByValues(array(
            'forum_data',
            $this->getObjId()
        ));

        if (false === $this->notificationCache->exists($cacheKey)) {
            $result = $this->db->queryf(
                '
                                SELECT top_pk, top_name, frm_settings.anonymized FROM frm_data
                                INNER JOIN frm_settings ON top_frm_fk = frm_settings.obj_id 
                                WHERE top_frm_fk = %s',
                array('integer'),
                array($this->getObjId()
            )
            );

            $row = $this->db->fetchAssoc($result);

            $container = $this->determineClosestContainer($this->getRefId());
            if ($container instanceof ilObjCourse || $container instanceof ilObjGroup) {
                $row['closest_container'] = $container;
            }

            $this->notificationCache->store($cacheKey, $row);
        }

        $row = $row ?? $this->notificationCache->fetch($cacheKey);
        $this->forum_id = $row['top_pk'];
        $this->forum_title = $row['top_name'];
        $this->closest_container = $row['closest_container'] ?? null;


        $this->is_anonymized = (bool) $row['anonymized'];
    }

    public function determineClosestContainer(int $frm_ref_id) : ?ilObject
    {
        $cacheKey = $this->notificationCache->createKeyByValues([
            'forum_container',
            $frm_ref_id
        ]);

        if (false === $this->notificationCache->exists($cacheKey)) {
            $ref_id = $this->tree->checkForParentType($frm_ref_id, 'crs');
            if (!($ref_id > 0)) {
                $ref_id = $this->tree->checkForParentType($frm_ref_id, 'grp');
            }

            if ($ref_id > 0) {
                $container = ilObjectFactory::getInstanceByRefId($ref_id);
                $this->notificationCache->store($cacheKey, $container);
                return $container;
            }
        }

        return null;
    }

    private function readAttachments()
    {
        if (ilForumProperties::isSendAttachmentsByMailEnabled()) {
            $fileDataForum = new ilFileDataForum($this->getObjId(), $this->objPost->getId());
            $filesOfPost = $fileDataForum->getFilesOfPost();
            
            $fileDataMail = new ilFileDataMail(ANONYMOUS_USER_ID);
            
            foreach ($filesOfPost as $attachment) {
                $this->attachments[$attachment['path']] = $attachment['name'];
                $fileDataMail->copyAttachmentFile($attachment['path'], $attachment['name']);
            }
        }
    }

    public function getForumNotificationRecipients()
    {
        $cacheKey = $this->notificationCache->createKeyByValues(array(
            'forum',
            $this->getForumId(),
            $this->user->getId()
        ));

        if (false === $this->notificationCache->exists($cacheKey)) {
            $res = $this->db->queryf(
                '
                        SELECT frm_notification.user_id FROM frm_notification, frm_data 
                        WHERE frm_data.top_pk = %s
                        AND frm_notification.frm_id = frm_data.top_frm_fk 
                        AND frm_notification.user_id != %s
                        GROUP BY frm_notification.user_id',
                array('integer', 'integer'),
                array($this->getForumId(), $this->user->getId())
            );

            $rcps = $this->createRecipientArray($res);
            $this->notificationCache->store($cacheKey, $rcps);
        }

        $rcps = $this->notificationCache->fetch($cacheKey);

        return array_unique($rcps);
    }

    public function getThreadNotificationRecipients()
    {
        if (!$this->getThreadId()) {
            return [];
        }

        $cacheKey = $this->notificationCache->createKeyByValues(array(
            'thread',
            $this->getThreadId(),
            $this->user->getId()
        ));

        if (false === $this->notificationCache->exists($cacheKey)) {
            $res = $this->db->queryF(
                '
                                SELECT frm_notification.user_id
                                FROM frm_notification
                                INNER JOIN frm_threads ON frm_threads.thr_pk = frm_notification.thread_id
                                WHERE frm_notification.thread_id = %s
                                AND frm_notification.user_id != %s',
                array('integer', 'integer'),
                array($this->getThreadId(), $this->user->getId())
            );

            $usrIds = $this->createRecipientArray($res);
            $this->notificationCache->store($cacheKey, $usrIds);
        }

        $usrIds = $this->notificationCache->fetch($cacheKey);

        return $usrIds;
    }

    public function getPostAnsweredRecipients()
    {
        $cacheKey = $this->notificationCache->createKeyByValues(array(
            'post_answered',
            $this->objPost->getParentId()
        ));

        if (false === $this->notificationCache->exists($cacheKey)) {
            $parent_objPost = new ilForumPost($this->objPost->getParentId());

            $this->notificationCache->store($cacheKey, $parent_objPost);
        }

        $parent_objPost = $this->notificationCache->fetch($cacheKey);
        $rcps = array();
        $rcps[] = $parent_objPost->getPosAuthorId();

        return $rcps;
    }

    public function getPostActivationRecipients()
    {
        $cacheKey = $this->notificationCache->createKeyByValues(array(
            'post_activation',
            $this->getRefId()
        ));

        if (false === $this->notificationCache->exists($cacheKey)) {
            // get moderators to notify about needed activation
            $rcps = ilForum::_getModerators($this->getRefId());
            $this->notificationCache->store($cacheKey, $rcps);
        }

        $rcps = $this->notificationCache->fetch($cacheKey);

        return (array) $rcps;
    }
    
    public function setPosAuthorId($pos_author_id)
    {
        $this->pos_author_id = $pos_author_id;
    }
    
    public function getPosAuthorId()
    {
        return $this->pos_author_id;
    }

    private function getRefIdsByObjId(int $objId) : array
    {
        $cacheKey = $this->notificationCache->createKeyByValues([
            'refs_by_obj_id',
            $objId
        ]);

        if (!$this->notificationCache->exists($cacheKey)) {
            $this->notificationCache->store($cacheKey, (array) ilObject::_getAllReferences($objId));
        }

        return $this->notificationCache->fetch($cacheKey);
    }

    private function createRecipientArray(\ilPDOStatement $statement) : array
    {
        $refIds = $this->getRefIdsByObjId((int) $this->getObjId());

        $usrIds = [];
        while ($row = $this->db->fetchAssoc($statement)) {
            foreach ($refIds as $refId) {
                if ($this->access->checkAccessOfUser($row['user_id'], 'read', '', $refId)) {
                    $usrIds[] = (int) $row['user_id'];
                }
            }
        }

        return $usrIds;
    }

    public function getDeletedBy()
    {
        global $DIC;

        if ($this->objPost->getUserAlias() && $this->objPost->getDisplayUserId() == 0
            && $this->objPost->getPosAuthorId() == $DIC->user()->getId()) {
            return (string) $this->objPost->getUserAlias();
        } else {
            return $DIC->user()->getLogin();
        }
    }
}