class.ilMailNotification.php

Go to the documentation of this file.

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


include_once './Services/Language/classes/class.ilLanguageFactory.php';
include_once './Services/Mail/classes/class.ilMail.php';

abstract class ilMailNotification
{
        const SUBJECT_TITLE_LENGTH = 60;
        
        protected $type = null;
        protected $sender = null;
        
        protected $mail = null;
        protected $subject = '';
        protected $body = '';

        protected $attachments = array();
        
        protected $language = null;
        protected $lang_modules = array();
        
        protected $recipients = array();
        
        protected $ref_id = null;
        protected $obj_id = null;
        protected $obj_type = null;
        
        protected $additional_info = array();
        
        protected $is_in_wsp;
        protected $wsp_tree; 
        protected $wsp_access_handler;

        public function __construct($a_is_personal_workspace = false)
        {
                global $lng, $ilUser;
                
                $this->is_in_wsp = (bool)$a_is_personal_workspace;

                $this->setSender(ANONYMOUS_USER_ID);
                $this->language = ilLanguageFactory::_getLanguage($lng->getDefaultLanguage());
                
                if($this->is_in_wsp)
                {                       
                        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
                        include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";                   
                        $this->wsp_tree = new ilWorkspaceTree($ilUser->getId()); // owner of tree is irrelevant
                        $this->wsp_access_handler = new ilWorkspaceAccessHandler($this->wsp_tree);                                      
                }
        }
        
        public function setType($a_type)
        {
                $this->type = $a_type;
        }
        
        public function getType()
        {
                return $this->type;
        }
        
        public function setSender($a_usr_id)
        {
                $this->sender = $a_usr_id;
        }
        
        public function getSender()
        {
                return $this->sender;
        }
        
        protected function setSubject($a_subject)
        {
                return $this->subject = $a_subject;
        }
        
        protected function getSubject()
        {
                return $this->subject;
        }

        protected function setBody($a_body)
        {
                $this->body = $a_body;
        }
        
        protected function appendBody($a_body)
        {
                return $this->body .= $a_body;
        }
        
        protected function getBody()
        {
                return $this->body;
        }

        public function setRecipients(array $a_rcp)
        {
                $this->recipients = $a_rcp;
        }
        
        public function getRecipients()
        {
                return $this->recipients;
        }

        public function setAttachments($a_att)
        {
                $this->attachments = $a_att;
        }

        public function getAttachments()
        {
                return (array) $this->attachments;
        }
                
        public function setLangModules(array $a_modules)
        {
                $this->lang_modules = $a_modules;
        }       
                
        protected function initLanguage($a_usr_id)
        {
                $this->language = $this->getUserLanguage($a_usr_id);
        }
        
        public function getUserLanguage($a_usr_id)
        {               
                $language = ilLanguageFactory::_getLanguageOfUser($a_usr_id);
                $language->loadLanguageModule('mail');
                
                if(sizeof($this->lang_modules))
                {
                        foreach($this->lang_modules as $lmod)
                        {
                                $language->loadLanguageModule($lmod);
                        }
                }
                
                return $language;
        }

        protected function initLanguageByIso2Code($a_code = '')
        {
                $this->language = ilLanguageFactory::_getLanguage($a_code);
                $this->language->loadLanguageModule('mail');
                
                if(sizeof($this->lang_modules))
                {
                        foreach($this->lang_modules as $lmod)
                        {
                                $this->language->loadLanguageModule($lmod);
                        }
                }
        }
        
        protected function setLanguage($a_language)
        {
                $this->language = $a_language;
        }
        
        protected function getLanguage()
        {
                return $this->language;
        }

        protected function getLanguageText($a_keyword)
        {
                return str_replace('\n', "\n", $this->getLanguage()->txt($a_keyword));
        }

        public function setRefId($a_id)
        {                                               
                if(!$this->is_in_wsp)
                {
                        $this->ref_id = $a_id;
                        $obj_id = ilObject::_lookupObjId($this->ref_id);                
                }               
                else
                {
                        $this->ref_id = (int)$a_id;                     
                        $obj_id = $this->wsp_tree->lookupObjectId($this->getRefId());                                   
                }
                
                $this->setObjId($obj_id);
        }
        
        public function getRefId()
        {
                return $this->ref_id;
        }
        
        public function getObjId()
        {
                return $this->obj_id;
        }

        public function setObjId($a_obj_id)
        {
                $this->obj_id = $a_obj_id;
                $this->obj_type = ilObject::_lookupType($this->obj_id);
        }
        
        public function getObjType()
        {
                return $this->obj_type;
        }

        public function setAdditionalInformation(array $a_info)
        {
                $this->additional_info = $a_info;
        }

        public function getAdditionalInformation()
        {
                return (array) $this->additional_info; 
        }

        protected function getObjectTitle($a_shorten = false)
        {
                if(!$this->getObjId())
                {
                        return '';
                }
                $txt = ilObject::_lookupTitle($this->getObjId());
                if((bool)$a_shorten)
                {
                        $txt = ilUtil::shortenText($txt, self::SUBJECT_TITLE_LENGTH,true);
                }
                return $txt;
        }

        public function sendMail(array $a_rcp, $a_type, $a_parse_recipients = true)
        {
                $recipients = array();
                foreach($a_rcp as $rcp)
                {
                        if($a_parse_recipients)
                        {
                                $recipients[] = ilObjUser::_lookupLogin($rcp);
                        }
                        else
                        {
                                $recipients[] = $rcp;
                        }
                }
                $recipients = implode(',',$recipients);
                $error = $this->getMail()->sendMail(
                        $recipients,
                        '',
                        '',
                        $this->getSubject(),
                        $this->getBody(),
                        $this->getAttachments(),
                        $a_type
                );

                if(strlen($error))
                {
                        require_once './Services/Logging/classes/public/class.ilLoggerFactory.php';
                        ilLoggerFactory::getLogger('mail')->error($error);
                }
        }

        protected function initMail()
        {
                return $this->mail = new ilMail($this->getSender());
        }

        protected function getMail()
        {
                return is_object($this->mail) ? $this->mail : $this->initMail();
        }

        protected function createPermanentLink($a_params = array(),$a_append = '')
        {
                include_once './Services/Link/classes/class.ilLink.php';
                
                if($this->getRefId())
                {
                        if(!$this->is_in_wsp)
                        {                       
                                return ilLink::_getLink($this->ref_id,$this->getObjType(),$a_params,$a_append);
                        }
                        else
                        {
                                return ilWorkspaceAccessHandler::getGotoLink($this->getRefId(), $this->getObjId(), $a_append);  
                        }
                }
                else
                {
                        // Return root
                        return ilLink::_getLink(ROOT_FOLDER_ID,'root');
                }
        }

        protected function userToString($a_usr_id)
        {
                $name = ilObjUser::_lookupName($a_usr_id);
                return ($name['title'] ? $name['title'].' ' : '').
                        ($name['firstname'] ? $name['firstname'].' ' : '').
                        ($name['lastname'] ? $name['lastname'].' ' : '');
        }
                
        protected function isRefIdAccessible($a_user_id, $a_ref_id, $a_permission = "read")
        {
                global $ilAccess;
                
                // no given permission == accessible
                
                if(!$this->is_in_wsp)
                {                                                                                               
                        if(trim($a_permission) &&
                                !$ilAccess->checkAccessOfUser($a_user_id, $a_permission, "", $a_ref_id, $this->getObjType()))
                        {
                                return false;
                        }
                }
                else
                {
                        if(trim($a_permission) &&
                                !$this->wsp_access_handler->checkAccessOfUser($this->wsp_tree, $a_user_id, $a_permission, "", $a_ref_id, $this->getObjType()))
                        {
                                return false;
                        }                                                               
                }
                return true;            
        }       
        
        public function getBlockBorder()
        {
                return "----------------------------------------\n";
        }
}

?>