Commit | Line | Data |
---|---|---|
a623b6b8 | 1 | <?php |
a623b6b8 JM |
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/>. | |
16 | ||
4615817d | 17 | |
a623b6b8 JM |
18 | /** |
19 | * External message API | |
20 | * | |
6fbd60ef | 21 | * @package core_message |
4615817d JM |
22 | * @category external |
23 | * @copyright 2011 Jerome Mouneyrac | |
a623b6b8 JM |
24 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
25 | */ | |
4615817d | 26 | |
a623b6b8 JM |
27 | require_once("$CFG->libdir/externallib.php"); |
28 | ||
5d1017e1 | 29 | /** |
4615817d | 30 | * Message external functions |
6fbd60ef AD |
31 | * |
32 | * @package core_message | |
4615817d JM |
33 | * @category external |
34 | * @copyright 2011 Jerome Mouneyrac | |
75e4f98c | 35 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
4615817d | 36 | * @since Moodle 2.2 |
5d1017e1 JM |
37 | */ |
38 | class core_message_external extends external_api { | |
a623b6b8 JM |
39 | |
40 | /** | |
41 | * Returns description of method parameters | |
4615817d | 42 | * |
a623b6b8 | 43 | * @return external_function_parameters |
4615817d | 44 | * @since Moodle 2.2 |
a623b6b8 | 45 | */ |
5d1017e1 | 46 | public static function send_instant_messages_parameters() { |
a623b6b8 JM |
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'), | |
93ce0e82 JM |
53 | 'text' => new external_value(PARAM_RAW, 'the text of the message'), |
54 | 'textformat' => new external_format_value('text', VALUE_DEFAULT), | |
a623b6b8 JM |
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 | } | |
62 | ||
63 | /** | |
64 | * Send private messages from the current USER to other users | |
65 | * | |
4615817d JM |
66 | * @param array $messages An array of message to send. |
67 | * @return array | |
68 | * @since Moodle 2.2 | |
a623b6b8 | 69 | */ |
5d1017e1 | 70 | public static function send_instant_messages($messages = array()) { |
a623b6b8 JM |
71 | global $CFG, $USER, $DB; |
72 | require_once($CFG->dirroot . "/message/lib.php"); | |
73 | ||
436bbf89 | 74 | // Check if messaging is enabled. |
a623b6b8 JM |
75 | if (!$CFG->messaging) { |
76 | throw new moodle_exception('disabled', 'message'); | |
77 | } | |
78 | ||
79 | // Ensure the current user is allowed to run this function | |
bf0f06b1 | 80 | $context = context_system::instance(); |
a623b6b8 JM |
81 | self::validate_context($context); |
82 | require_capability('moodle/site:sendmessage', $context); | |
83 | ||
5d1017e1 | 84 | $params = self::validate_parameters(self::send_instant_messages_parameters(), array('messages' => $messages)); |
a623b6b8 JM |
85 | |
86 | //retrieve all tousers of the messages | |
4de00da7 | 87 | $receivers = array(); |
a623b6b8 | 88 | foreach($params['messages'] as $message) { |
4de00da7 | 89 | $receivers[] = $message['touserid']; |
a623b6b8 | 90 | } |
4de00da7 | 91 | list($sqluserids, $sqlparams) = $DB->get_in_or_equal($receivers, SQL_PARAMS_NAMED, 'userid_'); |
a623b6b8 | 92 | $tousers = $DB->get_records_select("user", "id " . $sqluserids . " AND deleted = 0", $sqlparams); |
4de00da7 DC |
93 | $blocklist = array(); |
94 | $contactlist = array(); | |
a623b6b8 | 95 | $sqlparams['contactid'] = $USER->id; |
4de00da7 DC |
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(); | |
a623b6b8 JM |
110 | |
111 | $canreadallmessages = has_capability('moodle/site:readallmessages', $context); | |
112 | ||
113 | $resultmessages = array(); | |
114 | foreach ($params['messages'] as $message) { | |
a623b6b8 JM |
115 | $resultmsg = array(); //the infos about the success of the operation |
116 | ||
117 | //we are going to do some checking | |
118 | //code should match /messages/index.php checks | |
119 | $success = true; | |
120 | ||
121 | //check the user exists | |
122 | if (empty($tousers[$message['touserid']])) { | |
123 | $success = false; | |
124 | $errormessage = get_string('touserdoesntexist', 'message', $message['touserid']); | |
125 | } | |
126 | ||
127 | //check that the touser is not blocking the current user | |
4de00da7 | 128 | if ($success and !empty($blocklist[$message['touserid']]) and !$canreadallmessages) { |
a623b6b8 JM |
129 | $success = false; |
130 | $errormessage = get_string('userisblockingyou', 'message'); | |
131 | } | |
132 | ||
78736e5d | 133 | // Check if the user is a contact |
4615817d | 134 | //TODO MDL-31118 performance improvement - edit the function so we can pass an array instead userid |
4de00da7 DC |
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)) { | |
78736e5d SH |
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'); | |
a623b6b8 JM |
141 | } |
142 | ||
143 | //now we can send the message (at least try) | |
144 | if ($success) { | |
4615817d | 145 | //TODO MDL-31118 performance improvement - edit the function so we can pass an array instead one touser object |
93ce0e82 JM |
146 | $success = message_post_message($USER, $tousers[$message['touserid']], |
147 | $message['text'], external_validate_format($message['textformat'])); | |
a623b6b8 JM |
148 | } |
149 | ||
150 | //build the resultmsg | |
151 | if (isset($message['clientmsgid'])) { | |
78736e5d | 152 | $resultmsg['clientmsgid'] = $message['clientmsgid']; |
a623b6b8 JM |
153 | } |
154 | if ($success) { | |
155 | $resultmsg['msgid'] = $success; | |
156 | } else { | |
93ce0e82 JM |
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 . | |
a623b6b8 JM |
160 | $resultmsg['msgid'] = -1; |
161 | $resultmsg['errormessage'] = $errormessage; | |
162 | } | |
163 | ||
164 | $resultmessages[] = $resultmsg; | |
165 | } | |
166 | ||
167 | return $resultmessages; | |
168 | } | |
169 | ||
170 | /** | |
171 | * Returns description of method result value | |
4615817d | 172 | * |
a623b6b8 | 173 | * @return external_description |
4615817d | 174 | * @since Moodle 2.2 |
a623b6b8 | 175 | */ |
5d1017e1 | 176 | public static function send_instant_messages_returns() { |
a623b6b8 JM |
177 | return new external_multiple_structure( |
178 | new external_single_structure( | |
179 | array( | |
78736e5d | 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'), |
4de00da7 | 181 | 'clientmsgid' => new external_value(PARAM_ALPHANUMEXT, 'your own id for the message', VALUE_OPTIONAL), |
78736e5d | 182 | 'errormessage' => new external_value(PARAM_TEXT, 'error message - if it failed', VALUE_OPTIONAL) |
a623b6b8 JM |
183 | ) |
184 | ) | |
185 | ); | |
186 | } | |
187 | ||
d6731600 FM |
188 | /** |
189 | * Create contacts parameters description. | |
190 | * | |
191 | * @return external_function_parameters | |
5bcfd504 | 192 | * @since Moodle 2.5 |
d6731600 FM |
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 | } | |
204 | ||
205 | /** | |
206 | * Create contacts. | |
207 | * | |
208 | * @param array $userids array of user IDs. | |
209 | * @return external_description | |
5bcfd504 | 210 | * @since Moodle 2.5 |
d6731600 FM |
211 | */ |
212 | public static function create_contacts($userids) { | |
436bbf89 DM |
213 | global $CFG; |
214 | ||
215 | // Check if messaging is enabled. | |
216 | if (!$CFG->messaging) { | |
217 | throw new moodle_exception('disabled', 'message'); | |
218 | } | |
219 | ||
d6731600 FM |
220 | $params = array('userids' => $userids); |
221 | $params = self::validate_parameters(self::create_contacts_parameters(), $params); | |
222 | ||
223 | $warnings = array(); | |
224 | foreach ($params['userids'] as $id) { | |
225 | if (!message_add_contact($id)) { | |
226 | $warnings[] = array( | |
227 | 'item' => 'user', | |
228 | 'itemid' => $id, | |
229 | 'warningcode' => 'contactnotcreated', | |
230 | 'message' => 'The contact could not be created' | |
231 | ); | |
232 | } | |
233 | } | |
234 | return $warnings; | |
235 | } | |
236 | ||
237 | /** | |
238 | * Create contacts return description. | |
239 | * | |
240 | * @return external_description | |
5bcfd504 | 241 | * @since Moodle 2.5 |
d6731600 FM |
242 | */ |
243 | public static function create_contacts_returns() { | |
244 | return new external_warnings(); | |
245 | } | |
246 | ||
247 | /** | |
248 | * Delete contacts parameters description. | |
249 | * | |
250 | * @return external_function_parameters | |
5bcfd504 | 251 | * @since Moodle 2.5 |
d6731600 FM |
252 | */ |
253 | public static function delete_contacts_parameters() { | |
254 | return new external_function_parameters( | |
255 | array( | |
256 | 'userids' => new external_multiple_structure( | |
257 | new external_value(PARAM_INT, 'User ID'), | |
258 | 'List of user IDs' | |
259 | ) | |
260 | ) | |
261 | ); | |
262 | } | |
263 | ||
264 | /** | |
265 | * Delete contacts. | |
266 | * | |
267 | * @param array $userids array of user IDs. | |
268 | * @return null | |
5bcfd504 | 269 | * @since Moodle 2.5 |
d6731600 FM |
270 | */ |
271 | public static function delete_contacts($userids) { | |
436bbf89 DM |
272 | global $CFG; |
273 | ||
274 | // Check if messaging is enabled. | |
275 | if (!$CFG->messaging) { | |
276 | throw new moodle_exception('disabled', 'message'); | |
277 | } | |
278 | ||
d6731600 FM |
279 | $params = array('userids' => $userids); |
280 | $params = self::validate_parameters(self::delete_contacts_parameters(), $params); | |
281 | ||
282 | foreach ($params['userids'] as $id) { | |
283 | message_remove_contact($id); | |
284 | } | |
285 | ||
286 | return null; | |
287 | } | |
288 | ||
289 | /** | |
290 | * Delete contacts return description. | |
291 | * | |
292 | * @return external_description | |
5bcfd504 | 293 | * @since Moodle 2.5 |
d6731600 FM |
294 | */ |
295 | public static function delete_contacts_returns() { | |
296 | return null; | |
297 | } | |
298 | ||
299 | /** | |
300 | * Block contacts parameters description. | |
301 | * | |
302 | * @return external_function_parameters | |
5bcfd504 | 303 | * @since Moodle 2.5 |
d6731600 FM |
304 | */ |
305 | public static function block_contacts_parameters() { | |
306 | return new external_function_parameters( | |
307 | array( | |
308 | 'userids' => new external_multiple_structure( | |
309 | new external_value(PARAM_INT, 'User ID'), | |
310 | 'List of user IDs' | |
311 | ) | |
312 | ) | |
313 | ); | |
314 | } | |
315 | ||
316 | /** | |
317 | * Block contacts. | |
318 | * | |
319 | * @param array $userids array of user IDs. | |
320 | * @return external_description | |
5bcfd504 | 321 | * @since Moodle 2.5 |
d6731600 FM |
322 | */ |
323 | public static function block_contacts($userids) { | |
436bbf89 DM |
324 | global $CFG; |
325 | ||
326 | // Check if messaging is enabled. | |
327 | if (!$CFG->messaging) { | |
328 | throw new moodle_exception('disabled', 'message'); | |
329 | } | |
330 | ||
d6731600 FM |
331 | $params = array('userids' => $userids); |
332 | $params = self::validate_parameters(self::block_contacts_parameters(), $params); | |
333 | ||
334 | $warnings = array(); | |
335 | foreach ($params['userids'] as $id) { | |
336 | if (!message_block_contact($id)) { | |
337 | $warnings[] = array( | |
338 | 'item' => 'user', | |
339 | 'itemid' => $id, | |
340 | 'warningcode' => 'contactnotblocked', | |
341 | 'message' => 'The contact could not be blocked' | |
342 | ); | |
343 | } | |
344 | } | |
345 | return $warnings; | |
346 | } | |
347 | ||
348 | /** | |
349 | * Block contacts return description. | |
350 | * | |
351 | * @return external_description | |
5bcfd504 | 352 | * @since Moodle 2.5 |
d6731600 FM |
353 | */ |
354 | public static function block_contacts_returns() { | |
355 | return new external_warnings(); | |
356 | } | |
357 | ||
358 | /** | |
359 | * Unblock contacts parameters description. | |
360 | * | |
361 | * @return external_function_parameters | |
5bcfd504 | 362 | * @since Moodle 2.5 |
d6731600 FM |
363 | */ |
364 | public static function unblock_contacts_parameters() { | |
365 | return new external_function_parameters( | |
366 | array( | |
367 | 'userids' => new external_multiple_structure( | |
368 | new external_value(PARAM_INT, 'User ID'), | |
369 | 'List of user IDs' | |
370 | ) | |
371 | ) | |
372 | ); | |
373 | } | |
374 | ||
375 | /** | |
376 | * Unblock contacts. | |
377 | * | |
378 | * @param array $userids array of user IDs. | |
379 | * @return null | |
5bcfd504 | 380 | * @since Moodle 2.5 |
d6731600 FM |
381 | */ |
382 | public static function unblock_contacts($userids) { | |
436bbf89 DM |
383 | global $CFG; |
384 | ||
385 | // Check if messaging is enabled. | |
386 | if (!$CFG->messaging) { | |
387 | throw new moodle_exception('disabled', 'message'); | |
388 | } | |
389 | ||
d6731600 FM |
390 | $params = array('userids' => $userids); |
391 | $params = self::validate_parameters(self::unblock_contacts_parameters(), $params); | |
392 | ||
393 | foreach ($params['userids'] as $id) { | |
394 | message_unblock_contact($id); | |
395 | } | |
396 | ||
397 | return null; | |
398 | } | |
399 | ||
400 | /** | |
401 | * Unblock contacts return description. | |
402 | * | |
403 | * @return external_description | |
5bcfd504 | 404 | * @since Moodle 2.5 |
d6731600 FM |
405 | */ |
406 | public static function unblock_contacts_returns() { | |
407 | return null; | |
408 | } | |
409 | ||
410 | /** | |
411 | * Get contacts parameters description. | |
412 | * | |
413 | * @return external_function_parameters | |
5bcfd504 | 414 | * @since Moodle 2.5 |
d6731600 FM |
415 | */ |
416 | public static function get_contacts_parameters() { | |
417 | return new external_function_parameters(array()); | |
418 | } | |
419 | ||
420 | /** | |
421 | * Get contacts. | |
422 | * | |
423 | * @param array $userids array of user IDs. | |
424 | * @return external_description | |
5bcfd504 | 425 | * @since Moodle 2.5 |
d6731600 FM |
426 | */ |
427 | public static function get_contacts() { | |
d85bedf7 | 428 | global $CFG, $PAGE; |
436bbf89 DM |
429 | |
430 | // Check if messaging is enabled. | |
431 | if (!$CFG->messaging) { | |
432 | throw new moodle_exception('disabled', 'message'); | |
433 | } | |
434 | ||
d6731600 FM |
435 | require_once($CFG->dirroot . '/user/lib.php'); |
436 | ||
437 | list($online, $offline, $strangers) = message_get_contacts(); | |
438 | $allcontacts = array('online' => $online, 'offline' => $offline, 'strangers' => $strangers); | |
439 | foreach ($allcontacts as $mode => $contacts) { | |
440 | foreach ($contacts as $key => $contact) { | |
441 | $newcontact = array( | |
442 | 'id' => $contact->id, | |
443 | 'fullname' => fullname($contact), | |
444 | 'unread' => $contact->messagecount | |
445 | ); | |
446 | ||
d85bedf7 JL |
447 | $userpicture = new user_picture($contact); |
448 | $userpicture->size = 1; // Size f1. | |
449 | $newcontact['profileimageurl'] = $userpicture->get_url($PAGE)->out(false); | |
450 | $userpicture->size = 0; // Size f2. | |
451 | $newcontact['profileimageurlsmall'] = $userpicture->get_url($PAGE)->out(false); | |
d6731600 FM |
452 | |
453 | $allcontacts[$mode][$key] = $newcontact; | |
454 | } | |
455 | } | |
456 | return $allcontacts; | |
457 | } | |
458 | ||
459 | /** | |
460 | * Get contacts return description. | |
461 | * | |
462 | * @return external_description | |
5bcfd504 | 463 | * @since Moodle 2.5 |
d6731600 FM |
464 | */ |
465 | public static function get_contacts_returns() { | |
466 | return new external_single_structure( | |
467 | array( | |
468 | 'online' => new external_multiple_structure( | |
469 | new external_single_structure( | |
470 | array( | |
471 | 'id' => new external_value(PARAM_INT, 'User ID'), | |
472 | 'fullname' => new external_value(PARAM_NOTAGS, 'User full name'), | |
473 | 'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL), | |
474 | 'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL), | |
475 | 'unread' => new external_value(PARAM_INT, 'Unread message count') | |
476 | ) | |
477 | ), | |
478 | 'List of online contacts' | |
479 | ), | |
480 | 'offline' => new external_multiple_structure( | |
481 | new external_single_structure( | |
482 | array( | |
483 | 'id' => new external_value(PARAM_INT, 'User ID'), | |
484 | 'fullname' => new external_value(PARAM_NOTAGS, 'User full name'), | |
485 | 'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL), | |
486 | 'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL), | |
487 | 'unread' => new external_value(PARAM_INT, 'Unread message count') | |
488 | ) | |
489 | ), | |
490 | 'List of offline contacts' | |
491 | ), | |
492 | 'strangers' => new external_multiple_structure( | |
493 | new external_single_structure( | |
494 | array( | |
495 | 'id' => new external_value(PARAM_INT, 'User ID'), | |
496 | 'fullname' => new external_value(PARAM_NOTAGS, 'User full name'), | |
497 | 'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL), | |
498 | 'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL), | |
499 | 'unread' => new external_value(PARAM_INT, 'Unread message count') | |
500 | ) | |
501 | ), | |
502 | 'List of users that are not in the user\'s contact list but have sent a message' | |
503 | ) | |
504 | ) | |
505 | ); | |
506 | } | |
507 | ||
508 | /** | |
509 | * Search contacts parameters description. | |
510 | * | |
511 | * @return external_function_parameters | |
5bcfd504 | 512 | * @since Moodle 2.5 |
d6731600 FM |
513 | */ |
514 | public static function search_contacts_parameters() { | |
515 | return new external_function_parameters( | |
516 | array( | |
517 | 'searchtext' => new external_value(PARAM_CLEAN, 'String the user\'s fullname has to match to be found'), | |
518 | 'onlymycourses' => new external_value(PARAM_BOOL, 'Limit search to the user\'s courses', | |
519 | VALUE_DEFAULT, false) | |
520 | ) | |
521 | ); | |
522 | } | |
523 | ||
524 | /** | |
525 | * Search contacts. | |
526 | * | |
527 | * @param string $searchtext query string. | |
528 | * @param bool $onlymycourses limit the search to the user's courses only. | |
529 | * @return external_description | |
5bcfd504 | 530 | * @since Moodle 2.5 |
d6731600 FM |
531 | */ |
532 | public static function search_contacts($searchtext, $onlymycourses = false) { | |
d85bedf7 | 533 | global $CFG, $USER, $PAGE; |
11d83ab3 | 534 | require_once($CFG->dirroot . '/user/lib.php'); |
436bbf89 DM |
535 | |
536 | // Check if messaging is enabled. | |
537 | if (!$CFG->messaging) { | |
538 | throw new moodle_exception('disabled', 'message'); | |
539 | } | |
540 | ||
d6731600 FM |
541 | require_once($CFG->libdir . '/enrollib.php'); |
542 | ||
543 | $params = array('searchtext' => $searchtext, 'onlymycourses' => $onlymycourses); | |
544 | $params = self::validate_parameters(self::search_contacts_parameters(), $params); | |
545 | ||
546 | // Extra validation, we do not allow empty queries. | |
547 | if ($params['searchtext'] === '') { | |
548 | throw new moodle_exception('querystringcannotbeempty'); | |
549 | } | |
550 | ||
551 | $courseids = array(); | |
552 | if ($params['onlymycourses']) { | |
553 | $mycourses = enrol_get_my_courses(array('id')); | |
554 | foreach ($mycourses as $mycourse) { | |
555 | $courseids[] = $mycourse->id; | |
556 | } | |
557 | } else { | |
558 | $courseids[] = SITEID; | |
559 | } | |
560 | ||
561 | // Retrieving the users matching the query. | |
562 | $users = message_search_users($courseids, $params['searchtext']); | |
563 | $results = array(); | |
564 | foreach ($users as $user) { | |
565 | $results[$user->id] = $user; | |
566 | } | |
567 | ||
568 | // Reorganising information. | |
569 | foreach ($results as &$user) { | |
570 | $newuser = array( | |
571 | 'id' => $user->id, | |
572 | 'fullname' => fullname($user) | |
573 | ); | |
574 | ||
575 | // Avoid undefined property notice as phone not specified. | |
576 | $user->phone1 = null; | |
577 | $user->phone2 = null; | |
578 | ||
d85bedf7 JL |
579 | $userpicture = new user_picture($user); |
580 | $userpicture->size = 1; // Size f1. | |
581 | $newuser['profileimageurl'] = $userpicture->get_url($PAGE)->out(false); | |
582 | $userpicture->size = 0; // Size f2. | |
583 | $newuser['profileimageurlsmall'] = $userpicture->get_url($PAGE)->out(false); | |
d6731600 FM |
584 | |
585 | $user = $newuser; | |
586 | } | |
587 | ||
588 | return $results; | |
589 | } | |
590 | ||
591 | /** | |
592 | * Search contacts return description. | |
593 | * | |
594 | * @return external_description | |
5bcfd504 | 595 | * @since Moodle 2.5 |
d6731600 FM |
596 | */ |
597 | public static function search_contacts_returns() { | |
598 | return new external_multiple_structure( | |
599 | new external_single_structure( | |
600 | array( | |
601 | 'id' => new external_value(PARAM_INT, 'User ID'), | |
602 | 'fullname' => new external_value(PARAM_NOTAGS, 'User full name'), | |
603 | 'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL), | |
604 | 'profileimageurlsmall' => new external_value(PARAM_URL, 'Small user picture URL', VALUE_OPTIONAL) | |
605 | ) | |
606 | ), | |
607 | 'List of contacts' | |
608 | ); | |
609 | } | |
aff9da17 JL |
610 | |
611 | /** | |
612 | * Get messages parameters description. | |
613 | * | |
614 | * @return external_function_parameters | |
193edf7f | 615 | * @since 2.8 |
aff9da17 JL |
616 | */ |
617 | public static function get_messages_parameters() { | |
618 | return new external_function_parameters( | |
619 | array( | |
6ff4464b | 620 | 'useridto' => new external_value(PARAM_INT, 'the user id who received the message, 0 for any user', VALUE_REQUIRED), |
127ef540 SH |
621 | 'useridfrom' => new external_value( |
622 | PARAM_INT, 'the user id who send the message, 0 for any user. -10 or -20 for no-reply or support user', | |
623 | VALUE_DEFAULT, 0), | |
624 | 'type' => new external_value( | |
625 | PARAM_ALPHA, 'type of message to return, expected values are: notifications, conversations and both', | |
626 | VALUE_DEFAULT, 'both'), | |
6ff4464b | 627 | 'read' => new external_value(PARAM_BOOL, 'true for getting read messages, false for unread', VALUE_DEFAULT, true), |
127ef540 SH |
628 | 'newestfirst' => new external_value( |
629 | PARAM_BOOL, 'true for ordering by newest first, false for oldest first', | |
630 | VALUE_DEFAULT, true), | |
aff9da17 | 631 | 'limitfrom' => new external_value(PARAM_INT, 'limit from', VALUE_DEFAULT, 0), |
127ef540 SH |
632 | 'limitnum' => new external_value(PARAM_INT, 'limit number', VALUE_DEFAULT, 0) |
633 | ) | |
aff9da17 JL |
634 | ); |
635 | } | |
636 | ||
637 | /** | |
638 | * Get messages function implementation. | |
127ef540 SH |
639 | * |
640 | * @since 2.8 | |
641 | * @throws invalid_parameter_exception | |
642 | * @throws moodle_exception | |
6ff4464b JL |
643 | * @param int $useridto the user id who received the message |
644 | * @param int $useridfrom the user id who send the message. -10 or -20 for no-reply or support user | |
193edf7f | 645 | * @param string $type type of message to return, expected values: notifications, conversations and both |
aff9da17 | 646 | * @param bool $read true for retreiving read messages, false for unread |
6ff4464b | 647 | * @param bool $newestfirst true for ordering by newest first, false for oldest first |
aff9da17 JL |
648 | * @param int $limitfrom limit from |
649 | * @param int $limitnum limit num | |
650 | * @return external_description | |
aff9da17 | 651 | */ |
193edf7f | 652 | public static function get_messages($useridto, $useridfrom = 0, $type = 'both', $read = true, |
aff9da17 | 653 | $newestfirst = true, $limitfrom = 0, $limitnum = 0) { |
127ef540 | 654 | global $CFG, $USER; |
aff9da17 JL |
655 | require_once($CFG->dirroot . "/message/lib.php"); |
656 | ||
657 | $warnings = array(); | |
658 | ||
659 | $params = array( | |
660 | 'useridto' => $useridto, | |
6ff4464b | 661 | 'useridfrom' => $useridfrom, |
aff9da17 JL |
662 | 'type' => $type, |
663 | 'read' => $read, | |
aff9da17 JL |
664 | 'newestfirst' => $newestfirst, |
665 | 'limitfrom' => $limitfrom, | |
666 | 'limitnum' => $limitnum | |
667 | ); | |
668 | ||
669 | $params = self::validate_parameters(self::get_messages_parameters(), $params); | |
670 | ||
671 | $context = context_system::instance(); | |
672 | self::validate_context($context); | |
673 | ||
674 | $useridto = $params['useridto']; | |
6ff4464b | 675 | $useridfrom = $params['useridfrom']; |
aff9da17 JL |
676 | $type = $params['type']; |
677 | $read = $params['read']; | |
aff9da17 JL |
678 | $newestfirst = $params['newestfirst']; |
679 | $limitfrom = $params['limitfrom']; | |
680 | $limitnum = $params['limitnum']; | |
681 | ||
682 | $allowedvalues = array('notifications', 'conversations', 'both'); | |
683 | if (!in_array($type, $allowedvalues)) { | |
684 | throw new invalid_parameter_exception('Invalid value for type parameter (value: ' . $type . '),' . | |
685 | 'allowed values are: ' . implode(',', $allowedvalues)); | |
686 | } | |
687 | ||
688 | // Check if private messaging between users is allowed. | |
689 | if (empty($CFG->messaging)) { | |
690 | // If we are retreiving only conversations, and messaging is disabled, throw an exception. | |
aff9da17 JL |
691 | if ($type == "conversations") { |
692 | throw new moodle_exception('disabled', 'message'); | |
693 | } | |
694 | if ($type == "both") { | |
695 | $warning = array(); | |
696 | $warning['item'] = 'message'; | |
697 | $warning['itemid'] = $USER->id; | |
698 | $warning['warningcode'] = '1'; | |
699 | $warning['message'] = 'Private messages (conversations) are not enabled in this site. | |
700 | Only notifications will be returned'; | |
701 | $warnings[] = $warning; | |
702 | } | |
703 | } | |
704 | ||
705 | if (!empty($useridto)) { | |
6ff4464b JL |
706 | if (core_user::is_real_user($useridto)) { |
707 | $userto = core_user::get_user($useridto, '*', MUST_EXIST); | |
708 | } else { | |
709 | throw new moodle_exception('invaliduser'); | |
710 | } | |
aff9da17 JL |
711 | } |
712 | ||
713 | if (!empty($useridfrom)) { | |
714 | // We use get_user here because the from user can be the noreply or support user. | |
715 | $userfrom = core_user::get_user($useridfrom, '*', MUST_EXIST); | |
716 | } | |
717 | ||
718 | // Check if the current user is the sender/receiver or just a privileged user. | |
719 | if ($useridto != $USER->id and $useridfrom != $USER->id and | |
720 | !has_capability('moodle/site:readallmessages', $context)) { | |
721 | throw new moodle_exception('accessdenied', 'admin'); | |
722 | } | |
723 | ||
127ef540 | 724 | // Which type of messages to retrieve. |
193edf7f | 725 | $notifications = -1; |
aff9da17 | 726 | if ($type != 'both') { |
193edf7f | 727 | $notifications = ($type == 'notifications') ? 1 : 0; |
aff9da17 JL |
728 | } |
729 | ||
aff9da17 | 730 | $orderdirection = $newestfirst ? 'DESC' : 'ASC'; |
193edf7f | 731 | $sort = "mr.timecreated $orderdirection"; |
aff9da17 | 732 | |
193edf7f | 733 | if ($messages = message_get_messages($useridto, $useridfrom, $notifications, $read, $sort, $limitfrom, $limitnum)) { |
aff9da17 JL |
734 | $canviewfullname = has_capability('moodle/site:viewfullnames', $context); |
735 | ||
736 | // In some cases, we don't need to get the to/from user objects from the sql query. | |
737 | $userfromfullname = ''; | |
738 | $usertofullname = ''; | |
739 | ||
740 | // In this case, the useridto field is not empty, so we can get the user destinatary fullname from there. | |
741 | if (!empty($useridto)) { | |
742 | $usertofullname = fullname($userto, $canviewfullname); | |
743 | // The user from may or may not be filled. | |
744 | if (!empty($useridfrom)) { | |
745 | $userfromfullname = fullname($userfrom, $canviewfullname); | |
746 | } | |
747 | } else { | |
748 | // If the useridto field is empty, the useridfrom must be filled. | |
749 | $userfromfullname = fullname($userfrom, $canviewfullname); | |
750 | } | |
aff9da17 JL |
751 | foreach ($messages as $mid => $message) { |
752 | ||
753 | // We need to get the user from the query. | |
754 | if (empty($userfromfullname)) { | |
6ff4464b JL |
755 | // Check for non-reply and support users. |
756 | if (core_user::is_real_user($message->useridfrom)) { | |
127ef540 | 757 | $user = new stdClass(); |
6ff4464b JL |
758 | $user = username_load_fields_from_object($user, $message, 'userfrom'); |
759 | $message->userfromfullname = fullname($user, $canviewfullname); | |
760 | } else { | |
761 | $user = core_user::get_user($message->useridfrom); | |
762 | $message->userfromfullname = fullname($user, $canviewfullname); | |
763 | } | |
aff9da17 JL |
764 | } else { |
765 | $message->userfromfullname = $userfromfullname; | |
766 | } | |
767 | ||
768 | // We need to get the user from the query. | |
769 | if (empty($usertofullname)) { | |
127ef540 | 770 | $user = new stdClass(); |
aff9da17 JL |
771 | $user = username_load_fields_from_object($user, $message, 'userto'); |
772 | $message->usertofullname = fullname($user, $canviewfullname); | |
773 | } else { | |
774 | $message->usertofullname = $usertofullname; | |
775 | } | |
776 | ||
193edf7f | 777 | // This field is only available in the message_read table. |
aff9da17 JL |
778 | if (!isset($message->timeread)) { |
779 | $message->timeread = 0; | |
780 | } | |
781 | ||
aff9da17 | 782 | $message->text = message_format_message_text($message); |
aff9da17 JL |
783 | $messages[$mid] = (array) $message; |
784 | } | |
785 | } | |
786 | ||
787 | $results = array( | |
788 | 'messages' => $messages, | |
789 | 'warnings' => $warnings | |
790 | ); | |
791 | ||
792 | return $results; | |
793 | } | |
794 | ||
795 | /** | |
796 | * Get messages return description. | |
797 | * | |
6ff4464b | 798 | * @return external_single_structure |
193edf7f | 799 | * @since 2.8 |
aff9da17 JL |
800 | */ |
801 | public static function get_messages_returns() { | |
802 | return new external_single_structure( | |
803 | array( | |
804 | 'messages' => new external_multiple_structure( | |
805 | new external_single_structure( | |
806 | array( | |
193edf7f | 807 | 'id' => new external_value(PARAM_INT, 'Message id'), |
aff9da17 JL |
808 | 'useridfrom' => new external_value(PARAM_INT, 'User from id'), |
809 | 'useridto' => new external_value(PARAM_INT, 'User to id'), | |
810 | 'subject' => new external_value(PARAM_TEXT, 'The message subject'), | |
811 | 'text' => new external_value(PARAM_RAW, 'The message text formated'), | |
812 | 'fullmessage' => new external_value(PARAM_RAW, 'The message'), | |
193edf7f | 813 | 'fullmessageformat' => new external_format_value('fullmessage'), |
aff9da17 JL |
814 | 'fullmessagehtml' => new external_value(PARAM_RAW, 'The message in html'), |
815 | 'smallmessage' => new external_value(PARAM_RAW, 'The shorten message'), | |
816 | 'notification' => new external_value(PARAM_INT, 'Is a notification?'), | |
817 | 'contexturl' => new external_value(PARAM_RAW, 'Context URL'), | |
818 | 'contexturlname' => new external_value(PARAM_TEXT, 'Context URL link name'), | |
819 | 'timecreated' => new external_value(PARAM_INT, 'Time created'), | |
820 | 'timeread' => new external_value(PARAM_INT, 'Time read'), | |
821 | 'usertofullname' => new external_value(PARAM_TEXT, 'User to full name'), | |
822 | 'userfromfullname' => new external_value(PARAM_TEXT, 'User from full name') | |
823 | ), 'message' | |
824 | ) | |
825 | ), | |
826 | 'warnings' => new external_warnings() | |
827 | ) | |
828 | ); | |
829 | } | |
830 | ||
60ab2e1b JL |
831 | /** |
832 | * Get blocked users parameters description. | |
833 | * | |
834 | * @return external_function_parameters | |
835 | * @since 2.9 | |
836 | */ | |
837 | public static function get_blocked_users_parameters() { | |
838 | return new external_function_parameters( | |
839 | array( | |
840 | 'userid' => new external_value(PARAM_INT, | |
841 | 'the user whose blocked users we want to retrieve', | |
842 | VALUE_REQUIRED), | |
843 | ) | |
844 | ); | |
845 | } | |
846 | ||
847 | /** | |
848 | * Retrieve a list of users blocked | |
849 | * | |
850 | * @param int $userid the user whose blocked users we want to retrieve | |
851 | * @return external_description | |
852 | * @since 2.9 | |
853 | */ | |
854 | public static function get_blocked_users($userid) { | |
d85bedf7 | 855 | global $CFG, $USER, $PAGE; |
60ab2e1b JL |
856 | require_once($CFG->dirroot . "/message/lib.php"); |
857 | ||
858 | // Warnings array, it can be empty at the end but is mandatory. | |
859 | $warnings = array(); | |
860 | ||
861 | // Validate params. | |
862 | $params = array( | |
863 | 'userid' => $userid | |
864 | ); | |
865 | $params = self::validate_parameters(self::get_blocked_users_parameters(), $params); | |
866 | $userid = $params['userid']; | |
867 | ||
868 | // Validate context. | |
869 | $context = context_system::instance(); | |
870 | self::validate_context($context); | |
871 | ||
872 | // Check if private messaging between users is allowed. | |
873 | if (empty($CFG->messaging)) { | |
874 | throw new moodle_exception('disabled', 'message'); | |
875 | } | |
876 | ||
4485f7c5 JL |
877 | $user = core_user::get_user($userid, '*', MUST_EXIST); |
878 | core_user::require_active_user($user); | |
60ab2e1b JL |
879 | |
880 | // Check if we have permissions for retrieve the information. | |
881 | if ($userid != $USER->id and !has_capability('moodle/site:readallmessages', $context)) { | |
882 | throw new moodle_exception('accessdenied', 'admin'); | |
883 | } | |
884 | ||
885 | // Now, we can get safely all the blocked users. | |
886 | $users = message_get_blocked_users($user); | |
887 | ||
888 | $blockedusers = array(); | |
889 | foreach ($users as $user) { | |
890 | $newuser = array( | |
891 | 'id' => $user->id, | |
892 | 'fullname' => fullname($user), | |
893 | ); | |
0b074e88 | 894 | |
d85bedf7 JL |
895 | $userpicture = new user_picture($user); |
896 | $userpicture->size = 1; // Size f1. | |
897 | $newuser['profileimageurl'] = $userpicture->get_url($PAGE)->out(false); | |
60ab2e1b JL |
898 | |
899 | $blockedusers[] = $newuser; | |
900 | } | |
901 | ||
902 | $results = array( | |
903 | 'users' => $blockedusers, | |
904 | 'warnings' => $warnings | |
905 | ); | |
906 | return $results; | |
907 | } | |
908 | ||
909 | /** | |
910 | * Get blocked users return description. | |
911 | * | |
912 | * @return external_single_structure | |
913 | * @since 2.9 | |
914 | */ | |
915 | public static function get_blocked_users_returns() { | |
916 | return new external_single_structure( | |
917 | array( | |
918 | 'users' => new external_multiple_structure( | |
919 | new external_single_structure( | |
920 | array( | |
921 | 'id' => new external_value(PARAM_INT, 'User ID'), | |
922 | 'fullname' => new external_value(PARAM_NOTAGS, 'User full name'), | |
923 | 'profileimageurl' => new external_value(PARAM_URL, 'User picture URL', VALUE_OPTIONAL) | |
924 | ) | |
925 | ), | |
926 | 'List of blocked users' | |
927 | ), | |
928 | 'warnings' => new external_warnings() | |
929 | ) | |
930 | ); | |
931 | } | |
932 | ||
31c474da JL |
933 | /** |
934 | * Returns description of method parameters | |
935 | * | |
936 | * @return external_function_parameters | |
937 | * @since 2.9 | |
938 | */ | |
939 | public static function mark_message_read_parameters() { | |
940 | return new external_function_parameters( | |
941 | array( | |
942 | 'messageid' => new external_value(PARAM_INT, 'id of the message (in the message table)'), | |
943 | 'timeread' => new external_value(PARAM_INT, 'timestamp for when the message should be marked read') | |
944 | ) | |
945 | ); | |
946 | } | |
947 | ||
948 | /** | |
949 | * Mark a single message as read, trigger message_viewed event | |
950 | * | |
951 | * @param int $messageid id of the message (in the message table) | |
952 | * @param int $timeread timestamp for when the message should be marked read | |
953 | * @return external_description | |
954 | * @throws invalid_parameter_exception | |
955 | * @throws moodle_exception | |
956 | * @since 2.9 | |
957 | */ | |
958 | public static function mark_message_read($messageid, $timeread) { | |
959 | global $CFG, $DB, $USER; | |
960 | require_once($CFG->dirroot . "/message/lib.php"); | |
961 | ||
962 | // Check if private messaging between users is allowed. | |
963 | if (empty($CFG->messaging)) { | |
964 | throw new moodle_exception('disabled', 'message'); | |
965 | } | |
966 | ||
967 | // Warnings array, it can be empty at the end but is mandatory. | |
968 | $warnings = array(); | |
969 | ||
970 | // Validate params. | |
971 | $params = array( | |
972 | 'messageid' => $messageid, | |
973 | 'timeread' => $timeread | |
974 | ); | |
975 | $params = self::validate_parameters(self::mark_message_read_parameters(), $params); | |
976 | ||
977 | // Validate context. | |
978 | $context = context_system::instance(); | |
979 | self::validate_context($context); | |
980 | ||
981 | $message = $DB->get_record('message', array('id' => $params['messageid']), '*', MUST_EXIST); | |
982 | ||
983 | if ($message->useridto != $USER->id) { | |
984 | throw new invalid_parameter_exception('Invalid messageid, you don\'t have permissions to mark this message as read'); | |
985 | } | |
986 | ||
987 | $messageid = message_mark_message_read($message, $params['timeread']); | |
988 | ||
989 | $results = array( | |
990 | 'messageid' => $messageid, | |
991 | 'warnings' => $warnings | |
992 | ); | |
993 | return $results; | |
994 | } | |
995 | ||
996 | /** | |
997 | * Returns description of method result value | |
998 | * | |
999 | * @return external_description | |
1000 | * @since 2.9 | |
1001 | */ | |
1002 | public static function mark_message_read_returns() { | |
1003 | return new external_single_structure( | |
1004 | array( | |
1005 | 'messageid' => new external_value(PARAM_INT, 'the id of the message in the message_read table'), | |
1006 | 'warnings' => new external_warnings() | |
1007 | ) | |
1008 | ); | |
1009 | } | |
1010 | ||
a623b6b8 | 1011 | } |
5d1017e1 JM |
1012 | |
1013 | /** | |
4615817d | 1014 | * Deprecated message external functions |
6fbd60ef | 1015 | * |
4615817d JM |
1016 | * @package core_message |
1017 | * @copyright 2011 Jerome Mouneyrac | |
1018 | * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | |
1019 | * @since Moodle 2.1 | |
1020 | * @deprecated Moodle 2.2 MDL-29106 - Please do not use this class any more. | |
4615817d | 1021 | * @see core_notes_external |
5d1017e1 JM |
1022 | */ |
1023 | class moodle_message_external extends external_api { | |
1024 | ||
1025 | /** | |
1026 | * Returns description of method parameters | |
6fbd60ef | 1027 | * |
5d1017e1 | 1028 | * @return external_function_parameters |
4615817d JM |
1029 | * @since Moodle 2.1 |
1030 | * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more. | |
4615817d | 1031 | * @see core_message_external::send_instant_messages_parameters() |
5d1017e1 JM |
1032 | */ |
1033 | public static function send_instantmessages_parameters() { | |
1034 | return core_message_external::send_instant_messages_parameters(); | |
1035 | } | |
1036 | ||
1037 | /** | |
1038 | * Send private messages from the current USER to other users | |
6fbd60ef | 1039 | * |
4615817d JM |
1040 | * @param array $messages An array of message to send. |
1041 | * @return array | |
1042 | * @since Moodle 2.1 | |
1043 | * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more. | |
4615817d | 1044 | * @see core_message_external::send_instant_messages() |
5d1017e1 JM |
1045 | */ |
1046 | public static function send_instantmessages($messages = array()) { | |
1047 | return core_message_external::send_instant_messages($messages); | |
1048 | } | |
1049 | ||
1050 | /** | |
1051 | * Returns description of method result value | |
6fbd60ef | 1052 | * |
5d1017e1 | 1053 | * @return external_description |
4615817d JM |
1054 | * @since Moodle 2.1 |
1055 | * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more. | |
4615817d | 1056 | * @see core_message_external::send_instant_messages_returns() |
5d1017e1 JM |
1057 | */ |
1058 | public static function send_instantmessages_returns() { | |
1059 | return core_message_external::send_instant_messages_returns(); | |
1060 | } | |
1061 | ||
3c1aa6fd DM |
1062 | /** |
1063 | * Marking the method as deprecated. | |
1064 | * | |
1065 | * @return bool | |
1066 | */ | |
1067 | public static function send_instantmessages_is_deprecated() { | |
1068 | return true; | |
1069 | } | |
6fbd60ef | 1070 | } |