mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-19 06:18:28 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-78918-master' of https://github.com/ssj365/moodle

Browse Source
This commit is contained in:
Sara Arjona 2023-09-28 09:47:10 +02:00
commit c571d3a0da
No known key found for this signature in database
7 changed files with 304 additions and 218 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

224
mod/bigbluebuttonbn/classes/task/base_send_notification.php Normal file
View File

@ -0,0 +1,224 @@
<?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/>.
namespace mod_bigbluebuttonbn\task;
use core\message\message;
use core\task\adhoc_task;
use mod_bigbluebuttonbn\instance;
use moodle_exception;
use stdClass;
/**
* Class containing the abstract class for notification processes in BBB.
*
* @package mod_bigbluebuttonbn
* @copyright 2023 onwards, Blindside Networks Inc
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class base_send_notification extends adhoc_task {
/** @var instance */
protected $instance = null;
/** @var object */
protected $coursecontact = null;
/**
* Execute the task.
*/
public function execute() {
$this->send_all_notifications();
}
/**
* Append additional elements of custom data
*
* @param array $newdata
*/
protected function append_custom_data(array $newdata): void {
if ($currentdata = (array) $this->get_custom_data()) {
$newdata = array_merge($currentdata, $newdata);
}
$this->set_custom_data($newdata);
}
/**
* Set the instanceid in the custom data.
*
* @param int $instanceid
*/
public function set_instance_id(int $instanceid): void {
$this->append_custom_data(['instanceid' => $instanceid]);
}
/**
* Get the bigbluebutton instance that this notification is for.
*
* @return instance
*/
protected function get_instance(): instance {
if ($this->instance === null) {
$this->instance = instance::get_from_instanceid($this->get_custom_data()->instanceid);
}
return $this->instance;
}
/**
* Get the preferred course contact for this notification.
*
* @return stdClass
*/
protected function get_course_contact(): stdClass {
global $DB;
if ($this->coursecontact === null) {
// Get course managers so they can be highlighted in the list.
$coursecontext = $this->get_instance()->get_course_context();
if ($managerroles = get_config('', 'coursecontact')) {
$coursecontactroles = explode(',', $managerroles);
foreach ($coursecontactroles as $roleid) {
$contacts = get_role_users($roleid, $coursecontext, true, 'u.id', 'u.id ASC');
foreach ($contacts as $contact) {
$this->coursecontact = $contact;
break;
}
}
}
if ($this->coursecontact === null) {
$this->coursecontact = \core_user::get_noreply_user();
}
}
return $this->coursecontact;
}
/**
* Get the list of recipients for the notification.
*
* @return stdClass[]
*/
protected function get_recipients(): array {
// Potential users should be active users only.
return get_enrolled_users(
$this->get_instance()->get_course_context(),
'mod/bigbluebuttonbn:view',
0,
'u.*',
null,
0,
0,
true
);
}
/**
* Get the HTML message content.
*
* @return string
*/
abstract protected function get_html_message(): string;
/**
* Get the plain text message content.
*
* @return string
*/
protected function get_message(): string {
return html_to_text($this->get_html_message());
}
/**
* Get the short summary message.
*
* @return string
*/
abstract protected function get_small_message(): string;
/**
* Get the preferred message format
*
* @return string
*/
protected function get_message_format(): string {
return FORMAT_HTML;
}
/**
* Get the notification type.
*
* @return string
*/
abstract protected function get_notification_type(): string;
/**
* Get the subject of the notification.
*
* @return string
*/
abstract protected function get_subject(): string;
/**
* Send all of the notifications
*/
protected function send_all_notifications(): void {
$instance = $this->get_instance();
foreach ($this->get_recipients() as $recipient) {
try {
\core_user::require_active_user($recipient, true, true);
\core\cron::setup_user($recipient);
} catch (moodle_exception $e) {
// Skip sending.
continue;
}
$this->send_notification_to_current_user();
}
\core\cron::setup_user();
}
/**
* Send the notificiation to the current user.
*/
protected function send_notification_to_current_user(): void {
global $USER;
$instance = $this->get_instance();
$eventdata = new message();
$eventdata->courseid = $instance->get_course_id();
$eventdata->component = 'mod_bigbluebuttonbn';
$eventdata->name = $this->get_notification_type();
$eventdata->userfrom = $this->get_course_contact();
$eventdata->userto = $USER;
$eventdata->subject = $this->get_subject();
$eventdata->smallmessage = $this->get_small_message();
$eventdata->fullmessage = $this->get_message();
$eventdata->fullmessageformat = $this->get_message_format();
$eventdata->fullmessagehtml = $this->get_html_message();
$eventdata->notification = 1;
$eventdata->contexturl = $this->get_instance()->get_view_url();
$eventdata->contexturlname = $this->get_instance()->get_meeting_name();
message_send($eventdata);
}
}

2
mod/bigbluebuttonbn/classes/task/send_guest_emails.php
View File

@ -25,7 +25,7 @@ use html_writer;
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @author Laurent David (laurent [at] call-learning [dt] fr)
*/
class send_guest_emails extends send_notification {
class send_guest_emails extends base_send_notification {
/**
* Get the notification type.

197
mod/bigbluebuttonbn/classes/task/send_notification.php
View File

@ -15,210 +15,31 @@
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
namespace mod_bigbluebuttonbn\task;
use core\message\message;
use core\task\adhoc_task;
use mod_bigbluebuttonbn\instance;
use moodle_exception;
use stdClass;
/**
* Class containing the abstract class for notification processes in BBB.
* Class containing the deprecated class for send_notification event in BBB.
*
* @package mod_bigbluebuttonbn
* @copyright 2021 Andrew Lyons <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class send_notification extends adhoc_task {
/** @var instance */
protected $instance = null;
/** @var object */
protected $coursecontact = null;
class send_notification extends adhoc_task {
/**
* Execute the task.
*/
public function execute() {
$this->send_all_notifications();
// Log the debug message.
$message = $this->generate_message();
debugging($message, DEBUG_DEVELOPER);
}
/**
* Append additional elements of custom data
* Output the debug log message.
*
* @param array $newdata
* @return string The debug log message.
*/
protected function append_custom_data(array $newdata): void {
if ($currentdata = (array) $this->get_custom_data()) {
$newdata = array_merge($currentdata, $newdata);
}
$this->set_custom_data($newdata);
}
/**
* Set the instanceid in the custom data.
*
* @param int $instanceid
*/
public function set_instance_id(int $instanceid): void {
$this->append_custom_data(['instanceid' => $instanceid]);
}
/**
* Get the bigbluebutton instance that this notification is for.
*
* @return instance
*/
protected function get_instance(): instance {
if ($this->instance === null) {
$this->instance = instance::get_from_instanceid($this->get_custom_data()->instanceid);
}
return $this->instance;
}
/**
* Get the preferred course contact for this notification.
*
* @return stdClass
*/
protected function get_course_contact(): stdClass {
global $DB;
if ($this->coursecontact === null) {
// Get course managers so they can be highlighted in the list.
$coursecontext = $this->get_instance()->get_course_context();
if ($managerroles = get_config('', 'coursecontact')) {
$coursecontactroles = explode(',', $managerroles);
foreach ($coursecontactroles as $roleid) {
$contacts = get_role_users($roleid, $coursecontext, true, 'u.id', 'u.id ASC');
foreach ($contacts as $contact) {
$this->coursecontact = $contact;
break;
}
}
}
if ($this->coursecontact === null) {
$this->coursecontact = \core_user::get_noreply_user();
}
}
return $this->coursecontact;
}
/**
* Get the list of recipients for the notification.
*
* @return stdClass[]
*/
protected function get_recipients(): array {
// Potential users should be active users only.
return get_enrolled_users(
$this->get_instance()->get_course_context(),
'mod/bigbluebuttonbn:view',
0,
'u.*',
null,
0,
0,
true
);
}
/**
* Get the HTML message content.
*
* @return string
*/
abstract protected function get_html_message(): string;
/**
* Get the plain text message content.
*
* @return string
*/
protected function get_message(): string {
return html_to_text($this->get_html_message());
}
/**
* Get the short summary message.
*
* @return string
*/
abstract protected function get_small_message(): string;
/**
* Get the preferred message format
*
* @return string
*/
protected function get_message_format(): string {
return FORMAT_HTML;
}
/**
* Get the notification type.
*
* @return string
*/
abstract protected function get_notification_type(): string;
/**
* Get the subject of the notification.
*
* @return string
*/
abstract protected function get_subject(): string;
/**
* Send all of the notifications
*/
protected function send_all_notifications(): void {
$instance = $this->get_instance();
foreach ($this->get_recipients() as $recipient) {
try {
\core_user::require_active_user($recipient, true, true);
\core\cron::setup_user($recipient);
} catch (moodle_exception $e) {
// Skip sending.
continue;
}
$this->send_notification_to_current_user();
}
\core\cron::setup_user();
}
/**
* Send the notificiation to the current user.
*/
protected function send_notification_to_current_user(): void {
global $USER;
$instance = $this->get_instance();
$eventdata = new message();
$eventdata->courseid = $instance->get_course_id();
$eventdata->component = 'mod_bigbluebuttonbn';
$eventdata->name = $this->get_notification_type();
$eventdata->userfrom = $this->get_course_contact();
$eventdata->userto = $USER;
$eventdata->subject = $this->get_subject();
$eventdata->smallmessage = $this->get_small_message();
$eventdata->fullmessage = $this->get_message();
$eventdata->fullmessageformat = $this->get_message_format();
$eventdata->fullmessagehtml = $this->get_html_message();
$eventdata->notification = 1;
$eventdata->contexturl = $this->get_instance()->get_view_url();
$eventdata->contexturlname = $this->get_instance()->get_meeting_name();
message_send($eventdata);
public function generate_message() {
return "Attempted to run deprecated implementation of send_notification task.";
}
}

2
mod/bigbluebuttonbn/classes/task/send_recording_ready_notification.php
View File

@ -25,7 +25,7 @@ use html_writer;
* @copyright 2021 Andrew Lyons <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class send_recording_ready_notification extends send_notification {
class send_recording_ready_notification extends base_send_notification {
/**
* Get the notification type.
*

62
mod/bigbluebuttonbn/tests/task/base_send_notification_test.php Normal file
View File

@ -0,0 +1,62 @@
<?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/>.
namespace mod_bigbluebuttonbn\task;
use advanced_testcase;
/**
* Class containing the scheduled task for lti module.
*
* @package mod_bigbluebuttonbn
* @copyright 2023 onwards, Blindside Networks Inc
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @covers \mod_bigbluebuttonbn\task\base_send_notification
* @coversDefaultClass \mod_bigbluebuttonbn\task\base_send_notification
*/
class base_send_notification_test extends advanced_testcase {
/**
* Check if set instance ID works correctly
*
*/
public function test_set_instance_id(): void {
$this->resetAfterTest();
$stub = $this->getMockForAbstractClass(
base_send_notification::class,
[],
'',
true,
true,
true,
[]
);
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$instancedata = $generator->create_module('bigbluebuttonbn', [
'course' => $course->id,
]);
$stub->set_instance_id($instancedata->id);
$rc = new \ReflectionClass(base_send_notification::class);
$rcm = $rc->getMethod('get_instance');
$rcm->setAccessible(true);
$instance = $rcm->invoke($stub);
$this->assertEquals($instancedata->id, $instance->get_instance_id());
}
}

31
mod/bigbluebuttonbn/tests/task/send_notification_test.php
View File

@ -29,34 +29,13 @@ use advanced_testcase;
*/
class send_notification_test extends advanced_testcase {
/**
* Check if set instance ID works correctly
* Test that the debug message is correctly output.
*
*/
public function test_set_instance_id(): void {
public function test_generate_message() {
$this->resetAfterTest();
$stub = $this->getMockForAbstractClass(
send_notification::class,
[],
'',
true,
true,
true,
[]
);
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$instancedata = $generator->create_module('bigbluebuttonbn', [
'course' => $course->id,
]);
$stub->set_instance_id($instancedata->id);
$rc = new \ReflectionClass(send_notification::class);
$rcm = $rc->getMethod('get_instance');
$rcm->setAccessible(true);
$instance = $rcm->invoke($stub);
$this->assertEquals($instancedata->id, $instance->get_instance_id());
$task = new send_notification();
$message = $task->generate_message();
$this->assertEquals("Attempted to run deprecated implementation of send_notification task.", $message);
}
}

4
mod/bigbluebuttonbn/tests/task/send_recording_ready_notification_test.php
View File

@ -24,8 +24,8 @@ use advanced_testcase;
* @package mod_bigbluebuttonbn
* @copyright 2019 onwards, Blindside Networks Inc
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @coversDefaultClass \mod_bigbluebuttonbn\task\send_notification
* @covers \mod_bigbluebuttonbn\task\send_notification
* @coversDefaultClass \mod_bigbluebuttonbn\task\base_send_notification
* @covers \mod_bigbluebuttonbn\task\base_send_notification
* @covers \mod_bigbluebuttonbn\task\send_recording_ready_notification
*/
class send_recording_ready_notification_test extends advanced_testcase {