Skip to content

Commit

Permalink
Code cleanup of send_ical_notifications task
Browse files Browse the repository at this point in the history 
Code cleanup of send_ical_notifications task
  • Loading branch information
@paulandm
paulandm committed Oct 1, 2024
1 parent 3b80e0e commit c918384
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 103 deletions.
136 changes: 35 additions & 101 deletions classes/task/send_ical_notifications.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@

namespace mod_zoom\task;

use calendar_event;

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

require_once($CFG->dirroot.'/calendar/lib.php');
Expand All @@ -51,7 +49,7 @@ public function execute() {
foreach ($zoomrecords as $zoomrecord) {
mtrace('[Zoom ical Notifications] Checking to see if zoom record with ID ' .
$zoomrecord->id . ' was notified before.');
$executiontime = $this->get_notification_execution_time($zoomrecord->id);
$executiontime = $this->get_notification_executiontime($zoomrecord->id);
// Only run if it hasn't run before.
if ($executiontime == 0) {
mtrace('[Zoom ical Notifications] Zoom instance with ID ' .
Expand All @@ -60,7 +58,7 @@ public function execute() {
// Set execution time for this cron job.
mtrace('[Zoom ical Notifications] Zoom instance with ID ' . $zoomrecord->id .
' was successfully notified - set execution time for log table.');
$this->set_notification_execution_time($zoomrecord->id);
$this->set_notification_executiontime($zoomrecord->id);
}
}
} else {
Expand All @@ -75,15 +73,16 @@ public function execute() {
}

/**
* Get zoom module instances created/modified in the last hour, but ignore the last 10 minutes.
* Get zoom module instances created/modified in the last hour, but ignore the last 2 minutes.
* @return array
*/
private function get_potential_zoom_to_notify() {
global $DB;

$sql = 'SELECT *
FROM {zoom}
WHERE timemodified >= (unix_timestamp() - (60 * 60))
AND timemodified <= (unix_timestamp() - (10 * 60))';
AND timemodified <= (unix_timestamp() - (2 * 60))';

return $DB->get_records_sql($sql);
}
Expand All @@ -93,14 +92,10 @@ private function get_potential_zoom_to_notify() {
* @param string $zoomid The zoom instance id.
* @return string The timestamp of the last execution.
*/
private function get_notification_execution_time(string $zoomid) {
private function get_notification_executiontime(string $zoomid) {
global $DB;

$sql = 'SELECT execution_time
FROM {zoom_ical_notifications}
WHERE zoomid = :zoom_id';

$executiontime = $DB->get_field_sql($sql, ['zoom_id' => $zoomid]);
$executiontime = $DB->get_field('zoom_ical_notifications', 'executiontime', ['zoomid' => $zoomid]);
if (!$executiontime) {
$executiontime = 0;
}
Expand All @@ -111,49 +106,32 @@ private function get_notification_execution_time(string $zoomid) {
* Set the execution time (the current time) for the related zoom id.
* @param string $zoomid The zoom instance id.
*/
private function set_notification_execution_time(string $zoomid) {
private function set_notification_executiontime(string $zoomid) {
global $DB;

$icalnotifojb = new \stdClass();
$icalnotifojb->zoomid = $zoomid;
$icalnotifojb->execution_time = time();
$icalnotifojb->executiontime = time();

$DB->insert_record('zoom_ical_notifications', $icalnotifojb);
}

/**
* The zoom ical notification task.
* @param mixed $zoom The zoom entry.
* @param stdClass $zoom The zoom entry.
*/
private function zoom_ical_notification($zoom) {
global $CFG, $DB, $SITE;
global $DB;

mtrace('[Zoom ical Notifications] Notifying Zoom instance with ID ' . $zoom->id);

$zoomevent = $DB->get_record('event', ['instance' => $zoom->id, 'courseid' => $zoom->course,
'modulename' => 'zoom', 'eventtype' => 'zoom']);
if ($zoomevent) {

$calevent = new \calendar_event($zoomevent); // To use moodle calendar event services.

$users = $this->zoom_get_users_to_notify($zoom->id);
$users = $this->zoom_filter_users($zoom, $users);

// HTML value to render in email body.
$caleventdescription = $calevent->description;
// Avoid filters - so we can manually add links as required.
$activityurl = $CFG->wwwroot . '/mod/zoom/view.php?id=';
$modinfo = get_fast_modinfo($zoom->course);
$coursemodules = $modinfo->get_cms();
if ($coursemodules) {
foreach ($coursemodules as $coursemod) {
if ($coursemod->modname == 'zoom' && $coursemod->instance == $zoom->id) {
$activityurl .= $coursemod->id;
break;
}
}
}

$filestorage = get_file_storage();

foreach ($users as $user) {
Expand All @@ -162,8 +140,7 @@ private function zoom_ical_notification($zoom) {
continue;
}

// Send email.
$ical = $this->create_ical_object($zoom, $zoomevent, $calevent, $caleventdescription, $user);
$ical = $this->create_ical_object($zoom, $zoomevent, $user);

$filerecord = [
'contextid' => \context_user::instance($user->id)->id,
Expand All @@ -189,10 +166,10 @@ private function zoom_ical_notification($zoom) {
$messagedata->userfrom = \core_user::get_noreply_user();
$messagedata->userto = $user;
$messagedata->subject = $zoomevent->name;
$messagedata->fullmessage = $caleventdescription;
$messagedata->fullmessage = $zoomevent->description;
$messagedata->fullmessageformat = FORMAT_HTML;
$messagedata->fullmessagehtml = $caleventdescription;
$messagedata->smallmessage = $zoomevent->name . ' - ' . $caleventdescription;
$messagedata->fullmessagehtml = $zoomevent->description;
$messagedata->smallmessage = $zoomevent->name . ' - ' . $zoomevent->description;
$messagedata->notification = true;
$messagedata->attachment = $icalfileattachment;
$messagedata->attachname = $icalfileattachment->get_filename();
Expand All @@ -213,74 +190,45 @@ private function zoom_ical_notification($zoom) {
/**
* Create the ical object.
* @param stdClass $zoom The zoom entry.
* @param object $zoomevent The event entry for the zoom instance.
* @param \calendar_event $calevent The calendar event related to the zoom instance.
* @param string $description The calendar event description.
* @param \user $user The user object.
* @param stdClass $zoomevent The event entry for the zoom instance.
* @param stdClass $user The user object.
* @return \iCalendar
*/
private function create_ical_object($zoom, $zoomevent, $calevent, $description, $user) {
global $CFG;
$ical = new \iCalendar;
private function create_ical_object($zoom, $zoomevent, $user) {
global $CFG, $SITE;

$ical = new \iCalendar();
$ical->add_property('method', 'PUBLISH');
$ical->add_property('prodid', '-//Moodle Pty Ltd//NONSGML Moodle Version ' . $CFG->version . '//EN');

$hostaddress = str_replace('http://', '', $CFG->wwwroot);
$hostaddress = str_replace('https://', '', $hostaddress);

$ev = new \iCalendar_event; // To export in ical format.
$ev->add_property('uid', $zoomevent->id.'@'.$hostaddress);

// Set iCal event summary from event name.
$ev->add_property('summary', format_string($zoomevent->name, true, ['context' => $calevent->context]));

$ev->add_property('description', html_to_text($description, 0));

$ev->add_property('class', 'PUBLIC'); // PUBLIC / PRIVATE / CONFIDENTIAL.

// Since we don't cater for modified invites, the created and last modified dates are the same.
$ev->add_property('created', \Bennu::timestamp_to_datetime($zoomevent->timemodified));
$ev->add_property('last-modified', \Bennu::timestamp_to_datetime($zoomevent->timemodified));

$noreplyuser = \core_user::get_noreply_user();
$ev->add_property('organizer', 'mailto:' . $noreplyuser->email, ['cn' => $this->get_lms_site_name()]);
// Need to strip out the double quotations around the 'organizer' values - probably a bug in the core code.
$ev->properties['ORGANIZER'][0]->value = substr($ev->properties['ORGANIZER'][0]->value, 1, -1);
$ev->properties['ORGANIZER'][0]->parameters['CN'] = substr($ev->properties['ORGANIZER'][0]->parameters['CN'], 1, -1);

$ev->add_property('dtstamp', \Bennu::timestamp_to_datetime());
if ($zoomevent->timeduration > 0) {
// Property dtend is better than duration, because it works in Microsoft Outlook and works better in Korganizer.
$ev->add_property('dtstart', \Bennu::timestamp_to_datetime($zoomevent->timestart)); // When event starts.
$ev->add_property('dtend', \Bennu::timestamp_to_datetime($zoomevent->timestart + $zoomevent->timeduration));
} else if ($zoomevent->timeduration == 0) {
// When no duration is present, the event is instantaneous event, ex - Due date of a module.
// Moodle doesn't support all day events yet. See MDL-56227.
$ev->add_property('dtstart', \Bennu::timestamp_to_datetime($zoomevent->timestart));
$ev->add_property('dtend', \Bennu::timestamp_to_datetime($zoomevent->timestart));
} else {
// This can be used to represent all day events in future.
throw new \coding_exception("Negative duration is not supported yet.");
}
$icalevent = zoom_helper_icalendar_event($zoomevent, $zoomevent->description);

if ($zoom->registration == ZOOM_REGISTRATION_OFF) {
$ev->add_property('location', $zoom->join_url);
$icalevent->add_property('location', $zoom->join_url);
} else {
$registrantjoinurl = zoom_get_registrant_join_url($user->email, $zoom->meeting_id, $zoom->webinar);
if ($registrantjoinurl) {
$ev->add_property('location', $registrantjoinurl);
$icalevent->add_property('location', $registrantjoinurl);
} else {
$ev->add_property('location', $zoom->join_url);
$icalevent->add_property('location', $zoom->join_url);
}
}

$ical->add_component($ev);
$noreplyuser = \core_user::get_noreply_user();
$icalevent->add_property('organizer', 'mailto:' . $noreplyuser->email, ['cn' => $SITE->fullname]);
// Need to strip out the double quotations around the 'organizer' values - probably a bug in the core code.
$icalevent->properties['ORGANIZER'][0]->value = substr($icalevent->properties['ORGANIZER'][0]->value, 1, -1);
$icalevent->properties['ORGANIZER'][0]->parameters['CN'] = substr($icalevent->properties['ORGANIZER'][0]->parameters['CN'], 1, -1);

// Add the event to the iCal file.
$ical->add_component($icalevent);

return $ical;
}

/**
* Filter the zoom users based on availability restrictions.
* @param object $zoom The zoom entry.
* @param stdClass $zoom The zoom entry.
* @param array $users An array of users that potentially has access to the Zoom activity.
* @return array A filtered array of users.
*/
Expand Down Expand Up @@ -326,20 +274,6 @@ private function zoom_get_users_to_notify($zoomid) {
return $zoomusers;
}

/**
* Get the LMS site name.
* @return string The site name.
*/
private function get_lms_site_name() {
global $DB;

$sql = 'SELECT fullname
FROM {course}
WHERE format = :format';

return $DB->get_field_sql($sql, ['format' => 'site']);
}

/**
* Returns the name of the task.
*
Expand Down
2 changes: 1 addition & 1 deletion db/install.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@
<FIELDS>
<FIELD NAME="id" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="true"/>
<FIELD NAME="zoomid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false"/>
<FIELD NAME="execution_time" TYPE="int" LENGTH="12" NOTNULL="true" SEQUENCE="false" COMMENT="The time when this cron job was completed successfully."/>
<FIELD NAME="executiontime" TYPE="int" LENGTH="12" NOTNULL="true" SEQUENCE="false" COMMENT="The time when this cron job was completed successfully."/>
</FIELDS>
<KEYS>
<KEY NAME="id_primary" TYPE="primary" FIELDS="id"/>
Expand Down
2 changes: 1 addition & 1 deletion db/upgrade.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1005,7 +1005,7 @@ function xmldb_zoom_upgrade($oldversion) {

$table->add_field('id', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
$table->add_field('zoomid', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, null);
$table->add_field('execution_time', XMLDB_TYPE_INTEGER, '12', null, null, null, null);
$table->add_field('executiontime', XMLDB_TYPE_INTEGER, '12', null, null, null, null);

$table->add_key('primary', XMLDB_KEY_PRIMARY, ['id']);
$table->add_key('fk_zoomid', XMLDB_KEY_FOREIGN, ['zoomid'], 'zoom', ['id']);
Expand Down

0 comments on commit c918384

Please sign in to comment.