MDL-64417 message_popup: remove old notifications during cleanup task.
[moodle.git] / message / output / popup / message_output_popup.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 2 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Popup message processor
19  *
20  * @package   message_popup
21  * @copyright 2008 Luis Rodrigues
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v2 or later
23  */
25 require_once(__DIR__ . '/../../../config.php'); //included from messagelib (how to fix?)
26 require_once($CFG->dirroot.'/message/output/lib.php');
28 /**
29  * The popup message processor
30  *
31  * @package   message_popup
32  * @copyright 2008 Luis Rodrigues and Martin Dougiamas
33  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class message_output_popup extends message_output {
37     /**
38      * Adds notifications to the 'message_popup_notifications' table if applicable.
39      *
40      * The reason for this is because we may not want to show all notifications in the notification popover. This
41      * can happen if the popup processor was disabled when the notification was sent. If the processor is disabled this
42      * function is never called so the notification will never be added to the 'message_popup_notifications' table.
43      * Essentially this table is used to filter what notifications to display from the 'notifications' table.
44      *
45      * @param object $eventdata the event data submitted by the message sender plus $eventdata->savedmessageid
46      * @return true if ok, false if error
47      */
48     public function send_message($eventdata) {
49         global $DB;
51         // Prevent users from getting popup notifications from themselves (happens with forum notifications).
52         if ($eventdata->userfrom->id != $eventdata->userto->id && $eventdata->notification) {
53             if (!$DB->record_exists('message_popup_notifications', ['notificationid' => $eventdata->savedmessageid])) {
54                 $record = new stdClass();
55                 $record->notificationid = $eventdata->savedmessageid;
57                 $DB->insert_record('message_popup_notifications', $record);
58             }
59         }
61         return true;
62     }
64     /**
65      * Creates necessary fields in the messaging config form.
66      *
67      * @param array $preferences An array of user preferences
68      */
69     function config_form($preferences) {
70         return null;
71     }
73     /**
74      * Parses the submitted form data and saves it into preferences array.
75      *
76      * @param stdClass $form preferences form class
77      * @param array $preferences preferences array
78      */
79     public function process_form($form, &$preferences) {
80         return true;
81     }
83     /**
84      * Loads the config data from database to put on the form during initial form display
85      *
86      * @param array $preferences preferences array
87      * @param int $userid the user id
88      */
89     public function load_data(&$preferences, $userid) {
90         global $USER;
91         return true;
92     }
94     /**
95      * Don't show this processor on the message preferences page. The user can't disable
96      * the notifications for user-to-user messaging.
97      *
98      * @return bool
99      */
100     public function has_message_preferences() {
101         return false;
102     }
104     /**
105      * Determines if this processor should process a message regardless of user preferences or site settings.
106      *
107      * @return bool
108      */
109     public function force_process_messages() {
110         global $CFG;
112         return !empty($CFG->messaging);
113     }
115     /**
116      * Remove all popup notifications up to specified time
117      *
118      * @param int $notificationdeletetime
119      * @return void
120      */
121     public function cleanup_all_notifications(int $notificationdeletetime): void {
122         global $DB;
124         $DB->delete_records_select('message_popup_notifications',
125             'notificationid IN (SELECT id FROM {notifications} WHERE timecreated < ?)', [$notificationdeletetime]);
126     }
128     /**
129      * Remove read popup notifications up to specified time
130      *
131      * @param int $notificationdeletetime
132      * @return void
133      */
134     public function cleanup_read_notifications(int $notificationdeletetime): void {
135         global $DB;
137         $DB->delete_records_select('message_popup_notifications',
138             'notificationid IN (SELECT id FROM {notifications} WHERE timeread < ?)', [$notificationdeletetime]);
139     }