Merge branch 'MDL-62657-master' of git://github.com/junpataleta/moodle
[moodle.git] / user / 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/>.
17 /**
18  * External user API
19  *
20  * @package    core_user
21  * @category   external
22  * @copyright  2009 Petr Skodak
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 require_once("$CFG->libdir/externallib.php");
30 /**
31  * User external functions
32  *
33  * @package    core_user
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_user_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 create_users_parameters() {
48         global $CFG;
49         $userfields = [
50             'createpassword' => new external_value(PARAM_BOOL, 'True if password should be created and mailed to user.',
51                 VALUE_OPTIONAL),
52             // General.
53             'username' => new external_value(core_user::get_property_type('username'),
54                 'Username policy is defined in Moodle security config.'),
55             'auth' => new external_value(core_user::get_property_type('auth'), 'Auth plugins include manual, ldap, etc',
56                 VALUE_DEFAULT, 'manual', core_user::get_property_null('auth')),
57             'password' => new external_value(core_user::get_property_type('password'),
58                 'Plain text password consisting of any characters', VALUE_OPTIONAL),
59             'firstname' => new external_value(core_user::get_property_type('firstname'), 'The first name(s) of the user'),
60             'lastname' => new external_value(core_user::get_property_type('lastname'), 'The family name of the user'),
61             'email' => new external_value(core_user::get_property_type('email'), 'A valid and unique email address'),
62             'maildisplay' => new external_value(core_user::get_property_type('maildisplay'), 'Email display', VALUE_OPTIONAL),
63             'city' => new external_value(core_user::get_property_type('city'), 'Home city of the user', VALUE_OPTIONAL),
64             'country' => new external_value(core_user::get_property_type('country'),
65                 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
66             'timezone' => new external_value(core_user::get_property_type('timezone'),
67                 'Timezone code such as Australia/Perth, or 99 for default', VALUE_OPTIONAL),
68             'description' => new external_value(core_user::get_property_type('description'), 'User profile description, no HTML',
69                 VALUE_OPTIONAL),
70             // Additional names.
71             'firstnamephonetic' => new external_value(core_user::get_property_type('firstnamephonetic'),
72                 'The first name(s) phonetically of the user', VALUE_OPTIONAL),
73             'lastnamephonetic' => new external_value(core_user::get_property_type('lastnamephonetic'),
74                 'The family name phonetically of the user', VALUE_OPTIONAL),
75             'middlename' => new external_value(core_user::get_property_type('middlename'), 'The middle name of the user',
76                 VALUE_OPTIONAL),
77             'alternatename' => new external_value(core_user::get_property_type('alternatename'), 'The alternate name of the user',
78                 VALUE_OPTIONAL),
79             // Interests.
80             'interests' => new external_value(PARAM_TEXT, 'User interests (separated by commas)', VALUE_OPTIONAL),
81             // Optional.
82             'url' => new external_value(core_user::get_property_type('url'), 'User web page', VALUE_OPTIONAL),
83             'icq' => new external_value(core_user::get_property_type('icq'), 'ICQ number', VALUE_OPTIONAL),
84             'skype' => new external_value(core_user::get_property_type('skype'), 'Skype ID', VALUE_OPTIONAL),
85             'aim' => new external_value(core_user::get_property_type('aim'), 'AIM ID', VALUE_OPTIONAL),
86             'yahoo' => new external_value(core_user::get_property_type('yahoo'), 'Yahoo ID', VALUE_OPTIONAL),
87             'msn' => new external_value(core_user::get_property_type('msn'), 'MSN ID', VALUE_OPTIONAL),
88             'idnumber' => new external_value(core_user::get_property_type('idnumber'),
89                 'An arbitrary ID code number perhaps from the institution', VALUE_DEFAULT, ''),
90             'institution' => new external_value(core_user::get_property_type('institution'), 'institution', VALUE_OPTIONAL),
91             'department' => new external_value(core_user::get_property_type('department'), 'department', VALUE_OPTIONAL),
92             'phone1' => new external_value(core_user::get_property_type('phone1'), 'Phone 1', VALUE_OPTIONAL),
93             'phone2' => new external_value(core_user::get_property_type('phone2'), 'Phone 2', VALUE_OPTIONAL),
94             'address' => new external_value(core_user::get_property_type('address'), 'Postal address', VALUE_OPTIONAL),
95             // Other user preferences stored in the user table.
96             'lang' => new external_value(core_user::get_property_type('lang'), 'Language code such as "en", must exist on server',
97                 VALUE_DEFAULT, core_user::get_property_default('lang'), core_user::get_property_null('lang')),
98             'calendartype' => new external_value(core_user::get_property_type('calendartype'),
99                 'Calendar type such as "gregorian", must exist on server', VALUE_DEFAULT, $CFG->calendartype, VALUE_OPTIONAL),
100             'theme' => new external_value(core_user::get_property_type('theme'),
101                 'Theme name such as "standard", must exist on server', VALUE_OPTIONAL),
102             'mailformat' => new external_value(core_user::get_property_type('mailformat'),
103                 'Mail format code is 0 for plain text, 1 for HTML etc', VALUE_OPTIONAL),
104             // Custom user profile fields.
105             'customfields' => new external_multiple_structure(
106                 new external_single_structure(
107                     [
108                         'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the custom field'),
109                         'value' => new external_value(PARAM_RAW, 'The value of the custom field')
110                     ]
111                 ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
112             // User preferences.
113             'preferences' => new external_multiple_structure(
114             new external_single_structure(
115                 [
116                     'type'  => new external_value(PARAM_RAW, 'The name of the preference'),
117                     'value' => new external_value(PARAM_RAW, 'The value of the preference')
118                 ]
119             ), 'User preferences', VALUE_OPTIONAL),
120         ];
121         return new external_function_parameters(
122             [
123                 'users' => new external_multiple_structure(
124                     new external_single_structure($userfields)
125                 )
126             ]
127         );
128     }
130     /**
131      * Create one or more users.
132      *
133      * @throws invalid_parameter_exception
134      * @param array $users An array of users to create.
135      * @return array An array of arrays
136      * @since Moodle 2.2
137      */
138     public static function create_users($users) {
139         global $CFG, $DB;
140         require_once($CFG->dirroot."/lib/weblib.php");
141         require_once($CFG->dirroot."/user/lib.php");
142         require_once($CFG->dirroot."/user/editlib.php");
143         require_once($CFG->dirroot."/user/profile/lib.php"); // Required for customfields related function.
145         // Ensure the current user is allowed to run this function.
146         $context = context_system::instance();
147         self::validate_context($context);
148         require_capability('moodle/user:create', $context);
150         // Do basic automatic PARAM checks on incoming data, using params description.
151         // If any problems are found then exceptions are thrown with helpful error messages.
152         $params = self::validate_parameters(self::create_users_parameters(), array('users' => $users));
154         $availableauths  = core_component::get_plugin_list('auth');
155         unset($availableauths['mnet']);       // These would need mnethostid too.
156         unset($availableauths['webservice']); // We do not want new webservice users for now.
158         $availablethemes = core_component::get_plugin_list('theme');
159         $availablelangs  = get_string_manager()->get_list_of_translations();
161         $transaction = $DB->start_delegated_transaction();
163         $userids = array();
164         $createpassword = false;
165         foreach ($params['users'] as $user) {
166             // Make sure that the username, firstname and lastname are not blank.
167             foreach (array('username', 'firstname', 'lastname') as $fieldname) {
168                 if (trim($user[$fieldname]) === '') {
169                     throw new invalid_parameter_exception('The field '.$fieldname.' cannot be blank');
170                 }
171             }
173             // Make sure that the username doesn't already exist.
174             if ($DB->record_exists('user', array('username' => $user['username'], 'mnethostid' => $CFG->mnet_localhost_id))) {
175                 throw new invalid_parameter_exception('Username already exists: '.$user['username']);
176             }
178             // Make sure auth is valid.
179             if (empty($availableauths[$user['auth']])) {
180                 throw new invalid_parameter_exception('Invalid authentication type: '.$user['auth']);
181             }
183             // Make sure lang is valid.
184             if (empty($availablelangs[$user['lang']])) {
185                 throw new invalid_parameter_exception('Invalid language code: '.$user['lang']);
186             }
188             // Make sure lang is valid.
189             if (!empty($user['theme']) && empty($availablethemes[$user['theme']])) { // Theme is VALUE_OPTIONAL,
190                                                                                      // so no default value
191                                                                                      // We need to test if the client sent it
192                                                                                      // => !empty($user['theme']).
193                 throw new invalid_parameter_exception('Invalid theme: '.$user['theme']);
194             }
196             // Make sure we have a password or have to create one.
197             if (empty($user['password']) && empty($user['createpassword'])) {
198                 throw new invalid_parameter_exception('Invalid password: you must provide a password, or set createpassword.');
199             }
201             $user['confirmed'] = true;
202             $user['mnethostid'] = $CFG->mnet_localhost_id;
204             // Start of user info validation.
205             // Make sure we validate current user info as handled by current GUI. See user/editadvanced_form.php func validation().
206             if (!validate_email($user['email'])) {
207                 throw new invalid_parameter_exception('Email address is invalid: '.$user['email']);
208             } else if (empty($CFG->allowaccountssameemail) &&
209                     $DB->record_exists('user', array('email' => $user['email'], 'mnethostid' => $user['mnethostid']))) {
210                 throw new invalid_parameter_exception('Email address already exists: '.$user['email']);
211             }
212             // End of user info validation.
214             $createpassword = !empty($user['createpassword']);
215             unset($user['createpassword']);
216             if ($createpassword) {
217                 $user['password'] = '';
218                 $updatepassword = false;
219             } else {
220                 $updatepassword = true;
221             }
223             // Create the user data now!
224             $user['id'] = user_create_user($user, $updatepassword, false);
226             $userobject = (object)$user;
228             // Set user interests.
229             if (!empty($user['interests'])) {
230                 $trimmedinterests = array_map('trim', explode(',', $user['interests']));
231                 $interests = array_filter($trimmedinterests, function($value) {
232                     return !empty($value);
233                 });
234                 useredit_update_interests($userobject, $interests);
235             }
237             // Custom fields.
238             if (!empty($user['customfields'])) {
239                 foreach ($user['customfields'] as $customfield) {
240                     // Profile_save_data() saves profile file it's expecting a user with the correct id,
241                     // and custom field to be named profile_field_"shortname".
242                     $user["profile_field_".$customfield['type']] = $customfield['value'];
243                 }
244                 profile_save_data((object) $user);
245             }
247             if ($createpassword) {
248                 setnew_password_and_mail($userobject);
249                 unset_user_preference('create_password', $userobject);
250                 set_user_preference('auth_forcepasswordchange', 1, $userobject);
251             }
253             // Trigger event.
254             \core\event\user_created::create_from_userid($user['id'])->trigger();
256             // Preferences.
257             if (!empty($user['preferences'])) {
258                 $userpref = (object)$user;
259                 foreach ($user['preferences'] as $preference) {
260                     $userpref->{'preference_'.$preference['type']} = $preference['value'];
261                 }
262                 useredit_update_user_preference($userpref);
263             }
265             $userids[] = array('id' => $user['id'], 'username' => $user['username']);
266         }
268         $transaction->allow_commit();
270         return $userids;
271     }
273     /**
274      * Returns description of method result value
275      *
276      * @return external_description
277      * @since Moodle 2.2
278      */
279     public static function create_users_returns() {
280         return new external_multiple_structure(
281             new external_single_structure(
282                 array(
283                     'id'       => new external_value(core_user::get_property_type('id'), 'user id'),
284                     'username' => new external_value(core_user::get_property_type('username'), 'user name'),
285                 )
286             )
287         );
288     }
291     /**
292      * Returns description of method parameters
293      *
294      * @return external_function_parameters
295      * @since Moodle 2.2
296      */
297     public static function delete_users_parameters() {
298         return new external_function_parameters(
299             array(
300                 'userids' => new external_multiple_structure(new external_value(core_user::get_property_type('id'), 'user ID')),
301             )
302         );
303     }
305     /**
306      * Delete users
307      *
308      * @throws moodle_exception
309      * @param array $userids
310      * @return null
311      * @since Moodle 2.2
312      */
313     public static function delete_users($userids) {
314         global $CFG, $DB, $USER;
315         require_once($CFG->dirroot."/user/lib.php");
317         // Ensure the current user is allowed to run this function.
318         $context = context_system::instance();
319         require_capability('moodle/user:delete', $context);
320         self::validate_context($context);
322         $params = self::validate_parameters(self::delete_users_parameters(), array('userids' => $userids));
324         $transaction = $DB->start_delegated_transaction();
326         foreach ($params['userids'] as $userid) {
327             $user = $DB->get_record('user', array('id' => $userid, 'deleted' => 0), '*', MUST_EXIST);
328             // Must not allow deleting of admins or self!!!
329             if (is_siteadmin($user)) {
330                 throw new moodle_exception('useradminodelete', 'error');
331             }
332             if ($USER->id == $user->id) {
333                 throw new moodle_exception('usernotdeletederror', 'error');
334             }
335             user_delete_user($user);
336         }
338         $transaction->allow_commit();
340         return null;
341     }
343     /**
344      * Returns description of method result value
345      *
346      * @return null
347      * @since Moodle 2.2
348      */
349     public static function delete_users_returns() {
350         return null;
351     }
353     /**
354      * Returns description of method parameters.
355      *
356      * @return external_function_parameters
357      * @since Moodle 3.2
358      */
359     public static function update_user_preferences_parameters() {
360         return new external_function_parameters(
361             array(
362                 'userid' => new external_value(PARAM_INT, 'id of the user, default to current user', VALUE_DEFAULT, 0),
363                 'emailstop' => new external_value(core_user::get_property_type('emailstop'),
364                     'Enable or disable notifications for this user', VALUE_DEFAULT, null),
365                 'preferences' => new external_multiple_structure(
366                     new external_single_structure(
367                         array(
368                             'type'  => new external_value(PARAM_RAW, 'The name of the preference'),
369                             'value' => new external_value(PARAM_RAW, 'The value of the preference')
370                         )
371                     ), 'User preferences', VALUE_DEFAULT, array()
372                 )
373             )
374         );
375     }
377     /**
378      * Update the user's preferences.
379      *
380      * @param int $userid
381      * @param bool|null $emailstop
382      * @param array $preferences
383      * @return null
384      * @since Moodle 3.2
385      */
386     public static function update_user_preferences($userid, $emailstop = null, $preferences = array()) {
387         global $USER, $CFG;
389         require_once($CFG->dirroot . '/user/lib.php');
390         require_once($CFG->dirroot . '/user/editlib.php');
391         require_once($CFG->dirroot . '/message/lib.php');
393         if (empty($userid)) {
394             $userid = $USER->id;
395         }
397         $systemcontext = context_system::instance();
398         self::validate_context($systemcontext);
399         $params = array(
400             'userid' => $userid,
401             'emailstop' => $emailstop,
402             'preferences' => $preferences
403         );
404         self::validate_parameters(self::update_user_preferences_parameters(), $params);
406         // Preferences.
407         if (!empty($preferences)) {
408             $userpref = ['id' => $userid];
409             foreach ($preferences as $preference) {
410                 $userpref['preference_' . $preference['type']] = $preference['value'];
411             }
412             useredit_update_user_preference($userpref);
413         }
415         // Check if they want to update the email.
416         if ($emailstop !== null) {
417             $otheruser = ($userid == $USER->id) ? $USER : core_user::get_user($userid, '*', MUST_EXIST);
418             core_user::require_active_user($otheruser);
419             if (core_message_can_edit_message_profile($otheruser) && $otheruser->emailstop != $emailstop) {
420                 $user = new stdClass();
421                 $user->id = $userid;
422                 $user->emailstop = $emailstop;
423                 user_update_user($user);
425                 // Update the $USER if we should.
426                 if ($userid == $USER->id) {
427                     $USER->emailstop = $emailstop;
428                 }
429             }
430         }
432         return null;
433     }
435     /**
436      * Returns description of method result value
437      *
438      * @return null
439      * @since Moodle 3.2
440      */
441     public static function update_user_preferences_returns() {
442         return null;
443     }
445     /**
446      * Returns description of method parameters
447      *
448      * @return external_function_parameters
449      * @since Moodle 2.2
450      */
451     public static function update_users_parameters() {
452         $userfields = [
453             'id' => new external_value(core_user::get_property_type('id'), 'ID of the user'),
454             // General.
455             'username' => new external_value(core_user::get_property_type('username'),
456                 'Username policy is defined in Moodle security config.', VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
457             'auth' => new external_value(core_user::get_property_type('auth'), 'Auth plugins include manual, ldap, etc',
458                 VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
459             'suspended' => new external_value(core_user::get_property_type('suspended'),
460                 'Suspend user account, either false to enable user login or true to disable it', VALUE_OPTIONAL),
461             'password' => new external_value(core_user::get_property_type('password'),
462                 'Plain text password consisting of any characters', VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
463             'firstname' => new external_value(core_user::get_property_type('firstname'), 'The first name(s) of the user',
464                 VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
465             'lastname' => new external_value(core_user::get_property_type('lastname'), 'The family name of the user',
466                 VALUE_OPTIONAL),
467             'email' => new external_value(core_user::get_property_type('email'), 'A valid and unique email address', VALUE_OPTIONAL,
468                 '', NULL_NOT_ALLOWED),
469             'maildisplay' => new external_value(core_user::get_property_type('maildisplay'), 'Email display', VALUE_OPTIONAL),
470             'city' => new external_value(core_user::get_property_type('city'), 'Home city of the user', VALUE_OPTIONAL),
471             'country' => new external_value(core_user::get_property_type('country'),
472                 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
473             'timezone' => new external_value(core_user::get_property_type('timezone'),
474                 'Timezone code such as Australia/Perth, or 99 for default', VALUE_OPTIONAL),
475             'description' => new external_value(core_user::get_property_type('description'), 'User profile description, no HTML',
476                 VALUE_OPTIONAL),
477             // User picture.
478             'userpicture' => new external_value(PARAM_INT,
479                 'The itemid where the new user picture has been uploaded to, 0 to delete', VALUE_OPTIONAL),
480             // Additional names.
481             'firstnamephonetic' => new external_value(core_user::get_property_type('firstnamephonetic'),
482                 'The first name(s) phonetically of the user', VALUE_OPTIONAL),
483             'lastnamephonetic' => new external_value(core_user::get_property_type('lastnamephonetic'),
484                 'The family name phonetically of the user', VALUE_OPTIONAL),
485             'middlename' => new external_value(core_user::get_property_type('middlename'), 'The middle name of the user',
486                 VALUE_OPTIONAL),
487             'alternatename' => new external_value(core_user::get_property_type('alternatename'), 'The alternate name of the user',
488                 VALUE_OPTIONAL),
489             // Interests.
490             'interests' => new external_value(PARAM_TEXT, 'User interests (separated by commas)', VALUE_OPTIONAL),
491             // Optional.
492             'url' => new external_value(core_user::get_property_type('url'), 'User web page', VALUE_OPTIONAL),
493             'icq' => new external_value(core_user::get_property_type('icq'), 'ICQ number', VALUE_OPTIONAL),
494             'skype' => new external_value(core_user::get_property_type('skype'), 'Skype ID', VALUE_OPTIONAL),
495             'aim' => new external_value(core_user::get_property_type('aim'), 'AIM ID', VALUE_OPTIONAL),
496             'yahoo' => new external_value(core_user::get_property_type('yahoo'), 'Yahoo ID', VALUE_OPTIONAL),
497             'msn' => new external_value(core_user::get_property_type('msn'), 'MSN ID', VALUE_OPTIONAL),
498             'idnumber' => new external_value(core_user::get_property_type('idnumber'),
499                 'An arbitrary ID code number perhaps from the institution', VALUE_OPTIONAL),
500             'institution' => new external_value(core_user::get_property_type('institution'), 'Institution', VALUE_OPTIONAL),
501             'department' => new external_value(core_user::get_property_type('department'), 'Department', VALUE_OPTIONAL),
502             'phone1' => new external_value(core_user::get_property_type('phone1'), 'Phone', VALUE_OPTIONAL),
503             'phone2' => new external_value(core_user::get_property_type('phone2'), 'Mobile phone', VALUE_OPTIONAL),
504             'address' => new external_value(core_user::get_property_type('address'), 'Postal address', VALUE_OPTIONAL),
505             // Other user preferences stored in the user table.
506             'lang' => new external_value(core_user::get_property_type('lang'), 'Language code such as "en", must exist on server',
507                 VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
508             'calendartype' => new external_value(core_user::get_property_type('calendartype'),
509                 'Calendar type such as "gregorian", must exist on server', VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
510             'theme' => new external_value(core_user::get_property_type('theme'),
511                 'Theme name such as "standard", must exist on server', VALUE_OPTIONAL),
512             'mailformat' => new external_value(core_user::get_property_type('mailformat'),
513                 'Mail format code is 0 for plain text, 1 for HTML etc', VALUE_OPTIONAL),
514             // Custom user profile fields.
515             'customfields' => new external_multiple_structure(
516                 new external_single_structure(
517                     [
518                         'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the custom field'),
519                         'value' => new external_value(PARAM_RAW, 'The value of the custom field')
520                     ]
521                 ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
522             // User preferences.
523             'preferences' => new external_multiple_structure(
524                 new external_single_structure(
525                     [
526                         'type'  => new external_value(PARAM_RAW, 'The name of the preference'),
527                         'value' => new external_value(PARAM_RAW, 'The value of the preference')
528                     ]
529                 ), 'User preferences', VALUE_OPTIONAL),
530         ];
531         return new external_function_parameters(
532             [
533                 'users' => new external_multiple_structure(
534                     new external_single_structure($userfields)
535                 )
536             ]
537         );
538     }
540     /**
541      * Update users
542      *
543      * @param array $users
544      * @return null
545      * @since Moodle 2.2
546      */
547     public static function update_users($users) {
548         global $CFG, $DB, $USER;
549         require_once($CFG->dirroot."/user/lib.php");
550         require_once($CFG->dirroot."/user/profile/lib.php"); // Required for customfields related function.
551         require_once($CFG->dirroot.'/user/editlib.php');
553         // Ensure the current user is allowed to run this function.
554         $context = context_system::instance();
555         require_capability('moodle/user:update', $context);
556         self::validate_context($context);
558         $params = self::validate_parameters(self::update_users_parameters(), array('users' => $users));
560         $filemanageroptions = array('maxbytes' => $CFG->maxbytes,
561                 'subdirs'        => 0,
562                 'maxfiles'       => 1,
563                 'accepted_types' => 'web_image');
565         $transaction = $DB->start_delegated_transaction();
567         foreach ($params['users'] as $user) {
568             // First check the user exists.
569             if (!$existinguser = core_user::get_user($user['id'])) {
570                 continue;
571             }
572             // Check if we are trying to update an admin.
573             if ($existinguser->id != $USER->id and is_siteadmin($existinguser) and !is_siteadmin($USER)) {
574                 continue;
575             }
576             // Other checks (deleted, remote or guest users).
577             if ($existinguser->deleted or is_mnet_remote_user($existinguser) or isguestuser($existinguser->id)) {
578                 continue;
579             }
580             // Check duplicated emails.
581             if (isset($user['email']) && $user['email'] !== $existinguser->email) {
582                 if (!validate_email($user['email'])) {
583                     continue;
584                 } else if (empty($CFG->allowaccountssameemail) &&
585                         $DB->record_exists('user', array('email' => $user['email'], 'mnethostid' => $CFG->mnet_localhost_id))) {
586                     continue;
587                 }
588             }
590             user_update_user($user, true, false);
592             $userobject = (object)$user;
594             // Update user picture if it was specified for this user.
595             if (empty($CFG->disableuserimages) && isset($user['userpicture'])) {
596                 $userobject->deletepicture = null;
598                 if ($user['userpicture'] == 0) {
599                     $userobject->deletepicture = true;
600                 } else {
601                     $userobject->imagefile = $user['userpicture'];
602                 }
604                 core_user::update_picture($userobject, $filemanageroptions);
605             }
607             // Update user interests.
608             if (!empty($user['interests'])) {
609                 $trimmedinterests = array_map('trim', explode(',', $user['interests']));
610                 $interests = array_filter($trimmedinterests, function($value) {
611                     return !empty($value);
612                 });
613                 useredit_update_interests($userobject, $interests);
614             }
616             // Update user custom fields.
617             if (!empty($user['customfields'])) {
619                 foreach ($user['customfields'] as $customfield) {
620                     // Profile_save_data() saves profile file it's expecting a user with the correct id,
621                     // and custom field to be named profile_field_"shortname".
622                     $user["profile_field_".$customfield['type']] = $customfield['value'];
623                 }
624                 profile_save_data((object) $user);
625             }
627             // Trigger event.
628             \core\event\user_updated::create_from_userid($user['id'])->trigger();
630             // Preferences.
631             if (!empty($user['preferences'])) {
632                 $userpref = clone($existinguser);
633                 foreach ($user['preferences'] as $preference) {
634                     $userpref->{'preference_'.$preference['type']} = $preference['value'];
635                 }
636                 useredit_update_user_preference($userpref);
637             }
638             if (isset($user['suspended']) and $user['suspended']) {
639                 \core\session\manager::kill_user_sessions($user['id']);
640             }
641         }
643         $transaction->allow_commit();
645         return null;
646     }
648     /**
649      * Returns description of method result value
650      *
651      * @return null
652      * @since Moodle 2.2
653      */
654     public static function update_users_returns() {
655         return null;
656     }
658     /**
659      * Returns description of method parameters
660      *
661      * @return external_function_parameters
662      * @since Moodle 2.4
663      */
664     public static function get_users_by_field_parameters() {
665         return new external_function_parameters(
666             array(
667                 'field' => new external_value(PARAM_ALPHA, 'the search field can be
668                     \'id\' or \'idnumber\' or \'username\' or \'email\''),
669                 'values' => new external_multiple_structure(
670                         new external_value(PARAM_RAW, 'the value to match'))
671             )
672         );
673     }
675     /**
676      * Get user information for a unique field.
677      *
678      * @throws coding_exception
679      * @throws invalid_parameter_exception
680      * @param string $field
681      * @param array $values
682      * @return array An array of arrays containg user profiles.
683      * @since Moodle 2.4
684      */
685     public static function get_users_by_field($field, $values) {
686         global $CFG, $USER, $DB;
687         require_once($CFG->dirroot . "/user/lib.php");
689         $params = self::validate_parameters(self::get_users_by_field_parameters(),
690                 array('field' => $field, 'values' => $values));
692         // This array will keep all the users that are allowed to be searched,
693         // according to the current user's privileges.
694         $cleanedvalues = array();
696         switch ($field) {
697             case 'id':
698                 $paramtype = core_user::get_property_type('id');
699                 break;
700             case 'idnumber':
701                 $paramtype = core_user::get_property_type('idnumber');
702                 break;
703             case 'username':
704                 $paramtype = core_user::get_property_type('username');
705                 break;
706             case 'email':
707                 $paramtype = core_user::get_property_type('email');
708                 break;
709             default:
710                 throw new coding_exception('invalid field parameter',
711                         'The search field \'' . $field . '\' is not supported, look at the web service documentation');
712         }
714         // Clean the values.
715         foreach ($values as $value) {
716             $cleanedvalue = clean_param($value, $paramtype);
717             if ( $value != $cleanedvalue) {
718                 throw new invalid_parameter_exception('The field \'' . $field .
719                         '\' value is invalid: ' . $value . '(cleaned value: '.$cleanedvalue.')');
720             }
721             $cleanedvalues[] = $cleanedvalue;
722         }
724         // Retrieve the users.
725         $users = $DB->get_records_list('user', $field, $cleanedvalues, 'id');
727         $context = context_system::instance();
728         self::validate_context($context);
730         // Finally retrieve each users information.
731         $returnedusers = array();
732         foreach ($users as $user) {
733             $userdetails = user_get_user_details_courses($user);
735             // Return the user only if the searched field is returned.
736             // Otherwise it means that the $USER was not allowed to search the returned user.
737             if (!empty($userdetails) and !empty($userdetails[$field])) {
738                 $returnedusers[] = $userdetails;
739             }
740         }
742         return $returnedusers;
743     }
745     /**
746      * Returns description of method result value
747      *
748      * @return external_multiple_structure
749      * @since Moodle 2.4
750      */
751     public static function get_users_by_field_returns() {
752         return new external_multiple_structure(self::user_description());
753     }
756     /**
757      * Returns description of get_users() parameters.
758      *
759      * @return external_function_parameters
760      * @since Moodle 2.5
761      */
762     public static function get_users_parameters() {
763         return new external_function_parameters(
764             array(
765                 'criteria' => new external_multiple_structure(
766                     new external_single_structure(
767                         array(
768                             'key' => new external_value(PARAM_ALPHA, 'the user column to search, expected keys (value format) are:
769                                 "id" (int) matching user id,
770                                 "lastname" (string) user last name (Note: you can use % for searching but it may be considerably slower!),
771                                 "firstname" (string) user first name (Note: you can use % for searching but it may be considerably slower!),
772                                 "idnumber" (string) matching user idnumber,
773                                 "username" (string) matching user username,
774                                 "email" (string) user email (Note: you can use % for searching but it may be considerably slower!),
775                                 "auth" (string) matching user auth plugin'),
776                             'value' => new external_value(PARAM_RAW, 'the value to search')
777                         )
778                     ), 'the key/value pairs to be considered in user search. Values can not be empty.
779                         Specify different keys only once (fullname => \'user1\', auth => \'manual\', ...) -
780                         key occurences are forbidden.
781                         The search is executed with AND operator on the criterias. Invalid criterias (keys) are ignored,
782                         the search is still executed on the valid criterias.
783                         You can search without criteria, but the function is not designed for it.
784                         It could very slow or timeout. The function is designed to search some specific users.'
785                 )
786             )
787         );
788     }
790     /**
791      * Retrieve matching user.
792      *
793      * @throws moodle_exception
794      * @param array $criteria the allowed array keys are id/lastname/firstname/idnumber/username/email/auth.
795      * @return array An array of arrays containing user profiles.
796      * @since Moodle 2.5
797      */
798     public static function get_users($criteria = array()) {
799         global $CFG, $USER, $DB;
801         require_once($CFG->dirroot . "/user/lib.php");
803         $params = self::validate_parameters(self::get_users_parameters(),
804                 array('criteria' => $criteria));
806         // Validate the criteria and retrieve the users.
807         $users = array();
808         $warnings = array();
809         $sqlparams = array();
810         $usedkeys = array();
812         // Do not retrieve deleted users.
813         $sql = ' deleted = 0';
815         foreach ($params['criteria'] as $criteriaindex => $criteria) {
817             // Check that the criteria has never been used.
818             if (array_key_exists($criteria['key'], $usedkeys)) {
819                 throw new moodle_exception('keyalreadyset', '', '', null, 'The key ' . $criteria['key'] . ' can only be sent once');
820             } else {
821                 $usedkeys[$criteria['key']] = true;
822             }
824             $invalidcriteria = false;
825             // Clean the parameters.
826             $paramtype = PARAM_RAW;
827             switch ($criteria['key']) {
828                 case 'id':
829                     $paramtype = core_user::get_property_type('id');
830                     break;
831                 case 'idnumber':
832                     $paramtype = core_user::get_property_type('idnumber');
833                     break;
834                 case 'username':
835                     $paramtype = core_user::get_property_type('username');
836                     break;
837                 case 'email':
838                     // We use PARAM_RAW to allow searches with %.
839                     $paramtype = core_user::get_property_type('email');
840                     break;
841                 case 'auth':
842                     $paramtype = core_user::get_property_type('auth');
843                     break;
844                 case 'lastname':
845                 case 'firstname':
846                     $paramtype = core_user::get_property_type('firstname');
847                     break;
848                 default:
849                     // Send back a warning that this search key is not supported in this version.
850                     // This warning will make the function extandable without breaking clients.
851                     $warnings[] = array(
852                         'item' => $criteria['key'],
853                         'warningcode' => 'invalidfieldparameter',
854                         'message' =>
855                             'The search key \'' . $criteria['key'] . '\' is not supported, look at the web service documentation'
856                     );
857                     // Do not add this invalid criteria to the created SQL request.
858                     $invalidcriteria = true;
859                     unset($params['criteria'][$criteriaindex]);
860                     break;
861             }
863             if (!$invalidcriteria) {
864                 $cleanedvalue = clean_param($criteria['value'], $paramtype);
866                 $sql .= ' AND ';
868                 // Create the SQL.
869                 switch ($criteria['key']) {
870                     case 'id':
871                     case 'idnumber':
872                     case 'username':
873                     case 'auth':
874                         $sql .= $criteria['key'] . ' = :' . $criteria['key'];
875                         $sqlparams[$criteria['key']] = $cleanedvalue;
876                         break;
877                     case 'email':
878                     case 'lastname':
879                     case 'firstname':
880                         $sql .= $DB->sql_like($criteria['key'], ':' . $criteria['key'], false);
881                         $sqlparams[$criteria['key']] = $cleanedvalue;
882                         break;
883                     default:
884                         break;
885                 }
886             }
887         }
889         $users = $DB->get_records_select('user', $sql, $sqlparams, 'id ASC');
891         // Finally retrieve each users information.
892         $returnedusers = array();
893         foreach ($users as $user) {
894             $userdetails = user_get_user_details_courses($user);
896             // Return the user only if all the searched fields are returned.
897             // Otherwise it means that the $USER was not allowed to search the returned user.
898             if (!empty($userdetails)) {
899                 $validuser = true;
901                 foreach ($params['criteria'] as $criteria) {
902                     if (empty($userdetails[$criteria['key']])) {
903                         $validuser = false;
904                     }
905                 }
907                 if ($validuser) {
908                     $returnedusers[] = $userdetails;
909                 }
910             }
911         }
913         return array('users' => $returnedusers, 'warnings' => $warnings);
914     }
916     /**
917      * Returns description of get_users result value.
918      *
919      * @return external_description
920      * @since Moodle 2.5
921      */
922     public static function get_users_returns() {
923         return new external_single_structure(
924             array('users' => new external_multiple_structure(
925                                 self::user_description()
926                              ),
927                   'warnings' => new external_warnings('always set to \'key\'', 'faulty key name')
928             )
929         );
930     }
932     /**
933      * Returns description of method parameters
934      *
935      * @return external_function_parameters
936      * @since Moodle 2.2
937      */
938     public static function get_course_user_profiles_parameters() {
939         return new external_function_parameters(
940             array(
941                 'userlist' => new external_multiple_structure(
942                     new external_single_structure(
943                         array(
944                             'userid'    => new external_value(core_user::get_property_type('id'), 'userid'),
945                             'courseid'    => new external_value(PARAM_INT, 'courseid'),
946                         )
947                     )
948                 )
949             )
950         );
951     }
953     /**
954      * Get course participant's details
955      *
956      * @param array $userlist  array of user ids and according course ids
957      * @return array An array of arrays describing course participants
958      * @since Moodle 2.2
959      */
960     public static function get_course_user_profiles($userlist) {
961         global $CFG, $USER, $DB;
962         require_once($CFG->dirroot . "/user/lib.php");
963         $params = self::validate_parameters(self::get_course_user_profiles_parameters(), array('userlist' => $userlist));
965         $userids = array();
966         $courseids = array();
967         foreach ($params['userlist'] as $value) {
968             $userids[] = $value['userid'];
969             $courseids[$value['userid']] = $value['courseid'];
970         }
972         // Cache all courses.
973         $courses = array();
974         list($sqlcourseids, $params) = $DB->get_in_or_equal(array_unique($courseids), SQL_PARAMS_NAMED);
975         $cselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
976         $cjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
977         $params['contextlevel'] = CONTEXT_COURSE;
978         $coursesql = "SELECT c.* $cselect
979                         FROM {course} c $cjoin
980                        WHERE c.id $sqlcourseids";
981         $rs = $DB->get_recordset_sql($coursesql, $params);
982         foreach ($rs as $course) {
983             // Adding course contexts to cache.
984             context_helper::preload_from_record($course);
985             // Cache courses.
986             $courses[$course->id] = $course;
987         }
988         $rs->close();
990         list($sqluserids, $params) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED);
991         $uselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
992         $ujoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = u.id AND ctx.contextlevel = :contextlevel)";
993         $params['contextlevel'] = CONTEXT_USER;
994         $usersql = "SELECT u.* $uselect
995                       FROM {user} u $ujoin
996                      WHERE u.id $sqluserids";
997         $users = $DB->get_recordset_sql($usersql, $params);
998         $result = array();
999         foreach ($users as $user) {
1000             if (!empty($user->deleted)) {
1001                 continue;
1002             }
1003             context_helper::preload_from_record($user);
1004             $course = $courses[$courseids[$user->id]];
1005             $context = context_course::instance($courseids[$user->id], IGNORE_MISSING);
1006             self::validate_context($context);
1007             if ($userarray = user_get_user_details($user, $course)) {
1008                 $result[] = $userarray;
1009             }
1010         }
1012         $users->close();
1014         return $result;
1015     }
1017     /**
1018      * Returns description of method result value
1019      *
1020      * @return external_description
1021      * @since Moodle 2.2
1022      */
1023     public static function get_course_user_profiles_returns() {
1024         $additionalfields = array(
1025             'groups' => new external_multiple_structure(
1026                 new external_single_structure(
1027                     array(
1028                         'id'  => new external_value(PARAM_INT, 'group id'),
1029                         'name' => new external_value(PARAM_RAW, 'group name'),
1030                         'description' => new external_value(PARAM_RAW, 'group description'),
1031                         'descriptionformat' => new external_format_value('description'),
1032                     )
1033                 ), 'user groups', VALUE_OPTIONAL),
1034             'roles' => new external_multiple_structure(
1035                 new external_single_structure(
1036                     array(
1037                         'roleid'       => new external_value(PARAM_INT, 'role id'),
1038                         'name'         => new external_value(PARAM_RAW, 'role name'),
1039                         'shortname'    => new external_value(PARAM_ALPHANUMEXT, 'role shortname'),
1040                         'sortorder'    => new external_value(PARAM_INT, 'role sortorder')
1041                     )
1042                 ), 'user roles', VALUE_OPTIONAL),
1043             'enrolledcourses' => new external_multiple_structure(
1044                 new external_single_structure(
1045                     array(
1046                         'id'  => new external_value(PARAM_INT, 'Id of the course'),
1047                         'fullname'  => new external_value(PARAM_RAW, 'Fullname of the course'),
1048                         'shortname' => new external_value(PARAM_RAW, 'Shortname of the course')
1049                     )
1050                 ), 'Courses where the user is enrolled - limited by which courses the user is able to see', VALUE_OPTIONAL)
1051         );
1053         return new external_multiple_structure(self::user_description($additionalfields));
1054     }
1056     /**
1057      * Create user return value description.
1058      *
1059      * @param array $additionalfields some additional field
1060      * @return single_structure_description
1061      */
1062     public static function user_description($additionalfields = array()) {
1063         $userfields = array(
1064             'id'    => new external_value(core_user::get_property_type('id'), 'ID of the user'),
1065             'username'    => new external_value(core_user::get_property_type('username'), 'The username', VALUE_OPTIONAL),
1066             'firstname'   => new external_value(core_user::get_property_type('firstname'), 'The first name(s) of the user', VALUE_OPTIONAL),
1067             'lastname'    => new external_value(core_user::get_property_type('lastname'), 'The family name of the user', VALUE_OPTIONAL),
1068             'fullname'    => new external_value(core_user::get_property_type('firstname'), 'The fullname of the user'),
1069             'email'       => new external_value(core_user::get_property_type('email'), 'An email address - allow email as root@localhost', VALUE_OPTIONAL),
1070             'address'     => new external_value(core_user::get_property_type('address'), 'Postal address', VALUE_OPTIONAL),
1071             'phone1'      => new external_value(core_user::get_property_type('phone1'), 'Phone 1', VALUE_OPTIONAL),
1072             'phone2'      => new external_value(core_user::get_property_type('phone2'), 'Phone 2', VALUE_OPTIONAL),
1073             'icq'         => new external_value(core_user::get_property_type('icq'), 'icq number', VALUE_OPTIONAL),
1074             'skype'       => new external_value(core_user::get_property_type('skype'), 'skype id', VALUE_OPTIONAL),
1075             'yahoo'       => new external_value(core_user::get_property_type('yahoo'), 'yahoo id', VALUE_OPTIONAL),
1076             'aim'         => new external_value(core_user::get_property_type('aim'), 'aim id', VALUE_OPTIONAL),
1077             'msn'         => new external_value(core_user::get_property_type('msn'), 'msn number', VALUE_OPTIONAL),
1078             'department'  => new external_value(core_user::get_property_type('department'), 'department', VALUE_OPTIONAL),
1079             'institution' => new external_value(core_user::get_property_type('institution'), 'institution', VALUE_OPTIONAL),
1080             'idnumber'    => new external_value(core_user::get_property_type('idnumber'), 'An arbitrary ID code number perhaps from the institution', VALUE_OPTIONAL),
1081             'interests'   => new external_value(PARAM_TEXT, 'user interests (separated by commas)', VALUE_OPTIONAL),
1082             'firstaccess' => new external_value(core_user::get_property_type('firstaccess'), 'first access to the site (0 if never)', VALUE_OPTIONAL),
1083             'lastaccess'  => new external_value(core_user::get_property_type('lastaccess'), 'last access to the site (0 if never)', VALUE_OPTIONAL),
1084             'auth'        => new external_value(core_user::get_property_type('auth'), 'Auth plugins include manual, ldap, etc', VALUE_OPTIONAL),
1085             'suspended'   => new external_value(core_user::get_property_type('suspended'), 'Suspend user account, either false to enable user login or true to disable it', VALUE_OPTIONAL),
1086             'confirmed'   => new external_value(core_user::get_property_type('confirmed'), 'Active user: 1 if confirmed, 0 otherwise', VALUE_OPTIONAL),
1087             'lang'        => new external_value(core_user::get_property_type('lang'), 'Language code such as "en", must exist on server', VALUE_OPTIONAL),
1088             'calendartype' => new external_value(core_user::get_property_type('calendartype'), 'Calendar type such as "gregorian", must exist on server', VALUE_OPTIONAL),
1089             'theme'       => new external_value(core_user::get_property_type('theme'), 'Theme name such as "standard", must exist on server', VALUE_OPTIONAL),
1090             'timezone'    => new external_value(core_user::get_property_type('timezone'), 'Timezone code such as Australia/Perth, or 99 for default', VALUE_OPTIONAL),
1091             'mailformat'  => new external_value(core_user::get_property_type('mailformat'), 'Mail format code is 0 for plain text, 1 for HTML etc', VALUE_OPTIONAL),
1092             'description' => new external_value(core_user::get_property_type('description'), 'User profile description', VALUE_OPTIONAL),
1093             'descriptionformat' => new external_format_value(core_user::get_property_type('descriptionformat'), VALUE_OPTIONAL),
1094             'city'        => new external_value(core_user::get_property_type('city'), 'Home city of the user', VALUE_OPTIONAL),
1095             'url'         => new external_value(core_user::get_property_type('url'), 'URL of the user', VALUE_OPTIONAL),
1096             'country'     => new external_value(core_user::get_property_type('country'), 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
1097             'profileimageurlsmall' => new external_value(PARAM_URL, 'User image profile URL - small version'),
1098             'profileimageurl' => new external_value(PARAM_URL, 'User image profile URL - big version'),
1099             'customfields' => new external_multiple_structure(
1100                 new external_single_structure(
1101                     array(
1102                         'type'  => new external_value(PARAM_ALPHANUMEXT, 'The type of the custom field - text field, checkbox...'),
1103                         'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
1104                         'name' => new external_value(PARAM_RAW, 'The name of the custom field'),
1105                         'shortname' => new external_value(PARAM_RAW, 'The shortname of the custom field - to be able to build the field class in the code'),
1106                     )
1107                 ), 'User custom fields (also known as user profile fields)', VALUE_OPTIONAL),
1108             'preferences' => new external_multiple_structure(
1109                 new external_single_structure(
1110                     array(
1111                         'name'  => new external_value(PARAM_RAW, 'The name of the preferences'),
1112                         'value' => new external_value(PARAM_RAW, 'The value of the preference'),
1113                     )
1114             ), 'Users preferences', VALUE_OPTIONAL)
1115         );
1116         if (!empty($additionalfields)) {
1117             $userfields = array_merge($userfields, $additionalfields);
1118         }
1119         return new external_single_structure($userfields);
1120     }
1122     /**
1123      * Returns description of method parameters
1124      *
1125      * @return external_function_parameters
1126      * @since Moodle 2.6
1127      */
1128     public static function add_user_private_files_parameters() {
1129         return new external_function_parameters(
1130             array(
1131                 'draftid' => new external_value(PARAM_INT, 'draft area id')
1132             )
1133         );
1134     }
1136     /**
1137      * Copy files from a draft area to users private files area.
1138      *
1139      * @throws invalid_parameter_exception
1140      * @param int $draftid Id of a draft area containing files.
1141      * @return array An array of warnings
1142      * @since Moodle 2.6
1143      */
1144     public static function add_user_private_files($draftid) {
1145         global $CFG, $USER;
1146         require_once($CFG->libdir . "/filelib.php");
1148         $params = self::validate_parameters(self::add_user_private_files_parameters(), array('draftid' => $draftid));
1150         if (isguestuser()) {
1151             throw new invalid_parameter_exception('Guest users cannot upload files');
1152         }
1154         $context = context_user::instance($USER->id);
1155         require_capability('moodle/user:manageownfiles', $context);
1157         $maxbytes = $CFG->userquota;
1158         $maxareabytes = $CFG->userquota;
1159         if (has_capability('moodle/user:ignoreuserquota', $context)) {
1160             $maxbytes = USER_CAN_IGNORE_FILE_SIZE_LIMITS;
1161             $maxareabytes = FILE_AREA_MAX_BYTES_UNLIMITED;
1162         }
1164         $options = array('subdirs' => 1,
1165                          'maxbytes' => $maxbytes,
1166                          'maxfiles' => -1,
1167                          'areamaxbytes' => $maxareabytes);
1169         file_merge_files_from_draft_area_into_filearea($draftid, $context->id, 'user', 'private', 0, $options);
1171         return null;
1172     }
1174     /**
1175      * Returns description of method result value
1176      *
1177      * @return external_description
1178      * @since Moodle 2.2
1179      */
1180     public static function add_user_private_files_returns() {
1181         return null;
1182     }
1184     /**
1185      * Returns description of method parameters.
1186      *
1187      * @return external_function_parameters
1188      * @since Moodle 2.6
1189      */
1190     public static function add_user_device_parameters() {
1191         return new external_function_parameters(
1192             array(
1193                 'appid'     => new external_value(PARAM_NOTAGS, 'the app id, usually something like com.moodle.moodlemobile'),
1194                 'name'      => new external_value(PARAM_NOTAGS, 'the device name, \'occam\' or \'iPhone\' etc.'),
1195                 'model'     => new external_value(PARAM_NOTAGS, 'the device model \'Nexus4\' or \'iPad1,1\' etc.'),
1196                 'platform'  => new external_value(PARAM_NOTAGS, 'the device platform \'iOS\' or \'Android\' etc.'),
1197                 'version'   => new external_value(PARAM_NOTAGS, 'the device version \'6.1.2\' or \'4.2.2\' etc.'),
1198                 'pushid'    => new external_value(PARAM_RAW, 'the device PUSH token/key/identifier/registration id'),
1199                 'uuid'      => new external_value(PARAM_RAW, 'the device UUID')
1200             )
1201         );
1202     }
1204     /**
1205      * Add a user device in Moodle database (for PUSH notifications usually).
1206      *
1207      * @throws moodle_exception
1208      * @param string $appid The app id, usually something like com.moodle.moodlemobile.
1209      * @param string $name The device name, occam or iPhone etc.
1210      * @param string $model The device model Nexus4 or iPad1.1 etc.
1211      * @param string $platform The device platform iOs or Android etc.
1212      * @param string $version The device version 6.1.2 or 4.2.2 etc.
1213      * @param string $pushid The device PUSH token/key/identifier/registration id.
1214      * @param string $uuid The device UUID.
1215      * @return array List of possible warnings.
1216      * @since Moodle 2.6
1217      */
1218     public static function add_user_device($appid, $name, $model, $platform, $version, $pushid, $uuid) {
1219         global $CFG, $USER, $DB;
1220         require_once($CFG->dirroot . "/user/lib.php");
1222         $params = self::validate_parameters(self::add_user_device_parameters(),
1223                 array('appid' => $appid,
1224                       'name' => $name,
1225                       'model' => $model,
1226                       'platform' => $platform,
1227                       'version' => $version,
1228                       'pushid' => $pushid,
1229                       'uuid' => $uuid
1230                       ));
1232         $warnings = array();
1234         // Prevent duplicate keys for users.
1235         if ($DB->get_record('user_devices', array('pushid' => $params['pushid'], 'userid' => $USER->id))) {
1236             $warnings['warning'][] = array(
1237                 'item' => $params['pushid'],
1238                 'warningcode' => 'existingkeyforthisuser',
1239                 'message' => 'This key is already stored for this user'
1240             );
1241             return $warnings;
1242         }
1244         // Notice that we can have multiple devices because previously it was allowed to have repeated ones.
1245         // Since we don't have a clear way to decide which one is the more appropiate, we update all.
1246         if ($userdevices = $DB->get_records('user_devices', array('uuid' => $params['uuid'],
1247                 'appid' => $params['appid'], 'userid' => $USER->id))) {
1249             foreach ($userdevices as $userdevice) {
1250                 $userdevice->version    = $params['version'];   // Maybe the user upgraded the device.
1251                 $userdevice->pushid     = $params['pushid'];
1252                 $userdevice->timemodified  = time();
1253                 $DB->update_record('user_devices', $userdevice);
1254             }
1256         } else {
1257             $userdevice = new stdclass;
1258             $userdevice->userid     = $USER->id;
1259             $userdevice->appid      = $params['appid'];
1260             $userdevice->name       = $params['name'];
1261             $userdevice->model      = $params['model'];
1262             $userdevice->platform   = $params['platform'];
1263             $userdevice->version    = $params['version'];
1264             $userdevice->pushid     = $params['pushid'];
1265             $userdevice->uuid       = $params['uuid'];
1266             $userdevice->timecreated  = time();
1267             $userdevice->timemodified = $userdevice->timecreated;
1269             if (!$DB->insert_record('user_devices', $userdevice)) {
1270                 throw new moodle_exception("There was a problem saving in the database the device with key: " . $params['pushid']);
1271             }
1272         }
1274         return $warnings;
1275     }
1277     /**
1278      * Returns description of method result value.
1279      *
1280      * @return external_multiple_structure
1281      * @since Moodle 2.6
1282      */
1283     public static function add_user_device_returns() {
1284         return new external_multiple_structure(
1285            new external_warnings()
1286         );
1287     }
1289     /**
1290      * Returns description of method parameters.
1291      *
1292      * @return external_function_parameters
1293      * @since Moodle 2.9
1294      */
1295     public static function remove_user_device_parameters() {
1296         return new external_function_parameters(
1297             array(
1298                 'uuid'  => new external_value(PARAM_RAW, 'the device UUID'),
1299                 'appid' => new external_value(PARAM_NOTAGS,
1300                                                 'the app id, if empty devices matching the UUID for the user will be removed',
1301                                                 VALUE_DEFAULT, ''),
1302             )
1303         );
1304     }
1306     /**
1307      * Remove a user device from the Moodle database (for PUSH notifications usually).
1308      *
1309      * @param string $uuid The device UUID.
1310      * @param string $appid The app id, opitonal parameter. If empty all the devices fmatching the UUID or the user will be removed.
1311      * @return array List of possible warnings and removal status.
1312      * @since Moodle 2.9
1313      */
1314     public static function remove_user_device($uuid, $appid = "") {
1315         global $CFG;
1316         require_once($CFG->dirroot . "/user/lib.php");
1318         $params = self::validate_parameters(self::remove_user_device_parameters(), array('uuid' => $uuid, 'appid' => $appid));
1320         $context = context_system::instance();
1321         self::validate_context($context);
1323         // Warnings array, it can be empty at the end but is mandatory.
1324         $warnings = array();
1326         $removed = user_remove_user_device($params['uuid'], $params['appid']);
1328         if (!$removed) {
1329             $warnings[] = array(
1330                 'item' => $params['uuid'],
1331                 'warningcode' => 'devicedoesnotexist',
1332                 'message' => 'The device doesn\'t exists in the database'
1333             );
1334         }
1336         $result = array(
1337             'removed' => $removed,
1338             'warnings' => $warnings
1339         );
1341         return $result;
1342     }
1344     /**
1345      * Returns description of method result value.
1346      *
1347      * @return external_multiple_structure
1348      * @since Moodle 2.9
1349      */
1350     public static function remove_user_device_returns() {
1351         return new external_single_structure(
1352             array(
1353                 'removed' => new external_value(PARAM_BOOL, 'True if removed, false if not removed because it doesn\'t exists'),
1354                 'warnings' => new external_warnings(),
1355             )
1356         );
1357     }
1359     /**
1360      * Returns description of method parameters
1361      *
1362      * @return external_function_parameters
1363      * @since Moodle 2.9
1364      */
1365     public static function view_user_list_parameters() {
1366         return new external_function_parameters(
1367             array(
1368                 'courseid' => new external_value(PARAM_INT, 'id of the course, 0 for site')
1369             )
1370         );
1371     }
1373     /**
1374      * Trigger the user_list_viewed event.
1375      *
1376      * @param int $courseid id of course
1377      * @return array of warnings and status result
1378      * @since Moodle 2.9
1379      * @throws moodle_exception
1380      */
1381     public static function view_user_list($courseid) {
1382         global $CFG;
1383         require_once($CFG->dirroot . "/user/lib.php");
1384         require_once($CFG->dirroot . '/course/lib.php');
1386         $params = self::validate_parameters(self::view_user_list_parameters(),
1387                                             array(
1388                                                 'courseid' => $courseid
1389                                             ));
1391         $warnings = array();
1393         if (empty($params['courseid'])) {
1394             $params['courseid'] = SITEID;
1395         }
1397         $course = get_course($params['courseid']);
1399         if ($course->id == SITEID) {
1400             $context = context_system::instance();
1401         } else {
1402             $context = context_course::instance($course->id);
1403         }
1404         self::validate_context($context);
1406         course_require_view_participants($context);
1408         user_list_view($course, $context);
1410         $result = array();
1411         $result['status'] = true;
1412         $result['warnings'] = $warnings;
1413         return $result;
1414     }
1416     /**
1417      * Returns description of method result value
1418      *
1419      * @return external_description
1420      * @since Moodle 2.9
1421      */
1422     public static function view_user_list_returns() {
1423         return new external_single_structure(
1424             array(
1425                 'status' => new external_value(PARAM_BOOL, 'status: true if success'),
1426                 'warnings' => new external_warnings()
1427             )
1428         );
1429     }
1431     /**
1432      * Returns description of method parameters
1433      *
1434      * @return external_function_parameters
1435      * @since Moodle 2.9
1436      */
1437     public static function view_user_profile_parameters() {
1438         return new external_function_parameters(
1439             array(
1440                 'userid' => new external_value(PARAM_INT, 'id of the user, 0 for current user', VALUE_REQUIRED),
1441                 'courseid' => new external_value(PARAM_INT, 'id of the course, default site course', VALUE_DEFAULT, 0)
1442             )
1443         );
1444     }
1446     /**
1447      * Trigger the user profile viewed event.
1448      *
1449      * @param int $userid id of user
1450      * @param int $courseid id of course
1451      * @return array of warnings and status result
1452      * @since Moodle 2.9
1453      * @throws moodle_exception
1454      */
1455     public static function view_user_profile($userid, $courseid = 0) {
1456         global $CFG, $USER;
1457         require_once($CFG->dirroot . "/user/profile/lib.php");
1459         $params = self::validate_parameters(self::view_user_profile_parameters(),
1460                                             array(
1461                                                 'userid' => $userid,
1462                                                 'courseid' => $courseid
1463                                             ));
1465         $warnings = array();
1467         if (empty($params['userid'])) {
1468             $params['userid'] = $USER->id;
1469         }
1471         if (empty($params['courseid'])) {
1472             $params['courseid'] = SITEID;
1473         }
1475         $course = get_course($params['courseid']);
1476         $user = core_user::get_user($params['userid'], '*', MUST_EXIST);
1477         core_user::require_active_user($user);
1479         if ($course->id == SITEID) {
1480             $coursecontext = context_system::instance();;
1481         } else {
1482             $coursecontext = context_course::instance($course->id);
1483         }
1484         self::validate_context($coursecontext);
1486         $currentuser = $USER->id == $user->id;
1487         $usercontext = context_user::instance($user->id);
1489         if (!$currentuser and
1490                 !has_capability('moodle/user:viewdetails', $coursecontext) and
1491                 !has_capability('moodle/user:viewdetails', $usercontext)) {
1492             throw new moodle_exception('cannotviewprofile');
1493         }
1495         // Case like user/profile.php.
1496         if ($course->id == SITEID) {
1497             profile_view($user, $usercontext);
1498         } else {
1499             // Case like user/view.php.
1500             if (!$currentuser and !can_access_course($course, $user, '', true)) {
1501                 throw new moodle_exception('notenrolledprofile');
1502             }
1504             profile_view($user, $coursecontext, $course);
1505         }
1507         $result = array();
1508         $result['status'] = true;
1509         $result['warnings'] = $warnings;
1510         return $result;
1511     }
1513     /**
1514      * Returns description of method result value
1515      *
1516      * @return external_description
1517      * @since Moodle 2.9
1518      */
1519     public static function view_user_profile_returns() {
1520         return new external_single_structure(
1521             array(
1522                 'status' => new external_value(PARAM_BOOL, 'status: true if success'),
1523                 'warnings' => new external_warnings()
1524             )
1525         );
1526     }
1528     /**
1529      * Returns description of method parameters
1530      *
1531      * @return external_function_parameters
1532      * @since Moodle 3.2
1533      */
1534     public static function get_user_preferences_parameters() {
1535         return new external_function_parameters(
1536             array(
1537                 'name' => new external_value(PARAM_RAW, 'preference name, empty for all', VALUE_DEFAULT, ''),
1538                 'userid' => new external_value(PARAM_INT, 'id of the user, default to current user', VALUE_DEFAULT, 0)
1539             )
1540         );
1541     }
1543     /**
1544      * Return user preferences.
1545      *
1546      * @param string $name preference name, empty for all
1547      * @param int $userid id of the user, 0 for current user
1548      * @return array of warnings and preferences
1549      * @since Moodle 3.2
1550      * @throws moodle_exception
1551      */
1552     public static function get_user_preferences($name = '', $userid = 0) {
1553         global $USER;
1555         $params = self::validate_parameters(self::get_user_preferences_parameters(),
1556                                             array(
1557                                                 'name' => $name,
1558                                                 'userid' => $userid
1559                                             ));
1560         $preferences = array();
1561         $warnings = array();
1563         $context = context_system::instance();
1564         self::validate_context($context);
1566         if (empty($params['name'])) {
1567             $name = null;
1568         }
1569         if (empty($params['userid'])) {
1570             $user = null;
1571         } else {
1572             $user = core_user::get_user($params['userid'], '*', MUST_EXIST);
1573             core_user::require_active_user($user);
1574             if ($user->id != $USER->id) {
1575                 // Only admins can retrieve other users preferences.
1576                 require_capability('moodle/site:config', $context);
1577             }
1578         }
1580         $userpreferences = get_user_preferences($name, null, $user);
1581         // Check if we received just one preference.
1582         if (!is_array($userpreferences)) {
1583             $userpreferences = array($name => $userpreferences);
1584         }
1586         foreach ($userpreferences as $name => $value) {
1587             $preferences[] = array(
1588                 'name' => $name,
1589                 'value' => $value,
1590             );
1591         }
1593         $result = array();
1594         $result['preferences'] = $preferences;
1595         $result['warnings'] = $warnings;
1596         return $result;
1597     }
1599     /**
1600      * Returns description of method result value
1601      *
1602      * @return external_description
1603      * @since Moodle 3.2
1604      */
1605     public static function get_user_preferences_returns() {
1606         return new external_single_structure(
1607             array(
1608                 'preferences' => new external_multiple_structure(
1609                     new external_single_structure(
1610                         array(
1611                             'name' => new external_value(PARAM_RAW, 'The name of the preference'),
1612                             'value' => new external_value(PARAM_RAW, 'The value of the preference'),
1613                         )
1614                     ),
1615                     'User custom fields (also known as user profile fields)'
1616                 ),
1617                 'warnings' => new external_warnings()
1618             )
1619         );
1620     }
1622     /**
1623      * Returns description of method parameters
1624      *
1625      * @return external_function_parameters
1626      * @since Moodle 3.2
1627      */
1628     public static function update_picture_parameters() {
1629         return new external_function_parameters(
1630             array(
1631                 'draftitemid' => new external_value(PARAM_INT, 'Id of the user draft file to use as image'),
1632                 'delete' => new external_value(PARAM_BOOL, 'If we should delete the user picture', VALUE_DEFAULT, false),
1633                 'userid' => new external_value(PARAM_INT, 'Id of the user, 0 for current user', VALUE_DEFAULT, 0)
1634             )
1635         );
1636     }
1638     /**
1639      * Update or delete the user picture in the site
1640      *
1641      * @param  int  $draftitemid id of the user draft file to use as image
1642      * @param  bool $delete      if we should delete the user picture
1643      * @param  int $userid       id of the user, 0 for current user
1644      * @return array warnings and success status
1645      * @since Moodle 3.2
1646      * @throws moodle_exception
1647      */
1648     public static function update_picture($draftitemid, $delete = false, $userid = 0) {
1649         global $CFG, $USER, $PAGE;
1651         $params = self::validate_parameters(
1652             self::update_picture_parameters(),
1653             array(
1654                 'draftitemid' => $draftitemid,
1655                 'delete' => $delete,
1656                 'userid' => $userid
1657             )
1658         );
1660         $context = context_system::instance();
1661         self::validate_context($context);
1663         if (!empty($CFG->disableuserimages)) {
1664             throw new moodle_exception('userimagesdisabled', 'admin');
1665         }
1667         if (empty($params['userid']) or $params['userid'] == $USER->id) {
1668             $user = $USER;
1669             require_capability('moodle/user:editownprofile', $context);
1670         } else {
1671             $user = core_user::get_user($params['userid'], '*', MUST_EXIST);
1672             core_user::require_active_user($user);
1673             $personalcontext = context_user::instance($user->id);
1675             require_capability('moodle/user:editprofile', $personalcontext);
1676             if (is_siteadmin($user) and !is_siteadmin($USER)) {  // Only admins may edit other admins.
1677                 throw new moodle_exception('useradmineditadmin');
1678             }
1679         }
1681         // Load the appropriate auth plugin.
1682         $userauth = get_auth_plugin($user->auth);
1683         if (is_mnet_remote_user($user) or !$userauth->can_edit_profile() or $userauth->edit_profile_url()) {
1684             throw new moodle_exception('noprofileedit', 'auth');
1685         }
1687         $filemanageroptions = array('maxbytes' => $CFG->maxbytes, 'subdirs' => 0, 'maxfiles' => 1, 'accepted_types' => 'web_image');
1688         $user->deletepicture = $params['delete'];
1689         $user->imagefile = $params['draftitemid'];
1690         $success = core_user::update_picture($user, $filemanageroptions);
1692         $result = array(
1693             'success' => $success,
1694             'warnings' => array(),
1695         );
1696         if ($success) {
1697             $userpicture = new user_picture(core_user::get_user($user->id));
1698             $userpicture->size = 1; // Size f1.
1699             $result['profileimageurl'] = $userpicture->get_url($PAGE)->out(false);
1700         }
1701         return $result;
1702     }
1704     /**
1705      * Returns description of method result value
1706      *
1707      * @return external_description
1708      * @since Moodle 3.2
1709      */
1710     public static function update_picture_returns() {
1711         return new external_single_structure(
1712             array(
1713                 'success' => new external_value(PARAM_BOOL, 'True if the image was updated, false otherwise.'),
1714                 'profileimageurl' => new external_value(PARAM_URL, 'New profile user image url', VALUE_OPTIONAL),
1715                 'warnings' => new external_warnings()
1716             )
1717         );
1718     }
1720     /**
1721      * Returns description of method parameters
1722      *
1723      * @return external_function_parameters
1724      * @since Moodle 3.2
1725      */
1726     public static function set_user_preferences_parameters() {
1727         return new external_function_parameters(
1728             array(
1729                 'preferences' => new external_multiple_structure(
1730                     new external_single_structure(
1731                         array(
1732                             'name' => new external_value(PARAM_RAW, 'The name of the preference'),
1733                             'value' => new external_value(PARAM_RAW, 'The value of the preference'),
1734                             'userid' => new external_value(PARAM_INT, 'Id of the user to set the preference'),
1735                         )
1736                     )
1737                 )
1738             )
1739         );
1740     }
1742     /**
1743      * Set user preferences.
1744      *
1745      * @param array $preferences list of preferences including name, value and userid
1746      * @return array of warnings and preferences saved
1747      * @since Moodle 3.2
1748      * @throws moodle_exception
1749      */
1750     public static function set_user_preferences($preferences) {
1751         global $USER;
1753         $params = self::validate_parameters(self::set_user_preferences_parameters(), array('preferences' => $preferences));
1754         $warnings = array();
1755         $saved = array();
1757         $context = context_system::instance();
1758         self::validate_context($context);
1760         $userscache = array();
1761         foreach ($params['preferences'] as $pref) {
1762             // Check to which user set the preference.
1763             if (!empty($userscache[$pref['userid']])) {
1764                 $user = $userscache[$pref['userid']];
1765             } else {
1766                 try {
1767                     $user = core_user::get_user($pref['userid'], '*', MUST_EXIST);
1768                     core_user::require_active_user($user);
1769                     $userscache[$pref['userid']] = $user;
1770                 } catch (Exception $e) {
1771                     $warnings[] = array(
1772                         'item' => 'user',
1773                         'itemid' => $pref['userid'],
1774                         'warningcode' => 'invaliduser',
1775                         'message' => $e->getMessage()
1776                     );
1777                     continue;
1778                 }
1779             }
1781             try {
1782                 if (core_user::can_edit_preference($pref['name'], $user)) {
1783                     $value = core_user::clean_preference($pref['value'], $pref['name']);
1784                     set_user_preference($pref['name'], $value, $user->id);
1785                     $saved[] = array(
1786                         'name' => $pref['name'],
1787                         'userid' => $user->id,
1788                     );
1789                 } else {
1790                     $warnings[] = array(
1791                         'item' => 'user',
1792                         'itemid' => $user->id,
1793                         'warningcode' => 'nopermission',
1794                         'message' => 'You are not allowed to change the preference '.s($pref['name']).' for user '.$user->id
1795                     );
1796                 }
1797             } catch (Exception $e) {
1798                 $warnings[] = array(
1799                     'item' => 'user',
1800                     'itemid' => $user->id,
1801                     'warningcode' => 'errorsavingpreference',
1802                     'message' => $e->getMessage()
1803                 );
1804             }
1805         }
1807         $result = array();
1808         $result['saved'] = $saved;
1809         $result['warnings'] = $warnings;
1810         return $result;
1811     }
1813     /**
1814      * Returns description of method result value
1815      *
1816      * @return external_description
1817      * @since Moodle 3.2
1818      */
1819     public static function set_user_preferences_returns() {
1820         return new external_single_structure(
1821             array(
1822                 'saved' => new external_multiple_structure(
1823                     new external_single_structure(
1824                         array(
1825                             'name' => new external_value(PARAM_RAW, 'The name of the preference'),
1826                             'userid' => new external_value(PARAM_INT, 'The user the preference was set for'),
1827                         )
1828                     ), 'Preferences saved'
1829                 ),
1830                 'warnings' => new external_warnings()
1831             )
1832         );
1833     }
1835     /**
1836      * Returns description of method parameters.
1837      *
1838      * @return external_function_parameters
1839      * @since Moodle 3.2
1840      */
1841     public static function agree_site_policy_parameters() {
1842         return new external_function_parameters(array());
1843     }
1845     /**
1846      * Agree the site policy for the current user.
1847      *
1848      * @return array of warnings and status result
1849      * @since Moodle 3.2
1850      * @throws moodle_exception
1851      */
1852     public static function agree_site_policy() {
1853         global $CFG, $DB, $USER;
1855         $warnings = array();
1857         $context = context_system::instance();
1858         try {
1859             // We expect an exception here since the user didn't agree the site policy yet.
1860             self::validate_context($context);
1861         } catch (Exception $e) {
1862             // We are expecting only a sitepolicynotagreed exception.
1863             if (!($e instanceof moodle_exception) or $e->errorcode != 'sitepolicynotagreed') {
1864                 // In case we receive a different exception, throw it.
1865                 throw $e;
1866             }
1867         }
1869         $manager = new \core_privacy\local\sitepolicy\manager();
1870         if (!empty($USER->policyagreed)) {
1871             $status = false;
1872             $warnings[] = array(
1873                 'item' => 'user',
1874                 'itemid' => $USER->id,
1875                 'warningcode' => 'alreadyagreed',
1876                 'message' => 'The user already agreed the site policy.'
1877             );
1878         } else if (!$manager->is_defined()) {
1879             $status = false;
1880             $warnings[] = array(
1881                 'item' => 'user',
1882                 'itemid' => $USER->id,
1883                 'warningcode' => 'nositepolicy',
1884                 'message' => 'The site does not have a site policy configured.'
1885             );
1886         } else {
1887             $status = $manager->accept();
1888         }
1890         $result = array();
1891         $result['status'] = $status;
1892         $result['warnings'] = $warnings;
1893         return $result;
1894     }
1896     /**
1897      * Returns description of method result value.
1898      *
1899      * @return external_description
1900      * @since Moodle 3.2
1901      */
1902     public static function agree_site_policy_returns() {
1903         return new external_single_structure(
1904             array(
1905                 'status' => new external_value(PARAM_BOOL, 'Status: true only if we set the policyagreed to 1 for the user'),
1906                 'warnings' => new external_warnings()
1907             )
1908         );
1909     }
1911     /**
1912      * Returns description of method parameters.
1913      *
1914      * @return external_function_parameters
1915      * @since Moodle 3.4
1916      */
1917     public static function get_private_files_info_parameters() {
1918         return new external_function_parameters(
1919             array(
1920                 'userid' => new external_value(PARAM_INT, 'Id of the user, default to current user.', VALUE_DEFAULT, 0)
1921             )
1922         );
1923     }
1925     /**
1926      * Returns general information about files in the user private files area.
1927      *
1928      * @param int $userid Id of the user, default to current user.
1929      * @return array of warnings and file area information
1930      * @since Moodle 3.4
1931      * @throws moodle_exception
1932      */
1933     public static function get_private_files_info($userid = 0) {
1934         global $CFG, $USER;
1935         require_once($CFG->libdir . '/filelib.php');
1937         $params = self::validate_parameters(self::get_private_files_info_parameters(), array('userid' => $userid));
1938         $warnings = array();
1940         $context = context_system::instance();
1941         self::validate_context($context);
1943         if (empty($params['userid']) || $params['userid'] == $USER->id) {
1944             $usercontext = context_user::instance($USER->id);
1945             require_capability('moodle/user:manageownfiles', $usercontext);
1946         } else {
1947             $user = core_user::get_user($params['userid'], '*', MUST_EXIST);
1948             core_user::require_active_user($user);
1949             // Only admins can retrieve other users information.
1950             require_capability('moodle/site:config', $context);
1951             $usercontext = context_user::instance($user->id);
1952         }
1954         $fileareainfo = file_get_file_area_info($usercontext->id, 'user', 'private');
1956         $result = array();
1957         $result['filecount'] = $fileareainfo['filecount'];
1958         $result['foldercount'] = $fileareainfo['foldercount'];
1959         $result['filesize'] = $fileareainfo['filesize'];
1960         $result['filesizewithoutreferences'] = $fileareainfo['filesize_without_references'];
1961         $result['warnings'] = $warnings;
1962         return $result;
1963     }
1965     /**
1966      * Returns description of method result value.
1967      *
1968      * @return external_description
1969      * @since Moodle 3.4
1970      */
1971     public static function get_private_files_info_returns() {
1972         return new external_single_structure(
1973             array(
1974                 'filecount' => new external_value(PARAM_INT, 'Number of files in the area.'),
1975                 'foldercount' => new external_value(PARAM_INT, 'Number of folders in the area.'),
1976                 'filesize' => new external_value(PARAM_INT, 'Total size of the files in the area.'),
1977                 'filesizewithoutreferences' => new external_value(PARAM_INT, 'Total size of the area excluding file references'),
1978                 'warnings' => new external_warnings()
1979             )
1980         );
1981     }