externallib.php 50.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

17

18
19
20
/**
 * External user API
 *
21
22
23
 * @package    core_user
 * @category   external
 * @copyright  2009 Petr Skodak
24
25
26
27
28
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

require_once("$CFG->libdir/externallib.php");

29
/**
30
31
32
33
34
35
36
 * User external functions
 *
 * @package    core_user
 * @category   external
 * @copyright  2011 Jerome Mouneyrac
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @since Moodle 2.2
37
38
 */
class core_user_external extends external_api {
39

Petr Skoda's avatar
Petr Skoda committed
40
41
    /**
     * Returns description of method parameters
42
     *
Petr Skoda's avatar
Petr Skoda committed
43
     * @return external_function_parameters
44
     * @since Moodle 2.2
Petr Skoda's avatar
Petr Skoda committed
45
     */
skodak's avatar
skodak committed
46
    public static function create_users_parameters() {
Petr Skoda's avatar
Petr Skoda committed
47
48
        global $CFG;

49
50
51
52
53
        return new external_function_parameters(
            array(
                'users' => new external_multiple_structure(
                    new external_single_structure(
                        array(
54
                            'username'    => new external_value(PARAM_USERNAME, 'Username policy is defined in Moodle security config.'),
Petr Skoda's avatar
Petr Skoda committed
55
                            'password'    => new external_value(PARAM_RAW, 'Plain text password consisting of any characters'),
Petr Skoda's avatar
Petr Skoda committed
56
57
58
                            'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user'),
                            'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user'),
                            'email'       => new external_value(PARAM_EMAIL, 'A valid and unique email address'),
59
                            'auth'        => new external_value(PARAM_PLUGIN, 'Auth plugins include manual, ldap, imap, etc', VALUE_DEFAULT, 'manual', NULL_NOT_ALLOWED),
60
                            'idnumber'    => new external_value(PARAM_RAW, 'An arbitrary ID code number perhaps from the institution', VALUE_DEFAULT, ''),
61
                            'lang'        => new external_value(PARAM_SAFEDIR, 'Language code such as "en", must exist on server', VALUE_DEFAULT, $CFG->lang, NULL_NOT_ALLOWED),
62
                            'theme'       => new external_value(PARAM_PLUGIN, 'Theme name such as "standard", must exist on server', VALUE_OPTIONAL),
63
                            'timezone'    => new external_value(PARAM_TIMEZONE, 'Timezone code such as Australia/Perth, or 99 for default', VALUE_OPTIONAL),
64
                            'mailformat'  => new external_value(PARAM_INT, 'Mail format code is 0 for plain text, 1 for HTML etc', VALUE_OPTIONAL),
65
                            'description' => new external_value(PARAM_TEXT, 'User profile description, no HTML', VALUE_OPTIONAL),
66
67
                            'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
                            'country'     => new external_value(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
68
69
70
                            'preferences' => new external_multiple_structure(
                                new external_single_structure(
                                    array(
Petr Skoda's avatar
Petr Skoda committed
71
                                        'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the preference'),
72
73
                                        'value' => new external_value(PARAM_RAW, 'The value of the preference')
                                    )
74
                                ), 'User preferences', VALUE_OPTIONAL),
75
76
77
                            'customfields' => new external_multiple_structure(
                                new external_single_structure(
                                    array(
Petr Skoda's avatar
Petr Skoda committed
78
                                        'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the custom field'),
79
80
                                        'value' => new external_value(PARAM_RAW, 'The value of the custom field')
                                    )
81
                                ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL)
82
83
84
85
86
                        )
                    )
                )
            )
        );
87
88
    }

skodak's avatar
skodak committed
89
    /**
90
91
     * Create one or more users
     *
92
     * @param array $users An array of users to create.
Petr Skoda's avatar
Petr Skoda committed
93
     * @return array An array of arrays
94
     * @since Moodle 2.2
95
     */
Petr Skoda's avatar
Petr Skoda committed
96
    public static function create_users($users) {
97
        global $CFG, $DB;
98
        require_once($CFG->dirroot."/lib/weblib.php");
99
        require_once($CFG->dirroot."/user/lib.php");
100
        require_once($CFG->dirroot."/user/profile/lib.php"); //required for customfields related function
101

102
        // Ensure the current user is allowed to run this function
103
        $context = context_system::instance();
104
        self::validate_context($context);
105
        require_capability('moodle/user:create', $context);
106

107
108
        // Do basic automatic PARAM checks on incoming data, using params description
        // If any problems are found then exceptions are thrown with helpful error messages
Petr Skoda's avatar
Petr Skoda committed
109
        $params = self::validate_parameters(self::create_users_parameters(), array('users'=>$users));
110

Petr Skoda's avatar
Petr Skoda committed
111
112
113
114
115
        $availableauths  = get_plugin_list('auth');
        unset($availableauths['mnet']);       // these would need mnethostid too
        unset($availableauths['webservice']); // we do not want new webservice users for now

        $availablethemes = get_plugin_list('theme');
116
        $availablelangs  = get_string_manager()->get_list_of_translations();
117

118
        $transaction = $DB->start_delegated_transaction();
119

120
        $userids = array();
Petr Skoda's avatar
Petr Skoda committed
121
        foreach ($params['users'] as $user) {
Petr Skoda's avatar
Petr Skoda committed
122
123
124
            // Make sure that the username doesn't already exist
            if ($DB->record_exists('user', array('username'=>$user['username'], 'mnethostid'=>$CFG->mnet_localhost_id))) {
                throw new invalid_parameter_exception('Username already exists: '.$user['username']);
125
126
            }

Petr Skoda's avatar
Petr Skoda committed
127
128
129
            // Make sure auth is valid
            if (empty($availableauths[$user['auth']])) {
                throw new invalid_parameter_exception('Invalid authentication type: '.$user['auth']);
130
131
            }

Petr Skoda's avatar
Petr Skoda committed
132
133
134
            // Make sure lang is valid
            if (empty($availablelangs[$user['lang']])) {
                throw new invalid_parameter_exception('Invalid language code: '.$user['lang']);
135
136
            }

Petr Skoda's avatar
Petr Skoda committed
137
            // Make sure lang is valid
138
139
140
141
            if (!empty($user['theme']) && empty($availablethemes[$user['theme']])) { //theme is VALUE_OPTIONAL,
                                                                                     // so no default value.
                                                                                     // We need to test if the client sent it
                                                                                     // => !empty($user['theme'])
Petr Skoda's avatar
Petr Skoda committed
142
                throw new invalid_parameter_exception('Invalid theme: '.$user['theme']);
143
            }
144

145
            $user['confirmed'] = true;
146
            $user['mnethostid'] = $CFG->mnet_localhost_id;
147

148
149
150
151
152
153
154
155
156
            // Start of user info validation.
            // Lets make sure we validate current user info as handled by current GUI. see user/editadvanced_form.php function validation()
            if (!validate_email($user['email'])) {
                throw new invalid_parameter_exception('Email address is invalid: '.$user['email']);
            } else if ($DB->record_exists('user', array('email'=>$user['email'], 'mnethostid'=>$user['mnethostid']))) {
                throw new invalid_parameter_exception('Email address already exists: '.$user['email']);
            }
            // End of user info validation.

157
158
            // create the user data now!
            $user['id'] = user_create_user($user);
159

160
161
162
163
164
165
166
167
168
            // custom fields
            if(!empty($user['customfields'])) {
                foreach($user['customfields'] as $customfield) {
                    $user["profile_field_".$customfield['type']] = $customfield['value']; //profile_save_data() saves profile file
                                                                                            //it's expecting a user with the correct id,
                                                                                            //and custom field to be named profile_field_"shortname"
                }
                profile_save_data((object) $user);
            }
Petr Skoda's avatar
Petr Skoda committed
169

170
171
172
173
174
175
            //preferences
            if (!empty($user['preferences'])) {
                foreach($user['preferences'] as $preference) {
                    set_user_preference($preference['type'], $preference['value'],$user['id']);
                }
            }
skodak's avatar
skodak committed
176

177
            $userids[] = array('id'=>$user['id'], 'username'=>$user['username']);
178
179
        }

180
        $transaction->allow_commit();
Petr Skoda's avatar
Petr Skoda committed
181

182
        return $userids;
183
184
    }

Petr Skoda's avatar
Petr Skoda committed
185
186
   /**
     * Returns description of method result value
187
     *
Petr Skoda's avatar
Petr Skoda committed
188
     * @return external_description
189
     * @since Moodle 2.2
Petr Skoda's avatar
Petr Skoda committed
190
191
192
193
194
195
     */
    public static function create_users_returns() {
        return new external_multiple_structure(
            new external_single_structure(
                array(
                    'id'       => new external_value(PARAM_INT, 'user id'),
196
                    'username' => new external_value(PARAM_USERNAME, 'user name'),
Petr Skoda's avatar
Petr Skoda committed
197
198
199
                )
            )
        );
skodak's avatar
skodak committed
200
201
202
    }


Petr Skoda's avatar
Petr Skoda committed
203
204
    /**
     * Returns description of method parameters
205
     *
Petr Skoda's avatar
Petr Skoda committed
206
     * @return external_function_parameters
207
     * @since Moodle 2.2
Petr Skoda's avatar
Petr Skoda committed
208
     */
skodak's avatar
skodak committed
209
    public static function delete_users_parameters() {
Petr Skoda's avatar
Petr Skoda committed
210
211
212
213
214
        return new external_function_parameters(
            array(
                'userids' => new external_multiple_structure(new external_value(PARAM_INT, 'user ID')),
            )
        );
skodak's avatar
skodak committed
215
    }
Petr Skoda's avatar
Petr Skoda committed
216

217
218
    /**
     * Delete users
219
     *
220
     * @param array $userids
Sam Hemelryk's avatar
Sam Hemelryk committed
221
     * @return null
222
     * @since Moodle 2.2
223
     */
224
    public static function delete_users($userids) {
225
        global $CFG, $DB, $USER;
226
        require_once($CFG->dirroot."/user/lib.php");
227
228

        // Ensure the current user is allowed to run this function
229
        $context = context_system::instance();
230
231
232
        require_capability('moodle/user:delete', $context);
        self::validate_context($context);

233
        $params = self::validate_parameters(self::delete_users_parameters(), array('userids'=>$userids));
234
235
236
237
238

        $transaction = $DB->start_delegated_transaction();

        foreach ($params['userids'] as $userid) {
            $user = $DB->get_record('user', array('id'=>$userid, 'deleted'=>0), '*', MUST_EXIST);
239
            // must not allow deleting of admins or self!!!
240
241
242
243
244
            if (is_siteadmin($user)) {
                throw new moodle_exception('useradminodelete', 'error');
            }
            if ($USER->id == $user->id) {
                throw new moodle_exception('usernotdeletederror', 'error');
245
            }
246
            user_delete_user($user);
247
248
249
250
251
        }

        $transaction->allow_commit();

        return null;
252
    }
Petr Skoda's avatar
Petr Skoda committed
253
254
255

   /**
     * Returns description of method result value
256
257
258
     *
     * @return null
     * @since Moodle 2.2
Petr Skoda's avatar
Petr Skoda committed
259
     */
skodak's avatar
skodak committed
260
    public static function delete_users_returns() {
Petr Skoda's avatar
Petr Skoda committed
261
        return null;
skodak's avatar
skodak committed
262
    }
263
264


Petr Skoda's avatar
Petr Skoda committed
265
266
    /**
     * Returns description of method parameters
267
     *
Petr Skoda's avatar
Petr Skoda committed
268
     * @return external_function_parameters
269
     * @since Moodle 2.2
Petr Skoda's avatar
Petr Skoda committed
270
     */
skodak's avatar
skodak committed
271
    public static function update_users_parameters() {
272
        global $CFG;
273
        return new external_function_parameters(
274
275
276
277
            array(
                'users' => new external_multiple_structure(
                    new external_single_structure(
                        array(
278
                            'id'    => new external_value(PARAM_INT, 'ID of the user'),
279
                            'username'    => new external_value(PARAM_USERNAME, 'Username policy is defined in Moodle security config.', VALUE_OPTIONAL, '',NULL_NOT_ALLOWED),
280
281
282
283
                            'password'    => new external_value(PARAM_RAW, 'Plain text password consisting of any characters', VALUE_OPTIONAL, '',NULL_NOT_ALLOWED),
                            'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user', VALUE_OPTIONAL, '',NULL_NOT_ALLOWED),
                            'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user', VALUE_OPTIONAL),
                            'email'       => new external_value(PARAM_EMAIL, 'A valid and unique email address', VALUE_OPTIONAL, '',NULL_NOT_ALLOWED),
284
                            'auth'        => new external_value(PARAM_PLUGIN, 'Auth plugins include manual, ldap, imap, etc', VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
285
                            'idnumber'    => new external_value(PARAM_RAW, 'An arbitrary ID code number perhaps from the institution', VALUE_OPTIONAL),
286
                            'lang'        => new external_value(PARAM_SAFEDIR, 'Language code such as "en", must exist on server', VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
287
                            'theme'       => new external_value(PARAM_PLUGIN, 'Theme name such as "standard", must exist on server', VALUE_OPTIONAL),
288
                            'timezone'    => new external_value(PARAM_TIMEZONE, 'Timezone code such as Australia/Perth, or 99 for default', VALUE_OPTIONAL),
289
                            'mailformat'  => new external_value(PARAM_INT, 'Mail format code is 0 for plain text, 1 for HTML etc', VALUE_OPTIONAL),
290
                            'description' => new external_value(PARAM_TEXT, 'User profile description, no HTML', VALUE_OPTIONAL),
291
292
293
294
295
296
297
298
                            'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
                            'country'     => new external_value(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
                            'customfields' => new external_multiple_structure(
                                new external_single_structure(
                                    array(
                                        'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the custom field'),
                                        'value' => new external_value(PARAM_RAW, 'The value of the custom field')
                                    )
299
                                ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
300
301
302
303
304
305
306
                            'preferences' => new external_multiple_structure(
                                new external_single_structure(
                                    array(
                                        'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the preference'),
                                        'value' => new external_value(PARAM_RAW, 'The value of the preference')
                                    )
                                ), 'User preferences', VALUE_OPTIONAL),
307
308
309
310
311
                        )
                    )
                )
            )
        );
skodak's avatar
skodak committed
312
    }
313

314
315
    /**
     * Update users
316
     *
317
     * @param array $users
Sam Hemelryk's avatar
Sam Hemelryk committed
318
     * @return null
319
     * @since Moodle 2.2
320
     */
321
322
    public static function update_users($users) {
        global $CFG, $DB;
323
        require_once($CFG->dirroot."/user/lib.php");
324
        require_once($CFG->dirroot."/user/profile/lib.php"); //required for customfields related function
325
326

        // Ensure the current user is allowed to run this function
327
        $context = context_system::instance();
328
329
330
331
332
333
334
335
        require_capability('moodle/user:update', $context);
        self::validate_context($context);

        $params = self::validate_parameters(self::update_users_parameters(), array('users'=>$users));

        $transaction = $DB->start_delegated_transaction();

        foreach ($params['users'] as $user) {
336
            user_update_user($user);
337
338
339
340
341
342
343
344
345
346
            //update user custom fields
            if(!empty($user['customfields'])) {

                foreach($user['customfields'] as $customfield) {
                    $user["profile_field_".$customfield['type']] = $customfield['value']; //profile_save_data() saves profile file
                                                                                            //it's expecting a user with the correct id,
                                                                                            //and custom field to be named profile_field_"shortname"
                }
                profile_save_data((object) $user);
            }
347
348
349
350
351
352
353

            //preferences
            if (!empty($user['preferences'])) {
                foreach($user['preferences'] as $preference) {
                    set_user_preference($preference['type'], $preference['value'],$user['id']);
                }
            }
354
355
356
357
358
        }

        $transaction->allow_commit();

        return null;
359
    }
Petr Skoda's avatar
Petr Skoda committed
360
361
362

   /**
     * Returns description of method result value
363
364
365
     *
     * @return null
     * @since Moodle 2.2
Petr Skoda's avatar
Petr Skoda committed
366
     */
skodak's avatar
skodak committed
367
    public static function update_users_returns() {
Petr Skoda's avatar
Petr Skoda committed
368
        return null;
skodak's avatar
skodak committed
369
370
    }

371
372
373
374
   /**
   * Returns description of method parameters
   *
   * @return external_function_parameters
375
   * @since Moodle 2.4
376
   */
377
    public static function get_users_by_field_parameters() {
378
379
        return new external_function_parameters(
            array(
380
381
382
383
                'field' => new external_value(PARAM_ALPHA, 'the search field can be
                    \'id\' or \'idnumber\' or \'username\' or \'email\''),
                'values' => new external_multiple_structure(
                        new external_value(PARAM_RAW, 'the value to match'))
384
385
386
387
388
            )
        );
    }

    /**
389
     * Get user information for a unique field.
390
     *
391
392
393
394
     * @param string $field
     * @param array $values
     * @return array An array of arrays containg user profiles.
     * @since Moodle 2.4
395
     */
396
    public static function get_users_by_field($field, $values) {
397
398
399
        global $CFG, $USER, $DB;
        require_once($CFG->dirroot . "/user/lib.php");

400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
        $params = self::validate_parameters(self::get_users_by_field_parameters(),
                array('field' => $field, 'values' => $values));

        // This array will keep all the users that are allowed to be searched,
        // according to the current user's privileges.
        $cleanedvalues = array();

        switch ($field) {
            case 'id':
                $paramtype = PARAM_INT;
                break;
            case 'idnumber':
                $paramtype = PARAM_RAW;
                break;
            case 'username':
415
                $paramtype = PARAM_RAW;
416
417
418
419
420
421
422
                break;
            case 'email':
                $paramtype = PARAM_EMAIL;
                break;
            default:
                throw new coding_exception('invalid field parameter',
                        'The search field \'' . $field . '\' is not supported, look at the web service documentation');
423
424
        }

425
426
427
428
429
430
431
432
        // Clean the values
        foreach ($values as $value) {
            $cleanedvalue = clean_param($value, $paramtype);
            if ( $value != $cleanedvalue) {
                throw new invalid_parameter_exception('The field \'' . $field .
                        '\' value is invalid: ' . $value . '(cleaned value: '.$cleanedvalue.')');
            }
            $cleanedvalues[] = $cleanedvalue;
433
434
        }

435
436
        // Retrieve the users
        $users = $DB->get_records_list('user', $field, $cleanedvalues, 'id');
437

438
439
        // Finally retrieve each users information
        $returnedusers = array();
440
441
442
        foreach ($users as $user) {
            $userdetails = user_get_user_details_courses($user);

443
444
445
446
            // Return the user only if the searched field is returned
            // Otherwise it means that the $USER was not allowed to search the returned user
            if (!empty($userdetails) and !empty($userdetails[$field])) {
                $returnedusers[] = $userdetails;
447
448
449
            }
        }

450
        return $returnedusers;
451
452
453
454
455
    }

    /**
     * Returns description of method result value
     *
456
457
     * @return external_multiple_structure
     * @since Moodle 2.4
458
     */
459
    public static function get_users_by_field_returns() {
460
        return new external_multiple_structure(self::user_description());
461
462
463
464
    }


    /**
465
     * Returns description of get_users() parameters.
466
467
     *
     * @return external_function_parameters
468
     * @since Moodle 2.5
469
470
471
472
473
474
475
     */
    public static function get_users_parameters() {
        return new external_function_parameters(
            array(
                'criteria' => new external_multiple_structure(
                    new external_single_structure(
                        array(
476
477
478
479
480
481
482
483
484
                            'key' => new external_value(PARAM_ALPHA, 'the user column to search, expected keys (value format) are:
                                "id" (int) matching user id,
                                "lastname" (string) user last name (Note: you can use % for searching but it may be considerably slower!),
                                "firstname" (string) user first name (Note: you can use % for searching but it may be considerably slower!),
                                "idnumber" (string) matching user idnumber,
                                "username" (string) matching user username,
                                "email" (string) user email (Note: you can use % for searching but it may be considerably slower!),
                                "auth" (string) matching user auth plugin'),
                            'value' => new external_value(PARAM_RAW, 'the value to search')
485
486
                        )
                    ), 'the key/value pairs to be considered in user search. Values can not be empty.
487
                        Specify different keys only once (fullname => \'user1\', auth => \'manual\', ...) -
488
                        key occurences are forbidden.
489
                        The search is executed with AND operator on the criterias. Invalid criterias (keys) are ignored,
490
491
492
                        the search is still executed on the valid criterias.
                        You can search without criteria, but the function is not designed for it.
                        It could very slow or timeout. The function is designed to search some specific users.'
493
494
495
496
497
                )
            )
        );
    }

498
    /**
499
     * Retrieve matching user.
500
     *
501
502
503
     * @param array $criteria the allowed array keys are id/lastname/firstname/idnumber/username/email/auth.
     * @return array An array of arrays containing user profiles.
     * @since Moodle 2.5
504
505
506
507
508
509
510
511
512
     */
    public static function get_users($criteria = array()) {
        global $CFG, $USER, $DB;

        require_once($CFG->dirroot . "/user/lib.php");

        $params = self::validate_parameters(self::get_users_parameters(),
                array('criteria' => $criteria));

513
        // Validate the criteria and retrieve the users.
514
515
516
        $users = array();
        $warnings = array();
        $sqlparams = array();
517
518
519
520
        $usedkeys = array();

        // Do not retrieve deleted users.
        $sql = ' deleted = 0';
521

522
        foreach ($params['criteria'] as $criteriaindex => $criteria) {
523
524
525
526
527
528
529
530

            // Check that the criteria has never been used.
            if (array_key_exists($criteria['key'], $usedkeys)) {
                throw new moodle_exception('keyalreadyset', '', '', null, 'The key ' . $criteria['key'] . ' can only be sent once');
            } else {
                $usedkeys[$criteria['key']] = true;
            }

531
            $invalidcriteria = false;
532
            // Clean the parameters.
533
534
535
536
537
538
539
540
541
            $paramtype = PARAM_RAW;
            switch ($criteria['key']) {
                case 'id':
                    $paramtype = PARAM_INT;
                    break;
                case 'idnumber':
                    $paramtype = PARAM_RAW;
                    break;
                case 'username':
542
                    $paramtype = PARAM_RAW;
543
544
                    break;
                case 'email':
545
                    // We use PARAM_RAW to allow searches with %.
546
547
548
549
550
551
552
553
554
555
                    $paramtype = PARAM_RAW;
                    break;
                case 'auth':
                    $paramtype = PARAM_AUTH;
                    break;
                case 'lastname':
                case 'firstname':
                    $paramtype = PARAM_TEXT;
                    break;
                default:
556
557
                    // Send back a warning that this search key is not supported in this version.
                    // This warning will make the function extandable without breaking clients.
558
                    $warnings[] = array(
559
                        'item' => $criteria['key'],
560
                        'warningcode' => 'invalidfieldparameter',
561
                        'message' => 'The search key \'' . $criteria['key'] . '\' is not supported, look at the web service documentation'
562
                    );
563
564
565
566
                    // Do not add this invalid criteria to the created SQL request.
                    $invalidcriteria = true;
                    unset($params['criteria'][$criteriaindex]);
                    break;
567
568
            }

569
570
            if (!$invalidcriteria) {
                $cleanedvalue = clean_param($criteria['value'], $paramtype);
571

572
                $sql .= ' AND ';
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591

                // Create the SQL.
                switch ($criteria['key']) {
                    case 'id':
                    case 'idnumber':
                    case 'username':
                    case 'auth':
                        $sql .= $criteria['key'] . ' = :' . $criteria['key'];
                        $sqlparams[$criteria['key']] = $cleanedvalue;
                        break;
                    case 'email':
                    case 'lastname':
                    case 'firstname':
                        $sql .= $DB->sql_like($criteria['key'], ':' . $criteria['key'], false);
                        $sqlparams[$criteria['key']] = $cleanedvalue;
                        break;
                    default:
                        break;
                }
592
593
594
595
596
            }
        }

        $users = $DB->get_records_select('user', $sql, $sqlparams, 'id ASC');

597
        // Finally retrieve each users information.
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
        $returnedusers = array();
        foreach ($users as $user) {
            $userdetails = user_get_user_details_courses($user);

            // Return the user only if all the searched fields are returned.
            // Otherwise it means that the $USER was not allowed to search the returned user.
            if (!empty($userdetails)) {
                $validuser = true;

                foreach($params['criteria'] as $criteria) {
                    if (empty($userdetails[$criteria['key']])) {
                        $validuser = false;
                    }
                }

                if ($validuser) {
                    $returnedusers[] = $userdetails;
                }
            }
        }

        return array('users' => $returnedusers, 'warnings' => $warnings);
    }

    /**
623
     * Returns description of get_users result value.
624
625
     *
     * @return external_description
626
     * @since Moodle 2.5
627
628
629
630
     */
    public static function get_users_returns() {
        return new external_single_structure(
            array('users' => new external_multiple_structure(
631
                                self::user_description()
632
                             ),
633
                  'warnings' => new external_warnings('always set to \'key\'', 'faulty key name')
634
635
636
637
            )
        );
    }

Petr Skoda's avatar
Petr Skoda committed
638
639
    /**
     * Returns description of method parameters
640
     *
Petr Skoda's avatar
Petr Skoda committed
641
     * @return external_function_parameters
642
     * @since Moodle 2.2
643
644
     * @deprecated Moodle 2.5 MDL-38030 - Please do not call this function any more.
     * @see core_user_external::get_users_by_field_parameters()
Petr Skoda's avatar
Petr Skoda committed
645
     */
646
    public static function get_users_by_id_parameters() {
Petr Skoda's avatar
Petr Skoda committed
647
        return new external_function_parameters(
648
649
650
                array(
                    'userids' => new external_multiple_structure(new external_value(PARAM_INT, 'user ID')),
                )
Petr Skoda's avatar
Petr Skoda committed
651
        );
skodak's avatar
skodak committed
652
    }
Petr Skoda's avatar
Petr Skoda committed
653

Petr Skoda's avatar
Petr Skoda committed
654
655
    /**
     * Get user information
656
657
658
     * - This function is matching the permissions of /user/profil.php
     * - It is also matching some permissions from /user/editadvanced.php for the following fields:
     *   auth, confirmed, idnumber, lang, theme, timezone, mailformat
659
     *
Petr Skoda's avatar
Petr Skoda committed
660
661
     * @param array $userids  array of user ids
     * @return array An array of arrays describing users
662
     * @since Moodle 2.2
663
664
     * @deprecated Moodle 2.5 MDL-38030 - Please do not call this function any more.
     * @see core_user_external::get_users_by_field()
Petr Skoda's avatar
Petr Skoda committed
665
     */
666
    public static function get_users_by_id($userids) {
667
        global $CFG, $USER, $DB;
668
        require_once($CFG->dirroot . "/user/lib.php");
669

670
671
        $params = self::validate_parameters(self::get_users_by_id_parameters(),
                array('userids'=>$userids));
672

Dongsheng Cai's avatar
Dongsheng Cai committed
673
674
675
676
677
678
        list($uselect, $ujoin) = context_instance_preload_sql('u.id', CONTEXT_USER, 'ctx');
        list($sqluserids, $params) = $DB->get_in_or_equal($userids);
        $usersql = "SELECT u.* $uselect
                      FROM {user} u $ujoin
                     WHERE u.id $sqluserids";
        $users = $DB->get_recordset_sql($usersql, $params);
skodak's avatar
skodak committed
679

680
        $result = array();
681
        $hasuserupdatecap = has_capability('moodle/user:update', context_system::instance());
skodak's avatar
skodak committed
682
        foreach ($users as $user) {
Dongsheng Cai's avatar
Dongsheng Cai committed
683
684
685
686
            if (!empty($user->deleted)) {
                continue;
            }
            context_instance_preload($user);
687
            $usercontext = context_user::instance($user->id, IGNORE_MISSING);
688
            self::validate_context($usercontext);
689
690
            $currentuser = ($user->id == $USER->id);

691
692
693
694
695
696
697
698
699
700
            if ($userarray  = user_get_user_details($user)) {
                //fields matching permissions from /user/editadvanced.php
                if ($currentuser or $hasuserupdatecap) {
                    $userarray['auth']       = $user->auth;
                    $userarray['confirmed']  = $user->confirmed;
                    $userarray['idnumber']   = $user->idnumber;
                    $userarray['lang']       = $user->lang;
                    $userarray['theme']      = $user->theme;
                    $userarray['timezone']   = $user->timezone;
                    $userarray['mailformat'] = $user->mailformat;
701
                }
702
                $result[] = $userarray;
Dongsheng Cai's avatar
Dongsheng Cai committed
703
            }
704
        }
Dongsheng Cai's avatar
Dongsheng Cai committed
705
        $users->close();
Petr Skoda's avatar
Petr Skoda committed
706
707

        return $result;
skodak's avatar
skodak committed
708
    }
Petr Skoda's avatar
Petr Skoda committed
709

710
    /**
Petr Skoda's avatar
Petr Skoda committed
711
     * Returns description of method result value
712
     *
Petr Skoda's avatar
Petr Skoda committed
713
     * @return external_description
714
     * @since Moodle 2.2
715
716
     * @deprecated Moodle 2.5 MDL-38030 - Please do not call this function any more.
     * @see core_user_external::get_users_by_field_returns()
Petr Skoda's avatar
Petr Skoda committed
717
     */
718
    public static function get_users_by_id_returns() {
719
720
        $additionalfields = array (
            'enrolledcourses' => new external_multiple_structure(
Damyon Wiese's avatar
Damyon Wiese committed
721
722
723
724
725
726
727
            new external_single_structure(
                array(
                    'id'  => new external_value(PARAM_INT, 'Id of the course'),
                    'fullname'  => new external_value(PARAM_RAW, 'Fullname of the course'),
                    'shortname' => new external_value(PARAM_RAW, 'Shortname of the course')
                )
            ), 'Courses where the user is enrolled - limited by which courses the user is able to see', VALUE_OPTIONAL));
728
        return new external_multiple_structure(self::user_description($additionalfields));
Dongsheng Cai's avatar
Dongsheng Cai committed
729
    }
730

Dongsheng Cai's avatar
Dongsheng Cai committed
731
732
    /**
     * Returns description of method parameters
733
     *
Dongsheng Cai's avatar
Dongsheng Cai committed
734
     * @return external_function_parameters
735
     * @since Moodle 2.2
Dongsheng Cai's avatar
Dongsheng Cai committed
736
     */
737
    public static function get_course_user_profiles_parameters() {
Dongsheng Cai's avatar
Dongsheng Cai committed
738
739
740
741
742
743
744
        return new external_function_parameters(
            array(
                'userlist' => new external_multiple_structure(
                    new external_single_structure(
                        array(
                            'userid'    => new external_value(PARAM_INT, 'userid'),
                            'courseid'    => new external_value(PARAM_INT, 'courseid'),
745
                        )
Dongsheng Cai's avatar
Dongsheng Cai committed
746
                    )
Petr Skoda's avatar
Petr Skoda committed
747
                )
Dongsheng Cai's avatar
Dongsheng Cai committed
748
749
750
751
752
753
            )
        );
    }

    /**
     * Get course participant's details
754
     *
Dongsheng Cai's avatar
Dongsheng Cai committed
755
756
     * @param array $userlist  array of user ids and according course ids
     * @return array An array of arrays describing course participants
757
     * @since Moodle 2.2
Dongsheng Cai's avatar
Dongsheng Cai committed
758
     */
759
    public static function get_course_user_profiles($userlist) {
Dongsheng Cai's avatar
Dongsheng Cai committed
760
761
        global $CFG, $USER, $DB;
        require_once($CFG->dirroot . "/user/lib.php");
762
        $params = self::validate_parameters(self::get_course_user_profiles_parameters(), array('userlist'=>$userlist));
Dongsheng Cai's avatar
Dongsheng Cai committed
763
764
765
766
767
768
769
770
771
772
773
774

        $userids = array();
        $courseids = array();
        foreach ($params['userlist'] as $value) {
            $userids[] = $value['userid'];
            $courseids[$value['userid']] = $value['courseid'];
        }

        // cache all courses
        $courses = array();
        list($cselect, $cjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
        list($sqlcourseids, $params) = $DB->get_in_or_equal(array_unique($courseids));
775
        $coursesql = "SELECT c.* $cselect
Dongsheng Cai's avatar
Dongsheng Cai committed
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
                        FROM {course} c $cjoin
                       WHERE c.id $sqlcourseids";
        $rs = $DB->get_recordset_sql($coursesql, $params);
        foreach ($rs as $course) {
            // adding course contexts to cache
            context_instance_preload($course);
            // cache courses
            $courses[$course->id] = $course;
        }
        $rs->close();

        list($uselect, $ujoin) = context_instance_preload_sql('u.id', CONTEXT_USER, 'ctx');
        list($sqluserids, $params) = $DB->get_in_or_equal($userids);
        $usersql = "SELECT u.* $uselect
                      FROM {user} u $ujoin
                     WHERE u.id $sqluserids";
        $users = $DB->get_recordset_sql($usersql, $params);
        $result = array();
        foreach ($users as $user) {
            if (!empty($user->deleted)) {
                continue;
            }
            context_instance_preload($user);
            $course = $courses[$courseids[$user->id]];
800
            $context = context_course::instance($courseids[$user->id], IGNORE_MISSING);
Dongsheng Cai's avatar
Dongsheng Cai committed
801
            self::validate_context($context);
802
803
            if ($userarray = user_get_user_details($user, $course)) {
                $result[] = $userarray;
Dongsheng Cai's avatar
Dongsheng Cai committed
804
            }
805
        }
Dongsheng Cai's avatar
Dongsheng Cai committed
806

807
        $users->close();
Dongsheng Cai's avatar
Dongsheng Cai committed
808

809
810
        return $result;
    }
Dongsheng Cai's avatar
Dongsheng Cai committed
811

812
813
    /**
     * Returns description of method result value
814
     *
815
     * @return external_description
816
     * @since Moodle 2.2
817
     */
818
    public static function get_course_user_profiles_returns() {
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
        $additionalfields = array(
                    'groups' => new external_multiple_structure(
                        new external_single_structure(
                            array(
                                'id'  => new external_value(PARAM_INT, 'group id'),
                                'name' => new external_value(PARAM_RAW, 'group name'),
                                'description' => new external_value(PARAM_RAW, 'group description'),
                                'descriptionformat' => new external_format_value('description'),
                            )
                        ), 'user groups', VALUE_OPTIONAL),
                    'roles' => new external_multiple_structure(
                        new external_single_structure(
                            array(
                                'roleid'       => new external_value(PARAM_INT, 'role id'),
                                'name'         => new external_value(PARAM_RAW, 'role name'),
                                'shortname'    => new external_value(PARAM_ALPHANUMEXT, 'role shortname'),
                                'sortorder'    => new external_value(PARAM_INT, 'role sortorder')
                            )
                        ), 'user roles', VALUE_OPTIONAL),
                    'enrolledcourses' => new external_multiple_structure(
Damyon Wiese's avatar
Damyon Wiese committed
839
840
841
842
843
844
845
                        new external_single_structure(
                            array(
                                'id'  => new external_value(PARAM_INT, 'Id of the course'),
                                'fullname'  => new external_value(PARAM_RAW, 'Fullname of the course'),
                                'shortname' => new external_value(PARAM_RAW, 'Shortname of the course')
                            )
                        ), 'Courses where the user is enrolled - limited by which courses the user is able to see', VALUE_OPTIONAL)
846
847
                    );

848
        return new external_multiple_structure(self::user_description($additionalfields));
849
850
851
852
853
    }

    /**
     * Create user return value description.
     *
854
     * @param array $additionalfields some additional field
855
856
     * @return single_structure_description
     */
857
    public static function user_description($additionalfields = array()) {
858
        $userfields = array(
859
                    'id'    => new external_value(PARAM_INT, 'ID of the user'),
860
                    'username'    => new external_value(PARAM_RAW, 'The username', VALUE_OPTIONAL),
861
862
863
864
                    'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user', VALUE_OPTIONAL),
                    'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user', VALUE_OPTIONAL),
                    'fullname'    => new external_value(PARAM_NOTAGS, 'The fullname of the user'),
                    'email'       => new external_value(PARAM_TEXT, 'An email address - allow email as root@localhost', VALUE_OPTIONAL),
865
                    'address'     => new external_value(PARAM_TEXT, 'Postal address', VALUE_OPTIONAL),
866
867
868
869
870
871
872
873
874
                    'phone1'      => new external_value(PARAM_NOTAGS, 'Phone 1', VALUE_OPTIONAL),
                    'phone2'      => new external_value(PARAM_NOTAGS, 'Phone 2', VALUE_OPTIONAL),
                    'icq'         => new external_value(PARAM_NOTAGS, 'icq number', VALUE_OPTIONAL),
                    'skype'       => new external_value(PARAM_NOTAGS, 'skype id', VALUE_OPTIONAL),
                    'yahoo'       => new external_value(PARAM_NOTAGS, 'yahoo id', VALUE_OPTIONAL),
                    'aim'         => new external_value(PARAM_NOTAGS, 'aim id', VALUE_OPTIONAL),
                    'msn'         => new external_value(PARAM_NOTAGS, 'msn number', VALUE_OPTIONAL),
                    'department'  => new external_value(PARAM_TEXT, 'department', VALUE_OPTIONAL),
                    'institution' => new external_value(PARAM_TEXT, 'institution', VALUE_OPTIONAL),
875
                    'idnumber'    => new external_value(PARAM_RAW, 'An arbitrary ID code number perhaps from the institution', VALUE_OPTIONAL),
876
877
878
                    'interests'   => new external_value(PARAM_TEXT, 'user interests (separated by commas)', VALUE_OPTIONAL),
                    'firstaccess' => new external_value(PARAM_INT, 'first access to the site (0 if never)', VALUE_OPTIONAL),
                    'lastaccess'  => new external_value(PARAM_INT, 'last access to the site (0 if never)', VALUE_OPTIONAL),
879
880
881
882
883
884
                    'auth'        => new external_value(PARAM_PLUGIN, 'Auth plugins include manual, ldap, imap, etc', VALUE_OPTIONAL),
                    'confirmed'   => new external_value(PARAM_INT, 'Active user: 1 if confirmed, 0 otherwise', VALUE_OPTIONAL),
                    'lang'        => new external_value(PARAM_SAFEDIR, 'Language code such as "en", must exist on server', VALUE_OPTIONAL),
                    'theme'       => new external_value(PARAM_PLUGIN, 'Theme name such as "standard", must exist on server', VALUE_OPTIONAL),
                    'timezone'    => new external_value(PARAM_TIMEZONE, 'Timezone code such as Australia/Perth, or 99 for default', VALUE_OPTIONAL),
                    'mailformat'  => new external_value(PARAM_INT, 'Mail format code is 0 for plain text, 1 for HTML etc', VALUE_OPTIONAL),
885
                    'description' => new external_value(PARAM_RAW, 'User profile description', VALUE_OPTIONAL),
886
                    'descriptionformat' => new external_format_value('description', VALUE_OPTIONAL),
887
888
889
890
891
892
893
894
895
896
897
898
899
                    'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
                    'url'         => new external_value(PARAM_URL, 'URL of the user', VALUE_OPTIONAL),
                    'country'     => new external_value(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
                    'profileimageurlsmall' => new external_value(PARAM_URL, 'User image profile URL - small version'),
                    'profileimageurl' => new external_value(PARAM_URL, 'User image profile URL - big version'),
                    'customfields' => new external_multiple_structure(
                        new external_single_structure(
                            array(
                                'type'  => new external_value(PARAM_ALPHANUMEXT, 'The type of the custom field - text field, checkbox...'),
                                'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
                                'name' => new external_value(PARAM_RAW, 'The name of the custom field'),
                                'shortname' => new external_value(PARAM_RAW, 'The shortname of the custom field - to be able to build the field class in the code'),
                            )
900
                        ), 'User custom fields (also known as user profile fields)', VALUE_OPTIONAL),
901
902
903
904
905
906
                    'preferences' => new external_multiple_structure(
                        new external_single_structure(
                            array(
                                'name'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the preferences'),
                                'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
                            )
907
908
909
910
911
912
                    ), 'Users preferences', VALUE_OPTIONAL)
                );
        if (!empty($additionalfields)) {
            $userfields = array_merge($userfields, $additionalfields);
        }
        return new external_single_structure($userfields);
913
    }
914

915
916
}

917
918
919
920
921
922
923
924
925
 /**
 * Deprecated user external functions
 *
 * @package    core_user
 * @copyright  2009 Petr Skodak
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 * @since Moodle 2.0
 * @deprecated Moodle 2.2 MDL-29106 - Please do not use this class any more.
 * @see core_user_external
926
927
928
929
930
 */
class moodle_user_external extends external_api {

    /**
     * Returns description of method parameters
931
     *
932
     * @return external_function_parameters
933
934
935
     * @since Moodle 2.0
     * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
     * @see core_user_external::create_users_parameters()
936
937
938
939
940
941
942
     */
    public static function create_users_parameters() {
        return core_user_external::create_users_parameters();
    }

    /**
     * Create one or more users
943
     *
944
945
     * @param array $users  An array of users to create.
     * @return array An array of arrays
946
947
948
     * @since Moodle 2.0
     * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
     * @see core_user_external::create_users()
949
950
951
952
953
954
955
     */
    public static function create_users($users) {
        return core_user_external::create_users($users);
    }

   /**
     * Returns description of method result value
956
     *
957
     * @return external_description
958
959
960
     * @since Moodle 2.0
     * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
     * @see core_user_external::create_users_returns()
961
962
963
964
965
966
967
968
     */
    public static function create_users_returns() {
        return core_user_external::create_users_returns();
    }


    /**
     * Returns description of method parameters
969
     *
970
     * @return external_function_parameters
971
972
973
     * @since Moodle 2.0
     * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
     * @see core_user_external::delete_users_parameters()
974
975
976
977
978
979
980
     */
    public static function delete_users_parameters() {
        return core_user_external::delete_users_parameters();
    }

    /**
     * Delete users
981
     *
982
     * @param array $userids
Sam Hemelryk's avatar
Sam Hemelryk committed
983
     * @return null
984
985
986
     * @since Moodle 2.0
     * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
     * @see core_user_external::delete_users()
987
988
989
990
991
992
993
     */
    public static function delete_users($userids) {
        return core_user_external::delete_users($userids);
    }

   /**
     * Returns description of method result value
994
995
996
997
998
     *
     * @return null
     * @since Moodle 2.0
     * @deprecated Moodle 2.2 MDL-29106 - Please do not call this function any more.
     * @see core_user_external::delete_users_returns()
999
1000
     */
    public static function delete_users_returns() {
For faster browsing, not all history is shown. View entire blame