class.ilObjForumNotificationDataProvider.php

Go to the documentation of this file.

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

include_once './Modules/Forum/interfaces/interface.ilForumNotificationMailData.php';
include_once './Modules/Forum/classes/class.ilForumProperties.php';
require_once 'Modules/Forum/classes/class.ilForumAuthorInformation.php';

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 $forum_title = '';

        protected $thread_title = '';

        protected $attachments = array();

        public $objPost;
        protected $is_anonymized = false;

        public function __construct(ilForumPost $objPost, $ref_id)
        {
                $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 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);
                }

                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()
        {
                global $ilDB;

                $result = $ilDB->queryf('
                        SELECT thr_subject FROM frm_threads 
                        WHERE thr_pk = %s',
                        array('integer'), array($this->objPost->getThreadId()));

                $row = $ilDB->fetchAssoc($result);
                $this->thread_title = $row['thr_subject'];
        }

        private function readForumData()
        {
                global $ilDB;

                $result = $ilDB->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 = $ilDB->fetchAssoc($result);
                $this->forum_id    = $row['top_pk'];
                $this->forum_title = $row['top_name'];
                $this->is_anonymized = (bool)$row['anonymized'];
        }

        private function readAttachments()
        {
                if(ilForumProperties::isSendAttachmentsByMailEnabled())
                {
                        require_once 'Modules/Forum/classes/class.ilFileDataForum.php';
                        $fileDataForum = new ilFileDataForum($this->getObjId(), $this->objPost->getId());
                        $filesOfPost   = $fileDataForum->getFilesOfPost();
                        
                        require_once 'Services/Mail/classes/class.ilFileDataMail.php';
                        $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()
        {
                global $ilDB, $ilAccess, $ilUser;

                $res = $ilDB->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(), $ilUser->getId()));

                // get all references of obj_id
                $frm_references = ilObject::_getAllReferences($this->getObjId());
                $rcps = array();
                while($row = $ilDB->fetchAssoc($res))
                {
                        // do rbac check before sending notification
                        foreach((array)$frm_references as $ref_id)
                        {
                                if($ilAccess->checkAccessOfUser($row['user_id'], 'read', '', $ref_id))
                                {
                                        $rcps[] = $row['user_id'];
                                }
                        }
                }

                return array_unique($rcps);
        }

        public function getThreadNotificationRecipients()
        {
                global $ilDB, $ilAccess, $ilUser;

                // GET USERS WHO WANT TO BE INFORMED ABOUT NEW POSTS
                $res = $ilDB->queryf('
                        SELECT user_id FROM frm_notification 
                        WHERE thread_id = %s
                        AND user_id <> %s',
                        array('integer', 'integer'),
                        array($this->getThreadId(), $GLOBALS['DIC']['ilUser']->getId()));

                // get all references of obj_id
                $frm_references = ilObject::_getAllReferences($this->getObjId());
                $rcps = array();
                while($row = $ilDB->fetchAssoc($res))
                {
                        // do rbac check before sending notification
                        foreach((array)$frm_references as $ref_id)
                        {
                                if($ilAccess->checkAccessOfUser($row['user_id'], 'read', '', $ref_id))
                                {
                                        $rcps[] = $row['user_id'];
                                }
                        }
                }
                return $rcps;
        }

        public function getPostAnsweredRecipients()
        {
                include_once './Modules/Forum/classes/class.ilForumPost.php';
                $parent_objPost = new ilForumPost($this->objPost->getParentId());

                $rcps = array();
                $rcps[] = $parent_objPost->getPosAuthorId();

                return $rcps;
        }

        public function getPostActivationRecipients()
        {
                include_once './Modules/Forum/classes/class.ilForum.php';
                // get moderators to notify about needed activation
                $rcps =  ilForum::_getModerators($this->getRefId());
                return  (array)$rcps;
        }
        
        public function setPosAuthorId($pos_author_id)
        {
                $this->pos_author_id = $pos_author_id;
        }
        
        public function getPosAuthorId()
        {
                return $this->pos_author_id;
        }
}