Merge branch 'MDL-56407-master-2' of git://github.com/junpataleta/moodle
[moodle.git] / message / externallib.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/>.
18 /**
19  * External message API
20  *
21  * @package    core_message
22  * @category   external
23  * @copyright  2011 Jerome Mouneyrac
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 require_once("$CFG->libdir/externallib.php");
28 require_once($CFG->dirroot . "/message/lib.php");
30 /**
31  * Message external functions
32  *
33  * @package    core_message
34  * @category   external
35  * @copyright  2011 Jerome Mouneyrac
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  * @since Moodle 2.2
38  */
39 class core_message_external extends external_api {
41     /**
42      * Returns description of method parameters
43      *
44      * @return external_function_parameters
45      * @since Moodle 2.2
46      */
47     public static function send_instant_messages_parameters() {
48         return new external_function_parameters(
49             array(
50                 'messages' => new external_multiple_structure(
51                     new external_single_structure(
52                         array(
53                             'touserid' => new external_value(PARAM_INT, 'id of the user to send the private message'),
54                             'text' => new external_value(PARAM_RAW, 'the text of the message'),
55                             'textformat' => new external_format_value('text', VALUE_DEFAULT, FORMAT_MOODLE),
56                             'clientmsgid' => new external_value(PARAM_ALPHANUMEXT, 'your own client id for the message. If this id is provided, the fail message id will be returned to you', VALUE_OPTIONAL),
57                         )
58                     )
59                 )
60             )
61         );
62     }
64     /**
65      * Send private messages from the current USER to other users
66      *
67      * @param array $messages An array of message to send.
68      * @return array
69      * @since Moodle 2.2
70      */
71     public static function send_instant_messages($messages = array()) {
72         global $CFG, $USER, $DB;
74         // Check if messaging is enabled.
75         if (empty($CFG->messaging)) {
76             throw new moodle_exception('disabled', 'message');
77         }
79         // Ensure the current user is allowed to run this function
80         $context = context_system::instance();
81         self::validate_context($context);
82         require_capability('moodle/site:sendmessage', $context);
84         $params = self::validate_parameters(self::send_instant_messages_parameters(), array('messages' => $messages));
86         //retrieve all tousers of the messages
87         $receivers = array();
88         foreach($params['messages'] as $message) {
89             $receivers[] = $message['touserid'];
90         }
91         list($sqluserids, $sqlparams) = $DB->get_in_or_equal($receivers, SQL_PARAMS_NAMED, 'userid_');
92         $tousers = $DB->get_records_select("user", "id " . $sqluserids . " AND deleted = 0", $sqlparams);
93         $blocklist   = array();
94         $contactlist = array();
95         $sqlparams['contactid'] = $USER->id;
96         $rs = $DB->get_recordset_sql("SELECT *
97                                         FROM {message_contacts}
98                                        WHERE userid $sqluserids
99                                              AND contactid = :contactid", $sqlparams);
100         foreach ($rs as $record) {
101             if ($record->blocked) {
102                 // $record->userid is blocking current user
103                 $blocklist[$record->userid] = true;
104             } else {
105                 // $record->userid have current user as contact
106                 $contactlist[$record->userid] = true;
107             }
108         }
109         $rs->close();
111         $canreadallmessages = has_capability('moodle/site:readallmessages', $context);
113         $resultmessages = array();
114         foreach ($params['messages'] as $message) {
115             $resultmsg = array(); //the infos about the success of the operation
117             //we are going to do some checking
118             //code should match /messages/index.php checks
119             $success = true;
121             //check the user exists
122             if (empty($tousers[$message['touserid']])) {
123                 $success = false;
124                 $errormessage = get_string('touserdoesntexist', 'message', $message['touserid']);
125             }
127             //check that the touser is not blocking the current user
128             if ($success and !empty($blocklist[$message['touserid']]) and !$canreadallmessages) {
129                 $success = false;
130                 $errormessage = get_string('userisblockingyou', 'message');
131             }
133             // Check if the user is a contact
134             //TODO MDL-31118 performance improvement - edit the function so we can pass an array instead userid
135             $blocknoncontacts = get_user_preferences('message_blocknoncontacts', NULL, $message['touserid']);
136             // message_blocknoncontacts option is on and current user is not in contact list
137             if ($success && empty($contactlist[$message['touserid']]) && !empty($blocknoncontacts)) {
138                 // The user isn't a contact and they have selected to block non contacts so this message won't be sent.
139                 $success = false;
140                 $errormessage = get_string('userisblockingyounoncontact', 'message',
141                         fullname(core_user::get_user($message['touserid'])));
142             }
144             //now we can send the message (at least try)
145             if ($success) {
146                 //TODO MDL-31118 performance improvement - edit the function so we can pass an array instead one touser object
147                 $success = message_post_message($USER, $tousers[$message['touserid']],
148                         $message['text'], external_validate_format($message['textformat']));
149             }
151             //build the resultmsg
152             if (isset($message['clientmsgid'])) {
153                 $resultmsg['clientmsgid'] = $message['clientmsgid'];
154             }
155             if ($success) {
156                 $resultmsg['msgid'] = $success;
157             } else {
158                 // WARNINGS: for backward compatibility we return this errormessage.
159                 //          We should have thrown exceptions as these errors prevent results to be returned.
160                 // See http://docs.moodle.org/dev/Errors_handling_in_web_services#When_to_send_a_warning_on_the_server_side .
161                 $resultmsg['msgid'] = -1;
162                 $resultmsg['errormessage'] = $errormessage;
163             }
165             $resultmessages[] = $resultmsg;
166         }
168         return $resultmessages;
169     }
171     /**
172      * Returns description of method result value
173      *
174      * @return external_description
175      * @since Moodle 2.2
176      */
177     public static function send_instant_messages_returns() {
178         return new external_multiple_structure(
179             new external_single_structure(
180                 array(
181                     'msgid' => new external_value(PARAM_INT, 'test this to know if it succeeds:  id of the created message if it succeeded, -1 when failed'),
182                     'clientmsgid' => new external_value(PARAM_ALPHANUMEXT, 'your own id for the message', VALUE_OPTIONAL),
183                     'errormessage' => new external_value(PARAM_TEXT, 'error message - if it failed', VALUE_OPTIONAL)
184                 )
185             )
186         );
187     }
189     /**
190      * Create contacts parameters description.
191      *
192      * @return external_function_parameters
193      * @since Moodle 2.5
194      */
195     public static function create_contacts_parameters() {
196         return new external_function_parameters(
197             array(
198                 'userids' => new external_multiple_structure(
199                     new external_value(PARAM_INT, 'User ID'),
200                     'List of user IDs'
201                 ),
202                 'userid' => new external_value(PARAM_INT, 'The id of the user we are creating the contacts for, 0 for the
203                     current user', VALUE_DEFAULT, 0)
204             )
205         );
206     }
208     /**
209      * Create contacts.
210      *
211      * @param array $userids array of user IDs.
212      * @param int $userid The id of the user we are creating the contacts for
213      * @return external_description
214      * @since Moodle 2.5
215      */
216     public static function create_contacts($userids, $userid = 0) {
217         global $CFG, $USER;
219         // Check if messaging is enabled.
220         if (empty($CFG->messaging)) {
221             throw new moodle_exception('disabled', 'message');
222         }
224         if (empty($userid)) {
225             $userid = $USER->id;
226         }
228         // Validate context.
229         $context = context_system::instance();
230         self::validate_context($context);
232         $capability = 'moodle/site:manageallmessaging';
233         if (($USER->id != $userid) && !has_capability($capability, $context)) {
234             throw new required_capability_exception($context, $capability, 'nopermissions', '');
235         }
237         $params = array('userids' => $userids, 'userid' => $userid);
238         $params = self::validate_parameters(self::create_contacts_parameters(), $params);
240         $warnings = array();
241         foreach ($params['userids'] as $id) {
242             if (!message_add_contact($id, 0, $userid)) {
243                 $warnings[] = array(
244                     'item' => 'user',
245                     'itemid' => $id,
246                     'warningcode' => 'contactnotcreated',
247                     'message' => 'The contact could not be created'
248                 );
249             }
250         }
251         return $warnings;
252     }
254     /**
255      * Create contacts return description.
256      *
257      * @return external_description
258      * @since Moodle 2.5
259      */
260     public static function create_contacts_returns() {
261         return new external_warnings();
262     }
264     /**
265      * Delete contacts parameters description.
266      *
267      * @return external_function_parameters
268      * @since Moodle 2.5
269      */
270     public static function delete_contacts_parameters() {
271         return new external_function_parameters(
272             array(
273                 'userids' => new external_multiple_structure(
274                     new external_value(PARAM_INT, 'User ID'),
275                     'List of user IDs'
276                 ),
277                 'userid' => new external_value(PARAM_INT, 'The id of the user we are deleting the contacts for, 0 for the
278                     current user', VALUE_DEFAULT, 0)
279             )
280         );
281     }
283     /**
284      * Delete contacts.
285      *
286      * @param array $userids array of user IDs.
287      * @param int $userid The id of the user we are deleting the contacts for
288      * @return null
289      * @since Moodle 2.5
290      */
291     public static function delete_contacts($userids, $userid = 0) {
292         global $CFG, $USER;
294         // Check if messaging is enabled.
295         if (empty($CFG->messaging)) {
296             throw new moodle_exception('disabled', 'message');
297         }
299         if (empty($userid)) {
300             $userid = $USER->id;
301         }
303         // Validate context.
304         $context = context_system::instance();
305         self::validate_context($context);
307         $capability = 'moodle/site:manageallmessaging';
308         if (($USER->id != $userid) && !has_capability($capability, $context)) {
309             throw new required_capability_exception($context, $capability, 'nopermissions', '');
310         }
312         $params = array('userids' => $userids, 'userid' => $userid);
313         $params = self::validate_parameters(self::delete_contacts_parameters(), $params);
315         foreach ($params['userids'] as $id) {
316             message_remove_contact($id, $userid);
317         }
319         return null;
320     }
322     /**
323      * Delete contacts return description.
324      *
325      * @return external_description
326      * @since Moodle 2.5
327      */
328     public static function delete_contacts_returns() {
329         return null;
330     }
332     /**
333      * Block contacts parameters description.
334      *
335      * @return external_function_parameters
336      * @since Moodle 2.5
337      */
338     public static function block_contacts_parameters() {
339         return new external_function_parameters(
340             array(
341                 'userids' => new external_multiple_structure(
342                     new external_value(PARAM_INT, 'User ID'),
343                     'List of user IDs'
344                 ),
345                 'userid' => new external_value(PARAM_INT, 'The id of the user we are blocking the contacts for, 0 for the
346                     current user', VALUE_DEFAULT, 0)
347             )
348         );
349     }
351     /**
352      * Block contacts.
353      *
354      * @param array $userids array of user IDs.
355      * @param int $userid The id of the user we are blocking the contacts for
356      * @return external_description
357      * @since Moodle 2.5
358      */
359     public static function block_contacts($userids, $userid = 0) {
360         global $CFG, $USER;
362         // Check if messaging is enabled.
363         if (empty($CFG->messaging)) {
364             throw new moodle_exception('disabled', 'message');
365         }
367         if (empty($userid)) {
368             $userid = $USER->id;
369         }
371         // Validate context.
372         $context = context_system::instance();
373         self::validate_context($context);
375         $capability = 'moodle/site:manageallmessaging';
376         if (($USER->id != $userid) && !has_capability($capability, $context)) {
377             throw new required_capability_exception($context, $capability, 'nopermissions', '');
378         }
380         $params = array('userids' => $userids, 'userid' => $userid);
381         $params = self::validate_parameters(self::block_contacts_parameters(), $params);
383         $warnings = array();
384         foreach ($params['userids'] as $id) {
385             if (!message_block_contact($id, $userid)) {
386                 $warnings[] = array(
387                     'item' => 'user',
388                     'itemid' => $id,
389                     'warningcode' => 'contactnotblocked',
390                     'message' => 'The contact could not be blocked'
391                 );
392             }
393         }
394         return $warnings;
395     }
397     /**
398      * Block contacts return description.
399      *
400      * @return external_description
401      * @since Moodle 2.5
402      */
403     public static function block_contacts_returns() {
404         return new external_warnings();
405     }
407     /**
408      * Unblock contacts parameters description.
409      *
410      * @return external_function_parameters
411      * @since Moodle 2.5
412      */
413     public static function unblock_contacts_parameters() {
414         return new external_function_parameters(
415             array(
416                 'userids' => new external_multiple_structure(
417                     new external_value(PARAM_INT, 'User ID'),
418                     'List of user IDs'
419                 ),
420                 'userid' => new external_value(PARAM_INT, 'The id of the user we are unblocking the contacts for, 0 for the
421                     current user', VALUE_DEFAULT, 0)
422             )
423         );
424     }
426     /**
427      * Unblock contacts.
428      *
429      * @param array $userids array of user IDs.
430      * @param int $userid The id of the user we are unblocking the contacts for
431      * @return null
432      * @since Moodle 2.5
433      */
434     public static function unblock_contacts($userids, $userid = 0) {
435         global $CFG, $USER;
437         // Check if messaging is enabled.
438         if (empty($CFG->messaging)) {
439             throw new moodle_exception('disabled', 'message');
440         }
442         if (empty($userid)) {
443             $userid = $USER->id;
444         }
446         // Validate context.
447         $context = context_system::instance();
448         self::validate_context($context);
450         $capability = 'moodle/site:manageallmessaging';
451         if (($USER->id != $userid) && !has_capability($capability, $context)) {
452             throw new required_capability_exception($context, $capability, 'nopermissions', '');
453         }
455         $params = array('userids' => $userids, 'userid' => $userid);
456         $params = self::validate_parameters(self::unblock_contacts_parameters(), $params);
458         foreach ($params['userids'] as $id) {
459             message_unblock_contact($id, $userid);
460         }
462         return null;
463     }
465     /**
466      * Unblock contacts return description.
467      *
468      * @return external_description
469      * @since Moodle 2.5
470      */
471     public static function unblock_contacts_returns() {
472         return null;
473     }
475     /**
476      * Return the structure of a message area contact.
477      *
478      * @return external_single_structure
479      * @since Moodle 3.2
480      */
481     private static function get_messagearea_contact_structure() {
482         return new external_single_structure(
483             array(
484                 'userid' => new external_value(PARAM_INT, 'The user\'s id'),
485                 'fullname' => new external_value(PARAM_NOTAGS, 'The user\'s name'),
486                 'profileimageurl' => new external_value(PARAM_URL, 'User picture URL'),
487                 'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL'),
488                 'ismessaging' => new external_value(PARAM_BOOL, 'If we are messaging the user'),
489                 'sentfromcurrentuser' => new external_value(PARAM_BOOL, 'Was the last message sent from the current user?'),
490                 'lastmessage' => new external_value(PARAM_NOTAGS, 'The user\'s last message'),
491                 'messageid' => new external_value(PARAM_INT, 'The unique search message id', VALUE_DEFAULT, null),
492                 'isonline' => new external_value(PARAM_BOOL, 'The user\'s online status'),
493                 'isread' => new external_value(PARAM_BOOL, 'If the user has read the message'),
494                 'isblocked' => new external_value(PARAM_BOOL, 'If the user has been blocked'),
495                 'unreadcount' => new external_value(PARAM_INT, 'The number of unread messages in this conversation',
496                     VALUE_DEFAULT, null),
497             )
498         );
499     }
501     /**
502      * Return the structure of a message area message.
503      *
504      * @return external_single_structure
505      * @since Moodle 3.2
506      */
507     private static function get_messagearea_message_structure() {
508         return new external_single_structure(
509             array(
510                 'id' => new external_value(PARAM_INT, 'The id of the message'),
511                 'useridfrom' => new external_value(PARAM_INT, 'The id of the user who sent the message'),
512                 'useridto' => new external_value(PARAM_INT, 'The id of the user who received the message'),
513                 'text' => new external_value(PARAM_RAW, 'The text of the message'),
514                 'displayblocktime' => new external_value(PARAM_BOOL, 'Should we display the block time?'),
515                 'blocktime' => new external_value(PARAM_NOTAGS, 'The time to display above the message'),
516                 'position' => new external_value(PARAM_ALPHA, 'The position of the text'),
517                 'timesent' => new external_value(PARAM_NOTAGS, 'The time the message was sent'),
518                 'timecreated' => new external_value(PARAM_INT, 'The timecreated timestamp for the message'),
519                 'isread' => new external_value(PARAM_INT, 'Determines if the message was read or not'),
520             )
521         );
522     }
524     /**
525      * Get messagearea search users in course parameters.
526      *
527      * @return external_function_parameters
528      * @since 3.2
529      */
530     public static function data_for_messagearea_search_users_in_course_parameters() {
531         return new external_function_parameters(
532             array(
533                 'userid' => new external_value(PARAM_INT, 'The id of the user who is performing the search'),
534                 'courseid' => new external_value(PARAM_INT, 'The id of the course'),
535                 'search' => new external_value(PARAM_RAW, 'The string being searched'),
536                 'limitfrom' => new external_value(PARAM_INT, 'Limit from', VALUE_DEFAULT, 0),
537                 'limitnum' => new external_value(PARAM_INT, 'Limit number', VALUE_DEFAULT, 0)
538             )
539         );
540     }
542     /**
543      * Get messagearea search users in course results.
544      *
545      * @param int $userid The id of the user who is performing the search
546      * @param int $courseid The id of the course
547      * @param string $search The string being searched
548      * @param int $limitfrom
549      * @param int $limitnum
550      * @return stdClass
551      * @throws moodle_exception
552      * @since 3.2
553      */
554     public static function data_for_messagearea_search_users_in_course($userid, $courseid, $search, $limitfrom = 0,
555                                                                        $limitnum = 0) {
556         global $CFG, $PAGE, $USER;
558         // Check if messaging is enabled.
559         if (empty($CFG->messaging)) {
560             throw new moodle_exception('disabled', 'message');
561         }
563         $systemcontext = context_system::instance();
565         $params = array(
566             'userid' => $userid,
567             'courseid' => $courseid,
568             'search' => $search,
569             'limitfrom' => $limitfrom,
570             'limitnum' => $limitnum
571         );
572         self::validate_parameters(self::data_for_messagearea_search_users_in_course_parameters(), $params);
573         self::validate_context($systemcontext);
575         if (($USER->id != $userid) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
576             throw new moodle_exception('You do not have permission to perform this action.');
577         }
579         $users = \core_message\api::search_users_in_course($userid, $courseid, $search, $limitfrom, $limitnum);
580         $results = new \core_message\output\messagearea\user_search_results($users);
582         $renderer = $PAGE->get_renderer('core_message');
583         return $results->export_for_template($renderer);
584     }
586     /**
587      * Get messagearea search users in course returns.
588      *
589      * @return external_single_structure
590      * @since 3.2
591      */
592     public static function data_for_messagearea_search_users_in_course_returns() {
593         return new external_single_structure(
594             array(
595                 'contacts' => new external_multiple_structure(
596                     self::get_messagearea_contact_structure()
597                 ),
598             )
599         );
600     }
602     /**
603      * Get messagearea search users parameters.
604      *
605      * @return external_function_parameters
606      * @since 3.2
607      */
608     public static function data_for_messagearea_search_users_parameters() {
609         return new external_function_parameters(
610             array(
611                 'userid' => new external_value(PARAM_INT, 'The id of the user who is performing the search'),
612                 'search' => new external_value(PARAM_RAW, 'The string being searched'),
613                 'limitnum' => new external_value(PARAM_INT, 'Limit number', VALUE_DEFAULT, 0)
614             )
615         );
616     }
618     /**
619      * Get messagearea search users results.
620      *
621      * @param int $userid The id of the user who is performing the search
622      * @param string $search The string being searched
623      * @param int $limitnum
624      * @return stdClass
625      * @throws moodle_exception
626      * @since 3.2
627      */
628     public static function data_for_messagearea_search_users($userid, $search, $limitnum = 0) {
629         global $CFG, $PAGE, $USER;
631         // Check if messaging is enabled.
632         if (empty($CFG->messaging)) {
633             throw new moodle_exception('disabled', 'message');
634         }
636         $systemcontext = context_system::instance();
638         $params = array(
639             'userid' => $userid,
640             'search' => $search,
641             'limitnum' => $limitnum
642         );
643         self::validate_parameters(self::data_for_messagearea_search_users_parameters(), $params);
644         self::validate_context($systemcontext);
646         if (($USER->id != $userid) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
647             throw new moodle_exception('You do not have permission to perform this action.');
648         }
650         list($contacts, $courses, $noncontacts) = \core_message\api::search_users($userid, $search, $limitnum);
651         $search = new \core_message\output\messagearea\user_search_results($contacts, $courses, $noncontacts);
653         $renderer = $PAGE->get_renderer('core_message');
654         return $search->export_for_template($renderer);
655     }
657     /**
658      * Get messagearea search users returns.
659      *
660      * @return external_single_structure
661      * @since 3.2
662      */
663     public static function data_for_messagearea_search_users_returns() {
664         return new external_single_structure(
665             array(
666                 'contacts' => new external_multiple_structure(
667                     self::get_messagearea_contact_structure()
668                 ),
669                 'courses' => new external_multiple_structure(
670                     new external_single_structure(
671                         array(
672                             'id' => new external_value(PARAM_INT, 'The course id'),
673                             'shortname' => new external_value(PARAM_NOTAGS, 'The course shortname'),
674                             'fullname' => new external_value(PARAM_NOTAGS, 'The course fullname'),
675                         )
676                     )
677                 ),
678                 'noncontacts' => new external_multiple_structure(
679                     self::get_messagearea_contact_structure()
680                 )
681             )
682         );
683     }
685     /**
686      * Get messagearea search messages parameters.
687      *
688      * @return external_function_parameters
689      * @since 3.2
690      */
691     public static function data_for_messagearea_search_messages_parameters() {
692         return new external_function_parameters(
693             array(
694                 'userid' => new external_value(PARAM_INT, 'The id of the user who is performing the search'),
695                 'search' => new external_value(PARAM_RAW, 'The string being searched'),
696                 'limitfrom' => new external_value(PARAM_INT, 'Limit from', VALUE_DEFAULT, 0),
697                 'limitnum' => new external_value(PARAM_INT, 'Limit number', VALUE_DEFAULT, 0)
698             )
699         );
700     }
702     /**
703      * Get messagearea search messages results.
704      *
705      * @param int $userid The id of the user who is performing the search
706      * @param string $search The string being searched
707      * @param int $limitfrom
708      * @param int $limitnum
709      * @return stdClass
710      * @throws moodle_exception
711      * @since 3.2
712      */
713     public static function data_for_messagearea_search_messages($userid, $search, $limitfrom = 0, $limitnum = 0) {
714         global $CFG, $PAGE, $USER;
716         // Check if messaging is enabled.
717         if (empty($CFG->messaging)) {
718             throw new moodle_exception('disabled', 'message');
719         }
721         $systemcontext = context_system::instance();
723         $params = array(
724             'userid' => $userid,
725             'search' => $search,
726             'limitfrom' => $limitfrom,
727             'limitnum' => $limitnum
729         );
730         self::validate_parameters(self::data_for_messagearea_search_messages_parameters(), $params);
731         self::validate_context($systemcontext);
733         if (($USER->id != $userid) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
734             throw new moodle_exception('You do not have permission to perform this action.');
735         }
737         $messages = \core_message\api::search_messages($userid, $search, $limitfrom, $limitnum);
738         $results = new \core_message\output\messagearea\message_search_results($messages);
740         $renderer = $PAGE->get_renderer('core_message');
741         return $results->export_for_template($renderer);
742     }
744     /**
745      * Get messagearea search messages returns.
746      *
747      * @return external_single_structure
748      * @since 3.2
749      */
750     public static function data_for_messagearea_search_messages_returns() {
751         return new external_single_structure(
752             array(
753                 'contacts' => new external_multiple_structure(
754                     self::get_messagearea_contact_structure()
755                 )
756             )
757         );
758     }
760     /**
761      * The messagearea conversations parameters.
762      *
763      * @return external_function_parameters
764      * @since 3.2
765      */
766     public static function data_for_messagearea_conversations_parameters() {
767         return new external_function_parameters(
768             array(
769                 'userid' => new external_value(PARAM_INT, 'The id of the user who we are viewing conversations for'),
770                 'limitfrom' => new external_value(PARAM_INT, 'Limit from', VALUE_DEFAULT, 0),
771                 'limitnum' => new external_value(PARAM_INT, 'Limit number', VALUE_DEFAULT, 0)
772             )
773         );
774     }
776     /**
777      * Get messagearea conversations.
778      *
779      * @param int $userid The id of the user who we are viewing conversations for
780      * @param int $limitfrom
781      * @param int $limitnum
782      * @return stdClass
783      * @throws moodle_exception
784      * @since 3.2
785      */
786     public static function data_for_messagearea_conversations($userid, $limitfrom = 0, $limitnum = 0) {
787         global $CFG, $PAGE, $USER;
789         // Check if messaging is enabled.
790         if (empty($CFG->messaging)) {
791             throw new moodle_exception('disabled', 'message');
792         }
794         $systemcontext = context_system::instance();
796         $params = array(
797             'userid' => $userid,
798             'limitfrom' => $limitfrom,
799             'limitnum' => $limitnum
800         );
801         self::validate_parameters(self::data_for_messagearea_conversations_parameters(), $params);
802         self::validate_context($systemcontext);
804         if (($USER->id != $userid) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
805             throw new moodle_exception('You do not have permission to perform this action.');
806         }
808         $conversations = \core_message\api::get_conversations($userid, $limitfrom, $limitnum);
809         $conversations = new \core_message\output\messagearea\contacts(null, $conversations);
811         $renderer = $PAGE->get_renderer('core_message');
812         return $conversations->export_for_template($renderer);
813     }
815     /**
816      * The messagearea conversations return structure.
817      *
818      * @return external_single_structure
819      * @since 3.2
820      */
821     public static function data_for_messagearea_conversations_returns() {
822         return new external_single_structure(
823             array(
824                 'contacts' => new external_multiple_structure(
825                     self::get_messagearea_contact_structure()
826                 )
827             )
828         );
829     }
831     /**
832      * The messagearea contacts return parameters.
833      *
834      * @return external_function_parameters
835      * @since 3.2
836      */
837     public static function data_for_messagearea_contacts_parameters() {
838         return self::data_for_messagearea_conversations_parameters();
839     }
841     /**
842      * Get messagearea contacts parameters.
843      *
844      * @param int $userid The id of the user who we are viewing conversations for
845      * @param int $limitfrom
846      * @param int $limitnum
847      * @return stdClass
848      * @throws moodle_exception
849      * @since 3.2
850      */
851     public static function data_for_messagearea_contacts($userid, $limitfrom = 0, $limitnum = 0) {
852         global $CFG, $PAGE, $USER;
854         // Check if messaging is enabled.
855         if (empty($CFG->messaging)) {
856             throw new moodle_exception('disabled', 'message');
857         }
859         $systemcontext = context_system::instance();
861         $params = array(
862             'userid' => $userid,
863             'limitfrom' => $limitfrom,
864             'limitnum' => $limitnum
865         );
866         self::validate_parameters(self::data_for_messagearea_contacts_parameters(), $params);
867         self::validate_context($systemcontext);
869         if (($USER->id != $userid) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
870             throw new moodle_exception('You do not have permission to perform this action.');
871         }
873         $contacts = \core_message\api::get_contacts($userid, $limitfrom, $limitnum);
874         $contacts = new \core_message\output\messagearea\contacts(null, $contacts);
876         $renderer = $PAGE->get_renderer('core_message');
877         return $contacts->export_for_template($renderer);
878     }
880     /**
881      * The messagearea contacts return structure.
882      *
883      * @return external_single_structure
884      * @since 3.2
885      */
886     public static function data_for_messagearea_contacts_returns() {
887         return self::data_for_messagearea_conversations_returns();
888     }
890     /**
891      * The messagearea messages parameters.
892      *
893      * @return external_function_parameters
894      * @since 3.2
895      */
896     public static function data_for_messagearea_messages_parameters() {
897         return new external_function_parameters(
898             array(
899                 'currentuserid' => new external_value(PARAM_INT, 'The current user\'s id'),
900                 'otheruserid' => new external_value(PARAM_INT, 'The other user\'s id'),
901                 'limitfrom' => new external_value(PARAM_INT, 'Limit from', VALUE_DEFAULT, 0),
902                 'limitnum' => new external_value(PARAM_INT, 'Limit number', VALUE_DEFAULT, 0),
903                 'newest' => new external_value(PARAM_BOOL, 'Newest first?', VALUE_DEFAULT, false),
904                 'timefrom' => new external_value(PARAM_INT,
905                     'The timestamp from which the messages were created', VALUE_DEFAULT, 0),
906             )
907         );
908     }
910     /**
911      * Get messagearea messages.
912      *
913      * @param int $currentuserid The current user's id
914      * @param int $otheruserid The other user's id
915      * @param int $limitfrom
916      * @param int $limitnum
917      * @param boolean $newest
918      * @return stdClass
919      * @throws moodle_exception
920      * @since 3.2
921      */
922     public static function data_for_messagearea_messages($currentuserid, $otheruserid, $limitfrom = 0, $limitnum = 0,
923                                                          $newest = false, $timefrom = 0) {
924         global $CFG, $PAGE, $USER;
926         // Check if messaging is enabled.
927         if (empty($CFG->messaging)) {
928             throw new moodle_exception('disabled', 'message');
929         }
931         $systemcontext = context_system::instance();
933         $params = array(
934             'currentuserid' => $currentuserid,
935             'otheruserid' => $otheruserid,
936             'limitfrom' => $limitfrom,
937             'limitnum' => $limitnum,
938             'newest' => $newest,
939             'timefrom' => $timefrom,
940         );
941         self::validate_parameters(self::data_for_messagearea_messages_parameters(), $params);
942         self::validate_context($systemcontext);
944         if (($USER->id != $currentuserid) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
945             throw new moodle_exception('You do not have permission to perform this action.');
946         }
948         if ($newest) {
949             $sort = 'timecreated DESC';
950         } else {
951             $sort = 'timecreated ASC';
952         }
954         // We need to enforce a one second delay on messages to avoid race conditions of current
955         // messages still being sent.
956         //
957         // There is a chance that we could request messages before the current time's
958         // second has elapsed and while other messages are being sent in that same second. In which
959         // case those messages will be lost.
960         //
961         // Instead we ignore the current time in the result set to ensure that second is allowed to finish.
962         if (!empty($timefrom)) {
963             $timeto = time() - 1;
964         } else {
965             $timeto = 0;
966         }
968         // No requesting messages from the current time, as stated above.
969         if ($timefrom == time()) {
970             $messages = [];
971         } else {
972             $messages = \core_message\api::get_messages($currentuserid, $otheruserid, $limitfrom,
973                                                         $limitnum, $sort, $timefrom, $timeto);
974         }
976         $messages = new \core_message\output\messagearea\messages($currentuserid, $otheruserid, $messages);
978         $renderer = $PAGE->get_renderer('core_message');
979         return $messages->export_for_template($renderer);
980     }
982     /**
983      * The messagearea messages return structure.
984      *
985      * @return external_single_structure
986      * @since 3.2
987      */
988     public static function data_for_messagearea_messages_returns() {
989         return new external_single_structure(
990             array(
991                 'iscurrentuser' => new external_value(PARAM_BOOL, 'Is the currently logged in user the user we are viewing
992                     the messages on behalf of?'),
993                 'currentuserid' => new external_value(PARAM_INT, 'The current user\'s id'),
994                 'otheruserid' => new external_value(PARAM_INT, 'The other user\'s id'),
995                 'otheruserfullname' => new external_value(PARAM_NOTAGS, 'The other user\'s fullname'),
996                 'isonline' => new external_value(PARAM_BOOL, 'The user\'s online status'),
997                 'messages' => new external_multiple_structure(
998                     self::get_messagearea_message_structure()
999                 ),
1000                 'isblocked' => new external_value(PARAM_BOOL, 'Is this user blocked by the current user?', VALUE_DEFAULT, false),
1001             )
1002         );
1003     }
1005     /**
1006      * The get most recent message return parameters.
1007      *
1008      * @return external_function_parameters
1009      * @since 3.2
1010      */
1011     public static function data_for_messagearea_get_most_recent_message_parameters() {
1012         return new external_function_parameters(
1013             array(
1014                 'currentuserid' => new external_value(PARAM_INT, 'The current user\'s id'),
1015                 'otheruserid' => new external_value(PARAM_INT, 'The other user\'s id'),
1016             )
1017         );
1018     }
1020     /**
1021      * Get the most recent message in a conversation.
1022      *
1023      * @param int $currentuserid The current user's id
1024      * @param int $otheruserid The other user's id
1025      * @return stdClass
1026      * @throws moodle_exception
1027      * @since 3.2
1028      */
1029     public static function data_for_messagearea_get_most_recent_message($currentuserid, $otheruserid) {
1030         global $CFG, $PAGE, $USER;
1032         // Check if messaging is enabled.
1033         if (empty($CFG->messaging)) {
1034             throw new moodle_exception('disabled', 'message');
1035         }
1037         $systemcontext = context_system::instance();
1039         $params = array(
1040             'currentuserid' => $currentuserid,
1041             'otheruserid' => $otheruserid
1042         );
1043         self::validate_parameters(self::data_for_messagearea_get_most_recent_message_parameters(), $params);
1044         self::validate_context($systemcontext);
1046         if (($USER->id != $currentuserid) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
1047             throw new moodle_exception('You do not have permission to perform this action.');
1048         }
1050         $message = \core_message\api::get_most_recent_message($currentuserid, $otheruserid);
1051         $message = new \core_message\output\messagearea\message($message);
1053         $renderer = $PAGE->get_renderer('core_message');
1054         return $message->export_for_template($renderer);
1055     }
1057     /**
1058      * The get most recent message return structure.
1059      *
1060      * @return external_single_structure
1061      * @since 3.2
1062      */
1063     public static function data_for_messagearea_get_most_recent_message_returns() {
1064         return self::get_messagearea_message_structure();
1065     }
1067     /**
1068      * The get profile parameters.
1069      *
1070      * @return external_function_parameters
1071      * @since 3.2
1072      */
1073     public static function data_for_messagearea_get_profile_parameters() {
1074         return new external_function_parameters(
1075             array(
1076                 'currentuserid' => new external_value(PARAM_INT, 'The current user\'s id'),
1077                 'otheruserid' => new external_value(PARAM_INT, 'The id of the user whose profile we want to view'),
1078             )
1079         );
1080     }
1082     /**
1083      * Get the profile information for a contact.
1084      *
1085      * @param int $currentuserid The current user's id
1086      * @param int $otheruserid The id of the user whose profile we are viewing
1087      * @return stdClass
1088      * @throws moodle_exception
1089      * @since 3.2
1090      */
1091     public static function data_for_messagearea_get_profile($currentuserid, $otheruserid) {
1092         global $CFG, $PAGE, $USER;
1094         // Check if messaging is enabled.
1095         if (empty($CFG->messaging)) {
1096             throw new moodle_exception('disabled', 'message');
1097         }
1099         $systemcontext = context_system::instance();
1101         $params = array(
1102             'currentuserid' => $currentuserid,
1103             'otheruserid' => $otheruserid
1104         );
1105         self::validate_parameters(self::data_for_messagearea_get_profile_parameters(), $params);
1106         self::validate_context($systemcontext);
1108         if (($USER->id != $currentuserid) && !has_capability('moodle/site:readallmessages', $systemcontext)) {
1109             throw new moodle_exception('You do not have permission to perform this action.');
1110         }
1112         $profile = \core_message\api::get_profile($currentuserid, $otheruserid);
1113         $profile = new \core_message\output\messagearea\profile($profile);
1115         $renderer = $PAGE->get_renderer('core_message');
1116         return $profile->export_for_template($renderer);
1117     }
1119     /**
1120      * The get profile return structure.
1121      *
1122      * @return external_single_structure
1123      * @since 3.2
1124      */
1125     public static function data_for_messagearea_get_profile_returns() {
1126         return new external_single_structure(
1127             array(
1128                 'userid' => new external_value(PARAM_INT, 'The id of the user whose profile we are viewing'),
1129                 'email' => new external_value(core_user::get_property_type('email'), 'An email address'),
1130                 'country' => new external_value(PARAM_TEXT, 'Home country of the user'),
1131                 'city' => new external_value(core_user::get_property_type('city'), 'Home city of the user'),
1132                 'fullname' => new external_value(PARAM_NOTAGS, 'The user\'s name'),
1133                 'profileimageurl' => new external_value(PARAM_URL, 'User picture URL'),
1134                 'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL'),
1135                 'isonline' => new external_value(PARAM_BOOL, 'The user\'s online status'),
1136                 'isblocked' => new external_value(PARAM_BOOL, 'Is the user blocked?'),
1137                 'iscontact' => new external_value(PARAM_BOOL, 'Is the user a contact?')
1138             )
1139         );
1140     }
1142     /**
1143      * Get contacts parameters description.
1144      *
1145      * @return external_function_parameters
1146      * @since Moodle 2.5
1147      */
1148     public static function get_contacts_parameters() {
1149         return new external_function_parameters(array());
1150     }
1152     /**
1153      * Get contacts.
1154      *
1155      * @return external_description
1156      * @since Moodle 2.5
1157      */
1158     public static function get_contacts() {
1159         global $CFG, $PAGE;
1161         // Check if messaging is enabled.
1162         if (empty($CFG->messaging)) {
1163             throw new moodle_exception('disabled', 'message');
1164         }
1166         require_once($CFG->dirroot . '/user/lib.php');
1168         list($online, $offline, $strangers) = message_get_contacts();
1169         $allcontacts = array('online' => $online, 'offline' => $offline, 'strangers' => $strangers);
1170         foreach ($allcontacts as $mode => $contacts) {
1171             foreach ($contacts as $key => $contact) {
1172                 $newcontact = array(
1173                     'id' => $contact->id,
1174                     'fullname' => fullname($contact),
1175                     'unread' => $contact->messagecount
1176                 );
1178                 $userpicture = new user_picture($contact);
1179                 $userpicture->size = 1; // Size f1.
1180                 $newcontact['profileimageurl'] = $userpicture->get_url($PAGE)->out(false);
1181                 $userpicture->size = 0; // Size f2.
1182                 $newcontact['profileimageurlsmall'] = $userpicture->get_url($PAGE)->out(false);
1184                 $allcontacts[$mode][$key] = $newcontact;
1185             }
1186         }
1187         return $allcontacts;
1188     }
1190     /**
1191      * Get contacts return description.
1192      *
1193      * @return external_description
1194      * @since Moodle 2.5
1195      */
1196     public static function get_contacts_returns() {
1197         return new external_single_structure(
1198             array(
1199                 'online' => new external_multiple_structure(
1200                     new external_single_structure(
1201                         array(
1202                             'id' => new external_value(PARAM_INT, 'User ID'),
1203                             'fullname' => new external_value(PARAM_NOTAGS, 'User full name'),
1204                             'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL),
1205                             'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL),
1206                             'unread' => new external_value(PARAM_INT, 'Unread message count')
1207                         )
1208                     ),
1209                     'List of online contacts'
1210                 ),
1211                 'offline' => new external_multiple_structure(
1212                     new external_single_structure(
1213                         array(
1214                             'id' => new external_value(PARAM_INT, 'User ID'),
1215                             'fullname' => new external_value(PARAM_NOTAGS, 'User full name'),
1216                             'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL),
1217                             'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL),
1218                             'unread' => new external_value(PARAM_INT, 'Unread message count')
1219                         )
1220                     ),
1221                     'List of offline contacts'
1222                 ),
1223                 'strangers' => new external_multiple_structure(
1224                     new external_single_structure(
1225                         array(
1226                             'id' => new external_value(PARAM_INT, 'User ID'),
1227                             'fullname' => new external_value(PARAM_NOTAGS, 'User full name'),
1228                             'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL),
1229                             'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL),
1230                             'unread' => new external_value(PARAM_INT, 'Unread message count')
1231                         )
1232                     ),
1233                     'List of users that are not in the user\'s contact list but have sent a message'
1234                 )
1235             )
1236         );
1237     }
1239     /**
1240      * Search contacts parameters description.
1241      *
1242      * @return external_function_parameters
1243      * @since Moodle 2.5
1244      */
1245     public static function search_contacts_parameters() {
1246         return new external_function_parameters(
1247             array(
1248                 'searchtext' => new external_value(PARAM_CLEAN, 'String the user\'s fullname has to match to be found'),
1249                 'onlymycourses' => new external_value(PARAM_BOOL, 'Limit search to the user\'s courses',
1250                     VALUE_DEFAULT, false)
1251             )
1252         );
1253     }
1255     /**
1256      * Search contacts.
1257      *
1258      * @param string $searchtext query string.
1259      * @param bool $onlymycourses limit the search to the user's courses only.
1260      * @return external_description
1261      * @since Moodle 2.5
1262      */
1263     public static function search_contacts($searchtext, $onlymycourses = false) {
1264         global $CFG, $USER, $PAGE;
1265         require_once($CFG->dirroot . '/user/lib.php');
1267         // Check if messaging is enabled.
1268         if (empty($CFG->messaging)) {
1269             throw new moodle_exception('disabled', 'message');
1270         }
1272         require_once($CFG->libdir . '/enrollib.php');
1274         $params = array('searchtext' => $searchtext, 'onlymycourses' => $onlymycourses);
1275         $params = self::validate_parameters(self::search_contacts_parameters(), $params);
1277         // Extra validation, we do not allow empty queries.
1278         if ($params['searchtext'] === '') {
1279             throw new moodle_exception('querystringcannotbeempty');
1280         }
1282         $courseids = array();
1283         if ($params['onlymycourses']) {
1284             $mycourses = enrol_get_my_courses(array('id'));
1285             foreach ($mycourses as $mycourse) {
1286                 $courseids[] = $mycourse->id;
1287             }
1288         } else {
1289             $courseids[] = SITEID;
1290         }
1292         // Retrieving the users matching the query.
1293         $users = message_search_users($courseids, $params['searchtext']);
1294         $results = array();
1295         foreach ($users as $user) {
1296             $results[$user->id] = $user;
1297         }
1299         // Reorganising information.
1300         foreach ($results as &$user) {
1301             $newuser = array(
1302                 'id' => $user->id,
1303                 'fullname' => fullname($user)
1304             );
1306             // Avoid undefined property notice as phone not specified.
1307             $user->phone1 = null;
1308             $user->phone2 = null;
1310             $userpicture = new user_picture($user);
1311             $userpicture->size = 1; // Size f1.
1312             $newuser['profileimageurl'] = $userpicture->get_url($PAGE)->out(false);
1313             $userpicture->size = 0; // Size f2.
1314             $newuser['profileimageurlsmall'] = $userpicture->get_url($PAGE)->out(false);
1316             $user = $newuser;
1317         }
1319         return $results;
1320     }
1322     /**
1323      * Search contacts return description.
1324      *
1325      * @return external_description
1326      * @since Moodle 2.5
1327      */
1328     public static function search_contacts_returns() {
1329         return new external_multiple_structure(
1330             new external_single_structure(
1331                 array(
1332                     'id' => new external_value(PARAM_INT, 'User ID'),
1333                     'fullname' => new external_value(PARAM_NOTAGS, 'User full name'),
1334                     'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL),
1335                     'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL)
1336                 )
1337             ),
1338             'List of contacts'
1339         );
1340     }
1342     /**
1343      * Get messages parameters description.
1344      *
1345      * @return external_function_parameters
1346      * @since 2.8
1347      */
1348     public static function get_messages_parameters() {
1349         return new external_function_parameters(
1350             array(
1351                 'useridto' => new external_value(PARAM_INT, 'the user id who received the message, 0 for any user', VALUE_REQUIRED),
1352                 'useridfrom' => new external_value(
1353                     PARAM_INT, 'the user id who send the message, 0 for any user. -10 or -20 for no-reply or support user',
1354                     VALUE_DEFAULT, 0),
1355                 'type' => new external_value(
1356                     PARAM_ALPHA, 'type of message to return, expected values are: notifications, conversations and both',
1357                     VALUE_DEFAULT, 'both'),
1358                 'read' => new external_value(PARAM_BOOL, 'true for getting read messages, false for unread', VALUE_DEFAULT, true),
1359                 'newestfirst' => new external_value(
1360                     PARAM_BOOL, 'true for ordering by newest first, false for oldest first',
1361                     VALUE_DEFAULT, true),
1362                 'limitfrom' => new external_value(PARAM_INT, 'limit from', VALUE_DEFAULT, 0),
1363                 'limitnum' => new external_value(PARAM_INT, 'limit number', VALUE_DEFAULT, 0)
1364             )
1365         );
1366     }
1368     /**
1369      * Get messages function implementation.
1370      *
1371      * @since  2.8
1372      * @throws invalid_parameter_exception
1373      * @throws moodle_exception
1374      * @param  int      $useridto       the user id who received the message
1375      * @param  int      $useridfrom     the user id who send the message. -10 or -20 for no-reply or support user
1376      * @param  string   $type           type of message to return, expected values: notifications, conversations and both
1377      * @param  bool     $read           true for retreiving read messages, false for unread
1378      * @param  bool     $newestfirst    true for ordering by newest first, false for oldest first
1379      * @param  int      $limitfrom      limit from
1380      * @param  int      $limitnum       limit num
1381      * @return external_description
1382      */
1383     public static function get_messages($useridto, $useridfrom = 0, $type = 'both', $read = true,
1384                                         $newestfirst = true, $limitfrom = 0, $limitnum = 0) {
1385         global $CFG, $USER;
1387         $warnings = array();
1389         $params = array(
1390             'useridto' => $useridto,
1391             'useridfrom' => $useridfrom,
1392             'type' => $type,
1393             'read' => $read,
1394             'newestfirst' => $newestfirst,
1395             'limitfrom' => $limitfrom,
1396             'limitnum' => $limitnum
1397         );
1399         $params = self::validate_parameters(self::get_messages_parameters(), $params);
1401         $context = context_system::instance();
1402         self::validate_context($context);
1404         $useridto = $params['useridto'];
1405         $useridfrom = $params['useridfrom'];
1406         $type = $params['type'];
1407         $read = $params['read'];
1408         $newestfirst = $params['newestfirst'];
1409         $limitfrom = $params['limitfrom'];
1410         $limitnum = $params['limitnum'];
1412         $allowedvalues = array('notifications', 'conversations', 'both');
1413         if (!in_array($type, $allowedvalues)) {
1414             throw new invalid_parameter_exception('Invalid value for type parameter (value: ' . $type . '),' .
1415                 'allowed values are: ' . implode(',', $allowedvalues));
1416         }
1418         // Check if private messaging between users is allowed.
1419         if (empty($CFG->messaging)) {
1420             // If we are retreiving only conversations, and messaging is disabled, throw an exception.
1421             if ($type == "conversations") {
1422                 throw new moodle_exception('disabled', 'message');
1423             }
1424             if ($type == "both") {
1425                 $warning = array();
1426                 $warning['item'] = 'message';
1427                 $warning['itemid'] = $USER->id;
1428                 $warning['warningcode'] = '1';
1429                 $warning['message'] = 'Private messages (conversations) are not enabled in this site.
1430                     Only notifications will be returned';
1431                 $warnings[] = $warning;
1432             }
1433         }
1435         if (!empty($useridto)) {
1436             if (core_user::is_real_user($useridto)) {
1437                 $userto = core_user::get_user($useridto, '*', MUST_EXIST);
1438             } else {
1439                 throw new moodle_exception('invaliduser');
1440             }
1441         }
1443         if (!empty($useridfrom)) {
1444             // We use get_user here because the from user can be the noreply or support user.
1445             $userfrom = core_user::get_user($useridfrom, '*', MUST_EXIST);
1446         }
1448         // Check if the current user is the sender/receiver or just a privileged user.
1449         if ($useridto != $USER->id and $useridfrom != $USER->id and
1450              !has_capability('moodle/site:readallmessages', $context)) {
1451             throw new moodle_exception('accessdenied', 'admin');
1452         }
1454         // Which type of messages to retrieve.
1455         $notifications = -1;
1456         if ($type != 'both') {
1457             $notifications = ($type == 'notifications') ? 1 : 0;
1458         }
1460         $orderdirection = $newestfirst ? 'DESC' : 'ASC';
1461         $sort = "mr.timecreated $orderdirection";
1463         if ($messages = message_get_messages($useridto, $useridfrom, $notifications, $read, $sort, $limitfrom, $limitnum)) {
1464             $canviewfullname = has_capability('moodle/site:viewfullnames', $context);
1466             // In some cases, we don't need to get the to/from user objects from the sql query.
1467             $userfromfullname = '';
1468             $usertofullname = '';
1470             // In this case, the useridto field is not empty, so we can get the user destinatary fullname from there.
1471             if (!empty($useridto)) {
1472                 $usertofullname = fullname($userto, $canviewfullname);
1473                 // The user from may or may not be filled.
1474                 if (!empty($useridfrom)) {
1475                     $userfromfullname = fullname($userfrom, $canviewfullname);
1476                 }
1477             } else {
1478                 // If the useridto field is empty, the useridfrom must be filled.
1479                 $userfromfullname = fullname($userfrom, $canviewfullname);
1480             }
1481             foreach ($messages as $mid => $message) {
1483                 // Do not return deleted messages.
1484                 if (($useridto == $USER->id and $message->timeusertodeleted) or
1485                         ($useridfrom == $USER->id and $message->timeuserfromdeleted)) {
1487                     unset($messages[$mid]);
1488                     continue;
1489                 }
1491                 // We need to get the user from the query.
1492                 if (empty($userfromfullname)) {
1493                     // Check for non-reply and support users.
1494                     if (core_user::is_real_user($message->useridfrom)) {
1495                         $user = new stdClass();
1496                         $user = username_load_fields_from_object($user, $message, 'userfrom');
1497                         $message->userfromfullname = fullname($user, $canviewfullname);
1498                     } else {
1499                         $user = core_user::get_user($message->useridfrom);
1500                         $message->userfromfullname = fullname($user, $canviewfullname);
1501                     }
1502                 } else {
1503                     $message->userfromfullname = $userfromfullname;
1504                 }
1506                 // We need to get the user from the query.
1507                 if (empty($usertofullname)) {
1508                     $user = new stdClass();
1509                     $user = username_load_fields_from_object($user, $message, 'userto');
1510                     $message->usertofullname = fullname($user, $canviewfullname);
1511                 } else {
1512                     $message->usertofullname = $usertofullname;
1513                 }
1515                 // This field is only available in the message_read table.
1516                 if (!isset($message->timeread)) {
1517                     $message->timeread = 0;
1518                 }
1520                 $message->text = message_format_message_text($message);
1521                 $messages[$mid] = (array) $message;
1522             }
1523         }
1525         $results = array(
1526             'messages' => $messages,
1527             'warnings' => $warnings
1528         );
1530         return $results;
1531     }
1533     /**
1534      * Get messages return description.
1535      *
1536      * @return external_single_structure
1537      * @since 2.8
1538      */
1539     public static function get_messages_returns() {
1540         return new external_single_structure(
1541             array(
1542                 'messages' => new external_multiple_structure(
1543                     new external_single_structure(
1544                         array(
1545                             'id' => new external_value(PARAM_INT, 'Message id'),
1546                             'useridfrom' => new external_value(PARAM_INT, 'User from id'),
1547                             'useridto' => new external_value(PARAM_INT, 'User to id'),
1548                             'subject' => new external_value(PARAM_TEXT, 'The message subject'),
1549                             'text' => new external_value(PARAM_RAW, 'The message text formated'),
1550                             'fullmessage' => new external_value(PARAM_RAW, 'The message'),
1551                             'fullmessageformat' => new external_format_value('fullmessage'),
1552                             'fullmessagehtml' => new external_value(PARAM_RAW, 'The message in html'),
1553                             'smallmessage' => new external_value(PARAM_RAW, 'The shorten message'),
1554                             'notification' => new external_value(PARAM_INT, 'Is a notification?'),
1555                             'contexturl' => new external_value(PARAM_RAW, 'Context URL'),
1556                             'contexturlname' => new external_value(PARAM_TEXT, 'Context URL link name'),
1557                             'timecreated' => new external_value(PARAM_INT, 'Time created'),
1558                             'timeread' => new external_value(PARAM_INT, 'Time read'),
1559                             'usertofullname' => new external_value(PARAM_TEXT, 'User to full name'),
1560                             'userfromfullname' => new external_value(PARAM_TEXT, 'User from full name')
1561                         ), 'message'
1562                     )
1563                 ),
1564                 'warnings' => new external_warnings()
1565             )
1566         );
1567     }
1569     /**
1570      * Mark all notifications as read parameters description.
1571      *
1572      * @return external_function_parameters
1573      * @since 3.2
1574      */
1575     public static function mark_all_notifications_as_read_parameters() {
1576         return new external_function_parameters(
1577             array(
1578                 'useridto' => new external_value(PARAM_INT, 'the user id who received the message, 0 for any user', VALUE_REQUIRED),
1579                 'useridfrom' => new external_value(
1580                     PARAM_INT, 'the user id who send the message, 0 for any user. -10 or -20 for no-reply or support user',
1581                     VALUE_DEFAULT, 0),
1582             )
1583         );
1584     }
1586     /**
1587      * Mark all notifications as read function.
1588      *
1589      * @since  3.2
1590      * @throws invalid_parameter_exception
1591      * @throws moodle_exception
1592      * @param  int      $useridto       the user id who received the message
1593      * @param  int      $useridfrom     the user id who send the message. -10 or -20 for no-reply or support user
1594      * @return external_description
1595      */
1596     public static function mark_all_notifications_as_read($useridto, $useridfrom) {
1597         global $USER;
1599         $params = self::validate_parameters(
1600             self::mark_all_notifications_as_read_parameters(),
1601             array(
1602                 'useridto' => $useridto,
1603                 'useridfrom' => $useridfrom,
1604             )
1605         );
1607         $context = context_system::instance();
1608         self::validate_context($context);
1610         $useridto = $params['useridto'];
1611         $useridfrom = $params['useridfrom'];
1613         if (!empty($useridto)) {
1614             if (core_user::is_real_user($useridto)) {
1615                 $userto = core_user::get_user($useridto, '*', MUST_EXIST);
1616             } else {
1617                 throw new moodle_exception('invaliduser');
1618             }
1619         }
1621         if (!empty($useridfrom)) {
1622             // We use get_user here because the from user can be the noreply or support user.
1623             $userfrom = core_user::get_user($useridfrom, '*', MUST_EXIST);
1624         }
1626         // Check if the current user is the sender/receiver or just a privileged user.
1627         if ($useridto != $USER->id and $useridfrom != $USER->id and
1628             // The deleteanymessage cap seems more reasonable here than readallmessages.
1629              !has_capability('moodle/site:deleteanymessage', $context)) {
1630             throw new moodle_exception('accessdenied', 'admin');
1631         }
1633         \core_message\api::mark_all_read_for_user($useridto, $useridfrom, MESSAGE_TYPE_NOTIFICATION);
1635         return true;
1636     }
1638     /**
1639      * Mark all notifications as read return description.
1640      *
1641      * @return external_single_structure
1642      * @since 3.2
1643      */
1644     public static function mark_all_notifications_as_read_returns() {
1645         return new external_value(PARAM_BOOL, 'True if the messages were marked read, false otherwise');
1646     }
1648     /**
1649      * Get unread conversations count parameters description.
1650      *
1651      * @return external_function_parameters
1652      * @since 3.2
1653      */
1654     public static function get_unread_conversations_count_parameters() {
1655         return new external_function_parameters(
1656             array(
1657                 'useridto' => new external_value(PARAM_INT, 'the user id who received the message, 0 for any user', VALUE_REQUIRED),
1658             )
1659         );
1660     }
1662     /**
1663      * Get unread messages count function.
1664      *
1665      * @since  3.2
1666      * @throws invalid_parameter_exception
1667      * @throws moodle_exception
1668      * @param  int      $useridto       the user id who received the message
1669      * @return external_description
1670      */
1671     public static function get_unread_conversations_count($useridto) {
1672         global $USER, $CFG;
1674         // Check if messaging is enabled.
1675         if (empty($CFG->messaging)) {
1676             throw new moodle_exception('disabled', 'message');
1677         }
1679         $params = self::validate_parameters(
1680             self::get_unread_conversations_count_parameters(),
1681             array('useridto' => $useridto)
1682         );
1684         $context = context_system::instance();
1685         self::validate_context($context);
1687         $useridto = $params['useridto'];
1689         if (!empty($useridto)) {
1690             if (core_user::is_real_user($useridto)) {
1691                 $userto = core_user::get_user($useridto, '*', MUST_EXIST);
1692             } else {
1693                 throw new moodle_exception('invaliduser');
1694             }
1695         } else {
1696             $useridto = $USER->id;
1697         }
1699         // Check if the current user is the receiver or just a privileged user.
1700         if ($useridto != $USER->id and !has_capability('moodle/site:readallmessages', $context)) {
1701             throw new moodle_exception('accessdenied', 'admin');
1702         }
1704         return \core_message\api::count_unread_conversations($userto);
1705     }
1707     /**
1708      * Get unread conversations count return description.
1709      *
1710      * @return external_single_structure
1711      * @since 3.2
1712      */
1713     public static function get_unread_conversations_count_returns() {
1714         return new external_value(PARAM_INT, 'The count of unread messages for the user');
1715     }
1717     /**
1718      * Get blocked users parameters description.
1719      *
1720      * @return external_function_parameters
1721      * @since 2.9
1722      */
1723     public static function get_blocked_users_parameters() {
1724         return new external_function_parameters(
1725             array(
1726                 'userid' => new external_value(PARAM_INT,
1727                                 'the user whose blocked users we want to retrieve',
1728                                 VALUE_REQUIRED),
1729             )
1730         );
1731     }
1733     /**
1734      * Retrieve a list of users blocked
1735      *
1736      * @param  int $userid the user whose blocked users we want to retrieve
1737      * @return external_description
1738      * @since 2.9
1739      */
1740     public static function get_blocked_users($userid) {
1741         global $CFG, $USER, $PAGE;
1743         // Warnings array, it can be empty at the end but is mandatory.
1744         $warnings = array();
1746         // Validate params.
1747         $params = array(
1748             'userid' => $userid
1749         );
1750         $params = self::validate_parameters(self::get_blocked_users_parameters(), $params);
1751         $userid = $params['userid'];
1753         // Validate context.
1754         $context = context_system::instance();
1755         self::validate_context($context);
1757         // Check if private messaging between users is allowed.
1758         if (empty($CFG->messaging)) {
1759             throw new moodle_exception('disabled', 'message');
1760         }
1762         $user = core_user::get_user($userid, '*', MUST_EXIST);
1763         core_user::require_active_user($user);
1765         // Check if we have permissions for retrieve the information.
1766         $capability = 'moodle/site:manageallmessaging';
1767         if (($USER->id != $userid) && !has_capability($capability, $context)) {
1768             throw new required_capability_exception($context, $capability, 'nopermissions', '');
1769         }
1771         // Now, we can get safely all the blocked users.
1772         $users = message_get_blocked_users($user);
1774         $blockedusers = array();
1775         foreach ($users as $user) {
1776             $newuser = array(
1777                 'id' => $user->id,
1778                 'fullname' => fullname($user),
1779             );
1781             $userpicture = new user_picture($user);
1782             $userpicture->size = 1; // Size f1.
1783             $newuser['profileimageurl'] = $userpicture->get_url($PAGE)->out(false);
1785             $blockedusers[] = $newuser;
1786         }
1788         $results = array(
1789             'users' => $blockedusers,
1790             'warnings' => $warnings
1791         );
1792         return $results;
1793     }
1795     /**
1796      * Get blocked users return description.
1797      *
1798      * @return external_single_structure
1799      * @since 2.9
1800      */
1801     public static function get_blocked_users_returns() {
1802         return new external_single_structure(
1803             array(
1804                 'users' => new external_multiple_structure(
1805                     new external_single_structure(
1806                         array(
1807                             'id' => new external_value(PARAM_INT, 'User ID'),
1808                             'fullname' => new external_value(PARAM_NOTAGS, 'User full name'),
1809                             'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL)
1810                         )
1811                     ),
1812                     'List of blocked users'
1813                 ),
1814                 'warnings' => new external_warnings()
1815             )
1816         );
1817     }
1819     /**
1820      * Returns description of method parameters
1821      *
1822      * @return external_function_parameters
1823      * @since 2.9
1824      */
1825     public static function mark_message_read_parameters() {
1826         return new external_function_parameters(
1827             array(
1828                 'messageid' => new external_value(PARAM_INT, 'id of the message (in the message table)'),
1829                 'timeread' => new external_value(PARAM_INT, 'timestamp for when the message should be marked read',
1830                     VALUE_DEFAULT, 0)
1831             )
1832         );
1833     }
1835     /**
1836      * Mark a single message as read, trigger message_viewed event
1837      *
1838      * @param  int $messageid id of the message (in the message table)
1839      * @param  int $timeread timestamp for when the message should be marked read
1840      * @return external_description
1841      * @throws invalid_parameter_exception
1842      * @throws moodle_exception
1843      * @since 2.9
1844      */
1845     public static function mark_message_read($messageid, $timeread) {
1846         global $CFG, $DB, $USER;
1848         // Check if private messaging between users is allowed.
1849         if (empty($CFG->messaging)) {
1850             throw new moodle_exception('disabled', 'message');
1851         }
1853         // Warnings array, it can be empty at the end but is mandatory.
1854         $warnings = array();
1856         // Validate params.
1857         $params = array(
1858             'messageid' => $messageid,
1859             'timeread' => $timeread
1860         );
1861         $params = self::validate_parameters(self::mark_message_read_parameters(), $params);
1863         if (empty($params['timeread'])) {
1864             $timeread = time();
1865         } else {
1866             $timeread = $params['timeread'];
1867         }
1869         // Validate context.
1870         $context = context_system::instance();
1871         self::validate_context($context);
1873         $message = $DB->get_record('message', array('id' => $params['messageid']), '*', MUST_EXIST);
1875         if ($message->useridto != $USER->id) {
1876             throw new invalid_parameter_exception('Invalid messageid, you don\'t have permissions to mark this message as read');
1877         }
1879         $messageid = message_mark_message_read($message, $timeread);
1881         $results = array(
1882             'messageid' => $messageid,
1883             'warnings' => $warnings
1884         );
1885         return $results;
1886     }
1888     /**
1889      * Returns description of method result value
1890      *
1891      * @return external_description
1892      * @since 2.9
1893      */
1894     public static function mark_message_read_returns() {
1895         return new external_single_structure(
1896             array(
1897                 'messageid' => new external_value(PARAM_INT, 'the id of the message in the message_read table'),
1898                 'warnings' => new external_warnings()
1899             )
1900         );
1901     }
1903     /**
1904      * Mark all messages as read parameters description.
1905      *
1906      * @return external_function_parameters
1907      * @since 3.2
1908      */
1909     public static function mark_all_messages_as_read_parameters() {
1910         return new external_function_parameters(
1911             array(
1912                 'useridto' => new external_value(PARAM_INT, 'the user id who received the message, 0 for any user', VALUE_REQUIRED),
1913                 'useridfrom' => new external_value(
1914                     PARAM_INT, 'the user id who send the message, 0 for any user. -10 or -20 for no-reply or support user',
1915                     VALUE_DEFAULT, 0),
1916             )
1917         );
1918     }
1920     /**
1921      * Mark all notifications as read function.
1922      *
1923      * @since  3.2
1924      * @throws invalid_parameter_exception
1925      * @throws moodle_exception
1926      * @param  int      $useridto       the user id who received the message
1927      * @param  int      $useridfrom     the user id who send the message. -10 or -20 for no-reply or support user
1928      * @return external_description
1929      */
1930     public static function mark_all_messages_as_read($useridto, $useridfrom) {
1931         global $USER, $CFG;
1933         // Check if messaging is enabled.
1934         if (empty($CFG->messaging)) {
1935             throw new moodle_exception('disabled', 'message');
1936         }
1938         $params = self::validate_parameters(
1939             self::mark_all_messages_as_read_parameters(),
1940             array(
1941                 'useridto' => $useridto,
1942                 'useridfrom' => $useridfrom,
1943             )
1944         );
1946         $context = context_system::instance();
1947         self::validate_context($context);
1949         $useridto = $params['useridto'];
1950         $useridfrom = $params['useridfrom'];
1952         if (!empty($useridto)) {
1953             if (core_user::is_real_user($useridto)) {
1954                 $userto = core_user::get_user($useridto, '*', MUST_EXIST);
1955             } else {
1956                 throw new moodle_exception('invaliduser');
1957             }
1958         }
1960         if (!empty($useridfrom)) {
1961             // We use get_user here because the from user can be the noreply or support user.
1962             $userfrom = core_user::get_user($useridfrom, '*', MUST_EXIST);
1963         }
1965         // Check if the current user is the sender/receiver or just a privileged user.
1966         if ($useridto != $USER->id and $useridfrom != $USER->id and
1967             // The deleteanymessage cap seems more reasonable here than readallmessages.
1968              !has_capability('moodle/site:deleteanymessage', $context)) {
1969             throw new moodle_exception('accessdenied', 'admin');
1970         }
1972         \core_message\api::mark_all_read_for_user($useridto, $useridfrom, MESSAGE_TYPE_MESSAGE);
1974         return true;
1975     }
1977     /**
1978      * Mark all notifications as read return description.
1979      *
1980      * @return external_single_structure
1981      * @since 3.2
1982      */
1983     public static function mark_all_messages_as_read_returns() {
1984         return new external_value(PARAM_BOOL, 'True if the messages were marked read, false otherwise');
1985     }
1987     /**
1988      * Returns description of method parameters.
1989      *
1990      * @return external_function_parameters
1991      * @since 3.2
1992      */
1993     public static function delete_conversation_parameters() {
1994         return new external_function_parameters(
1995             array(
1996                 'userid' => new external_value(PARAM_INT, 'The user id of who we want to delete the conversation for'),
1997                 'otheruserid' => new external_value(PARAM_INT, 'The user id of the other user in the conversation'),
1998             )
1999         );
2000     }
2002     /**
2003      * Deletes a conversation.
2004      *
2005      * @param int $userid The user id of who we want to delete the conversation for
2006      * @param int $otheruserid The user id of the other user in the conversation
2007      * @return array
2008      * @throws moodle_exception
2009      * @since 3.2
2010      */
2011     public static function delete_conversation($userid, $otheruserid) {
2012         global $CFG;
2014         // Check if private messaging between users is allowed.
2015         if (empty($CFG->messaging)) {
2016             throw new moodle_exception('disabled', 'message');
2017         }
2019         // Warnings array, it can be empty at the end but is mandatory.
2020         $warnings = array();
2022         // Validate params.
2023         $params = array(
2024             'userid' => $userid,
2025             'otheruserid' => $otheruserid,
2026         );
2027         $params = self::validate_parameters(self::delete_conversation_parameters(), $params);
2029         // Validate context.
2030         $context = context_system::instance();
2031         self::validate_context($context);
2033         $user = core_user::get_user($params['userid'], '*', MUST_EXIST);
2034         core_user::require_active_user($user);
2036         if (\core_message\api::can_delete_conversation($user->id)) {
2037             $status = \core_message\api::delete_conversation($user->id, $otheruserid);
2038         } else {
2039             throw new moodle_exception('You do not have permission to delete messages');
2040         }
2042         $results = array(
2043             'status' => $status,
2044             'warnings' => $warnings
2045         );
2047         return $results;
2048     }
2050     /**
2051      * Returns description of method result value.
2052      *
2053      * @return external_description
2054      * @since 3.2
2055      */
2056     public static function delete_conversation_returns() {
2057         return new external_single_structure(
2058             array(
2059                 'status' => new external_value(PARAM_BOOL, 'True if the conversation was deleted, false otherwise'),
2060                 'warnings' => new external_warnings()
2061             )
2062         );
2063     }
2065     /**
2066      * Returns description of method parameters
2067      *
2068      * @return external_function_parameters
2069      * @since 3.1
2070      */
2071     public static function delete_message_parameters() {
2072         return new external_function_parameters(
2073             array(
2074                 'messageid' => new external_value(PARAM_INT, 'The message id'),
2075                 'userid' => new external_value(PARAM_INT, 'The user id of who we want to delete the message for'),
2076                 'read' => new external_value(PARAM_BOOL, 'If is a message read', VALUE_DEFAULT, true)
2077             )
2078         );
2079     }
2081     /**
2082      * Deletes a message
2083      *
2084      * @param  int $messageid the message id
2085      * @param  int $userid the user id of who we want to delete the message for
2086      * @param  bool $read if is a message read (default to true)
2087      * @return external_description
2088      * @throws moodle_exception
2089      * @since 3.1
2090      */
2091     public static function delete_message($messageid, $userid, $read = true) {
2092         global $CFG, $DB;
2094         // Check if private messaging between users is allowed.
2095         if (empty($CFG->messaging)) {
2096             throw new moodle_exception('disabled', 'message');
2097         }
2099         // Warnings array, it can be empty at the end but is mandatory.
2100         $warnings = array();
2102         // Validate params.
2103         $params = array(
2104             'messageid' => $messageid,
2105             'userid' => $userid,
2106             'read' => $read
2107         );
2108         $params = self::validate_parameters(self::delete_message_parameters(), $params);
2110         // Validate context.
2111         $context = context_system::instance();
2112         self::validate_context($context);
2114         $messagestable = $params['read'] ? 'message_read' : 'message';
2115         $message = $DB->get_record($messagestable, array('id' => $params['messageid']), '*', MUST_EXIST);
2117         $user = core_user::get_user($params['userid'], '*', MUST_EXIST);
2118         core_user::require_active_user($user);
2120         $status = false;
2121         if (message_can_delete_message($message, $user->id)) {
2122             $status = message_delete_message($message, $user->id);;
2123         } else {
2124             throw new moodle_exception('You do not have permission to delete this message');
2125         }
2127         $results = array(
2128             'status' => $status,
2129             'warnings' => $warnings
2130         );
2131         return $results;
2132     }
2134     /**
2135      * Returns description of method result value
2136      *
2137      * @return external_description
2138      * @since 3.1
2139      */
2140     public static function delete_message_returns() {
2141         return new external_single_structure(
2142             array(
2143                 'status' => new external_value(PARAM_BOOL, 'True if the message was deleted, false otherwise'),
2144                 'warnings' => new external_warnings()
2145             )
2146         );
2147     }
2149     /**
2150      * Returns description of method parameters
2151      *
2152      * @return external_function_parameters
2153      * @since 3.2
2154      */
2155     public static function message_processor_config_form_parameters() {
2156         return new external_function_parameters(
2157             array(
2158                 'userid' => new external_value(PARAM_INT, 'id of the user, 0 for current user', VALUE_REQUIRED),
2159                 'name' => new external_value(PARAM_TEXT, 'The name of the message processor'),
2160                 'formvalues' => new external_multiple_structure(
2161                     new external_single_structure(
2162                         array(
2163                             'name' => new external_value(PARAM_TEXT, 'name of the form element', VALUE_REQUIRED),
2164                             'value' => new external_value(PARAM_RAW, 'value of the form element', VALUE_REQUIRED),
2165                         )
2166                     ),
2167                     'Config form values',
2168                     VALUE_REQUIRED
2169                 ),
2170             )
2171         );
2172     }
2174     /**
2175      * Processes a message processor config form.
2176      *
2177      * @param  int $userid the user id
2178      * @param  string $name the name of the processor
2179      * @param  array $formvalues the form values
2180      * @return external_description
2181      * @throws moodle_exception
2182      * @since 3.2
2183      */
2184     public static function message_processor_config_form($userid, $name, $formvalues) {
2185         global $USER, $CFG;
2187         // Check if messaging is enabled.
2188         if (empty($CFG->messaging)) {
2189             throw new moodle_exception('disabled', 'message');
2190         }
2192         $params = self::validate_parameters(
2193             self::message_processor_config_form_parameters(),
2194             array(
2195                 'userid' => $userid,
2196                 'name' => $name,
2197                 'formvalues' => $formvalues,
2198             )
2199         );
2201         if (empty($params['userid'])) {
2202             $params['userid'] = $USER->id;
2203         }
2205         $user = core_user::get_user($params['userid'], '*', MUST_EXIST);
2206         core_user::require_active_user($user);
2208         $processor = get_message_processor($name);
2209         $preferences = [];
2210         $form = new stdClass();
2212         foreach ($formvalues as $formvalue) {
2213             // Curly braces to ensure interpretation is consistent between
2214             // php 5 and php 7.
2215             $form->{$formvalue['name']} = $formvalue['value'];
2216         }
2218         $processor->process_form($form, $preferences);
2220         if (!empty($preferences)) {
2221             set_user_preferences($preferences, $userid);
2222         }
2223     }
2225     /**
2226      * Returns description of method result value
2227      *
2228      * @return external_description
2229      * @since 3.2
2230      */
2231     public static function message_processor_config_form_returns() {
2232         return null;
2233     }
2235     /**
2236      * Returns description of method parameters
2237      *
2238      * @return external_function_parameters
2239      * @since 3.2
2240      */
2241     public static function get_message_processor_parameters() {
2242         return new external_function_parameters(
2243             array(
2244                 'userid' => new external_value(PARAM_INT, 'id of the user, 0 for current user'),
2245                 'name' => new external_value(PARAM_TEXT, 'The name of the message processor', VALUE_REQUIRED),
2246             )
2247         );
2248     }
2250     /**
2251      * Get a message processor.
2252      *
2253      * @param int $userid
2254      * @param string $name the name of the processor
2255      * @return external_description
2256      * @throws moodle_exception
2257      * @since 3.2
2258      */
2259     public static function get_message_processor($userid = 0, $name) {
2260         global $USER, $PAGE, $CFG;
2262         // Check if messaging is enabled.
2263         if (empty($CFG->messaging)) {
2264             throw new moodle_exception('disabled', 'message');
2265         }
2267         $params = self::validate_parameters(
2268             self::get_message_processor_parameters(),
2269             array(
2270                 'userid' => $userid,
2271                 'name' => $name,
2272             )
2273         );
2275         if (empty($params['userid'])) {
2276             $params['userid'] = $USER->id;
2277         }
2279         $user = core_user::get_user($params['userid'], '*', MUST_EXIST);
2280         core_user::require_active_user($user);
2281         self::validate_context(context_user::instance($params['userid']));
2283         $processor = get_message_processor($name);
2285         $processoroutput = new \core_message\output\processor($processor, $user);
2286         $renderer = $PAGE->get_renderer('core_message');
2288         return $processoroutput->export_for_template($renderer);
2289     }
2291     /**
2292      * Returns description of method result value
2293      *
2294      * @return external_description
2295      * @since 3.2
2296      */
2297     public static function get_message_processor_returns() {
2298         return new external_function_parameters(
2299             array(
2300                 'systemconfigured' => new external_value(PARAM_BOOL, 'Site configuration status'),
2301                 'userconfigured' => new external_value(PARAM_BOOL, 'The user configuration status'),
2302             )
2303         );
2304     }
2306     /**
2307      * Check that the user has enough permission to retrieve message or notifications preferences.
2308      *
2309      * @param  int $userid the user id requesting the preferences
2310      * @return stdClass full user object
2311      * @throws moodle_exception
2312      * @since  Moodle 3.2
2313      */
2314     protected static function validate_preferences_permissions($userid) {
2315         global $USER;
2317         if (empty($userid)) {
2318             $user = $USER;
2319         } else {
2320             $user = core_user::get_user($userid, '*', MUST_EXIST);
2321             core_user::require_active_user($user);
2322         }
2324         $systemcontext = context_system::instance();
2325         self::validate_context($systemcontext);
2327         // Check access control.
2328         if ($user->id == $USER->id) {
2329             // Editing own message profile.
2330             require_capability('moodle/user:editownmessageprofile', $systemcontext);
2331         } else {
2332             // Teachers, parents, etc.
2333             $personalcontext = context_user::instance($user->id);
2334             require_capability('moodle/user:editmessageprofile', $personalcontext);
2335         }
2336         return $user;
2337     }
2339     /**
2340      * Returns a notification or message preference structure.
2341      *
2342      * @return external_single_structure the structure
2343      * @since  Moodle 3.2
2344      */
2345     protected static function get_preferences_structure() {
2346         return new external_single_structure(
2347             array(
2348                 'userid' => new external_value(PARAM_INT, 'User id'),
2349                 'disableall' => new external_value(PARAM_INT, 'Whether all the preferences are disabled'),
2350                 'processors' => new external_multiple_structure(
2351                     new external_single_structure(
2352                         array(
2353                             'displayname' => new external_value(PARAM_TEXT, 'Display name'),
2354                             'name' => new external_value(PARAM_PLUGIN, 'Processor name'),
2355                             'hassettings' => new external_value(PARAM_BOOL, 'Whether has settings'),
2356                             'contextid' => new external_value(PARAM_INT, 'Context id'),
2357                             'userconfigured' => new external_value(PARAM_INT, 'Whether is configured by the user'),
2358                         )
2359                     ),
2360                     'Config form values'
2361                 ),
2362                 'components' => new external_multiple_structure(
2363                     new external_single_structure(
2364                         array(
2365                             'displayname' => new external_value(PARAM_TEXT, 'Display name'),
2366                             'notifications' => new external_multiple_structure(
2367                                 new external_single_structure(
2368                                     array(
2369                                         'displayname' => new external_value(PARAM_TEXT, 'Display name'),
2370                                         'preferencekey' => new external_value(PARAM_ALPHANUMEXT, 'Preference key'),
2371                                         'processors' => new external_multiple_structure(
2372                                             new external_single_structure(
2373                                                 array(
2374                                                     'displayname' => new external_value(PARAM_TEXT, 'Display name'),
2375                                                     'name' => new external_value(PARAM_PLUGIN, 'Processor name'),
2376                                                     'locked' => new external_value(PARAM_BOOL, 'Is locked by admin?'),
2377                                                     'userconfigured' => new external_value(PARAM_INT, 'Is configured?'),
2378                                                     'loggedin' => new external_single_structure(
2379                                                         array(
2380                                                             'name' => new external_value(PARAM_NOTAGS, 'Name'),
2381                                                             'displayname' => new external_value(PARAM_TEXT, 'Display name'),
2382                                                             'checked' => new external_value(PARAM_BOOL, 'Is checked?'),
2383                                                         )
2384                                                     ),
2385                                                     'loggedoff' => new external_single_structure(
2386                                                         array(
2387                                                             'name' => new external_value(PARAM_NOTAGS, 'Name'),
2388                                                             'displayname' => new external_value(PARAM_TEXT, 'Display name'),
2389                                                             'checked' => new external_value(PARAM_BOOL, 'Is checked?'),
2390                                                         )
2391                                                     ),
2392                                                 )
2393                                             ),
2394                                             'Processors values for this notification'
2395                                         ),
2396                                     )
2397                                 ),
2398                                 'List of notificaitons for the component'
2399                             ),
2400                         )
2401                     ),
2402                     'Available components'
2403                 ),
2404             )
2405         );
2406     }
2408     /**
2409      * Returns description of method parameters
2410      *
2411      * @return external_function_parameters
2412      * @since 3.2
2413      */
2414     public static function get_user_notification_preferences_parameters() {
2415         return new external_function_parameters(
2416             array(
2417                 'userid' => new external_value(PARAM_INT, 'id of the user, 0 for current user', VALUE_DEFAULT, 0)
2418             )
2419         );
2420     }
2422     /**
2423      * Get the notification preferences for a given user.
2424      *
2425      * @param int $userid id of the user, 0 for current user
2426      * @return external_description
2427      * @throws moodle_exception
2428      * @since 3.2
2429      */
2430     public static function get_user_notification_preferences($userid = 0) {
2431         global $PAGE;
2433         $params = self::validate_parameters(
2434             self::get_user_notification_preferences_parameters(),
2435             array(
2436                 'userid' => $userid,
2437             )
2438         );
2439         $user = self::validate_preferences_permissions($params['userid']);
2441         $processors = get_message_processors();
2442         $providers = message_get_providers_for_user($user->id);
2443         $preferences = \core_message\api::get_all_message_preferences($processors, $providers, $user);
2444         $notificationlist = new \core_message\output\preferences\notification_list($processors, $providers, $preferences, $user);
2446         $renderer = $PAGE->get_renderer('core_message');
2448         $result = array(
2449             'warnings' => array(),
2450             'preferences' => $notificationlist->export_for_template($renderer)
2451         );
2452         return $result;
2453     }
2455     /**
2456      * Returns description of method result value
2457      *
2458      * @return external_description
2459      * @since 3.2
2460      */
2461     public static function get_user_notification_preferences_returns() {
2462         return new external_function_parameters(
2463             array(
2464                 'preferences' => self::get_preferences_structure(),
2465                 'warnings' => new external_warnings(),
2466             )
2467         );
2468     }
2471     /**
2472      * Returns description of method parameters
2473      *
2474      * @return external_function_parameters
2475      * @since 3.2
2476      */
2477     public static function get_user_message_preferences_parameters() {
2478         return new external_function_parameters(
2479             array(
2480                 'userid' => new external_value(PARAM_INT, 'id of the user, 0 for current user', VALUE_DEFAULT, 0)
2481             )
2482         );
2483     }
2485     /**
2486      * Get the notification preferences for a given user.
2487      *
2488      * @param int $userid id of the user, 0 for current user
2489      * @return external_description
2490      * @throws moodle_exception
2491      * @since 3.2
2492      */
2493     public static function get_user_message_preferences($userid = 0) {
2494         global $PAGE;
2496         $params = self::validate_parameters(
2497             self::get_user_message_preferences_parameters(),
2498             array(
2499                 'userid' => $userid,
2500             )
2501         );
2503         $user = self::validate_preferences_permissions($params['userid']);
2505         // Filter out enabled, available system_configured and user_configured processors only.
2506         $readyprocessors = array_filter(get_message_processors(), function($processor) {
2507             return $processor->enabled &&
2508                 $processor->configured &&
2509                 $processor->object->is_user_configured() &&
2510                 // Filter out processors that don't have and message preferences to configure.
2511                 $processor->object->has_message_preferences();
2512         });
2514         $providers = array_filter(message_get_providers_for_user($user->id), function($provider) {
2515             return $provider->component === 'moodle';
2516         });
2517         $preferences = \core_message\api::get_all_message_preferences($readyprocessors, $providers, $user);
2518         $notificationlistoutput = new \core_message\output\preferences\message_notification_list($readyprocessors,
2519             $providers, $preferences, $user);
2521         $renderer = $PAGE->get_renderer('core_message');
2523         $result = array(
2524             'warnings' => array(),
2525             'preferences' => $notificationlistoutput->export_for_template($renderer),
2526             'blocknoncontacts' => get_user_preferences('message_blocknoncontacts', '', $user->id) ? true : false,
2527         );
2528         return $result;
2529     }
2531     /**
2532      * Returns description of method result value
2533      *
2534      * @return external_description
2535      * @since 3.2
2536      */
2537     public static function get_user_message_preferences_returns() {
2538         return new external_function_parameters(
2539             array(
2540                 'preferences' => self::get_preferences_structure(),
2541                 'blocknoncontacts' => new external_value(PARAM_BOOL, 'Whether to block or not messages from non contacts'),
2542                 'warnings' => new external_warnings(),
2543             )
2544         );
2545     }