chamilo-lms2/main/inc/lib/notification.lib.php

<?php
/* For licensing terms, see /license.txt */
/**
 *    This class provides methods for the Notification management.
 *    Include/require it in your code to use its features.
 * @package chamilo.library
 */
/**
 * Code
 */

/**
 * Notification class
 * @package chamilo.library
 */
class Notification extends Model
{
    public $table;
    public $columns = array(
        'id',
        'dest_user_id',
        'dest_mail',
        'title',
        'content',
        'send_freq',
        'created_at',
        'sent_at'
    );
    public $max_content_length = 254; //Max lenght of the notification.content field
    public $debug = false;
    public $type;
    public $admin_name;
    public $admin_email;

    public $send_email_as_user;

    //default values
    const NOTIFY_MESSAGE_AT_ONCE = 1;
    const NOTIFY_MESSAGE_DAILY   = 8;
    const NOTIFY_MESSAGE_WEEKLY  = 12;
    const NOTIFY_MESSAGE_NO      = 0;
    //mail_notify_message ("At once", "Daily", "No")

    const NOTIFY_INVITATION_AT_ONCE = 1;
    const NOTIFY_INVITATION_DAILY   = 8;
    const NOTIFY_INVITATION_WEEKLY  = 12;
    const NOTIFY_INVITATION_NO      = 0;

    //mail_notify_invitation ("At once", "Daily", "No")

    const NOTIFY_GROUP_AT_ONCE         = 1;
    const NOTIFY_GROUP_DAILY           = 8;
    const NOTIFY_GROUP_WEEKLY          = 12;
    const NOTIFY_GROUP_NO              = 0;
    const NOTIFICATION_TYPE_MESSAGE    = 1;
    const NOTIFICATION_TYPE_INVITATION = 2;
    const NOTIFICATION_TYPE_GROUP      = 3;

    // mail_notify_group_message ("At once", "Daily", "No")

    /**
     *
     */
    public function __construct()
    {
        $this->table = Database::get_main_table(TABLE_NOTIFICATION);

        $this->sender_email = api_get_setting('noreply_email_address');
        $this->sender_name  = api_get_setting('siteName');

        // If no-reply  email doesn't exist use the admin email
        if (empty($this->sender_email)) {
            $this->sender_email = api_get_setting('emailAdministrator');
            $this->sender_name  = api_get_person_name(
                api_get_setting('administratorName'),
                api_get_setting('administratorSurname'),
                null,
                PERSON_NAME_EMAIL_ADDRESS
            );
        }
    }

    /**
     *  Send the notifications
     * @param int notification frequency
     */
    public function send($frec = NOTIFY_MESSAGE_DAILY)
    {
        $notifications = $this->find('all', array('where' => array('sent_at IS NULL AND send_freq = ?' => $frec)));

        if (!empty($notifications)) {
            foreach ($notifications as $item_to_send) {

                $this->set_sender_info($item_to_send['sender_id']);

                //Sending email
                api_mail_html(
                    $item_to_send['dest_mail'],
                    $item_to_send['dest_mail'],
                    Security::filter_terms($item_to_send['title']),
                    Security::filter_terms($item_to_send['content']),
                    $this->sender_name,
                    $this->sender_email,
                    $this->extra_headers
                );
                if ($this->debug) {
                    error_log('Sending message to: '.$item_to_send['dest_mail']);
                }

                //Updating
                $item_to_send['sent_at'] = api_get_utc_datetime();
                $this->update($item_to_send);
                if ($this->debug) {
                    error_log('Updating record : '.print_r($item_to_send, 1));
                }
            }
        }
    }

    /**
     * Sets the sender info in order to add the reply-to
     */
    function set_sender_info($user_id)
    {
        if (!empty($user_id)) {
            $sender_user_info = api_get_user_info($user_id);
            if ($this->send_email_as_user) {
                $this->sender_email = $sender_user_info['email'];
                $this->sender_name  = $sender_user_info['complete_name'];
            } else {
                $this->extra_headers = array(
                    'reply_to' => array(
                        'name' => $sender_user_info['complete_name'],
                        'mail' => $sender_user_info['email']
                    )
                );
            }
        }
    }

    /**
     * Save message notification
     * @param    array    message type NOTIFICATION_TYPE_MESSAGE, NOTIFICATION_TYPE_INVITATION, NOTIFICATION_TYPE_GROUP
     * @param    array    recipients: user list of ids
     * @param    string    title
     * @param    string    content of the message
     * @param    array    result of api_get_user_info() or UserGroup->get()
     */
    public function save_notification($type, $user_list, $title, $content, $sender_info = array(), $text_content = null)
    {
        $this->type = intval($type);
        $content    = $this->format_content($content, $sender_info);

        $sender_id = 0;
        if (!empty($sender_info) && isset($sender_info['user_id'])) {
            $sender_id = $sender_info['user_id'];
            $this->set_sender_info($sender_id);
        }

        $setting_to_check = '';
        $avoid_my_self    = false;

        $default_status = self::NOTIFY_MESSAGE_AT_ONCE;

        switch ($this->type) {
            case self::NOTIFICATION_TYPE_MESSAGE:
                $setting_to_check = 'mail_notify_message';
                $default_status   = self::NOTIFY_MESSAGE_AT_ONCE;
                break;
            case self::NOTIFICATION_TYPE_INVITATION:
                $setting_to_check = 'mail_notify_invitation';
                $default_status   = self::NOTIFY_INVITATION_AT_ONCE;
                break;
            case self::NOTIFICATION_TYPE_GROUP:
                $setting_to_check = 'mail_notify_group_message';
                $default_status   = self::NOTIFY_GROUP_AT_ONCE;
                $avoid_my_self    = true;
                break;
        }

        $setting_info = UserManager::get_extra_field_information_by_name($setting_to_check);
        if (!empty($user_list)) {
            foreach ($user_list as $user_id) {
                if ($avoid_my_self) {
                    if ($user_id == api_get_user_id()) {
                        continue;
                    }
                }

                $user_info = api_get_user_info($user_id);
                //Extra field was deleted or removed? Use the default status
                if (empty($setting_info)) {
                    $user_setting = $default_status;
                } else {
                    $extra_data   = UserManager::get_extra_user_data($user_id);
                    $user_setting = $extra_data[$setting_to_check];
                }

                $params = array();

                switch ($user_setting) {
                    //No notifications
                    case self::NOTIFY_MESSAGE_NO:
                    case self::NOTIFY_INVITATION_NO:
                    case self::NOTIFY_GROUP_NO:
                        break;
                    //Send notification right now!
                    case self::NOTIFY_MESSAGE_AT_ONCE:
                    case self::NOTIFY_INVITATION_AT_ONCE:
                    case self::NOTIFY_GROUP_AT_ONCE:
                        if (!empty($user_info['mail'])) {
                            $name = api_get_person_name($user_info['firstname'], $user_info['lastname']);
                            if (!empty($sender_info['complete_name']) && !empty($sender_info['email'])) {
                                $extra_headers                     = array();
                                $extra_headers['reply_to']['mail'] = $sender_info['email'];
                                $extra_headers['reply_to']['name'] = $sender_info['complete_name'];
                                api_mail_html(
                                    $name,
                                    $user_info['mail'],
                                    Security::filter_terms($title),
                                    Security::filter_terms($content),
                                    $sender_info['complete_name'],
                                    $sender_info['email'],
                                    $extra_headers,
                                    array(),
                                    null,
                                    $text_content
                                );
                            } else {
                                api_mail_html(
                                    $name,
                                    $user_info['mail'],
                                    Security::filter_terms($title),
                                    Security::filter_terms($content),
                                    $sender_info['complete_name'],
                                    $sender_info['email'],
                                    array(),
                                    null,
                                    $text_content
                                );
                            }
                        }
                        $params['sent_at'] = api_get_utc_datetime();
                        // Saving the notification to be sent some day.
                    default:
                        $params['dest_user_id'] = $user_id;
                        $params['dest_mail']    = $user_info['mail'];
                        $params['title']        = $title;
                        $params['content']      = Text::cut($content, $this->max_content_length);
                        $params['send_freq']    = $user_setting;
                        $params['sender_id']    = $sender_id;
                        $this->save($params);
                        break;
                }
            }
        }
    }

    /**
     * Formats the content in order to add the welcome message, the notification preference, etc
     * @param    string    the content
     * @param    array    result of api_get_user_info() or UserGroup->get()
     * @todo create new templates based in Twig
     * */
    public function format_content($content, $sender_info)
    {
        return $content;
        $new_message_text = $link_to_new_message = '';

        switch ($this->type) {
            case self::NOTIFICATION_TYPE_MESSAGE:
                if (!empty($sender_info)) {
                    $sender_name      = api_get_person_name(
                        $sender_info['firstname'],
                        $sender_info['lastname'],
                        null,
                        PERSON_NAME_EMAIL_ADDRESS
                    );
                    $new_message_text = sprintf(get_lang('YouHaveANewMessageFromX'), $sender_name);
                }
                $link_to_new_message = Display::url(
                    get_lang('SeeMessage'),
                    api_get_path(WEB_CODE_PATH).'messages/inbox.php'
                );
                break;
            case self::NOTIFICATION_TYPE_INVITATION:
                if (!empty($sender_info)) {
                    $sender_name = api_get_person_name(
                        $sender_info['firstname'],
                        $sender_info['lastname'],
                        null,
                        PERSON_NAME_EMAIL_ADDRESS
                    );
                    //$sender_mail = $sender_info['email'] ;
                    $new_message_text = sprintf(get_lang('YouHaveANewInvitationFromX'), $sender_name);
                }
                $link_to_new_message = Display::url(
                    get_lang('SeeInvitation'),
                    api_get_path(WEB_CODE_PATH).'social/invitations.php'
                );
                break;
            case self::NOTIFICATION_TYPE_GROUP:
                $topic_page = intval($_REQUEST['topics_page_nr']);
                if (!empty($sender_info)) {
                    $sender_name      = $sender_info['group_info']['name'];
                    $new_message_text = sprintf(get_lang('YouHaveReceivedANewMessageInTheGroupX'), $sender_name);
                    if (isset($sender_info['user_info']) && !empty($sender_info['user_info'])) {
                        $sender_name = api_get_person_name(
                            $sender_info['user_info']['firstname'],
                            $sender_info['user_info']['lastname'],
                            null,
                            PERSON_NAME_EMAIL_ADDRESS
                        );
                        $sender_name = Display::url(
                            $sender_name,
                            api_get_path(WEB_CODE_PATH).'social/profile.php?'.$sender_info['user_info']['user_id']
                        );
                        $new_message_text .= '<br />'.get_lang('User').': '.$sender_name;
                    }
                }
                $group_url = api_get_path(WEB_CODE_PATH).'social/group_topics.php?id='.$sender_info['group_info']['id'].'&topic_id='.$sender_info['group_info']['topic_id'].'&msg_id='.$sender_info['group_info']['msg_id'].'&topics_page_nr='.$topic_page;
                $link_to_new_message = Display::url(get_lang('SeeMessage'), $group_url);
                break;
        }
        $preference_url = api_get_path(WEB_CODE_PATH).'auth/profile.php';

        // You have received a new message text
        if (!empty($new_message_text)) {
            $content = $new_message_text.'<br /><hr><br />'.$content;
        }

        // See message with link text
        if (!empty($link_to_new_message)) {
            $content = $content.'<br /><br />'.$link_to_new_message;
        }

        // You have received this message because you are subscribed text
        $content = $content.'<br /><hr><i>'.
            sprintf(
                get_lang(
                    'YouHaveReceivedThisNotificationBecauseYouAreSubscribedOrInvolvedInItToChangeYourNotificationPreferencesPleaseClickHereX'
                ),
                Display::url($preference_url, $preference_url)
            ).'</i>';

        return $content;
    }
}