notifier::enqueue_notifications() - Code Metrics - Inspection of "CONTRIB-7905 (#164)" - jfederico/moodle-mod_bigbluebuttonbn - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 2cf02e...c7d8b1 )

by Jesus
created 2020-01-21 18:08 UTC
notifier::enqueue_notifications() A

↳ Parent: notifier
Complexity

Conditions	4
Paths	6
Size

Total Lines	20
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	12
c	0
b	0
f	0
nc	6
nop	3
dl	0
loc	20
rs	9.8666
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * The mod_bigbluebuttonbn locallib/notifier.
 *
 * @package   mod_bigbluebuttonbn
 * @copyright 2017 - present, Blindside Networks Inc
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @author    Jesus Federico  (jesus [at] blindsidenetworks [dt] com)
 */

namespace mod_bigbluebuttonbn\locallib;

defined('MOODLE_INTERNAL') || die();

require_once($CFG->dirroot . '/mod/bigbluebuttonbn/locallib.php');

/**
 * Helper class for sending notifications.
 *
 * @copyright 2010 onwards, Blindside Networks Inc
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class notifier
{
    /**
     * Prepares html message body for instance updated notification.
     *
     * @param object $msg
     * @return string
     */
    public static function htmlmsg_instance_updated($msg) {
        $messagetext = '<p>'.$msg->activity_type.' "'.$msg->activity_title.'" '.
            get_string('email_body_notification_meeting_has_been', 'bigbluebuttonbn').' '.$msg->action.'.</p>'."\n";
            get_string('email_body_notification_meeting_has_been', 'bigbluebuttonbn').' '.$msg->action.'.</p>'."\n";
        $messagetext .= '<p><b>'.$msg->activity_title.'</b> '.
            get_string('email_body_notification_meeting_details', 'bigbluebuttonbn').':'."\n";
        $messagetext .= '<table border="0" style="margin: 5px 0 0 20px"><tbody>'."\n";
        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
            get_string('email_body_notification_meeting_title', 'bigbluebuttonbn').': </td><td>'."\n";
        $messagetext .= $msg->activity_title.'</td></tr>'."\n";
        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
            get_string('email_body_notification_meeting_description', 'bigbluebuttonbn').': </td><td>'."\n";
        $messagetext .= $msg->activity_description.'</td></tr>'."\n";
        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
            get_string('email_body_notification_meeting_start_date', 'bigbluebuttonbn').': </td><td>'."\n";
        $messagetext .= $msg->activity_openingtime.'</td></tr>'."\n";
        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.
            get_string('email_body_notification_meeting_end_date', 'bigbluebuttonbn').': </td><td>'."\n";
        $messagetext .= $msg->activity_closingtime.'</td></tr>'."\n";
        $messagetext .= '<tr><td style="font-weight:bold;color:#555;">'.$msg->action.' '.
            get_string('email_body_notification_meeting_by', 'bigbluebuttonbn').': </td><td>'."\n";
        $messagetext .= $msg->activity_owner.'</td></tr></tbody></table></p>'."\n";
        $messagetext .= '<p><hr/><br/>'.get_string('email_footer_sent_by', 'bigbluebuttonbn').' '.
            $msg->user_name.'('.$msg->user_email.') ';
        $messagetext .= get_string('email_footer_sent_from', 'bigbluebuttonbn').' '.$msg->course_name.'.</p>';
        return $messagetext;
    }

    /**
     * Starts the notification process.
     *
     * @param object $bigbluebuttonbn
     * @param string $action
     * @return void
     */
    public static function notify_instance_updated($bigbluebuttonbn, $action) {
        global $USER;
        $coursemodinfo = \course_modinfo::instance($bigbluebuttonbn->course);
filter:
    dependency_paths: ["lib/*"]
        $course = $coursemodinfo->get_course($bigbluebuttonbn->course);
        $sender = $USER;
        // Prepare message.
        $msg = (object) array();
        // Build the message_body.
        $msg->action = $action;
        $msg->activity_type = '';
        $msg->activity_title = $bigbluebuttonbn->name;
        // Add the meeting details to the message_body.
        $msg->action = ucfirst($action);
        $msg->activity_description = '';
        if (!empty($bigbluebuttonbn->intro)) {
            $msg->activity_description = trim($bigbluebuttonbn->intro);
        }
        $msg->activity_openingtime = bigbluebuttonbn_format_activity_time($bigbluebuttonbn->openingtime);
        $msg->activity_closingtime = bigbluebuttonbn_format_activity_time($bigbluebuttonbn->closingtime);
        $msg->activity_owner = fullname($sender);
        $msg->activity_owner = /** @scrutinizer ignore-call */ fullname($sender);

        $msg->user_name = fullname($sender);
        $msg->user_email = $sender->email;
        $msg->course_name = $course->fullname;

        // Send notification to all users enrolled.
        self::send_notifications($bigbluebuttonbn, $sender, self::htmlmsg_instance_updated($msg));
              send_notifications($bigbluebuttonbn, $sender, self::htmlmsg_instance_updated($msg));
    }

    /**
     * Prepares html message body for recording ready notification.
     *
     * @param object $bigbluebuttonbn
     *
     * @return void
     */
    public static function htmlmsg_recording_ready($bigbluebuttonbn) {
        return '<p>'.get_string('email_body_recording_ready_for', 'bigbluebuttonbn').
        return '<p>'./** @scrutinizer ignore-call */ get_string('email_body_recording_ready_for', 'bigbluebuttonbn').
            ' &quot;' . $bigbluebuttonbn->name . '&quot; '.
            get_string('email_body_recording_ready_is_ready', 'bigbluebuttonbn').'.</p>';
    }

    /**
     * Helper function triggers a send notification when the recording is ready.
     *
     * @param object $bigbluebuttonbn
     *
     * @return void
     */
    public static function notify_recording_ready($bigbluebuttonbn) {
        $sender = get_admin();
        $sender = /** @scrutinizer ignore-call */ get_admin();
        $htmlmsg = self::htmlmsg_recording_ready($bigbluebuttonbn);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        self::send_notifications($bigbluebuttonbn, $sender, $htmlmsg);
    }

    /**
     * Enqueue notifications to be sent to all users in a context where the instance belongs.
     *
     * @param object $bigbluebuttonbn
     * @param object $sender
     * @param string $htmlmsg
     * @return void
     */
    public static function enqueue_notifications($bigbluebuttonbn, $sender, $htmlmsg) {
        foreach (self::receivers($bigbluebuttonbn->course) as $receiver) {
            if ($sender->id != $receiver->id) {
                // Enqueue a task for sending a notification.
                try {
                    // Create the instance of completion_update_state task.
                    $task = new \mod_bigbluebuttonbn\task\send_notification();
                    // Add custom data.
                    $data = array(
                        'sender' => $sender,
                        'receiver' => $receiver,
                        'htmlmsg' => $htmlmsg
                    );
                    $task->set_custom_data($data);
                    // CONTRIB-7457: Task should be executed by a user, maybe Teacher as Student won't have rights for everriding.
                    // $ task -> set_userid ( $ user -> id );.
                    // Queue it.
                    \core\task\manager::queue_adhoc_task($task);
filter:
    dependency_paths: ["lib/*"]
                } catch (Exception $e) {

                    mtrace("Error while enqueuing completion_uopdate_state task. " . (string)$e);
                    mtrace("Error while enqueuing completion_uopdate_state task. " . (string)$e);
                }
            }
        }
    }

    /**
     * Sends notification to a user.
     *
     * @param object $sender
     * @param object $receiver
     * @param object $htmlmsg
     * @return void
     */
    public static function send_notification($sender, $receiver, $htmlmsg) {
        // Send the message.
        message_post_message($sender, $receiver, $htmlmsg, FORMAT_HTML);
        message_post_message($sender, $receiver, $htmlmsg, FORMAT_HTML);
    }

    /**
     * Define users to be notified.
     *
     * @param object $courseid
     * @return array
     */
    public static function receivers($courseid) {
        $context = \context_course::instance($courseid);
filter:
    dependency_paths: ["lib/*"]
        $users = array();

        // See if there are any users in the lesson.
        list($sort, $params) = users_order_by_sql('u');
        list($sort, $params) = /** @scrutinizer ignore-call */ users_order_by_sql('u');
        $users = get_enrolled_users($context, 'mod/bigbluebuttonbn:view', 0, 'u.*', $sort);
        $users = /** @scrutinizer ignore-call */ get_enrolled_users($context, 'mod/bigbluebuttonbn:view', 0, 'u.*', $sort);
        return $users;
    }
}

jfederico / moodle-mod_bigbluebuttonbn

Push — master ( 2cf02e...c7d8b1 )

notifier::enqueue_notifications() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
