user/externallib.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * External user API
  20  *
  21  * @package    moodlecore
  22  * @subpackage webservice
  23  * @copyright  2009 Moodle Pty Ltd (http://moodle.com)
  24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25  */
  26
  27 require_once("$CFG->libdir/externallib.php");
  28
  29 /**
  30  * User functions
  31  */
  32 class core_user_external extends external_api {
  33
  34     /**
  35      * Returns description of method parameters
  36      * @return external_function_parameters
  37      */
  38     public static function create_users_parameters() {
  39         global $CFG;
  40
  41         return new external_function_parameters(
  42             array(
  43                 'users' => new external_multiple_structure(
  44                     new external_single_structure(
  45                         array(
  46                             'username'    => new external_value(PARAM_RAW, 'Username policy is defined in Moodle security config'),
  47                             'password'    => new external_value(PARAM_RAW, 'Plain text password consisting of any characters'),
  48                             'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user'),
  49                             'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user'),
  50                             'email'       => new external_value(PARAM_EMAIL, 'A valid and unique email address'),
  51                             'auth'        => new external_value(PARAM_PLUGIN, 'Auth plugins include manual, ldap, imap, etc', VALUE_DEFAULT, 'manual', NULL_NOT_ALLOWED),
  52                             'idnumber'    => new external_value(PARAM_RAW, 'An arbitrary ID code number perhaps from the institution', VALUE_DEFAULT, ''),
  53                             'lang'        => new external_value(PARAM_SAFEDIR, 'Language code such as "en", must exist on server', VALUE_DEFAULT, $CFG->lang, NULL_NOT_ALLOWED),
  54                             'theme'       => new external_value(PARAM_PLUGIN, 'Theme name such as "standard", must exist on server', VALUE_OPTIONAL),
  55                             'timezone'    => new external_value(PARAM_TIMEZONE, 'Timezone code such as Australia/Perth, or 99 for default', VALUE_OPTIONAL),
  56                             'mailformat'  => new external_value(PARAM_INTEGER, 'Mail format code is 0 for plain text, 1 for HTML etc', VALUE_OPTIONAL),
  57                             'description' => new external_value(PARAM_TEXT, 'User profile description, no HTML', VALUE_OPTIONAL),
  58                             'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
  59                             'country'     => new external_value(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
  60                             'preferences' => new external_multiple_structure(
  61                                 new external_single_structure(
  62                                     array(
  63                                         'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the preference'),
  64                                         'value' => new external_value(PARAM_RAW, 'The value of the preference')
  65                                     )
  66                                 ), 'User preferences', VALUE_OPTIONAL),
  67                             'customfields' => new external_multiple_structure(
  68                                 new external_single_structure(
  69                                     array(
  70                                         'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the custom field'),
  71                                         'value' => new external_value(PARAM_RAW, 'The value of the custom field')
  72                                     )
  73                                 ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL)
  74                         )
  75                     )
  76                 )
  77             )
  78         );
  79     }
  80
  81     /**
  82      * Create one or more users
  83      *
  84      * @param array $users  An array of users to create.
  85      * @return array An array of arrays
  86      */
  87     public static function create_users($users) {
  88         global $CFG, $DB;
  89         require_once($CFG->dirroot."/lib/weblib.php");
  90         require_once($CFG->dirroot."/user/lib.php");
  91         require_once($CFG->dirroot."/user/profile/lib.php"); //required for customfields related function
  92                                                              //TODO: move the functions somewhere else as
  93                                                              //they are "user" related
  94
  95         // Ensure the current user is allowed to run this function
  96         $context = get_context_instance(CONTEXT_SYSTEM);
  97         self::validate_context($context);
  98         require_capability('moodle/user:create', $context);
  99
 100         // Do basic automatic PARAM checks on incoming data, using params description
 101         // If any problems are found then exceptions are thrown with helpful error messages
 102         $params = self::validate_parameters(self::create_users_parameters(), array('users'=>$users));
 103
 104         $availableauths  = get_plugin_list('auth');
 105         unset($availableauths['mnet']);       // these would need mnethostid too
 106         unset($availableauths['webservice']); // we do not want new webservice users for now
 107
 108         $availablethemes = get_plugin_list('theme');
 109         $availablelangs  = get_string_manager()->get_list_of_translations();
 110
 111         $transaction = $DB->start_delegated_transaction();
 112
 113         $userids = array();
 114         foreach ($params['users'] as $user) {
 115             // Make sure that the username doesn't already exist
 116             if ($DB->record_exists('user', array('username'=>$user['username'], 'mnethostid'=>$CFG->mnet_localhost_id))) {
 117                 throw new invalid_parameter_exception('Username already exists: '.$user['username']);
 118             }
 119
 120             // Make sure auth is valid
 121             if (empty($availableauths[$user['auth']])) {
 122                 throw new invalid_parameter_exception('Invalid authentication type: '.$user['auth']);
 123             }
 124
 125             // Make sure lang is valid
 126             if (empty($availablelangs[$user['lang']])) {
 127                 throw new invalid_parameter_exception('Invalid language code: '.$user['lang']);
 128             }
 129
 130             // Make sure lang is valid
 131             if (!empty($user['theme']) && empty($availablethemes[$user['theme']])) { //theme is VALUE_OPTIONAL,
 132                                                                                      // so no default value.
 133                                                                                      // We need to test if the client sent it
 134                                                                                      // => !empty($user['theme'])
 135                 throw new invalid_parameter_exception('Invalid theme: '.$user['theme']);
 136             }
 137
 138             $user['confirmed'] = true;
 139             $user['mnethostid'] = $CFG->mnet_localhost_id;
 140
 141             // Start of user info validation.
 142             // Lets make sure we validate current user info as handled by current GUI. see user/editadvanced_form.php function validation()
 143             if (!validate_email($user['email'])) {
 144                 throw new invalid_parameter_exception('Email address is invalid: '.$user['email']);
 145             } else if ($DB->record_exists('user', array('email'=>$user['email'], 'mnethostid'=>$user['mnethostid']))) {
 146                 throw new invalid_parameter_exception('Email address already exists: '.$user['email']);
 147             }
 148             // End of user info validation.
 149
 150             // create the user data now!
 151             $user['id'] = user_create_user($user);
 152
 153             // custom fields
 154             if(!empty($user['customfields'])) {
 155                 foreach($user['customfields'] as $customfield) {
 156                     $user["profile_field_".$customfield['type']] = $customfield['value']; //profile_save_data() saves profile file
 157                                                                                             //it's expecting a user with the correct id,
 158                                                                                             //and custom field to be named profile_field_"shortname"
 159                 }
 160                 profile_save_data((object) $user);
 161             }
 162
 163             //preferences
 164             if (!empty($user['preferences'])) {
 165                 foreach($user['preferences'] as $preference) {
 166                     set_user_preference($preference['type'], $preference['value'],$user['id']);
 167                 }
 168             }
 169
 170             $userids[] = array('id'=>$user['id'], 'username'=>$user['username']);
 171         }
 172
 173         $transaction->allow_commit();
 174
 175         return $userids;
 176     }
 177
 178    /**
 179      * Returns description of method result value
 180      * @return external_description
 181      */
 182     public static function create_users_returns() {
 183         return new external_multiple_structure(
 184             new external_single_structure(
 185                 array(
 186                     'id'       => new external_value(PARAM_INT, 'user id'),
 187                     'username' => new external_value(PARAM_RAW, 'user name'),
 188                 )
 189             )
 190         );
 191     }
 192
 193
 194     /**
 195      * Returns description of method parameters
 196      * @return external_function_parameters
 197      */
 198     public static function delete_users_parameters() {
 199         return new external_function_parameters(
 200             array(
 201                 'userids' => new external_multiple_structure(new external_value(PARAM_INT, 'user ID')),
 202             )
 203         );
 204     }
 205
 206     /**
 207      * Delete users
 208      * @param array $userids
 209      * @return null
 210      */
 211     public static function delete_users($userids) {
 212         global $CFG, $DB, $USER;
 213         require_once($CFG->dirroot."/user/lib.php");
 214
 215         // Ensure the current user is allowed to run this function
 216         $context = get_context_instance(CONTEXT_SYSTEM);
 217         require_capability('moodle/user:delete', $context);
 218         self::validate_context($context);
 219
 220         $params = self::validate_parameters(self::delete_users_parameters(), array('userids'=>$userids));
 221
 222         $transaction = $DB->start_delegated_transaction();
 223
 224         foreach ($params['userids'] as $userid) {
 225             $user = $DB->get_record('user', array('id'=>$userid, 'deleted'=>0), '*', MUST_EXIST);
 226             // must not allow deleting of admins or self!!!
 227             if (is_siteadmin($user)) {
 228                 throw new moodle_exception('useradminodelete', 'error');
 229             }
 230             if ($USER->id == $user->id) {
 231                 throw new moodle_exception('usernotdeletederror', 'error');
 232             }
 233             user_delete_user($user);
 234         }
 235
 236         $transaction->allow_commit();
 237
 238         return null;
 239     }
 240
 241    /**
 242      * Returns description of method result value
 243      * @return external_description
 244      */
 245     public static function delete_users_returns() {
 246         return null;
 247     }
 248
 249
 250     /**
 251      * Returns description of method parameters
 252      * @return external_function_parameters
 253      */
 254     public static function update_users_parameters() {
 255         global $CFG;
 256         return new external_function_parameters(
 257             array(
 258                 'users' => new external_multiple_structure(
 259                     new external_single_structure(
 260                         array(
 261                             'id'    => new external_value(PARAM_NUMBER, 'ID of the user'),
 262                             'username'    => new external_value(PARAM_RAW, 'Username policy is defined in Moodle security config', VALUE_OPTIONAL, '',NULL_NOT_ALLOWED),
 263                             'password'    => new external_value(PARAM_RAW, 'Plain text password consisting of any characters', VALUE_OPTIONAL, '',NULL_NOT_ALLOWED),
 264                             'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user', VALUE_OPTIONAL, '',NULL_NOT_ALLOWED),
 265                             'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user', VALUE_OPTIONAL),
 266                             'email'       => new external_value(PARAM_EMAIL, 'A valid and unique email address', VALUE_OPTIONAL, '',NULL_NOT_ALLOWED),
 267                             'auth'        => new external_value(PARAM_PLUGIN, 'Auth plugins include manual, ldap, imap, etc', VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
 268                             'idnumber'    => new external_value(PARAM_RAW, 'An arbitrary ID code number perhaps from the institution', VALUE_OPTIONAL),
 269                             'lang'        => new external_value(PARAM_SAFEDIR, 'Language code such as "en", must exist on server', VALUE_OPTIONAL, '', NULL_NOT_ALLOWED),
 270                             'theme'       => new external_value(PARAM_PLUGIN, 'Theme name such as "standard", must exist on server', VALUE_OPTIONAL),
 271                             'timezone'    => new external_value(PARAM_TIMEZONE, 'Timezone code such as Australia/Perth, or 99 for default', VALUE_OPTIONAL),
 272                             'mailformat'  => new external_value(PARAM_INTEGER, 'Mail format code is 0 for plain text, 1 for HTML etc', VALUE_OPTIONAL),
 273                             'description' => new external_value(PARAM_TEXT, 'User profile description, no HTML', VALUE_OPTIONAL),
 274                             'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
 275                             'country'     => new external_value(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
 276                             'customfields' => new external_multiple_structure(
 277                                 new external_single_structure(
 278                                     array(
 279                                         'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the custom field'),
 280                                         'value' => new external_value(PARAM_RAW, 'The value of the custom field')
 281                                     )
 282                                 ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
 283                             'preferences' => new external_multiple_structure(
 284                                 new external_single_structure(
 285                                     array(
 286                                         'type'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the preference'),
 287                                         'value' => new external_value(PARAM_RAW, 'The value of the preference')
 288                                     )
 289                                 ), 'User preferences', VALUE_OPTIONAL),
 290                         )
 291                     )
 292                 )
 293             )
 294         );
 295     }
 296
 297     /**
 298      * Update users
 299      * @param array $users
 300      * @return null
 301      */
 302     public static function update_users($users) {
 303         global $CFG, $DB;
 304         require_once($CFG->dirroot."/user/lib.php");
 305         require_once($CFG->dirroot."/user/profile/lib.php"); //required for customfields related function
 306                                                              //TODO: move the functions somewhere else as
 307                                                              //they are "user" related
 308
 309         // Ensure the current user is allowed to run this function
 310         $context = get_context_instance(CONTEXT_SYSTEM);
 311         require_capability('moodle/user:update', $context);
 312         self::validate_context($context);
 313
 314         $params = self::validate_parameters(self::update_users_parameters(), array('users'=>$users));
 315
 316         $transaction = $DB->start_delegated_transaction();
 317
 318         foreach ($params['users'] as $user) {
 319             user_update_user($user);
 320             //update user custom fields
 321             if(!empty($user['customfields'])) {
 322
 323                 foreach($user['customfields'] as $customfield) {
 324                     $user["profile_field_".$customfield['type']] = $customfield['value']; //profile_save_data() saves profile file
 325                                                                                             //it's expecting a user with the correct id,
 326                                                                                             //and custom field to be named profile_field_"shortname"
 327                 }
 328                 profile_save_data((object) $user);
 329             }
 330
 331             //preferences
 332             if (!empty($user['preferences'])) {
 333                 foreach($user['preferences'] as $preference) {
 334                     set_user_preference($preference['type'], $preference['value'],$user['id']);
 335                 }
 336             }
 337         }
 338
 339         $transaction->allow_commit();
 340
 341         return null;
 342     }
 343
 344    /**
 345      * Returns description of method result value
 346      * @return external_description
 347      */
 348     public static function update_users_returns() {
 349         return null;
 350     }
 351
 352     /**
 353      * Returns description of method parameters
 354      * @return external_function_parameters
 355      */
 356     public static function get_users_by_id_parameters() {
 357         return new external_function_parameters(
 358                 array(
 359                     'userids' => new external_multiple_structure(new external_value(PARAM_INT, 'user ID')),
 360                 )
 361         );
 362     }
 363
 364     /**
 365      * Get user information
 366      * - This function is matching the permissions of /user/profil.php
 367      * - It is also matching some permissions from /user/editadvanced.php for the following fields:
 368      *   auth, confirmed, idnumber, lang, theme, timezone, mailformat
 369      * @param array $userids  array of user ids
 370      * @return array An array of arrays describing users
 371      */
 372     public static function get_users_by_id($userids) {
 373         global $CFG, $USER, $DB;
 374         require_once($CFG->dirroot . "/user/lib.php");
 375
 376         $params = self::validate_parameters(self::get_users_by_id_parameters(),
 377                 array('userids'=>$userids));
 378
 379         list($uselect, $ujoin) = context_instance_preload_sql('u.id', CONTEXT_USER, 'ctx');
 380         list($sqluserids, $params) = $DB->get_in_or_equal($userids);
 381         $usersql = "SELECT u.* $uselect
 382                       FROM {user} u $ujoin
 383                      WHERE u.id $sqluserids";
 384         $users = $DB->get_recordset_sql($usersql, $params);
 385
 386         $result = array();
 387         $hasuserupdatecap = has_capability('moodle/user:update', get_system_context());
 388         foreach ($users as $user) {
 389             if (!empty($user->deleted)) {
 390                 continue;
 391             }
 392             context_instance_preload($user);
 393             $usercontext = get_context_instance(CONTEXT_USER, $user->id);
 394             self::validate_context($usercontext);
 395             $currentuser = ($user->id == $USER->id);
 396
 397             if ($userarray  = user_get_user_details($user)) {
 398                 //fields matching permissions from /user/editadvanced.php
 399                 if ($currentuser or $hasuserupdatecap) {
 400                     $userarray['auth']       = $user->auth;
 401                     $userarray['confirmed']  = $user->confirmed;
 402                     $userarray['idnumber']   = $user->idnumber;
 403                     $userarray['lang']       = $user->lang;
 404                     $userarray['theme']      = $user->theme;
 405                     $userarray['timezone']   = $user->timezone;
 406                     $userarray['mailformat'] = $user->mailformat;
 407                 }
 408                 $result[] = $userarray;
 409             }
 410         }
 411         $users->close();
 412
 413         return $result;
 414     }
 415
 416     /**
 417      * Returns description of method result value
 418      * @return external_description
 419      */
 420     public static function get_users_by_id_returns() {
 421         return new external_multiple_structure(
 422             new external_single_structure(
 423                 array(
 424                     'id'    => new external_value(PARAM_NUMBER, 'ID of the user'),
 425                     'username'    => new external_value(PARAM_RAW, 'Username policy is defined in Moodle security config', VALUE_OPTIONAL),
 426                     'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user', VALUE_OPTIONAL),
 427                     'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user', VALUE_OPTIONAL),
 428                     'fullname'    => new external_value(PARAM_NOTAGS, 'The fullname of the user'),
 429                     'email'       => new external_value(PARAM_TEXT, 'An email address - allow email as root@localhost', VALUE_OPTIONAL),
 430                     'address'     => new external_value(PARAM_MULTILANG, 'Postal address', VALUE_OPTIONAL),
 431                     'phone1'      => new external_value(PARAM_NOTAGS, 'Phone 1', VALUE_OPTIONAL),
 432                     'phone2'      => new external_value(PARAM_NOTAGS, 'Phone 2', VALUE_OPTIONAL),
 433                     'icq'         => new external_value(PARAM_NOTAGS, 'icq number', VALUE_OPTIONAL),
 434                     'skype'       => new external_value(PARAM_NOTAGS, 'skype id', VALUE_OPTIONAL),
 435                     'yahoo'       => new external_value(PARAM_NOTAGS, 'yahoo id', VALUE_OPTIONAL),
 436                     'aim'         => new external_value(PARAM_NOTAGS, 'aim id', VALUE_OPTIONAL),
 437                     'msn'         => new external_value(PARAM_NOTAGS, 'msn number', VALUE_OPTIONAL),
 438                     'department'  => new external_value(PARAM_TEXT, 'department', VALUE_OPTIONAL),
 439                     'institution' => new external_value(PARAM_TEXT, 'institution', VALUE_OPTIONAL),
 440                     'interests'   => new external_value(PARAM_TEXT, 'user interests (separated by commas)', VALUE_OPTIONAL),
 441                     'firstaccess' => new external_value(PARAM_INT, 'first access to the site (0 if never)', VALUE_OPTIONAL),
 442                     'lastaccess'  => new external_value(PARAM_INT, 'last access to the site (0 if never)', VALUE_OPTIONAL),
 443                     'auth'        => new external_value(PARAM_PLUGIN, 'Auth plugins include manual, ldap, imap, etc', VALUE_OPTIONAL),
 444                     'confirmed'   => new external_value(PARAM_NUMBER, 'Active user: 1 if confirmed, 0 otherwise', VALUE_OPTIONAL),
 445                     'idnumber'    => new external_value(PARAM_RAW, 'An arbitrary ID code number perhaps from the institution', VALUE_OPTIONAL),
 446                     'lang'        => new external_value(PARAM_SAFEDIR, 'Language code such as "en", must exist on server', VALUE_OPTIONAL),
 447                     'theme'       => new external_value(PARAM_PLUGIN, 'Theme name such as "standard", must exist on server', VALUE_OPTIONAL),
 448                     'timezone'    => new external_value(PARAM_TIMEZONE, 'Timezone code such as Australia/Perth, or 99 for default', VALUE_OPTIONAL),
 449                     'mailformat'  => new external_value(PARAM_INTEGER, 'Mail format code is 0 for plain text, 1 for HTML etc', VALUE_OPTIONAL),
 450                     'description' => new external_value(PARAM_RAW, 'User profile description', VALUE_OPTIONAL),
 451                     'descriptionformat' => new external_value(PARAM_INT, 'User profile description format', VALUE_OPTIONAL),
 452                     'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
 453                     'url'         => new external_value(PARAM_URL, 'URL of the user', VALUE_OPTIONAL),
 454                     'country'     => new external_value(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
 455                     'profileimageurlsmall' => new external_value(PARAM_URL, 'User image profile URL - small version'),
 456                     'profileimageurl' => new external_value(PARAM_URL, 'User image profile URL - big version'),
 457                     'customfields' => new external_multiple_structure(
 458                         new external_single_structure(
 459                             array(
 460                                 'type'  => new external_value(PARAM_ALPHANUMEXT, 'The type of the custom field - text field, checkbox...'),
 461                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
 462                                 'name' => new external_value(PARAM_RAW, 'The name of the custom field'),
 463                                 'shortname' => new external_value(PARAM_RAW, 'The shortname of the custom field - to be able to build the field class in the code'),
 464                             )
 465                     ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
 466                     'preferences' => new external_multiple_structure(
 467                         new external_single_structure(
 468                             array(
 469                                 'name'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the preferences'),
 470                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
 471                             )
 472                     ), 'User preferences', VALUE_OPTIONAL),
 473                     'enrolledcourses' => new external_multiple_structure(
 474                         new external_single_structure(
 475                             array(
 476                                 'id'  => new external_value(PARAM_INT, 'Id of the course'),
 477                                 'fullname'  => new external_value(PARAM_RAW, 'Fullname of the course'),
 478                                 'shortname' => new external_value(PARAM_RAW, 'Shortname of the course')
 479                             )
 480                     ), 'Courses where the user is enrolled - limited by which courses the user is able to see', VALUE_OPTIONAL)
 481                 )
 482             )
 483         );
 484     }
 485     /**
 486      * Returns description of method parameters
 487      * @return external_function_parameters
 488      */
 489     public static function get_course_user_profiles_parameters() {
 490         return new external_function_parameters(
 491             array(
 492                 'userlist' => new external_multiple_structure(
 493                     new external_single_structure(
 494                         array(
 495                             'userid'    => new external_value(PARAM_INT, 'userid'),
 496                             'courseid'    => new external_value(PARAM_INT, 'courseid'),
 497                         )
 498                     )
 499                 )
 500             )
 501         );
 502     }
 503
 504     /**
 505      * Get course participant's details
 506      * @param array $userlist  array of user ids and according course ids
 507      * @return array An array of arrays describing course participants
 508      */
 509     public static function get_course_user_profiles($userlist) {
 510         global $CFG, $USER, $DB;
 511         require_once($CFG->dirroot . "/user/lib.php");
 512         $params = self::validate_parameters(self::get_course_user_profiles_parameters(), array('userlist'=>$userlist));
 513
 514         $userids = array();
 515         $courseids = array();
 516         foreach ($params['userlist'] as $value) {
 517             $userids[] = $value['userid'];
 518             $courseids[$value['userid']] = $value['courseid'];
 519         }
 520
 521         // cache all courses
 522         $courses = array();
 523         list($cselect, $cjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
 524         list($sqlcourseids, $params) = $DB->get_in_or_equal(array_unique($courseids));
 525         $coursesql = "SELECT c.* $cselect
 526                         FROM {course} c $cjoin
 527                        WHERE c.id $sqlcourseids";
 528         $rs = $DB->get_recordset_sql($coursesql, $params);
 529         foreach ($rs as $course) {
 530             // adding course contexts to cache
 531             context_instance_preload($course);
 532             // cache courses
 533             $courses[$course->id] = $course;
 534         }
 535         $rs->close();
 536
 537         list($uselect, $ujoin) = context_instance_preload_sql('u.id', CONTEXT_USER, 'ctx');
 538         list($sqluserids, $params) = $DB->get_in_or_equal($userids);
 539         $usersql = "SELECT u.* $uselect
 540                       FROM {user} u $ujoin
 541                      WHERE u.id $sqluserids";
 542         $users = $DB->get_recordset_sql($usersql, $params);
 543         $result = array();
 544         foreach ($users as $user) {
 545             if (!empty($user->deleted)) {
 546                 continue;
 547             }
 548             context_instance_preload($user);
 549             $course = $courses[$courseids[$user->id]];
 550             $context = get_context_instance(CONTEXT_COURSE, $courseids[$user->id]);
 551             self::validate_context($context);
 552             if ($userarray = user_get_user_details($user, $course)) {
 553                 $result[] = $userarray;
 554             }
 555         }
 556
 557         $users->close();
 558
 559         return $result;
 560     }
 561
 562     /**
 563      * Returns description of method result value
 564      * @return external_description
 565      */
 566     public static function get_course_user_profiles_returns() {
 567         return new external_multiple_structure(
 568             new external_single_structure(
 569                 array(
 570                     'id'    => new external_value(PARAM_NUMBER, 'ID of the user'),
 571                     'username'    => new external_value(PARAM_RAW, 'Username policy is defined in Moodle security config', VALUE_OPTIONAL),
 572                     'firstname'   => new external_value(PARAM_NOTAGS, 'The first name(s) of the user', VALUE_OPTIONAL),
 573                     'lastname'    => new external_value(PARAM_NOTAGS, 'The family name of the user', VALUE_OPTIONAL),
 574                     'fullname'    => new external_value(PARAM_NOTAGS, 'The fullname of the user'),
 575                     'email'       => new external_value(PARAM_TEXT, 'An email address - allow email as root@localhost', VALUE_OPTIONAL),
 576                     'address'     => new external_value(PARAM_MULTILANG, 'Postal address', VALUE_OPTIONAL),
 577                     'phone1'      => new external_value(PARAM_NOTAGS, 'Phone 1', VALUE_OPTIONAL),
 578                     'phone2'      => new external_value(PARAM_NOTAGS, 'Phone 2', VALUE_OPTIONAL),
 579                     'icq'         => new external_value(PARAM_NOTAGS, 'icq number', VALUE_OPTIONAL),
 580                     'skype'       => new external_value(PARAM_NOTAGS, 'skype id', VALUE_OPTIONAL),
 581                     'yahoo'       => new external_value(PARAM_NOTAGS, 'yahoo id', VALUE_OPTIONAL),
 582                     'aim'         => new external_value(PARAM_NOTAGS, 'aim id', VALUE_OPTIONAL),
 583                     'msn'         => new external_value(PARAM_NOTAGS, 'msn number', VALUE_OPTIONAL),
 584                     'department'  => new external_value(PARAM_TEXT, 'department', VALUE_OPTIONAL),
 585                     'institution' => new external_value(PARAM_TEXT, 'institution', VALUE_OPTIONAL),
 586                     'interests'   => new external_value(PARAM_TEXT, 'user interests (separated by commas)', VALUE_OPTIONAL),
 587                     'firstaccess' => new external_value(PARAM_INT, 'first access to the site (0 if never)', VALUE_OPTIONAL),
 588                     'lastaccess'  => new external_value(PARAM_INT, 'last access to the site (0 if never)', VALUE_OPTIONAL),
 589                     'description' => new external_value(PARAM_RAW, 'User profile description', VALUE_OPTIONAL),
 590                     'descriptionformat' => new external_value(PARAM_INT, 'User profile description format', VALUE_OPTIONAL),
 591                     'city'        => new external_value(PARAM_NOTAGS, 'Home city of the user', VALUE_OPTIONAL),
 592                     'url'         => new external_value(PARAM_URL, 'URL of the user', VALUE_OPTIONAL),
 593                     'country'     => new external_value(PARAM_ALPHA, 'Home country code of the user, such as AU or CZ', VALUE_OPTIONAL),
 594                     'profileimageurlsmall' => new external_value(PARAM_URL, 'User image profile URL - small version'),
 595                     'profileimageurl' => new external_value(PARAM_URL, 'User image profile URL - big version'),
 596                     'customfields' => new external_multiple_structure(
 597                         new external_single_structure(
 598                             array(
 599                                 'type'  => new external_value(PARAM_ALPHANUMEXT, 'The type of the custom field - text field, checkbox...'),
 600                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
 601                                 'name' => new external_value(PARAM_RAW, 'The name of the custom field'),
 602                                 'shortname' => new external_value(PARAM_RAW, 'The shortname of the custom field - to be able to build the field class in the code'),
 603                             )
 604                         ), 'User custom fields (also known as user profil fields)', VALUE_OPTIONAL),
 605                     'groups' => new external_multiple_structure(
 606                         new external_single_structure(
 607                             array(
 608                                 'id'  => new external_value(PARAM_INT, 'group id'),
 609                                 'name' => new external_value(PARAM_RAW, 'group name'),
 610                                 'description' => new external_value(PARAM_RAW, 'group description'),
 611                             )
 612                         ), 'user groups', VALUE_OPTIONAL),
 613                     'roles' => new external_multiple_structure(
 614                         new external_single_structure(
 615                             array(
 616                                 'roleid'       => new external_value(PARAM_INT, 'role id'),
 617                                 'name'         => new external_value(PARAM_RAW, 'role name'),
 618                                 'shortname'    => new external_value(PARAM_ALPHANUMEXT, 'role shortname'),
 619                                 'sortorder'    => new external_value(PARAM_INT, 'role sortorder')
 620                             )
 621                         ), 'user roles', VALUE_OPTIONAL),
 622                     'preferences' => new external_multiple_structure(
 623                         new external_single_structure(
 624                             array(
 625                                 'name'  => new external_value(PARAM_ALPHANUMEXT, 'The name of the preferences'),
 626                                 'value' => new external_value(PARAM_RAW, 'The value of the custom field'),
 627                             )
 628                     ), 'User preferences', VALUE_OPTIONAL),
 629                     'enrolledcourses' => new external_multiple_structure(
 630                         new external_single_structure(
 631                             array(
 632                                 'id'  => new external_value(PARAM_INT, 'Id of the course'),
 633                                 'fullname' => new external_value(PARAM_RAW, 'Fullname of the course'),
 634                                 'shortname' => new external_value(PARAM_RAW, 'Shortname of the course')
 635                             )
 636                     ), 'Courses where the user is enrolled - limited by which courses the user is able to see', VALUE_OPTIONAL)
 637                 )
 638             )
 639         );
 640     }
 641 }
 642
 643 /**
 644  * Deprecated user functions
 645  * @deprecated since Moodle 2.2 please use core_user_external instead
 646  */
 647 class moodle_user_external extends external_api {
 648
 649     /**
 650      * Returns description of method parameters
 651      * @deprecated since Moodle 2.2 please use core_user_external::create_users_parameters instead
 652      * @return external_function_parameters
 653      */
 654     public static function create_users_parameters() {
 655         return core_user_external::create_users_parameters();
 656     }
 657
 658     /**
 659      * Create one or more users
 660      * @deprecated since Moodle 2.2 please use core_user_external::create_users instead
 661      * @param array $users  An array of users to create.
 662      * @return array An array of arrays
 663      */
 664     public static function create_users($users) {
 665         return core_user_external::create_users($users);
 666     }
 667
 668    /**
 669      * Returns description of method result value
 670      * @deprecated since Moodle 2.2 please use core_user_external::create_users_returns instead
 671      * @return external_description
 672      */
 673     public static function create_users_returns() {
 674         return core_user_external::create_users_returns();
 675     }
 676
 677
 678     /**
 679      * Returns description of method parameters
 680      * @deprecated since Moodle 2.2 please use core_user_external::delete_users_parameters instead
 681      * @return external_function_parameters
 682      */
 683     public static function delete_users_parameters() {
 684         return core_user_external::delete_users_parameters();
 685     }
 686
 687     /**
 688      * Delete users
 689      * @deprecated since Moodle 2.2 please use core_user_external::delete_users instead
 690      * @param array $userids
 691      * @return null
 692      */
 693     public static function delete_users($userids) {
 694         return core_user_external::delete_users($userids);
 695     }
 696
 697    /**
 698      * Returns description of method result value
 699      * @deprecated since Moodle 2.2 please use core_user_external::delete_users_returns instead
 700      * @return external_description
 701      */
 702     public static function delete_users_returns() {
 703         return core_user_external::delete_users_returns();
 704     }
 705
 706
 707     /**
 708      * Returns description of method parameters
 709      * @deprecated since Moodle 2.2 please use core_user_external::update_users_parameters instead
 710      * @return external_function_parameters
 711      */
 712     public static function update_users_parameters() {
 713         return core_user_external::update_users_parameters();
 714     }
 715
 716     /**
 717      * Update users
 718      * @deprecated since Moodle 2.2 please use core_user_external::update_users instead
 719      * @param array $users
 720      * @return null
 721      */
 722     public static function update_users($users) {
 723         return core_user_external::update_users($users);
 724     }
 725
 726    /**
 727      * Returns description of method result value
 728     * @deprecated since Moodle 2.2 please use core_user_external::update_users_returns instead
 729      * @return external_description
 730      */
 731     public static function update_users_returns() {
 732         return core_user_external::update_users_returns();
 733     }
 734
 735     /**
 736      * Returns description of method parameters
 737      * @deprecated since Moodle 2.2 please use core_user_external::get_users_by_id_parameters instead
 738      * @return external_function_parameters
 739      */
 740     public static function get_users_by_id_parameters() {
 741         return core_user_external::get_users_by_id_parameters();
 742     }
 743
 744     /**
 745      * Get user information
 746      * - This function is matching the permissions of /user/profil.php
 747      * - It is also matching some permissions from /user/editadvanced.php for the following fields:
 748      *   auth, confirmed, idnumber, lang, theme, timezone, mailformat
 749      * @deprecated since Moodle 2.2 please use core_user_external::get_users_by_id instead
 750      * @param array $userids  array of user ids
 751      * @return array An array of arrays describing users
 752      */
 753     public static function get_users_by_id($userids) {
 754         return core_user_external::get_users_by_id($userids);
 755     }
 756
 757     /**
 758      * Returns description of method result value
 759      * @deprecated since Moodle 2.2 please use core_user_external::get_users_by_id_returns instead
 760      * @return external_description
 761      */
 762     public static function get_users_by_id_returns() {
 763         return core_user_external::get_users_by_id_returns();
 764     }
 765     /**
 766      * Returns description of method parameters
 767      * @deprecated since Moodle 2.2 please use core_user_external::get_course_user_profiles_parameters instead
 768      * @return external_function_parameters
 769      */
 770     public static function get_course_participants_by_id_parameters() {
 771         return core_user_external::get_course_user_profiles_parameters();
 772     }
 773
 774     /**
 775      * Get course participant's details
 776      * @deprecated since Moodle 2.2 please use core_user_external::get_course_user_profiles instead
 777      * @param array $userlist  array of user ids and according course ids
 778      * @return array An array of arrays describing course participants
 779      */
 780     public static function get_course_participants_by_id($userlist) {
 781         return core_user_external::get_course_user_profiles($userlist);
 782     }
 783
 784     /**
 785      * Returns description of method result value
 786      * @deprecated since Moodle 2.2 please use core_user_external::get_course_user_profiles_returns instead
 787      * @return external_description
 788      */
 789     public static function get_course_participants_by_id_returns() {
 790         return core_user_external::get_course_user_profiles_returns();
 791     }
 792
 793     /**
 794      * Returns description of method parameters
 795      * @deprecated since Moodle 2.2 please use core_enrol_external::get_enrolled_users_parameters instead
 796      * @return external_function_parameters
 797      */
 798     public static function get_users_by_courseid_parameters() {
 799         global $CFG;
 800         require_once($CFG->dirroot . '/enrol/externallib.php');
 801         return core_enrol_external::get_enrolled_users_parameters();
 802     }
 803
 804     /**
 805      * Get course participants details
 806      * @deprecated since Moodle 2.2 please use core_enrol_external::get_enrolled_users instead
 807      * @param int $courseid  course id
 808      * @param array $options options {
 809      *          'name' => option name
 810      *          'value' => option value
 811      * }
 812      * @return array An array of users
 813      */
 814     public static function get_users_by_courseid($courseid, $options) {
 815         global $CFG;
 816         require_once($CFG->dirroot . '/enrol/externallib.php');
 817         return core_enrol_external::get_enrolled_users($courseid, $options);
 818     }
 819     /**
 820      * Returns description of method result value
 821      * @deprecated since Moodle 2.2 please use core_enrol_external::get_enrolled_users_returns instead
 822      * @return external_description
 823      */
 824     public static function get_users_by_courseid_returns() {
 825         global $CFG;
 826         require_once($CFG->dirroot . '/enrol/externallib.php');
 827         return core_enrol_external::get_enrolled_users_returns();
 828     }
 829 }