class.ilSystemNotification.php

Go to the documentation of this file.

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

include_once './Services/Mail/classes/class.ilMailNotification.php';

class ilSystemNotification extends ilMailNotification
{
        protected $subject_lang_id; // [string]
        protected $introduction; // [string]
        protected $introduction_direct; // [string]
        protected $task; // [string]
        protected $reason; // [string]
        protected $additional; // [array]
        protected $goto_caption; // [string]    
        protected $changed_by; // [int]
        protected $all_ref_ids; // [array]
        
        public function setSubjectLangId($a_lang_id)
        {
                $this->subject_lang_id = (string)$a_lang_id;
        }
        
        public function setIntroductionLangId($a_lang_id)
        {
                $this->introduction = (string)$a_lang_id;
        }
        
        public function setIntroductionDirect($a_text)
        {
                $this->introduction_direct = trim($a_text);
        }
        
        public function setTaskLangId($a_lang_id)
        {
                $this->task = (string)$a_lang_id;
        }
        
        public function setReasonLangId($a_lang_id)
        {
                $this->reason = (string)$a_lang_id;
        }
        
        public function setGotoLangId($a_lang_id)
        {
                $this->goto_caption = (string)$a_lang_id;
        }
        
        public function setChangedByUserId($a_id)
        {
                $this->changed_by = (int)$a_id;
                
                include_once "Services/User/classes/class.ilUserUtil.php";
        }
        
        public function addAdditionalInfo($a_lang_id, $a_value, $a_multiline = false, $a_lang_direct = false)
        {
                $this->additional[$a_lang_id] = array(trim($a_value), (bool)$a_multiline, (bool)$a_lang_direct);
        }
        
        public function sendMail(array $a_user_ids, $a_goto_additional = null, $a_permission = "read")
        {               
                $this->all_ref_ids = null;
                
                // prepare object related info
                if($this->getObjId())
                {                                               
                        if(!$this->getRefId())
                        {
                                // try to find ref_id(s)
                                if(!$this->is_in_wsp)
                                {
                                        $ref_ids = ilObject::_getAllReferences($this->getObjId());                              
                                        if(sizeof($ref_ids) == 1)
                                        {
                                                $this->ref_id = array_shift($ref_ids);
                                        }
                                        else
                                        {
                                                $this->all_ref_ids = $ref_ids;
                                        }
                                }
                        }
                        else if($this->is_in_wsp) // #11680
                        {                                       
                                $this->ref_id = $this->wsp_tree->lookupNodeId($this->getObjId());
                        }
                        
                        // default values
                        if(!$this->goto_caption)
                        {
                                $this->goto_caption = "url";                    
                        }
                }
                
                $recipient_ids = array();
                foreach(array_unique($a_user_ids) as $user_id)
                {                               
                        // author of change should not get notification
                        if($this->changed_by == $user_id)
                        {
                                continue;
                        }
                        
                        if($this->composeAndSendMail($user_id, $a_goto_additional, $a_permission))
                        {
                                $recipient_ids[] = $user_id;
                        }
                }       
                
                return $recipient_ids;
        }       
        
        public function compose($a_user_id, $a_goto_additional = null, $a_permission = "read", $a_append_signature_direct = false)
        {
                $this->initLanguage($a_user_id);                
                $this->initMail();

                $this->setSubject(
                        sprintf($this->getLanguageText($this->subject_lang_id), $this->getObjectTitle(true))
                );

                $this->setBody(ilMail::getSalutation($a_user_id, $this->getLanguage()));
                $this->appendBody("\n\n");

                if($this->introduction)
                {
                        $this->appendBody($this->getLanguageText($this->introduction)); 
                        $this->appendBody("\n\n");
                }

                if($this->introduction_direct)
                {
                        $this->appendBody($this->introduction_direct);  
                        $this->appendBody("\n\n");
                }

                if($this->task)
                {
                        $this->appendBody($this->getLanguageText($this->task)); 
                        $this->appendBody("\n\n");
                }

                // details table
                if($this->getObjId())
                {
                        $this->appendBody($this->getLanguageText("obj_".$this->getObjType()).": ".
                                $this->getObjectTitle()."\n");
                }
                if(sizeof($this->additional))
                {
                        foreach($this->additional as $lang_id => $item)
                        {
                                $caption = "";
                                if($lang_id)
                                {
                                        $caption = (!$item[2])
                                                ? $this->getLanguageText($lang_id)
                                                : $lang_id;                                     
                                }                               
                                if(!$item[1])
                                {
                                        if($caption)
                                        {
                                                $caption .= ": ";
                                        }                                                               
                                        $this->appendBody($caption.$item[0]."\n");                                              
                                }                               
                                else
                                {
                                        if($caption)
                                        {
                                                $caption .= "\n";
                                        }               
                                        $this->appendBody("\n".$caption.
                                                $this->getBlockBorder().
                                                $item[0]."\n".
                                                $this->getBlockBorder()."\n");  
                                }
                        }
                }
                $this->body = trim($this->body);
                $this->appendBody("\n\n");

                if($this->changed_by)
                {                               
                        $this->appendBody($this->getLanguageText("system_notification_installation_changed_by").": ".
                                ilUserUtil::getNamePresentation($this->changed_by));
                        $this->appendBody("\n\n");
                }

                if($this->getObjId())
                {
                        // try to find accessible ref_id
                        if(!$this->getRefId() && $this->all_ref_ids)
                        {
                                $find_ref_id = true;                                            
                                foreach($this->all_ref_ids as $ref_id)
                                {               
                                        if($this->isRefIdAccessible($a_user_id, $ref_id, $a_permission))                                                
                                        {
                                                $this->ref_id = $ref_id;
                                                break;
                                        }
                                }
                        }
                        
                        // check if initially given ref_id is accessible for current recipient
                        if($this->getRefId() &&
                                !$find_ref_id && 
                                !$this->isRefIdAccessible($a_user_id, $this->getRefId(), $a_permission))
                        {
                                return false;
                        }
                        
                        $goto = $this->createPermanentLink(array(), $a_goto_additional);                                                        
                        if($goto)
                        {                               
                                $this->appendBody($this->getLanguageText($this->goto_caption).": ".
                                        $goto);
                                $this->appendBody("\n\n");
                        }

                        if($find_ref_id)
                        {
                                $this->ref_id = null;
                        }
                }

                if($this->reason)
                {
                        $this->appendBody($this->getLanguageText($this->reason));       
                        $this->appendBody("\n\n");
                }                               
                
                $this->appendBody(ilMail::_getAutoGeneratedMessageString($this->language));                     

                // signature will append new lines
                $this->body = trim($this->body);

                if(!$a_append_signature_direct)
                {                       
                        $this->getMail()->appendInstallationSignature(true);
                }
                else 
                {                       
                        $this->appendBody(ilMail::_getInstallationSignature());
                }       
                
                return true;
        }
        
        protected function composeAndSendMail($a_user_id, $a_goto_additional = null, $a_permission = "read")
        {                                               
                if($this->compose($a_user_id, $a_goto_additional, $a_permission))
                {
                        parent::sendMail(array($a_user_id), array('system'), is_numeric($a_user_id));                                                           
                        return true;
                }
                return false;
        }
        
        public function composeAndGetMessage($a_user_id, $a_goto_additional = null, $a_permission = "read", $a_append_signature_direct = false)
        {
                if($this->compose($a_user_id, $a_goto_additional, $a_permission, $a_append_signature_direct))
                {
                        return $this->body;
                }
        }
}

?>