7aafa36233fde42aa3aa021bcb2f5021b1b67039
[moodle.git] / user / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * External user API
19  *
20  * @package   core_user
21  * @copyright 2009 Moodle Pty Ltd (http://moodle.com)
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Creates a user
27  *
28  * @throws moodle_exception
29  * @param stdClass $user user to create
30  * @param bool $updatepassword if true, authentication plugin will update password.
31  * @param bool $triggerevent set false if user_created event should not be triggred.
32  *             This will not affect user_password_updated event triggering.
33  * @return int id of the newly created user
34  */
35 function user_create_user($user, $updatepassword = true, $triggerevent = true) {
36     global $DB;
38     // Set the timecreate field to the current time.
39     if (!is_object($user)) {
40         $user = (object) $user;
41     }
43     // Check username.
44     if ($user->username !== core_text::strtolower($user->username)) {
45         throw new moodle_exception('usernamelowercase');
46     } else {
47         if ($user->username !== core_user::clean_field($user->username, 'username')) {
48             throw new moodle_exception('invalidusername');
49         }
50     }
52     // Save the password in a temp value for later.
53     if ($updatepassword && isset($user->password)) {
55         // Check password toward the password policy.
56         if (!check_password_policy($user->password, $errmsg)) {
57             throw new moodle_exception($errmsg);
58         }
60         $userpassword = $user->password;
61         unset($user->password);
62     }
64     // Apply default values for user preferences that are stored in users table.
65     if (!isset($user->calendartype)) {
66         $user->calendartype = core_user::get_property_default('calendartype');
67     }
68     if (!isset($user->maildisplay)) {
69         $user->maildisplay = core_user::get_property_default('maildisplay');
70     }
71     if (!isset($user->mailformat)) {
72         $user->mailformat = core_user::get_property_default('mailformat');
73     }
74     if (!isset($user->maildigest)) {
75         $user->maildigest = core_user::get_property_default('maildigest');
76     }
77     if (!isset($user->autosubscribe)) {
78         $user->autosubscribe = core_user::get_property_default('autosubscribe');
79     }
80     if (!isset($user->trackforums)) {
81         $user->trackforums = core_user::get_property_default('trackforums');
82     }
83     if (!isset($user->lang)) {
84         $user->lang = core_user::get_property_default('lang');
85     }
87     $user->timecreated = time();
88     $user->timemodified = $user->timecreated;
90     // Validate user data object.
91     $uservalidation = core_user::validate($user);
92     if ($uservalidation !== true) {
93         foreach ($uservalidation as $field => $message) {
94             debugging("The property '$field' has invalid data and has been cleaned.", DEBUG_DEVELOPER);
95             $user->$field = core_user::clean_field($user->$field, $field);
96         }
97     }
99     // Insert the user into the database.
100     $newuserid = $DB->insert_record('user', $user);
102     // Create USER context for this user.
103     $usercontext = context_user::instance($newuserid);
105     // Update user password if necessary.
106     if (isset($userpassword)) {
107         // Get full database user row, in case auth is default.
108         $newuser = $DB->get_record('user', array('id' => $newuserid));
109         $authplugin = get_auth_plugin($newuser->auth);
110         $authplugin->user_update_password($newuser, $userpassword);
111     }
113     // Trigger event If required.
114     if ($triggerevent) {
115         \core\event\user_created::create_from_userid($newuserid)->trigger();
116     }
118     return $newuserid;
121 /**
122  * Update a user with a user object (will compare against the ID)
123  *
124  * @throws moodle_exception
125  * @param stdClass $user the user to update
126  * @param bool $updatepassword if true, authentication plugin will update password.
127  * @param bool $triggerevent set false if user_updated event should not be triggred.
128  *             This will not affect user_password_updated event triggering.
129  */
130 function user_update_user($user, $updatepassword = true, $triggerevent = true) {
131     global $DB;
133     // Set the timecreate field to the current time.
134     if (!is_object($user)) {
135         $user = (object) $user;
136     }
138     // Check username.
139     if (isset($user->username)) {
140         if ($user->username !== core_text::strtolower($user->username)) {
141             throw new moodle_exception('usernamelowercase');
142         } else {
143             if ($user->username !== core_user::clean_field($user->username, 'username')) {
144                 throw new moodle_exception('invalidusername');
145             }
146         }
147     }
149     // Unset password here, for updating later, if password update is required.
150     if ($updatepassword && isset($user->password)) {
152         // Check password toward the password policy.
153         if (!check_password_policy($user->password, $errmsg)) {
154             throw new moodle_exception($errmsg);
155         }
157         $passwd = $user->password;
158         unset($user->password);
159     }
161     // Make sure calendartype, if set, is valid.
162     if (empty($user->calendartype)) {
163         // Unset this variable, must be an empty string, which we do not want to update the calendartype to.
164         unset($user->calendartype);
165     }
167     $user->timemodified = time();
169     // Validate user data object.
170     $uservalidation = core_user::validate($user);
171     if ($uservalidation !== true) {
172         foreach ($uservalidation as $field => $message) {
173             debugging("The property '$field' has invalid data and has been cleaned.", DEBUG_DEVELOPER);
174             $user->$field = core_user::clean_field($user->$field, $field);
175         }
176     }
178     $DB->update_record('user', $user);
180     if ($updatepassword) {
181         // Get full user record.
182         $updateduser = $DB->get_record('user', array('id' => $user->id));
184         // If password was set, then update its hash.
185         if (isset($passwd)) {
186             $authplugin = get_auth_plugin($updateduser->auth);
187             if ($authplugin->can_change_password()) {
188                 $authplugin->user_update_password($updateduser, $passwd);
189             }
190         }
191     }
192     // Trigger event if required.
193     if ($triggerevent) {
194         \core\event\user_updated::create_from_userid($user->id)->trigger();
195     }
198 /**
199  * Marks user deleted in internal user database and notifies the auth plugin.
200  * Also unenrols user from all roles and does other cleanup.
201  *
202  * @todo Decide if this transaction is really needed (look for internal TODO:)
203  * @param object $user Userobject before delete    (without system magic quotes)
204  * @return boolean success
205  */
206 function user_delete_user($user) {
207     return delete_user($user);
210 /**
211  * Get users by id
212  *
213  * @param array $userids id of users to retrieve
214  * @return array
215  */
216 function user_get_users_by_id($userids) {
217     global $DB;
218     return $DB->get_records_list('user', 'id', $userids);
221 /**
222  * Returns the list of default 'displayable' fields
223  *
224  * Contains database field names but also names used to generate information, such as enrolledcourses
225  *
226  * @return array of user fields
227  */
228 function user_get_default_fields() {
229     return array( 'id', 'username', 'fullname', 'firstname', 'lastname', 'email',
230         'address', 'phone1', 'phone2', 'icq', 'skype', 'yahoo', 'aim', 'msn', 'department',
231         'institution', 'interests', 'firstaccess', 'lastaccess', 'auth', 'confirmed',
232         'idnumber', 'lang', 'theme', 'timezone', 'mailformat', 'description', 'descriptionformat',
233         'city', 'url', 'country', 'profileimageurlsmall', 'profileimageurl', 'customfields',
234         'groups', 'roles', 'preferences', 'enrolledcourses', 'suspended'
235     );
238 /**
239  *
240  * Give user record from mdl_user, build an array contains all user details.
241  *
242  * Warning: description file urls are 'webservice/pluginfile.php' is use.
243  *          it can be changed with $CFG->moodlewstextformatlinkstoimagesfile
244  *
245  * @throws moodle_exception
246  * @param stdClass $user user record from mdl_user
247  * @param stdClass $course moodle course
248  * @param array $userfields required fields
249  * @return array|null
250  */
251 function user_get_user_details($user, $course = null, array $userfields = array()) {
252     global $USER, $DB, $CFG, $PAGE;
253     require_once($CFG->dirroot . "/user/profile/lib.php"); // Custom field library.
254     require_once($CFG->dirroot . "/lib/filelib.php");      // File handling on description and friends.
256     $defaultfields = user_get_default_fields();
258     if (empty($userfields)) {
259         $userfields = $defaultfields;
260     }
262     foreach ($userfields as $thefield) {
263         if (!in_array($thefield, $defaultfields)) {
264             throw new moodle_exception('invaliduserfield', 'error', '', $thefield);
265         }
266     }
268     // Make sure id and fullname are included.
269     if (!in_array('id', $userfields)) {
270         $userfields[] = 'id';
271     }
273     if (!in_array('fullname', $userfields)) {
274         $userfields[] = 'fullname';
275     }
277     if (!empty($course)) {
278         $context = context_course::instance($course->id);
279         $usercontext = context_user::instance($user->id);
280         $canviewdetailscap = (has_capability('moodle/user:viewdetails', $context) || has_capability('moodle/user:viewdetails', $usercontext));
281     } else {
282         $context = context_user::instance($user->id);
283         $usercontext = $context;
284         $canviewdetailscap = has_capability('moodle/user:viewdetails', $usercontext);
285     }
287     $currentuser = ($user->id == $USER->id);
288     $isadmin = is_siteadmin($USER);
290     $showuseridentityfields = get_extra_user_fields($context);
292     if (!empty($course)) {
293         $canviewhiddenuserfields = has_capability('moodle/course:viewhiddenuserfields', $context);
294     } else {
295         $canviewhiddenuserfields = has_capability('moodle/user:viewhiddendetails', $context);
296     }
297     $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
298     if (!empty($course)) {
299         $canviewuseremail = has_capability('moodle/course:useremail', $context);
300     } else {
301         $canviewuseremail = false;
302     }
303     $cannotviewdescription   = !empty($CFG->profilesforenrolledusersonly) && !$currentuser && !$DB->record_exists('role_assignments', array('userid' => $user->id));
304     if (!empty($course)) {
305         $canaccessallgroups = has_capability('moodle/site:accessallgroups', $context);
306     } else {
307         $canaccessallgroups = false;
308     }
310     if (!$currentuser && !$canviewdetailscap && !has_coursecontact_role($user->id)) {
311         // Skip this user details.
312         return null;
313     }
315     $userdetails = array();
316     $userdetails['id'] = $user->id;
318     if (in_array('username', $userfields)) {
319         if ($currentuser or has_capability('moodle/user:viewalldetails', $context)) {
320             $userdetails['username'] = $user->username;
321         }
322     }
323     if ($isadmin or $canviewfullnames) {
324         if (in_array('firstname', $userfields)) {
325             $userdetails['firstname'] = $user->firstname;
326         }
327         if (in_array('lastname', $userfields)) {
328             $userdetails['lastname'] = $user->lastname;
329         }
330     }
331     $userdetails['fullname'] = fullname($user);
333     if (in_array('customfields', $userfields)) {
334         $fields = $DB->get_recordset_sql("SELECT f.*
335                                             FROM {user_info_field} f
336                                             JOIN {user_info_category} c
337                                                  ON f.categoryid=c.id
338                                         ORDER BY c.sortorder ASC, f.sortorder ASC");
339         $userdetails['customfields'] = array();
340         foreach ($fields as $field) {
341             require_once($CFG->dirroot.'/user/profile/field/'.$field->datatype.'/field.class.php');
342             $newfield = 'profile_field_'.$field->datatype;
343             $formfield = new $newfield($field->id, $user->id);
344             if ($formfield->is_visible() and !$formfield->is_empty()) {
346                 // TODO: Part of MDL-50728, this conditional coding must be moved to
347                 // proper profile fields API so they are self-contained.
348                 // We only use display_data in fields that require text formatting.
349                 if ($field->datatype == 'text' or $field->datatype == 'textarea') {
350                     $fieldvalue = $formfield->display_data();
351                 } else {
352                     // Cases: datetime, checkbox and menu.
353                     $fieldvalue = $formfield->data;
354                 }
356                 $userdetails['customfields'][] =
357                     array('name' => $formfield->field->name, 'value' => $fieldvalue,
358                         'type' => $field->datatype, 'shortname' => $formfield->field->shortname);
359             }
360         }
361         $fields->close();
362         // Unset customfields if it's empty.
363         if (empty($userdetails['customfields'])) {
364             unset($userdetails['customfields']);
365         }
366     }
368     // Profile image.
369     if (in_array('profileimageurl', $userfields)) {
370         $userpicture = new user_picture($user);
371         $userpicture->size = 1; // Size f1.
372         $userdetails['profileimageurl'] = $userpicture->get_url($PAGE)->out(false);
373     }
374     if (in_array('profileimageurlsmall', $userfields)) {
375         if (!isset($userpicture)) {
376             $userpicture = new user_picture($user);
377         }
378         $userpicture->size = 0; // Size f2.
379         $userdetails['profileimageurlsmall'] = $userpicture->get_url($PAGE)->out(false);
380     }
382     // Hidden user field.
383     if ($canviewhiddenuserfields) {
384         $hiddenfields = array();
385         // Address, phone1 and phone2 not appears in hidden fields list but require viewhiddenfields capability
386         // according to user/profile.php.
387         if (!empty($user->address) && in_array('address', $userfields)) {
388             $userdetails['address'] = $user->address;
389         }
390     } else {
391         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
392     }
394     if (!empty($user->phone1) && in_array('phone1', $userfields) &&
395             (in_array('phone1', $showuseridentityfields) or $canviewhiddenuserfields)) {
396         $userdetails['phone1'] = $user->phone1;
397     }
398     if (!empty($user->phone2) && in_array('phone2', $userfields) &&
399             (in_array('phone2', $showuseridentityfields) or $canviewhiddenuserfields)) {
400         $userdetails['phone2'] = $user->phone2;
401     }
403     if (isset($user->description) &&
404         ((!isset($hiddenfields['description']) && !$cannotviewdescription) or $isadmin)) {
405         if (in_array('description', $userfields)) {
406             // Always return the descriptionformat if description is requested.
407             list($userdetails['description'], $userdetails['descriptionformat']) =
408                     external_format_text($user->description, $user->descriptionformat,
409                             $usercontext->id, 'user', 'profile', null);
410         }
411     }
413     if (in_array('country', $userfields) && (!isset($hiddenfields['country']) or $isadmin) && $user->country) {
414         $userdetails['country'] = $user->country;
415     }
417     if (in_array('city', $userfields) && (!isset($hiddenfields['city']) or $isadmin) && $user->city) {
418         $userdetails['city'] = $user->city;
419     }
421     if (in_array('url', $userfields) && $user->url && (!isset($hiddenfields['webpage']) or $isadmin)) {
422         $url = $user->url;
423         if (strpos($user->url, '://') === false) {
424             $url = 'http://'. $url;
425         }
426         $user->url = clean_param($user->url, PARAM_URL);
427         $userdetails['url'] = $user->url;
428     }
430     if (in_array('icq', $userfields) && $user->icq && (!isset($hiddenfields['icqnumber']) or $isadmin)) {
431         $userdetails['icq'] = $user->icq;
432     }
434     if (in_array('skype', $userfields) && $user->skype && (!isset($hiddenfields['skypeid']) or $isadmin)) {
435         $userdetails['skype'] = $user->skype;
436     }
437     if (in_array('yahoo', $userfields) && $user->yahoo && (!isset($hiddenfields['yahooid']) or $isadmin)) {
438         $userdetails['yahoo'] = $user->yahoo;
439     }
440     if (in_array('aim', $userfields) && $user->aim && (!isset($hiddenfields['aimid']) or $isadmin)) {
441         $userdetails['aim'] = $user->aim;
442     }
443     if (in_array('msn', $userfields) && $user->msn && (!isset($hiddenfields['msnid']) or $isadmin)) {
444         $userdetails['msn'] = $user->msn;
445     }
446     if (in_array('suspended', $userfields) && (!isset($hiddenfields['suspended']) or $isadmin)) {
447         $userdetails['suspended'] = (bool)$user->suspended;
448     }
450     if (in_array('firstaccess', $userfields) && (!isset($hiddenfields['firstaccess']) or $isadmin)) {
451         if ($user->firstaccess) {
452             $userdetails['firstaccess'] = $user->firstaccess;
453         } else {
454             $userdetails['firstaccess'] = 0;
455         }
456     }
457     if (in_array('lastaccess', $userfields) && (!isset($hiddenfields['lastaccess']) or $isadmin)) {
458         if ($user->lastaccess) {
459             $userdetails['lastaccess'] = $user->lastaccess;
460         } else {
461             $userdetails['lastaccess'] = 0;
462         }
463     }
465     if (in_array('email', $userfields) && ($isadmin // The admin is allowed the users email.
466       or $currentuser // Of course the current user is as well.
467       or $canviewuseremail  // This is a capability in course context, it will be false in usercontext.
468       or in_array('email', $showuseridentityfields)
469       or $user->maildisplay == 1
470       or ($user->maildisplay == 2 and enrol_sharing_course($user, $USER)))) {
471         $userdetails['email'] = $user->email;
472     }
474     if (in_array('interests', $userfields)) {
475         $interests = core_tag_tag::get_item_tags_array('core', 'user', $user->id, core_tag_tag::BOTH_STANDARD_AND_NOT, 0, false);
476         if ($interests) {
477             $userdetails['interests'] = join(', ', $interests);
478         }
479     }
481     // Departement/Institution/Idnumber are not displayed on any profile, however you can get them from editing profile.
482     if (in_array('idnumber', $userfields) && $user->idnumber) {
483         if (in_array('idnumber', $showuseridentityfields) or $currentuser or
484                 has_capability('moodle/user:viewalldetails', $context)) {
485             $userdetails['idnumber'] = $user->idnumber;
486         }
487     }
488     if (in_array('institution', $userfields) && $user->institution) {
489         if (in_array('institution', $showuseridentityfields) or $currentuser or
490                 has_capability('moodle/user:viewalldetails', $context)) {
491             $userdetails['institution'] = $user->institution;
492         }
493     }
494     // Isset because it's ok to have department 0.
495     if (in_array('department', $userfields) && isset($user->department)) {
496         if (in_array('department', $showuseridentityfields) or $currentuser or
497                 has_capability('moodle/user:viewalldetails', $context)) {
498             $userdetails['department'] = $user->department;
499         }
500     }
502     if (in_array('roles', $userfields) && !empty($course)) {
503         // Not a big secret.
504         $roles = get_user_roles($context, $user->id, false);
505         $userdetails['roles'] = array();
506         foreach ($roles as $role) {
507             $userdetails['roles'][] = array(
508                 'roleid'       => $role->roleid,
509                 'name'         => $role->name,
510                 'shortname'    => $role->shortname,
511                 'sortorder'    => $role->sortorder
512             );
513         }
514     }
516     // If groups are in use and enforced throughout the course, then make sure we can meet in at least one course level group.
517     if (in_array('groups', $userfields) && !empty($course) && $canaccessallgroups) {
518         $usergroups = groups_get_all_groups($course->id, $user->id, $course->defaultgroupingid,
519                 'g.id, g.name,g.description,g.descriptionformat');
520         $userdetails['groups'] = array();
521         foreach ($usergroups as $group) {
522             list($group->description, $group->descriptionformat) =
523                 external_format_text($group->description, $group->descriptionformat,
524                         $context->id, 'group', 'description', $group->id);
525             $userdetails['groups'][] = array('id' => $group->id, 'name' => $group->name,
526                 'description' => $group->description, 'descriptionformat' => $group->descriptionformat);
527         }
528     }
529     // List of courses where the user is enrolled.
530     if (in_array('enrolledcourses', $userfields) && !isset($hiddenfields['mycourses'])) {
531         $enrolledcourses = array();
532         if ($mycourses = enrol_get_users_courses($user->id, true)) {
533             foreach ($mycourses as $mycourse) {
534                 if ($mycourse->category) {
535                     $coursecontext = context_course::instance($mycourse->id);
536                     $enrolledcourse = array();
537                     $enrolledcourse['id'] = $mycourse->id;
538                     $enrolledcourse['fullname'] = format_string($mycourse->fullname, true, array('context' => $coursecontext));
539                     $enrolledcourse['shortname'] = format_string($mycourse->shortname, true, array('context' => $coursecontext));
540                     $enrolledcourses[] = $enrolledcourse;
541                 }
542             }
543             $userdetails['enrolledcourses'] = $enrolledcourses;
544         }
545     }
547     // User preferences.
548     if (in_array('preferences', $userfields) && $currentuser) {
549         $preferences = array();
550         $userpreferences = get_user_preferences();
551         foreach ($userpreferences as $prefname => $prefvalue) {
552             $preferences[] = array('name' => $prefname, 'value' => $prefvalue);
553         }
554         $userdetails['preferences'] = $preferences;
555     }
557     if ($currentuser or has_capability('moodle/user:viewalldetails', $context)) {
558         $extrafields = ['auth', 'confirmed', 'lang', 'theme', 'timezone', 'mailformat'];
559         foreach ($extrafields as $extrafield) {
560             if (in_array($extrafield, $userfields) && isset($user->$extrafield)) {
561                 $userdetails[$extrafield] = $user->$extrafield;
562             }
563         }
564     }
566     return $userdetails;
569 /**
570  * Tries to obtain user details, either recurring directly to the user's system profile
571  * or through one of the user's course enrollments (course profile).
572  *
573  * @param stdClass $user The user.
574  * @return array if unsuccessful or the allowed user details.
575  */
576 function user_get_user_details_courses($user) {
577     global $USER;
578     $userdetails = null;
580     // Get the courses that the user is enrolled in (only active).
581     $courses = enrol_get_users_courses($user->id, true);
583     $systemprofile = false;
584     if (can_view_user_details_cap($user) || ($user->id == $USER->id) || has_coursecontact_role($user->id)) {
585         $systemprofile = true;
586     }
588     // Try using system profile.
589     if ($systemprofile) {
590         $userdetails = user_get_user_details($user, null);
591     } else {
592         // Try through course profile.
593         foreach ($courses as $course) {
594             if (can_view_user_details_cap($user, $course) || ($user->id == $USER->id) || has_coursecontact_role($user->id)) {
595                 $userdetails = user_get_user_details($user, $course);
596             }
597         }
598     }
600     return $userdetails;
603 /**
604  * Check if $USER have the necessary capabilities to obtain user details.
605  *
606  * @param stdClass $user
607  * @param stdClass $course if null then only consider system profile otherwise also consider the course's profile.
608  * @return bool true if $USER can view user details.
609  */
610 function can_view_user_details_cap($user, $course = null) {
611     // Check $USER has the capability to view the user details at user context.
612     $usercontext = context_user::instance($user->id);
613     $result = has_capability('moodle/user:viewdetails', $usercontext);
614     // Otherwise can $USER see them at course context.
615     if (!$result && !empty($course)) {
616         $context = context_course::instance($course->id);
617         $result = has_capability('moodle/user:viewdetails', $context);
618     }
619     return $result;
622 /**
623  * Return a list of page types
624  * @param string $pagetype current page type
625  * @param stdClass $parentcontext Block's parent context
626  * @param stdClass $currentcontext Current context of block
627  * @return array
628  */
629 function user_page_type_list($pagetype, $parentcontext, $currentcontext) {
630     return array('user-profile' => get_string('page-user-profile', 'pagetype'));
633 /**
634  * Count the number of failed login attempts for the given user, since last successful login.
635  *
636  * @param int|stdclass $user user id or object.
637  * @param bool $reset Resets failed login count, if set to true.
638  *
639  * @return int number of failed login attempts since the last successful login.
640  */
641 function user_count_login_failures($user, $reset = true) {
642     global $DB;
644     if (!is_object($user)) {
645         $user = $DB->get_record('user', array('id' => $user), '*', MUST_EXIST);
646     }
647     if ($user->deleted) {
648         // Deleted user, nothing to do.
649         return 0;
650     }
651     $count = get_user_preferences('login_failed_count_since_success', 0, $user);
652     if ($reset) {
653         set_user_preference('login_failed_count_since_success', 0, $user);
654     }
655     return $count;
658 /**
659  * Converts a string into a flat array of menu items, where each menu items is a
660  * stdClass with fields type, url, title, pix, and imgsrc.
661  *
662  * @param string $text the menu items definition
663  * @param moodle_page $page the current page
664  * @return array
665  */
666 function user_convert_text_to_menu_items($text, $page) {
667     global $OUTPUT, $CFG;
669     $lines = explode("\n", $text);
670     $items = array();
671     $lastchild = null;
672     $lastdepth = null;
673     $lastsort = 0;
674     $children = array();
675     foreach ($lines as $line) {
676         $line = trim($line);
677         $bits = explode('|', $line, 3);
678         $itemtype = 'link';
679         if (preg_match("/^#+$/", $line)) {
680             $itemtype = 'divider';
681         } else if (!array_key_exists(0, $bits) or empty($bits[0])) {
682             // Every item must have a name to be valid.
683             continue;
684         } else {
685             $bits[0] = ltrim($bits[0], '-');
686         }
688         // Create the child.
689         $child = new stdClass();
690         $child->itemtype = $itemtype;
691         if ($itemtype === 'divider') {
692             // Add the divider to the list of children and skip link
693             // processing.
694             $children[] = $child;
695             continue;
696         }
698         // Name processing.
699         $namebits = explode(',', $bits[0], 2);
700         if (count($namebits) == 2) {
701             // Check the validity of the identifier part of the string.
702             if (clean_param($namebits[0], PARAM_STRINGID) !== '') {
703                 // Treat this as a language string.
704                 $child->title = get_string($namebits[0], $namebits[1]);
705                 $child->titleidentifier = implode(',', $namebits);
706             }
707         }
708         if (empty($child->title)) {
709             // Use it as is, don't even clean it.
710             $child->title = $bits[0];
711             $child->titleidentifier = str_replace(" ", "-", $bits[0]);
712         }
714         // URL processing.
715         if (!array_key_exists(1, $bits) or empty($bits[1])) {
716             // Set the url to null, and set the itemtype to invalid.
717             $bits[1] = null;
718             $child->itemtype = "invalid";
719         } else {
720             // Nasty hack to replace the grades with the direct url.
721             if (strpos($bits[1], '/grade/report/mygrades.php') !== false) {
722                 $bits[1] = user_mygrades_url();
723             }
725             // Make sure the url is a moodle url.
726             $bits[1] = new moodle_url(trim($bits[1]));
727         }
728         $child->url = $bits[1];
730         // PIX processing.
731         $pixpath = "t/edit";
732         if (!array_key_exists(2, $bits) or empty($bits[2])) {
733             // Use the default.
734             $child->pix = $pixpath;
735         } else {
736             // Check for the specified image existing.
737             $pixpath = "t/" . $bits[2];
738             if ($page->theme->resolve_image_location($pixpath, 'moodle', true)) {
739                 // Use the image.
740                 $child->pix = $pixpath;
741             } else {
742                 // Treat it like a URL.
743                 $child->pix = null;
744                 $child->imgsrc = $bits[2];
745             }
746         }
748         // Add this child to the list of children.
749         $children[] = $child;
750     }
751     return $children;
754 /**
755  * Get a list of essential user navigation items.
756  *
757  * @param stdclass $user user object.
758  * @param moodle_page $page page object.
759  * @param array $options associative array.
760  *     options are:
761  *     - avatarsize=35 (size of avatar image)
762  * @return stdClass $returnobj navigation information object, where:
763  *
764  *      $returnobj->navitems    array    array of links where each link is a
765  *                                       stdClass with fields url, title, and
766  *                                       pix
767  *      $returnobj->metadata    array    array of useful user metadata to be
768  *                                       used when constructing navigation;
769  *                                       fields include:
770  *
771  *          ROLE FIELDS
772  *          asotherrole    bool    whether viewing as another role
773  *          rolename       string  name of the role
774  *
775  *          USER FIELDS
776  *          These fields are for the currently-logged in user, or for
777  *          the user that the real user is currently logged in as.
778  *
779  *          userid         int        the id of the user in question
780  *          userfullname   string     the user's full name
781  *          userprofileurl moodle_url the url of the user's profile
782  *          useravatar     string     a HTML fragment - the rendered
783  *                                    user_picture for this user
784  *          userloginfail  string     an error string denoting the number
785  *                                    of login failures since last login
786  *
787  *          "REAL USER" FIELDS
788  *          These fields are for when asotheruser is true, and
789  *          correspond to the underlying "real user".
790  *
791  *          asotheruser        bool    whether viewing as another user
792  *          realuserid         int        the id of the user in question
793  *          realuserfullname   string     the user's full name
794  *          realuserprofileurl moodle_url the url of the user's profile
795  *          realuseravatar     string     a HTML fragment - the rendered
796  *                                        user_picture for this user
797  *
798  *          MNET PROVIDER FIELDS
799  *          asmnetuser            bool   whether viewing as a user from an
800  *                                       MNet provider
801  *          mnetidprovidername    string name of the MNet provider
802  *          mnetidproviderwwwroot string URL of the MNet provider
803  */
804 function user_get_user_navigation_info($user, $page, $options = array()) {
805     global $OUTPUT, $DB, $SESSION, $CFG;
807     $returnobject = new stdClass();
808     $returnobject->navitems = array();
809     $returnobject->metadata = array();
811     $course = $page->course;
813     // Query the environment.
814     $context = context_course::instance($course->id);
816     // Get basic user metadata.
817     $returnobject->metadata['userid'] = $user->id;
818     $returnobject->metadata['userfullname'] = fullname($user, true);
819     $returnobject->metadata['userprofileurl'] = new moodle_url('/user/profile.php', array(
820         'id' => $user->id
821     ));
823     $avataroptions = array('link' => false, 'visibletoscreenreaders' => false);
824     if (!empty($options['avatarsize'])) {
825         $avataroptions['size'] = $options['avatarsize'];
826     }
827     $returnobject->metadata['useravatar'] = $OUTPUT->user_picture (
828         $user, $avataroptions
829     );
830     // Build a list of items for a regular user.
832     // Query MNet status.
833     if ($returnobject->metadata['asmnetuser'] = is_mnet_remote_user($user)) {
834         $mnetidprovider = $DB->get_record('mnet_host', array('id' => $user->mnethostid));
835         $returnobject->metadata['mnetidprovidername'] = $mnetidprovider->name;
836         $returnobject->metadata['mnetidproviderwwwroot'] = $mnetidprovider->wwwroot;
837     }
839     // Did the user just log in?
840     if (isset($SESSION->justloggedin)) {
841         // Don't unset this flag as login_info still needs it.
842         if (!empty($CFG->displayloginfailures)) {
843             // Don't reset the count either, as login_info() still needs it too.
844             if ($count = user_count_login_failures($user, false)) {
846                 // Get login failures string.
847                 $a = new stdClass();
848                 $a->attempts = html_writer::tag('span', $count, array('class' => 'value'));
849                 $returnobject->metadata['userloginfail'] =
850                     get_string('failedloginattempts', '', $a);
852             }
853         }
854     }
856     // Links: Dashboard.
857     $myhome = new stdClass();
858     $myhome->itemtype = 'link';
859     $myhome->url = new moodle_url('/my/');
860     $myhome->title = get_string('mymoodle', 'admin');
861     $myhome->titleidentifier = 'mymoodle,admin';
862     $myhome->pix = "i/dashboard";
863     $returnobject->navitems[] = $myhome;
865     // Links: My Profile.
866     $myprofile = new stdClass();
867     $myprofile->itemtype = 'link';
868     $myprofile->url = new moodle_url('/user/profile.php', array('id' => $user->id));
869     $myprofile->title = get_string('profile');
870     $myprofile->titleidentifier = 'profile,moodle';
871     $myprofile->pix = "i/user";
872     $returnobject->navitems[] = $myprofile;
874     $returnobject->metadata['asotherrole'] = false;
876     // Before we add the last items (usually a logout + switch role link), add any
877     // custom-defined items.
878     $customitems = user_convert_text_to_menu_items($CFG->customusermenuitems, $page);
879     foreach ($customitems as $item) {
880         $returnobject->navitems[] = $item;
881     }
884     if ($returnobject->metadata['asotheruser'] = \core\session\manager::is_loggedinas()) {
885         $realuser = \core\session\manager::get_realuser();
887         // Save values for the real user, as $user will be full of data for the
888         // user the user is disguised as.
889         $returnobject->metadata['realuserid'] = $realuser->id;
890         $returnobject->metadata['realuserfullname'] = fullname($realuser, true);
891         $returnobject->metadata['realuserprofileurl'] = new moodle_url('/user/profile.php', array(
892             'id' => $realuser->id
893         ));
894         $returnobject->metadata['realuseravatar'] = $OUTPUT->user_picture($realuser, $avataroptions);
896         // Build a user-revert link.
897         $userrevert = new stdClass();
898         $userrevert->itemtype = 'link';
899         $userrevert->url = new moodle_url('/course/loginas.php', array(
900             'id' => $course->id,
901             'sesskey' => sesskey()
902         ));
903         $userrevert->pix = "a/logout";
904         $userrevert->title = get_string('logout');
905         $userrevert->titleidentifier = 'logout,moodle';
906         $returnobject->navitems[] = $userrevert;
908     } else {
910         // Build a logout link.
911         $logout = new stdClass();
912         $logout->itemtype = 'link';
913         $logout->url = new moodle_url('/login/logout.php', array('sesskey' => sesskey()));
914         $logout->pix = "a/logout";
915         $logout->title = get_string('logout');
916         $logout->titleidentifier = 'logout,moodle';
917         $returnobject->navitems[] = $logout;
918     }
920     if (is_role_switched($course->id)) {
921         if ($role = $DB->get_record('role', array('id' => $user->access['rsw'][$context->path]))) {
922             // Build role-return link instead of logout link.
923             $rolereturn = new stdClass();
924             $rolereturn->itemtype = 'link';
925             $rolereturn->url = new moodle_url('/course/switchrole.php', array(
926                 'id' => $course->id,
927                 'sesskey' => sesskey(),
928                 'switchrole' => 0,
929                 'returnurl' => $page->url->out_as_local_url(false)
930             ));
931             $rolereturn->pix = "a/logout";
932             $rolereturn->title = get_string('switchrolereturn');
933             $rolereturn->titleidentifier = 'switchrolereturn,moodle';
934             $returnobject->navitems[] = $rolereturn;
936             $returnobject->metadata['asotherrole'] = true;
937             $returnobject->metadata['rolename'] = role_get_name($role, $context);
939         }
940     } else {
941         // Build switch role link.
942         $roles = get_switchable_roles($context);
943         if (is_array($roles) && (count($roles) > 0)) {
944             $switchrole = new stdClass();
945             $switchrole->itemtype = 'link';
946             $switchrole->url = new moodle_url('/course/switchrole.php', array(
947                 'id' => $course->id,
948                 'switchrole' => -1,
949                 'returnurl' => $page->url->out_as_local_url(false)
950             ));
951             $switchrole->pix = "i/switchrole";
952             $switchrole->title = get_string('switchroleto');
953             $switchrole->titleidentifier = 'switchroleto,moodle';
954             $returnobject->navitems[] = $switchrole;
955         }
956     }
958     return $returnobject;
961 /**
962  * Add password to the list of used hashes for this user.
963  *
964  * This is supposed to be used from:
965  *  1/ change own password form
966  *  2/ password reset process
967  *  3/ user signup in auth plugins if password changing supported
968  *
969  * @param int $userid user id
970  * @param string $password plaintext password
971  * @return void
972  */
973 function user_add_password_history($userid, $password) {
974     global $CFG, $DB;
976     if (empty($CFG->passwordreuselimit) or $CFG->passwordreuselimit < 0) {
977         return;
978     }
980     // Note: this is using separate code form normal password hashing because
981     //       we need to have this under control in the future. Also the auth
982     //       plugin might not store the passwords locally at all.
984     $record = new stdClass();
985     $record->userid = $userid;
986     $record->hash = password_hash($password, PASSWORD_DEFAULT);
987     $record->timecreated = time();
988     $DB->insert_record('user_password_history', $record);
990     $i = 0;
991     $records = $DB->get_records('user_password_history', array('userid' => $userid), 'timecreated DESC, id DESC');
992     foreach ($records as $record) {
993         $i++;
994         if ($i > $CFG->passwordreuselimit) {
995             $DB->delete_records('user_password_history', array('id' => $record->id));
996         }
997     }
1000 /**
1001  * Was this password used before on change or reset password page?
1002  *
1003  * The $CFG->passwordreuselimit setting determines
1004  * how many times different password needs to be used
1005  * before allowing previously used password again.
1006  *
1007  * @param int $userid user id
1008  * @param string $password plaintext password
1009  * @return bool true if password reused
1010  */
1011 function user_is_previously_used_password($userid, $password) {
1012     global $CFG, $DB;
1014     if (empty($CFG->passwordreuselimit) or $CFG->passwordreuselimit < 0) {
1015         return false;
1016     }
1018     $reused = false;
1020     $i = 0;
1021     $records = $DB->get_records('user_password_history', array('userid' => $userid), 'timecreated DESC, id DESC');
1022     foreach ($records as $record) {
1023         $i++;
1024         if ($i > $CFG->passwordreuselimit) {
1025             $DB->delete_records('user_password_history', array('id' => $record->id));
1026             continue;
1027         }
1028         // NOTE: this is slow but we cannot compare the hashes directly any more.
1029         if (password_verify($password, $record->hash)) {
1030             $reused = true;
1031         }
1032     }
1034     return $reused;
1037 /**
1038  * Remove a user device from the Moodle database (for PUSH notifications usually).
1039  *
1040  * @param string $uuid The device UUID.
1041  * @param string $appid The app id. If empty all the devices matching the UUID for the user will be removed.
1042  * @return bool true if removed, false if the device didn't exists in the database
1043  * @since Moodle 2.9
1044  */
1045 function user_remove_user_device($uuid, $appid = "") {
1046     global $DB, $USER;
1048     $conditions = array('uuid' => $uuid, 'userid' => $USER->id);
1049     if (!empty($appid)) {
1050         $conditions['appid'] = $appid;
1051     }
1053     if (!$DB->count_records('user_devices', $conditions)) {
1054         return false;
1055     }
1057     $DB->delete_records('user_devices', $conditions);
1059     return true;
1062 /**
1063  * Trigger user_list_viewed event.
1064  *
1065  * @param stdClass  $course course  object
1066  * @param stdClass  $context course context object
1067  * @since Moodle 2.9
1068  */
1069 function user_list_view($course, $context) {
1071     $event = \core\event\user_list_viewed::create(array(
1072         'objectid' => $course->id,
1073         'courseid' => $course->id,
1074         'context' => $context,
1075         'other' => array(
1076             'courseshortname' => $course->shortname,
1077             'coursefullname' => $course->fullname
1078         )
1079     ));
1080     $event->trigger();
1083 /**
1084  * Returns the url to use for the "Grades" link in the user navigation.
1085  *
1086  * @param int $userid The user's ID.
1087  * @param int $courseid The course ID if available.
1088  * @return mixed A URL to be directed to for "Grades".
1089  */
1090 function user_mygrades_url($userid = null, $courseid = SITEID) {
1091     global $CFG, $USER;
1092     $url = null;
1093     if (isset($CFG->grade_mygrades_report) && $CFG->grade_mygrades_report != 'external') {
1094         if (isset($userid) && $USER->id != $userid) {
1095             // Send to the gradebook report.
1096             $url = new moodle_url('/grade/report/' . $CFG->grade_mygrades_report . '/index.php',
1097                     array('id' => $courseid, 'userid' => $userid));
1098         } else {
1099             $url = new moodle_url('/grade/report/' . $CFG->grade_mygrades_report . '/index.php');
1100         }
1101     } else if (isset($CFG->grade_mygrades_report) && $CFG->grade_mygrades_report == 'external'
1102             && !empty($CFG->gradereport_mygradeurl)) {
1103         $url = $CFG->gradereport_mygradeurl;
1104     } else {
1105         $url = $CFG->wwwroot;
1106     }
1107     return $url;
1110 /**
1111  * Check if a user has the permission to viewdetails in a shared course's context.
1112  *
1113  * @param object $user The other user's details.
1114  * @param object $course Use this course to see if we have permission to see this user's profile.
1115  * @param context $usercontext The user context if available.
1116  * @return bool true for ability to view this user, else false.
1117  */
1118 function user_can_view_profile($user, $course = null, $usercontext = null) {
1119     global $USER, $CFG;
1121     if ($user->deleted) {
1122         return false;
1123     }
1125     // Perform some quick checks and eventually return early.
1127     // Number 1.
1128     if (empty($CFG->forceloginforprofiles)) {
1129         return true;
1130     } else {
1131        if (!isloggedin() || isguestuser()) {
1132             // User is not logged in and forceloginforprofile is set, we need to return now.
1133             return false;
1134         }
1135     }
1137     // Number 2.
1138     if ($USER->id == $user->id) {
1139         return true;
1140     }
1142     if (empty($usercontext)) {
1143         $usercontext = context_user::instance($user->id);
1144     }
1145     // Number 3.
1146     if (has_capability('moodle/user:viewdetails', $usercontext) || has_capability('moodle/user:viewalldetails', $usercontext)) {
1147         return true;
1148     }
1150     // Number 4.
1151     if (has_coursecontact_role($user->id)) {
1152         return true;
1153     }
1155     if (isset($course)) {
1156         $userscourses = array($course);
1157     } else {
1158         // This returns context information, so we can preload below.
1159         $userscourses = enrol_get_all_users_courses($user->id);
1160     }
1162     if (empty($userscourses)) {
1163         return false;
1164     }
1166     foreach ($userscourses as $userscourse) {
1167         context_helper::preload_from_record($userscourse);
1168         $coursecontext = context_course::instance($userscourse->id);
1169         if (has_capability('moodle/user:viewdetails', $coursecontext)) {
1170             if (!groups_user_groups_visible($userscourse, $user->id)) {
1171                 // Not a member of the same group.
1172                 continue;
1173             }
1174             return true;
1175         }
1176     }
1177     return false;
1180 /**
1181  * Returns users tagged with a specified tag.
1182  *
1183  * @param core_tag_tag $tag
1184  * @param bool $exclusivemode if set to true it means that no other entities tagged with this tag
1185  *             are displayed on the page and the per-page limit may be bigger
1186  * @param int $fromctx context id where the link was displayed, may be used by callbacks
1187  *            to display items in the same context first
1188  * @param int $ctx context id where to search for records
1189  * @param bool $rec search in subcontexts as well
1190  * @param int $page 0-based number of page being displayed
1191  * @return \core_tag\output\tagindex
1192  */
1193 function user_get_tagged_users($tag, $exclusivemode = false, $fromctx = 0, $ctx = 0, $rec = 1, $page = 0) {
1194     global $PAGE;
1196     if ($ctx && $ctx != context_system::instance()->id) {
1197         $usercount = 0;
1198     } else {
1199         // Users can only be displayed in system context.
1200         $usercount = $tag->count_tagged_items('core', 'user',
1201                 'it.deleted=:notdeleted', array('notdeleted' => 0));
1202     }
1203     $perpage = $exclusivemode ? 24 : 5;
1204     $content = '';
1205     $totalpages = ceil($usercount / $perpage);
1207     if ($usercount) {
1208         $userlist = $tag->get_tagged_items('core', 'user', $page * $perpage, $perpage,
1209                 'it.deleted=:notdeleted', array('notdeleted' => 0));
1210         $renderer = $PAGE->get_renderer('core', 'user');
1211         $content .= $renderer->user_list($userlist, $exclusivemode);
1212     }
1214     return new core_tag\output\tagindex($tag, 'core', 'user', $content,
1215             $exclusivemode, $fromctx, $ctx, $rec, $page, $totalpages);
1218 /**
1219  * Returns the SQL used by the participants table.
1220  *
1221  * @param int $courseid The course id
1222  * @param int $groupid The groupid, 0 means all groups
1223  * @param int $accesssince The time since last access, 0 means any time
1224  * @param int $roleid The role id, 0 means all roles
1225  * @param int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
1226  * @param int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
1227  * @param string|array $search The search that was performed, empty means perform no search
1228  * @param string $additionalwhere Any additional SQL to add to where
1229  * @param array $additionalparams The additional params
1230  * @return array
1231  */
1232 function user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,
1233                                    $search = '', $additionalwhere = '', $additionalparams = array()) {
1234     global $DB;
1236     // Get the context.
1237     $context = \context_course::instance($courseid, MUST_EXIST);
1239     $isfrontpage = ($courseid == SITEID);
1241     // Default filter settings. We only show active by default, especially if the user has no capability to review enrolments.
1242     $onlyactive = true;
1243     $onlysuspended = false;
1244     if (has_capability('moodle/course:enrolreview', $context)) {
1245         switch ($statusid) {
1246             case ENROL_USER_ACTIVE:
1247                 // Nothing to do here.
1248                 break;
1249             case ENROL_USER_SUSPENDED:
1250                 $onlyactive = false;
1251                 $onlysuspended = true;
1252                 break;
1253             default:
1254                 // If the user has capability to review user enrolments, but statusid is set to -1, set $onlyactive to false.
1255                 $onlyactive = false;
1256                 break;
1257         }
1258     }
1260     list($esql, $params) = get_enrolled_sql($context, null, $groupid, $onlyactive, $onlysuspended, $enrolid);
1262     $joins = array('FROM {user} u');
1263     $wheres = array();
1265     $userfields = get_extra_user_fields($context, array('username', 'lang', 'timezone', 'maildisplay'));
1266     $userfieldssql = user_picture::fields('u', $userfields);
1268     if ($isfrontpage) {
1269         $select = "SELECT $userfieldssql, u.lastaccess";
1270         $joins[] = "JOIN ($esql) e ON e.id = u.id"; // Everybody on the frontpage usually.
1271         if ($accesssince) {
1272             $wheres[] = user_get_user_lastaccess_sql($accesssince);
1273         }
1274     } else {
1275         $select = "SELECT $userfieldssql, COALESCE(ul.timeaccess, 0) AS lastaccess";
1276         $joins[] = "JOIN ($esql) e ON e.id = u.id"; // Course enrolled users only.
1277         // Not everybody has accessed the course yet.
1278         $joins[] = 'LEFT JOIN {user_lastaccess} ul ON (ul.userid = u.id AND ul.courseid = :courseid)';
1279         $params['courseid'] = $courseid;
1280         if ($accesssince) {
1281             $wheres[] = user_get_course_lastaccess_sql($accesssince);
1282         }
1283     }
1285     // Performance hacks - we preload user contexts together with accounts.
1286     $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1287     $ccjoin = 'LEFT JOIN {context} ctx ON (ctx.instanceid = u.id AND ctx.contextlevel = :contextlevel)';
1288     $params['contextlevel'] = CONTEXT_USER;
1289     $select .= $ccselect;
1290     $joins[] = $ccjoin;
1292     // Limit list to users with some role only.
1293     if ($roleid) {
1294         // We want to query both the current context and parent contexts.
1295         list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true),
1296             SQL_PARAMS_NAMED, 'relatedctx');
1298         $wheres[] = "u.id IN (SELECT userid FROM {role_assignments} WHERE roleid = :roleid AND contextid $relatedctxsql)";
1299         $params = array_merge($params, array('roleid' => $roleid), $relatedctxparams);
1300     }
1302     if (!empty($search)) {
1303         if (!is_array($search)) {
1304             $search = [$search];
1305         }
1306         foreach ($search as $index => $keyword) {
1307             $searchkey1 = 'search' . $index . '1';
1308             $searchkey2 = 'search' . $index . '2';
1309             $searchkey3 = 'search' . $index . '3';
1310             $fullname = $DB->sql_fullname('u.firstname', 'u.lastname');
1311             $wheres[] = '(' . $DB->sql_like($fullname, ':' . $searchkey1, false, false) .
1312                 ' OR ' . $DB->sql_like('email', ':' . $searchkey2, false, false) .
1313                 ' OR ' . $DB->sql_like('idnumber', ':' . $searchkey3, false, false) . ') ';
1314             $params[$searchkey1] = "%$keyword%";
1315             $params[$searchkey2] = "%$keyword%";
1316             $params[$searchkey3] = "%$keyword%";
1317         }
1318     }
1320     if (!empty($additionalwhere)) {
1321         $wheres[] = $additionalwhere;
1322         $params = array_merge($params, $additionalparams);
1323     }
1325     $from = implode("\n", $joins);
1326     if ($wheres) {
1327         $where = 'WHERE ' . implode(' AND ', $wheres);
1328     } else {
1329         $where = '';
1330     }
1332     return array($select, $from, $where, $params);
1335 /**
1336  * Returns the total number of participants for a given course.
1337  *
1338  * @param int $courseid The course id
1339  * @param int $groupid The groupid, 0 means all groups
1340  * @param int $accesssince The time since last access, 0 means any time
1341  * @param int $roleid The role id, 0 means all roles
1342  * @param int $enrolid The applied filter for the user enrolment ID.
1343  * @param int $status The applied filter for the user's enrolment status.
1344  * @param string|array $search The search that was performed, empty means perform no search
1345  * @param string $additionalwhere Any additional SQL to add to where
1346  * @param array $additionalparams The additional params
1347  * @return int
1348  */
1349 function user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,
1350                                      $search = '', $additionalwhere = '', $additionalparams = array()) {
1351     global $DB;
1353     list($select, $from, $where, $params) = user_get_participants_sql($courseid, $groupid, $accesssince, $roleid, $enrolid,
1354         $statusid, $search, $additionalwhere, $additionalparams);
1356     return $DB->count_records_sql("SELECT COUNT(u.id) $from $where", $params);
1359 /**
1360  * Returns the participants for a given course.
1361  *
1362  * @param int $courseid The course id
1363  * @param int $groupid The group id
1364  * @param int $accesssince The time since last access
1365  * @param int $roleid The role id
1366  * @param int $enrolid The applied filter for the user enrolment ID.
1367  * @param int $status The applied filter for the user's enrolment status.
1368  * @param string $search The search that was performed
1369  * @param string $additionalwhere Any additional SQL to add to where
1370  * @param array $additionalparams The additional params
1371  * @param string $sort The SQL sort
1372  * @param int $limitfrom return a subset of records, starting at this point (optional).
1373  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
1374  * @return moodle_recordset
1375  */
1376 function user_get_participants($courseid, $groupid = 0, $accesssince, $roleid, $enrolid = 0, $statusid, $search,
1377                                $additionalwhere = '', $additionalparams = array(), $sort = '', $limitfrom = 0, $limitnum = 0) {
1378     global $DB;
1380     list($select, $from, $where, $params) = user_get_participants_sql($courseid, $groupid, $accesssince, $roleid, $enrolid,
1381         $statusid, $search, $additionalwhere, $additionalparams);
1383     return $DB->get_recordset_sql("$select $from $where $sort", $params, $limitfrom, $limitnum);
1386 /**
1387  * Returns SQL that can be used to limit a query to a period where the user last accessed a course.
1388  *
1389  * @param int $accesssince The time since last access
1390  * @param string $tableprefix
1391  * @return string
1392  */
1393 function user_get_course_lastaccess_sql($accesssince = null, $tableprefix = 'ul') {
1394     if (empty($accesssince)) {
1395         return '';
1396     }
1398     if ($accesssince == -1) { // Never.
1399         return $tableprefix . '.timeaccess = 0';
1400     } else {
1401         return $tableprefix . '.timeaccess != 0 AND ul.timeaccess < ' . $accesssince;
1402     }
1405 /**
1406  * Returns SQL that can be used to limit a query to a period where the user last accessed the system.
1407  *
1408  * @param int $accesssince The time since last access
1409  * @param string $tableprefix
1410  * @return string
1411  */
1412 function user_get_user_lastaccess_sql($accesssince = null, $tableprefix = 'u') {
1413     if (empty($accesssince)) {
1414         return '';
1415     }
1417     if ($accesssince == -1) { // Never.
1418         return $tableprefix . '.lastaccess = 0';
1419     } else {
1420         return $tableprefix . '.lastaccess != 0 AND u.lastaccess < ' . $accesssince;
1421     }
1424 /**
1425  * Callback for inplace editable API.
1426  *
1427  * @param string $itemtype - Only user_roles is supported.
1428  * @param string $itemid - Courseid and userid separated by a :
1429  * @param string $newvalue - json encoded list of roleids.
1430  * @return \core\output\inplace_editable
1431  */
1432 function core_user_inplace_editable($itemtype, $itemid, $newvalue) {
1433     if ($itemtype === 'user_roles') {
1434         return \core_user\output\user_roles_editable::update($itemid, $newvalue);
1435     }