MDL-45374 messages: get_messages ws unit tests
[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");
29 /**
30  * Message external functions
31  *
32  * @package    core_message
33  * @category   external
34  * @copyright  2011 Jerome Mouneyrac
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  * @since Moodle 2.2
37  */
38 class core_message_external extends external_api {
40     /**
41      * Returns description of method parameters
42      *
43      * @return external_function_parameters
44      * @since Moodle 2.2
45      */
46     public static function send_instant_messages_parameters() {
47         return new external_function_parameters(
48             array(
49                 'messages' => new external_multiple_structure(
50                     new external_single_structure(
51                         array(
52                             'touserid' => new external_value(PARAM_INT, 'id of the user to send the private message'),
53                             'text' => new external_value(PARAM_RAW, 'the text of the message'),
54                             'textformat' => new external_format_value('text', VALUE_DEFAULT),
55                             '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),
56                         )
57                     )
58                 )
59             )
60         );
61     }
63     /**
64      * Send private messages from the current USER to other users
65      *
66      * @param array $messages An array of message to send.
67      * @return array
68      * @since Moodle 2.2
69      */
70     public static function send_instant_messages($messages = array()) {
71         global $CFG, $USER, $DB;
72         require_once($CFG->dirroot . "/message/lib.php");
74         //check if messaging is enabled
75         if (!$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             }
143             //now we can send the message (at least try)
144             if ($success) {
145                 //TODO MDL-31118 performance improvement - edit the function so we can pass an array instead one touser object
146                 $success = message_post_message($USER, $tousers[$message['touserid']],
147                         $message['text'], external_validate_format($message['textformat']));
148             }
150             //build the resultmsg
151             if (isset($message['clientmsgid'])) {
152                 $resultmsg['clientmsgid'] = $message['clientmsgid'];
153             }
154             if ($success) {
155                 $resultmsg['msgid'] = $success;
156             } else {
157                 // WARNINGS: for backward compatibility we return this errormessage.
158                 //          We should have thrown exceptions as these errors prevent results to be returned.
159                 // See http://docs.moodle.org/dev/Errors_handling_in_web_services#When_to_send_a_warning_on_the_server_side .
160                 $resultmsg['msgid'] = -1;
161                 $resultmsg['errormessage'] = $errormessage;
162             }
164             $resultmessages[] = $resultmsg;
165         }
167         return $resultmessages;
168     }
170     /**
171      * Returns description of method result value
172      *
173      * @return external_description
174      * @since Moodle 2.2
175      */
176     public static function send_instant_messages_returns() {
177         return new external_multiple_structure(
178             new external_single_structure(
179                 array(
180                     'msgid' => new external_value(PARAM_INT, 'test this to know if it succeeds:  id of the created message if it succeeded, -1 when failed'),
181                     'clientmsgid' => new external_value(PARAM_ALPHANUMEXT, 'your own id for the message', VALUE_OPTIONAL),
182                     'errormessage' => new external_value(PARAM_TEXT, 'error message - if it failed', VALUE_OPTIONAL)
183                 )
184             )
185         );
186     }
188     /**
189      * Create contacts parameters description.
190      *
191      * @return external_function_parameters
192      * @since Moodle 2.5
193      */
194     public static function create_contacts_parameters() {
195         return new external_function_parameters(
196             array(
197                 'userids' => new external_multiple_structure(
198                     new external_value(PARAM_INT, 'User ID'),
199                     'List of user IDs'
200                 )
201             )
202         );
203     }
205     /**
206      * Create contacts.
207      *
208      * @param array $userids array of user IDs.
209      * @return external_description
210      * @since Moodle 2.5
211      */
212     public static function create_contacts($userids) {
213         $params = array('userids' => $userids);
214         $params = self::validate_parameters(self::create_contacts_parameters(), $params);
216         $warnings = array();
217         foreach ($params['userids'] as $id) {
218             if (!message_add_contact($id)) {
219                 $warnings[] = array(
220                     'item' => 'user',
221                     'itemid' => $id,
222                     'warningcode' => 'contactnotcreated',
223                     'message' => 'The contact could not be created'
224                 );
225             }
226         }
227         return $warnings;
228     }
230     /**
231      * Create contacts return description.
232      *
233      * @return external_description
234      * @since Moodle 2.5
235      */
236     public static function create_contacts_returns() {
237         return new external_warnings();
238     }
240     /**
241      * Delete contacts parameters description.
242      *
243      * @return external_function_parameters
244      * @since Moodle 2.5
245      */
246     public static function delete_contacts_parameters() {
247         return new external_function_parameters(
248             array(
249                 'userids' => new external_multiple_structure(
250                     new external_value(PARAM_INT, 'User ID'),
251                     'List of user IDs'
252                 )
253             )
254         );
255     }
257     /**
258      * Delete contacts.
259      *
260      * @param array $userids array of user IDs.
261      * @return null
262      * @since Moodle 2.5
263      */
264     public static function delete_contacts($userids) {
265         $params = array('userids' => $userids);
266         $params = self::validate_parameters(self::delete_contacts_parameters(), $params);
268         foreach ($params['userids'] as $id) {
269             message_remove_contact($id);
270         }
272         return null;
273     }
275     /**
276      * Delete contacts return description.
277      *
278      * @return external_description
279      * @since Moodle 2.5
280      */
281     public static function delete_contacts_returns() {
282         return null;
283     }
285     /**
286      * Block contacts parameters description.
287      *
288      * @return external_function_parameters
289      * @since Moodle 2.5
290      */
291     public static function block_contacts_parameters() {
292         return new external_function_parameters(
293             array(
294                 'userids' => new external_multiple_structure(
295                     new external_value(PARAM_INT, 'User ID'),
296                     'List of user IDs'
297                 )
298             )
299         );
300     }
302     /**
303      * Block contacts.
304      *
305      * @param array $userids array of user IDs.
306      * @return external_description
307      * @since Moodle 2.5
308      */
309     public static function block_contacts($userids) {
310         $params = array('userids' => $userids);
311         $params = self::validate_parameters(self::block_contacts_parameters(), $params);
313         $warnings = array();
314         foreach ($params['userids'] as $id) {
315             if (!message_block_contact($id)) {
316                 $warnings[] = array(
317                     'item' => 'user',
318                     'itemid' => $id,
319                     'warningcode' => 'contactnotblocked',
320                     'message' => 'The contact could not be blocked'
321                 );
322             }
323         }
324         return $warnings;
325     }
327     /**
328      * Block contacts return description.
329      *
330      * @return external_description
331      * @since Moodle 2.5
332      */
333     public static function block_contacts_returns() {
334         return new external_warnings();
335     }
337     /**
338      * Unblock contacts parameters description.
339      *
340      * @return external_function_parameters
341      * @since Moodle 2.5
342      */
343     public static function unblock_contacts_parameters() {
344         return new external_function_parameters(
345             array(
346                 'userids' => new external_multiple_structure(
347                     new external_value(PARAM_INT, 'User ID'),
348                     'List of user IDs'
349                 )
350             )
351         );
352     }
354     /**
355      * Unblock contacts.
356      *
357      * @param array $userids array of user IDs.
358      * @return null
359      * @since Moodle 2.5
360      */
361     public static function unblock_contacts($userids) {
362         $params = array('userids' => $userids);
363         $params = self::validate_parameters(self::unblock_contacts_parameters(), $params);
365         foreach ($params['userids'] as $id) {
366             message_unblock_contact($id);
367         }
369         return null;
370     }
372     /**
373      * Unblock contacts return description.
374      *
375      * @return external_description
376      * @since Moodle 2.5
377      */
378     public static function unblock_contacts_returns() {
379         return null;
380     }
382     /**
383      * Get contacts parameters description.
384      *
385      * @return external_function_parameters
386      * @since Moodle 2.5
387      */
388     public static function get_contacts_parameters() {
389         return new external_function_parameters(array());
390     }
392     /**
393      * Get contacts.
394      *
395      * @param array $userids array of user IDs.
396      * @return external_description
397      * @since Moodle 2.5
398      */
399     public static function get_contacts() {
400         global $CFG;
401         require_once($CFG->dirroot . '/user/lib.php');
403         list($online, $offline, $strangers) = message_get_contacts();
404         $allcontacts = array('online' => $online, 'offline' => $offline, 'strangers' => $strangers);
405         foreach ($allcontacts as $mode => $contacts) {
406             foreach ($contacts as $key => $contact) {
407                 $newcontact = array(
408                     'id' => $contact->id,
409                     'fullname' => fullname($contact),
410                     'unread' => $contact->messagecount
411                 );
413                 // Try to get the user picture, but sometimes this method can return null.
414                 $userdetails = user_get_user_details($contact, null, array('profileimageurl', 'profileimageurlsmall'));
415                 if (!empty($userdetails)) {
416                     $newcontact['profileimageurl'] = $userdetails['profileimageurl'];
417                     $newcontact['profileimageurlsmall'] = $userdetails['profileimageurlsmall'];
418                 }
420                 $allcontacts[$mode][$key] = $newcontact;
421             }
422         }
423         return $allcontacts;
424     }
426     /**
427      * Get contacts return description.
428      *
429      * @return external_description
430      * @since Moodle 2.5
431      */
432     public static function get_contacts_returns() {
433         return new external_single_structure(
434             array(
435                 'online' => new external_multiple_structure(
436                     new external_single_structure(
437                         array(
438                             'id' => new external_value(PARAM_INT, 'User ID'),
439                             'fullname' => new external_value(PARAM_NOTAGS, 'User full name'),
440                             'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL),
441                             'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL),
442                             'unread' => new external_value(PARAM_INT, 'Unread message count')
443                         )
444                     ),
445                     'List of online contacts'
446                 ),
447                 'offline' => new external_multiple_structure(
448                     new external_single_structure(
449                         array(
450                             'id' => new external_value(PARAM_INT, 'User ID'),
451                             'fullname' => new external_value(PARAM_NOTAGS, 'User full name'),
452                             'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL),
453                             'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL),
454                             'unread' => new external_value(PARAM_INT, 'Unread message count')
455                         )
456                     ),
457                     'List of offline contacts'
458                 ),
459                 'strangers' => new external_multiple_structure(
460                     new external_single_structure(
461                         array(
462                             'id' => new external_value(PARAM_INT, 'User ID'),
463                             'fullname' => new external_value(PARAM_NOTAGS, 'User full name'),
464                             'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL),
465                             'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL),
466                             'unread' => new external_value(PARAM_INT, 'Unread message count')
467                         )
468                     ),
469                     'List of users that are not in the user\'s contact list but have sent a message'
470                 )
471             )
472         );
473     }
475     /**
476      * Search contacts parameters description.
477      *
478      * @return external_function_parameters
479      * @since Moodle 2.5
480      */
481     public static function search_contacts_parameters() {
482         return new external_function_parameters(
483             array(
484                 'searchtext' => new external_value(PARAM_CLEAN, 'String the user\'s fullname has to match to be found'),
485                 'onlymycourses' => new external_value(PARAM_BOOL, 'Limit search to the user\'s courses',
486                     VALUE_DEFAULT, false)
487             )
488         );
489     }
491     /**
492      * Search contacts.
493      *
494      * @param string $searchtext query string.
495      * @param bool $onlymycourses limit the search to the user's courses only.
496      * @return external_description
497      * @since Moodle 2.5
498      */
499     public static function search_contacts($searchtext, $onlymycourses = false) {
500         global $CFG, $USER;
501         require_once($CFG->libdir . '/enrollib.php');
503         $params = array('searchtext' => $searchtext, 'onlymycourses' => $onlymycourses);
504         $params = self::validate_parameters(self::search_contacts_parameters(), $params);
506         // Extra validation, we do not allow empty queries.
507         if ($params['searchtext'] === '') {
508             throw new moodle_exception('querystringcannotbeempty');
509         }
511         $courseids = array();
512         if ($params['onlymycourses']) {
513             $mycourses = enrol_get_my_courses(array('id'));
514             foreach ($mycourses as $mycourse) {
515                 $courseids[] = $mycourse->id;
516             }
517         } else {
518             $courseids[] = SITEID;
519         }
521         // Retrieving the users matching the query.
522         $users = message_search_users($courseids, $params['searchtext']);
523         $results = array();
524         foreach ($users as $user) {
525             $results[$user->id] = $user;
526         }
528         // Reorganising information.
529         foreach ($results as &$user) {
530             $newuser = array(
531                 'id' => $user->id,
532                 'fullname' => fullname($user)
533             );
535             // Avoid undefined property notice as phone not specified.
536             $user->phone1 = null;
537             $user->phone2 = null;
539             // Try to get the user picture, but sometimes this method can return null.
540             $userdetails = user_get_user_details($user, null, array('profileimageurl', 'profileimageurlsmall'));
541             if (!empty($userdetails)) {
542                 $newuser['profileimageurl'] = $userdetails['profileimageurl'];
543                 $newuser['profileimageurlsmall'] = $userdetails['profileimageurlsmall'];
544             }
546             $user = $newuser;
547         }
549         return $results;
550     }
552     /**
553      * Search contacts return description.
554      *
555      * @return external_description
556      * @since Moodle 2.5
557      */
558     public static function search_contacts_returns() {
559         return new external_multiple_structure(
560             new external_single_structure(
561                 array(
562                     'id' => new external_value(PARAM_INT, 'User ID'),
563                     'fullname' => new external_value(PARAM_NOTAGS, 'User full name'),
564                     'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL),
565                     'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL)
566                 )
567             ),
568             'List of contacts'
569         );
570     }
572     /**
573      * Get messages parameters description.
574      *
575      * @return external_function_parameters
576      * @since 2.7
577      */
578     public static function get_messages_parameters() {
579         return new external_function_parameters(
580             array(
581                 'useridto' => new external_value(PARAM_INT, 'the user id who received the message, 0 for any user', VALUE_REQUIRED),
582                 'useridfrom' => new external_value(PARAM_INT,
583                             'the user id who send the message, 0 for any user. -10 or -20 for no-reply or support user',
584                             VALUE_DEFAULT, 0),
585                 'type' => new external_value(PARAM_ALPHA,
586                             'type of message to return, expected values are: notifications, conversations and both',
587                             VALUE_DEFAULT, 'both'),
588                 'read' => new external_value(PARAM_BOOL, 'true for getting read messages, false for unread', VALUE_DEFAULT, true),
589                 'newestfirst' => new external_value(PARAM_BOOL,
590                             'true for ordering by newest first, false for oldest first', VALUE_DEFAULT, true),
591                 'limitfrom' => new external_value(PARAM_INT, 'limit from', VALUE_DEFAULT, 0),
592                 'limitnum' => new external_value(PARAM_INT, 'limit number', VALUE_DEFAULT, 0)            )
593         );
594     }
596     /**
597      * Get messages function implementation.
598      * @param  int      $useridto       the user id who received the message
599      * @param  int      $useridfrom     the user id who send the message. -10 or -20 for no-reply or support user
600      * @param  string   $type           type of message tu return, expected values: notifications, conversations and both
601      * @param  bool     $read           true for retreiving read messages, false for unread
602      * @param  bool     $newestfirst    true for ordering by newest first, false for oldest first
603      * @param  int      $limitfrom      limit from
604      * @param  int      $limitnum       limit num
605      * @return external_description
606      * @since  2.7
607      */
608     public static function get_messages($useridto, $useridfrom = 0, $type = 'both' , $read = true,
609                                         $newestfirst = true, $limitfrom = 0, $limitnum = 0) {
610         global $CFG, $DB, $USER;
611         require_once($CFG->dirroot . "/message/lib.php");
613         $warnings = array();
615         $params = array(
616             'useridto' => $useridto,
617             'useridfrom' => $useridfrom,
618             'type' => $type,
619             'read' => $read,
620             'newestfirst' => $newestfirst,
621             'limitfrom' => $limitfrom,
622             'limitnum' => $limitnum
623         );
625         $params = self::validate_parameters(self::get_messages_parameters(), $params);
627         $context = context_system::instance();
628         self::validate_context($context);
630         $useridto = $params['useridto'];
631         $useridfrom = $params['useridfrom'];
632         $type = $params['type'];
633         $read = $params['read'];
634         $newestfirst = $params['newestfirst'];
635         $limitfrom = $params['limitfrom'];
636         $limitnum = $params['limitnum'];
638         $allowedvalues = array('notifications', 'conversations', 'both');
639         if (!in_array($type, $allowedvalues)) {
640             throw new invalid_parameter_exception('Invalid value for type parameter (value: ' . $type . '),' .
641                 'allowed values are: ' . implode(',', $allowedvalues));
642         }
644         // Check if private messaging between users is allowed.
645         if (empty($CFG->messaging)) {
646             // If we are retreiving only conversations, and messaging is disabled, throw an exception.
647             if ($type == "conversations") {
648                 throw new moodle_exception('disabled', 'message');
649             }
650             if ($type == "both") {
651                 $warning = array();
652                 $warning['item'] = 'message';
653                 $warning['itemid'] = $USER->id;
654                 $warning['warningcode'] = '1';
655                 $warning['message'] = 'Private messages (conversations) are not enabled in this site.
656                     Only notifications will be returned';
657                 $warnings[] = $warning;
658             }
659         }
661         if (!empty($useridto)) {
662             if (core_user::is_real_user($useridto)) {
663                 $userto = core_user::get_user($useridto, '*', MUST_EXIST);
664             } else {
665                 throw new moodle_exception('invaliduser');
666             }
667         }
669         if (!empty($useridfrom)) {
670             // We use get_user here because the from user can be the noreply or support user.
671             $userfrom = core_user::get_user($useridfrom, '*', MUST_EXIST);
672         }
674         // Check if the current user is the sender/receiver or just a privileged user.
675         if ($useridto != $USER->id and $useridfrom != $USER->id and
676              !has_capability('moodle/site:readallmessages', $context)) {
677             throw new moodle_exception('accessdenied', 'admin');
678         }
680         // Get messages.
681         $messagetable = $read ? '{message_read}' : '{message}';
682         $usersql = "";
683         $joinsql = "";
684         $params = array('deleted' => 0);
686         // Empty useridto means that we are going to retrieve messages send by the useridfrom to any user.
687         if (empty($useridto)) {
688             $userfields = get_all_user_name_fields(true, 'u', '', 'userto');
689             $joinsql = "JOIN {user} u ON u.id = mr.useridto";
690             $usersql = "mr.useridfrom = :useridfrom AND u.deleted = :deleted";
691             $params['useridfrom'] = $useridfrom;
692         } else {
693             $userfields = get_all_user_name_fields(true, 'u', '', 'userfrom');
694             // Left join because useridfrom may be -10 or -20 (no-reply and support users).
695             $joinsql = "LEFT JOIN {user} u ON u.id = mr.useridfrom";
696             $usersql = "mr.useridto = :useridto AND (u.deleted IS NULL OR u.deleted = :deleted)";
697             $params['useridto'] = $useridto;
698             if (!empty($useridfrom)) {
699                 $usersql .= " AND mr.useridfrom = :useridfrom";
700                 $params['useridfrom'] = $useridfrom;
701             }
702         }
704         // Now, if retrieve notifications, conversations or both.
705         $typesql = "";
706         if ($type != 'both') {
707             $typesql = "AND mr.notification = :notification";
708             $params['notification'] = ($type == 'notifications') ? 1 : 0;
709         }
711         // Finally the sort direction.
712         $orderdirection = $newestfirst ? 'DESC' : 'ASC';
714         $sql = "SELECT mr.*, $userfields
715                   FROM $messagetable mr
716                      $joinsql
717                  WHERE  $usersql
718                         $typesql
719                  ORDER BY mr.timecreated $orderdirection";
721         if ($messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum)) {
722             $canviewfullname = has_capability('moodle/site:viewfullnames', $context);
724             // In some cases, we don't need to get the to/from user objects from the sql query.
725             $userfromfullname = '';
726             $usertofullname = '';
728             // In this case, the useridto field is not empty, so we can get the user destinatary fullname from there.
729             if (!empty($useridto)) {
730                 $usertofullname = fullname($userto, $canviewfullname);
731                 // The user from may or may not be filled.
732                 if (!empty($useridfrom)) {
733                     $userfromfullname = fullname($userfrom, $canviewfullname);
734                 }
735             } else {
736                 // If the useridto field is empty, the useridfrom must be filled.
737                 $userfromfullname = fullname($userfrom, $canviewfullname);
738             }
740             foreach ($messages as $mid => $message) {
742                 // We need to get the user from the query.
743                 if (empty($userfromfullname)) {
744                     // Check for non-reply and support users.
745                     if (core_user::is_real_user($message->useridfrom)) {
746                         $user = new stdclass();
747                         $user = username_load_fields_from_object($user, $message, 'userfrom');
748                         $message->userfromfullname = fullname($user, $canviewfullname);
749                     } else {
750                         $user = core_user::get_user($message->useridfrom);
751                         $message->userfromfullname = fullname($user, $canviewfullname);
752                     }
753                 } else {
754                     $message->userfromfullname = $userfromfullname;
755                 }
757                 // We need to get the user from the query.
758                 if (empty($usertofullname)) {
759                     $user = new stdclass();
760                     $user = username_load_fields_from_object($user, $message, 'userto');
761                     $message->usertofullname = fullname($user, $canviewfullname);
762                 } else {
763                     $message->usertofullname = $usertofullname;
764                 }
766                 if (!isset($message->timeread)) {
767                     $message->timeread = 0;
768                 }
770                 $message->text = message_format_message_text($message);
772                 $messages[$mid] = (array) $message;
773             }
774         }
776         $results = array(
777             'messages' => $messages,
778             'warnings' => $warnings
779         );
781         return $results;
782     }
784     /**
785      * Get messages return description.
786      *
787      * @return external_single_structure
788      * @since 2.7
789      */
790     public static function get_messages_returns() {
791         return new external_single_structure(
792             array(
793                 'messages' => new external_multiple_structure(
794                     new external_single_structure(
795                         array(
796                             'id' => new external_value(PARAM_INT, 'mMssage id'),
797                             'useridfrom' => new external_value(PARAM_INT, 'User from id'),
798                             'useridto' => new external_value(PARAM_INT, 'User to id'),
799                             'subject' => new external_value(PARAM_TEXT, 'The message subject'),
800                             'text' => new external_value(PARAM_RAW, 'The message text formated'),
801                             'fullmessage' => new external_value(PARAM_RAW, 'The message'),
802                             'fullmessageformat' => new external_value(PARAM_INT, 'The message message format'),
803                             'fullmessagehtml' => new external_value(PARAM_RAW, 'The message in html'),
804                             'smallmessage' => new external_value(PARAM_RAW, 'The shorten message'),
805                             'notification' => new external_value(PARAM_INT, 'Is a notification?'),
806                             'contexturl' => new external_value(PARAM_RAW, 'Context URL'),
807                             'contexturlname' => new external_value(PARAM_TEXT, 'Context URL link name'),
808                             'timecreated' => new external_value(PARAM_INT, 'Time created'),
809                             'timeread' => new external_value(PARAM_INT, 'Time read'),
810                             'usertofullname' => new external_value(PARAM_TEXT, 'User to full name'),
811                             'userfromfullname' => new external_value(PARAM_TEXT, 'User from full name')
812                         ), 'message'
813                     )
814                 ),
815                 'warnings' => new external_warnings()
816             )
817         );
818     }
822 /**
823  * Deprecated message external functions
824  *
825  * @package    core_message
826  * @copyright  2011 Jerome Mouneyrac
827  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
828  * @since Moodle 2.1
829  * @deprecated Moodle 2.2 MDL-29106 - Please do not use this class any more.
830  * @see core_notes_external
831  */
832 class moodle_message_external extends external_api {
834     /**
835      * Returns description of method parameters
836      *
837      * @return external_function_parameters
838      * @since Moodle 2.1
839      * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
840      * @see core_message_external::send_instant_messages_parameters()
841      */
842     public static function send_instantmessages_parameters() {
843         return core_message_external::send_instant_messages_parameters();
844     }
846     /**
847      * Send private messages from the current USER to other users
848      *
849      * @param array $messages An array of message to send.
850      * @return array
851      * @since Moodle 2.1
852      * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
853      * @see core_message_external::send_instant_messages()
854      */
855     public static function send_instantmessages($messages = array()) {
856         return core_message_external::send_instant_messages($messages);
857     }
859     /**
860      * Returns description of method result value
861      *
862      * @return external_description
863      * @since Moodle 2.1
864      * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
865      * @see core_message_external::send_instant_messages_returns()
866      */
867     public static function send_instantmessages_returns() {
868         return core_message_external::send_instant_messages_returns();
869     }