MDL-54708 message: add backend APIs for notifications popover
[moodle.git] / lib / messagelib.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 3 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  * Functions for interacting with the message system
19  *
20  * @package   core_message
21  * @copyright 2008 Luis Rodrigues and Martin Dougiamas
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once(__DIR__ . '/../message/lib.php');
29 /**
30  * Called when a message provider wants to send a message.
31  * This functions checks the message recipient's message processor configuration then
32  * sends the message to the configured processors
33  *
34  * Required parameters of the $eventdata object:
35  *  component string component name. must exist in message_providers
36  *  name string message type name. must exist in message_providers
37  *  userfrom object|int the user sending the message
38  *  userto object|int the message recipient
39  *  subject string the message subject
40  *  fullmessage string the full message in a given format
41  *  fullmessageformat int the format if the full message (FORMAT_MOODLE, FORMAT_HTML, ..)
42  *  fullmessagehtml string the full version (the message processor will choose with one to use)
43  *  smallmessage string the small version of the message
44  *
45  * Optional parameters of the $eventdata object:
46  *  notification bool should the message be considered as a notification rather than a personal message
47  *  contexturl string if this is a notification then you can specify a url to view the event. For example the forum post the user is being notified of.
48  *  contexturlname string the display text for contexturl
49  *
50  * Note: processor failure is is not reported as false return value,
51  *       earlier versions did not do it consistently either.
52  *
53  * @category message
54  * @param stdClass|\core\message\message $eventdata information about the message (component, userfrom, userto, ...)
55  * @return mixed the integer ID of the new message or false if there was a problem with submitted data
56  */
57 function message_send($eventdata) {
58     global $CFG, $DB;
60     //new message ID to return
61     $messageid = false;
63     // Fetch default (site) preferences
64     $defaultpreferences = get_message_output_default_preferences();
65     $preferencebase = $eventdata->component.'_'.$eventdata->name;
66     // If message provider is disabled then don't do any processing.
67     if (!empty($defaultpreferences->{$preferencebase.'_disable'})) {
68         return $messageid;
69     }
71     // By default a message is a notification. Only personal/private messages aren't notifications.
72     if (!isset($eventdata->notification)) {
73         $eventdata->notification = 1;
74     }
76     if (!is_object($eventdata->userto)) {
77         $eventdata->userto = core_user::get_user($eventdata->userto);
78     }
79     if (!is_object($eventdata->userfrom)) {
80         $eventdata->userfrom = core_user::get_user($eventdata->userfrom);
81     }
82     if (!$eventdata->userto) {
83         debugging('Attempt to send msg to unknown user', DEBUG_NORMAL);
84         return false;
85     }
86     if (!$eventdata->userfrom) {
87         debugging('Attempt to send msg from unknown user', DEBUG_NORMAL);
88         return false;
89     }
91     // Verify all necessary data fields are present.
92     if (!isset($eventdata->userto->auth) or !isset($eventdata->userto->suspended)
93             or !isset($eventdata->userto->deleted) or !isset($eventdata->userto->emailstop)) {
95         debugging('Necessary properties missing in userto object, fetching full record', DEBUG_DEVELOPER);
96         $eventdata->userto = core_user::get_user($eventdata->userto->id);
97     }
99     $usertoisrealuser = (core_user::is_real_user($eventdata->userto->id) != false);
100     // If recipient is internal user (noreply user), and emailstop is set then don't send any msg.
101     if (!$usertoisrealuser && !empty($eventdata->userto->emailstop)) {
102         debugging('Attempt to send msg to internal (noreply) user', DEBUG_NORMAL);
103         return false;
104     }
106     //after how long inactive should the user be considered logged off?
107     if (isset($CFG->block_online_users_timetosee)) {
108         $timetoshowusers = $CFG->block_online_users_timetosee * 60;
109     } else {
110         $timetoshowusers = 300;//5 minutes
111     }
113     // Work out if the user is logged in or not
114     if (!empty($eventdata->userto->lastaccess) && (time()-$timetoshowusers) < $eventdata->userto->lastaccess) {
115         $userstate = 'loggedin';
116     } else {
117         $userstate = 'loggedoff';
118     }
120     // Create the message object
121     $savemessage = new stdClass();
122     $savemessage->useridfrom        = $eventdata->userfrom->id;
123     $savemessage->useridto          = $eventdata->userto->id;
124     $savemessage->subject           = $eventdata->subject;
125     $savemessage->fullmessage       = $eventdata->fullmessage;
126     $savemessage->fullmessageformat = $eventdata->fullmessageformat;
127     $savemessage->fullmessagehtml   = $eventdata->fullmessagehtml;
128     $savemessage->smallmessage      = $eventdata->smallmessage;
129     $savemessage->notification      = $eventdata->notification;
130     $savemessage->eventtype         = $eventdata->name;
131     $savemessage->component         = $eventdata->component;
133     if (!empty($eventdata->contexturl)) {
134         $savemessage->contexturl = (string)$eventdata->contexturl;
135     } else {
136         $savemessage->contexturl = null;
137     }
139     if (!empty($eventdata->contexturlname)) {
140         $savemessage->contexturlname = (string)$eventdata->contexturlname;
141     } else {
142         $savemessage->contexturlname = null;
143     }
145     $savemessage->timecreated = time();
147     if (PHPUNIT_TEST and class_exists('phpunit_util')) {
148         // Add some more tests to make sure the normal code can actually work.
149         $componentdir = core_component::get_component_directory($eventdata->component);
150         if (!$componentdir or !is_dir($componentdir)) {
151             throw new coding_exception('Invalid component specified in message-send(): '.$eventdata->component);
152         }
153         if (!file_exists("$componentdir/db/messages.php")) {
154             throw new coding_exception("$eventdata->component does not contain db/messages.php necessary for message_send()");
155         }
156         $messageproviders = null;
157         include("$componentdir/db/messages.php");
158         if (!isset($messageproviders[$eventdata->name])) {
159             throw new coding_exception("Missing messaging defaults for event '$eventdata->name' in '$eventdata->component' messages.php file");
160         }
161         unset($componentdir);
162         unset($messageproviders);
163         // Now ask phpunit if it wants to catch this message.
164         if (phpunit_util::is_redirecting_messages()) {
165             $savemessage->timeread = time();
166             $messageid = $DB->insert_record('message_read', $savemessage);
167             $message = $DB->get_record('message_read', array('id'=>$messageid));
168             phpunit_util::message_sent($message);
169             return $messageid;
170         }
171     }
173     // Fetch enabled processors
174     $processors = get_message_processors(true);
176     // Preset variables
177     $processorlist = array();
178     // Fill in the array of processors to be used based on default and user preferences
179     foreach ($processors as $processor) {
180         // Skip adding processors for internal user, if processor doesn't support sending message to internal user.
181         if (!$usertoisrealuser && !$processor->object->can_send_to_any_users()) {
182             continue;
183         }
185         // First find out permissions
186         $defaultpreference = $processor->name.'_provider_'.$preferencebase.'_permitted';
187         if (isset($defaultpreferences->{$defaultpreference})) {
188             $permitted = $defaultpreferences->{$defaultpreference};
189         } else {
190             // MDL-25114 They supplied an $eventdata->component $eventdata->name combination which doesn't
191             // exist in the message_provider table (thus there is no default settings for them).
192             $preferrormsg = "Could not load preference $defaultpreference. Make sure the component and name you supplied
193                     to message_send() are valid.";
194             throw new coding_exception($preferrormsg);
195         }
197         // Find out if user has configured this output
198         // Some processors cannot function without settings from the user
199         $userisconfigured = $processor->object->is_user_configured($eventdata->userto);
201         // DEBUG: notify if we are forcing unconfigured output
202         if ($permitted == 'forced' && !$userisconfigured) {
203             debugging('Attempt to force message delivery to user who has "'.$processor->name.'" output unconfigured', DEBUG_NORMAL);
204         }
206         // Populate the list of processors we will be using
207         if ($permitted == 'forced' && $userisconfigured) {
208             // An admin is forcing users to use this message processor. Use this processor unconditionally.
209             $processorlist[] = $processor->name;
210         } else if ($permitted == 'permitted' && $userisconfigured && !$eventdata->userto->emailstop) {
211             // User has not disabled notifications
212             // See if user set any notification preferences, otherwise use site default ones
213             $userpreferencename = 'message_provider_'.$preferencebase.'_'.$userstate;
214             if ($userpreference = get_user_preferences($userpreferencename, null, $eventdata->userto)) {
215                 if (in_array($processor->name, explode(',', $userpreference))) {
216                     $processorlist[] = $processor->name;
217                 }
218             } else if (isset($defaultpreferences->{$userpreferencename})) {
219                 if (in_array($processor->name, explode(',', $defaultpreferences->{$userpreferencename}))) {
220                     $processorlist[] = $processor->name;
221                 }
222             }
223         }
224     }
226     // Store unread message just in case we get a fatal error any time later.
227     $savemessage->id = $DB->insert_record('message', $savemessage);
228     $eventdata->savedmessageid = $savemessage->id;
230     // Let the manager do the sending or buffering when db transaction in progress.
231     return \core\message\manager::send_message($eventdata, $savemessage, $processorlist);
235 /**
236  * Updates the message_providers table with the current set of message providers
237  *
238  * @param string $component For example 'moodle', 'mod_forum' or 'block_quiz_results'
239  * @return boolean True on success
240  */
241 function message_update_providers($component='moodle') {
242     global $DB;
244     // load message providers from files
245     $fileproviders = message_get_providers_from_file($component);
247     // load message providers from the database
248     $dbproviders = message_get_providers_from_db($component);
250     foreach ($fileproviders as $messagename => $fileprovider) {
252         if (!empty($dbproviders[$messagename])) {   // Already exists in the database
253             // check if capability has changed
254             if ($dbproviders[$messagename]->capability == $fileprovider['capability']) {  // Same, so ignore
255                 // exact same message provider already present in db, ignore this entry
256                 unset($dbproviders[$messagename]);
257                 continue;
259             } else {                                // Update existing one
260                 $provider = new stdClass();
261                 $provider->id         = $dbproviders[$messagename]->id;
262                 $provider->capability = $fileprovider['capability'];
263                 $DB->update_record('message_providers', $provider);
264                 unset($dbproviders[$messagename]);
265                 continue;
266             }
268         } else {             // New message provider, add it
270             $provider = new stdClass();
271             $provider->name       = $messagename;
272             $provider->component  = $component;
273             $provider->capability = $fileprovider['capability'];
275             $transaction = $DB->start_delegated_transaction();
276             $DB->insert_record('message_providers', $provider);
277             message_set_default_message_preference($component, $messagename, $fileprovider);
278             $transaction->allow_commit();
279         }
280     }
282     foreach ($dbproviders as $dbprovider) {  // Delete old ones
283         $DB->delete_records('message_providers', array('id' => $dbprovider->id));
284         $DB->delete_records_select('config_plugins', "plugin = 'message' AND ".$DB->sql_like('name', '?', false), array("%_provider_{$component}_{$dbprovider->name}_%"));
285         $DB->delete_records_select('user_preferences', $DB->sql_like('name', '?', false), array("message_provider_{$component}_{$dbprovider->name}_%"));
286         cache_helper::invalidate_by_definition('core', 'config', array(), 'message');
287     }
289     return true;
292 /**
293  * This function populates default message preferences for all existing providers
294  * when the new message processor is added.
295  *
296  * @param string $processorname The name of message processor plugin (e.g. 'email', 'jabber')
297  * @throws invalid_parameter_exception if $processorname does not exist in the database
298  */
299 function message_update_processors($processorname) {
300     global $DB;
302     // validate if our processor exists
303     $processor = $DB->get_records('message_processors', array('name' => $processorname));
304     if (empty($processor)) {
305         throw new invalid_parameter_exception();
306     }
308     $providers = $DB->get_records_sql('SELECT DISTINCT component FROM {message_providers}');
310     $transaction = $DB->start_delegated_transaction();
311     foreach ($providers as $provider) {
312         // load message providers from files
313         $fileproviders = message_get_providers_from_file($provider->component);
314         foreach ($fileproviders as $messagename => $fileprovider) {
315             message_set_default_message_preference($provider->component, $messagename, $fileprovider, $processorname);
316         }
317     }
318     $transaction->allow_commit();
321 /**
322  * Setting default messaging preferences for particular message provider
323  *
324  * @param  string $component   The name of component (e.g. moodle, mod_forum, etc.)
325  * @param  string $messagename The name of message provider
326  * @param  array  $fileprovider The value of $messagename key in the array defined in plugin messages.php
327  * @param  string $processorname The optional name of message processor
328  */
329 function message_set_default_message_preference($component, $messagename, $fileprovider, $processorname='') {
330     global $DB;
332     // Fetch message processors
333     $condition = null;
334     // If we need to process a particular processor, set the select condition
335     if (!empty($processorname)) {
336        $condition = array('name' => $processorname);
337     }
338     $processors = $DB->get_records('message_processors', $condition);
340     // load default messaging preferences
341     $defaultpreferences = get_message_output_default_preferences();
343     // Setting default preference
344     $componentproviderbase = $component.'_'.$messagename;
345     $loggedinpref = array();
346     $loggedoffpref = array();
347     // set 'permitted' preference first for each messaging processor
348     foreach ($processors as $processor) {
349         $preferencename = $processor->name.'_provider_'.$componentproviderbase.'_permitted';
350         // if we do not have this setting yet, set it
351         if (!isset($defaultpreferences->{$preferencename})) {
352             // determine plugin default settings
353             $plugindefault = 0;
354             if (isset($fileprovider['defaults'][$processor->name])) {
355                 $plugindefault = $fileprovider['defaults'][$processor->name];
356             }
357             // get string values of the settings
358             list($permitted, $loggedin, $loggedoff) = translate_message_default_setting($plugindefault, $processor->name);
359             // store default preferences for current processor
360             set_config($preferencename, $permitted, 'message');
361             // save loggedin/loggedoff settings
362             if ($loggedin) {
363                 $loggedinpref[] = $processor->name;
364             }
365             if ($loggedoff) {
366                 $loggedoffpref[] = $processor->name;
367             }
368         }
369     }
370     // now set loggedin/loggedoff preferences
371     if (!empty($loggedinpref)) {
372         $preferencename = 'message_provider_'.$componentproviderbase.'_loggedin';
373         if (isset($defaultpreferences->{$preferencename})) {
374             // We have the default preferences for this message provider, which
375             // likely means that we have been adding a new processor. Add defaults
376             // to exisitng preferences.
377             $loggedinpref = array_merge($loggedinpref, explode(',', $defaultpreferences->{$preferencename}));
378         }
379         set_config($preferencename, join(',', $loggedinpref), 'message');
380     }
381     if (!empty($loggedoffpref)) {
382         $preferencename = 'message_provider_'.$componentproviderbase.'_loggedoff';
383         if (isset($defaultpreferences->{$preferencename})) {
384             // We have the default preferences for this message provider, which
385             // likely means that we have been adding a new processor. Add defaults
386             // to exisitng preferences.
387             $loggedoffpref = array_merge($loggedoffpref, explode(',', $defaultpreferences->{$preferencename}));
388         }
389         set_config($preferencename, join(',', $loggedoffpref), 'message');
390     }
393 /**
394  * Returns the active providers for the user specified, based on capability
395  *
396  * @param int $userid id of user
397  * @return array An array of message providers
398  */
399 function message_get_providers_for_user($userid) {
400     global $DB, $CFG;
402     $providers = get_message_providers();
404     // Ensure user is not allowed to configure instantmessage if it is globally disabled.
405     if (!$CFG->messaging) {
406         foreach ($providers as $providerid => $provider) {
407             if ($provider->name == 'instantmessage') {
408                 unset($providers[$providerid]);
409                 break;
410             }
411         }
412     }
414     // If the component is an enrolment plugin, check it is enabled
415     foreach ($providers as $providerid => $provider) {
416         list($type, $name) = core_component::normalize_component($provider->component);
417         if ($type == 'enrol' && !enrol_is_enabled($name)) {
418             unset($providers[$providerid]);
419         }
420     }
422     // Now we need to check capabilities. We need to eliminate the providers
423     // where the user does not have the corresponding capability anywhere.
424     // Here we deal with the common simple case of the user having the
425     // capability in the system context. That handles $CFG->defaultuserroleid.
426     // For the remaining providers/capabilities, we need to do a more complex
427     // query involving all overrides everywhere.
428     $unsureproviders = array();
429     $unsurecapabilities = array();
430     $systemcontext = context_system::instance();
431     foreach ($providers as $providerid => $provider) {
432         if (empty($provider->capability) || has_capability($provider->capability, $systemcontext, $userid)) {
433             // The provider is relevant to this user.
434             continue;
435         }
437         $unsureproviders[$providerid] = $provider;
438         $unsurecapabilities[$provider->capability] = 1;
439         unset($providers[$providerid]);
440     }
442     if (empty($unsureproviders)) {
443         // More complex checks are not required.
444         return $providers;
445     }
447     // Now check the unsure capabilities.
448     list($capcondition, $params) = $DB->get_in_or_equal(
449             array_keys($unsurecapabilities), SQL_PARAMS_NAMED);
450     $params['userid'] = $userid;
452     $sql = "SELECT DISTINCT rc.capability, 1
454               FROM {role_assignments} ra
455               JOIN {context} actx ON actx.id = ra.contextid
456               JOIN {role_capabilities} rc ON rc.roleid = ra.roleid
457               JOIN {context} cctx ON cctx.id = rc.contextid
459              WHERE ra.userid = :userid
460                AND rc.capability $capcondition
461                AND rc.permission > 0
462                AND (".$DB->sql_concat('actx.path', "'/'")." LIKE ".$DB->sql_concat('cctx.path', "'/%'").
463                " OR ".$DB->sql_concat('cctx.path', "'/'")." LIKE ".$DB->sql_concat('actx.path', "'/%'").")";
465     if (!empty($CFG->defaultfrontpageroleid)) {
466         $frontpagecontext = context_course::instance(SITEID);
468         list($capcondition2, $params2) = $DB->get_in_or_equal(
469                 array_keys($unsurecapabilities), SQL_PARAMS_NAMED);
470         $params = array_merge($params, $params2);
471         $params['frontpageroleid'] = $CFG->defaultfrontpageroleid;
472         $params['frontpagepathpattern'] = $frontpagecontext->path . '/';
474         $sql .= "
475              UNION
477             SELECT DISTINCT rc.capability, 1
479               FROM {role_capabilities} rc
480               JOIN {context} cctx ON cctx.id = rc.contextid
482              WHERE rc.roleid = :frontpageroleid
483                AND rc.capability $capcondition2
484                AND rc.permission > 0
485                AND ".$DB->sql_concat('cctx.path', "'/'")." LIKE :frontpagepathpattern";
486     }
488     $relevantcapabilities = $DB->get_records_sql_menu($sql, $params);
490     // Add back any providers based on the detailed capability check.
491     foreach ($unsureproviders as $providerid => $provider) {
492         if (array_key_exists($provider->capability, $relevantcapabilities)) {
493             $providers[$providerid] = $provider;
494         }
495     }
497     return $providers;
500 /**
501  * Gets the message providers that are in the database for this component.
502  *
503  * This is an internal function used within messagelib.php
504  *
505  * @see message_update_providers()
506  * @param string $component A moodle component like 'moodle', 'mod_forum', 'block_quiz_results'
507  * @return array An array of message providers
508  */
509 function message_get_providers_from_db($component) {
510     global $DB;
512     return $DB->get_records('message_providers', array('component'=>$component), '', 'name, id, component, capability');  // Name is unique per component
515 /**
516  * Loads the messages definitions for a component from file
517  *
518  * If no messages are defined for the component, return an empty array.
519  * This is an internal function used within messagelib.php
520  *
521  * @see message_update_providers()
522  * @see message_update_processors()
523  * @param string $component A moodle component like 'moodle', 'mod_forum', 'block_quiz_results'
524  * @return array An array of message providers or empty array if not exists
525  */
526 function message_get_providers_from_file($component) {
527     $defpath = core_component::get_component_directory($component).'/db/messages.php';
529     $messageproviders = array();
531     if (file_exists($defpath)) {
532         require($defpath);
533     }
535     foreach ($messageproviders as $name => $messageprovider) {   // Fix up missing values if required
536         if (empty($messageprovider['capability'])) {
537             $messageproviders[$name]['capability'] = NULL;
538         }
539         if (empty($messageprovider['defaults'])) {
540             $messageproviders[$name]['defaults'] = array();
541         }
542     }
544     return $messageproviders;
547 /**
548  * Remove all message providers for particular component and corresponding settings
549  *
550  * @param string $component A moodle component like 'moodle', 'mod_forum', 'block_quiz_results'
551  * @return void
552  */
553 function message_provider_uninstall($component) {
554     global $DB;
556     $transaction = $DB->start_delegated_transaction();
557     $DB->delete_records('message_providers', array('component' => $component));
558     $DB->delete_records_select('config_plugins', "plugin = 'message' AND ".$DB->sql_like('name', '?', false), array("%_provider_{$component}_%"));
559     $DB->delete_records_select('user_preferences', $DB->sql_like('name', '?', false), array("message_provider_{$component}_%"));
560     $transaction->allow_commit();
561     // Purge all messaging settings from the caches. They are stored by plugin so we have to clear all message settings.
562     cache_helper::invalidate_by_definition('core', 'config', array(), 'message');
565 /**
566  * Uninstall a message processor
567  *
568  * @param string $name A message processor name like 'email', 'jabber'
569  */
570 function message_processor_uninstall($name) {
571     global $DB;
573     $transaction = $DB->start_delegated_transaction();
574     $DB->delete_records('message_processors', array('name' => $name));
575     $DB->delete_records_select('config_plugins', "plugin = ?", array("message_{$name}"));
576     // delete permission preferences only, we do not care about loggedin/loggedoff
577     // defaults, they will be removed on the next attempt to update the preferences
578     $DB->delete_records_select('config_plugins', "plugin = 'message' AND ".$DB->sql_like('name', '?', false), array("{$name}_provider_%"));
579     $transaction->allow_commit();
580     // Purge all messaging settings from the caches. They are stored by plugin so we have to clear all message settings.
581     cache_helper::invalidate_by_definition('core', 'config', array(), array('message', "message_{$name}"));