MDL-50130 todo: Conditional code to be changed to API by MDL-50728
[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  */
26 /**
27  * Creates a user
28  *
29  * @throws moodle_exception
30  * @param stdClass $user user to create
31  * @param bool $updatepassword if true, authentication plugin will update password.
32  * @param bool $triggerevent set false if user_created event should not be triggred.
33  *             This will not affect user_password_updated event triggering.
34  * @return int id of the newly created user
35  */
36 function user_create_user($user, $updatepassword = true, $triggerevent = true) {
37     global $CFG, $DB;
39     // Set the timecreate field to the current time.
40     if (!is_object($user)) {
41         $user = (object) $user;
42     }
44     // Check username.
45     if ($user->username !== core_text::strtolower($user->username)) {
46         throw new moodle_exception('usernamelowercase');
47     } else {
48         if ($user->username !== clean_param($user->username, PARAM_USERNAME)) {
49             throw new moodle_exception('invalidusername');
50         }
51     }
53     // Save the password in a temp value for later.
54     if ($updatepassword && isset($user->password)) {
56         // Check password toward the password policy.
57         if (!check_password_policy($user->password, $errmsg)) {
58             throw new moodle_exception($errmsg);
59         }
61         $userpassword = $user->password;
62         unset($user->password);
63     }
65     // Make sure calendartype, if set, is valid.
66     if (!empty($user->calendartype)) {
67         $availablecalendartypes = \core_calendar\type_factory::get_list_of_calendar_types();
68         if (empty($availablecalendartypes[$user->calendartype])) {
69             $user->calendartype = $CFG->calendartype;
70         }
71     } else {
72         $user->calendartype = $CFG->calendartype;
73     }
75     // Apply default values for user preferences that are stored in users table.
76     if (!isset($user->maildisplay)) {
77         $user->maildisplay = $CFG->defaultpreference_maildisplay;
78     }
79     if (!isset($user->mailformat)) {
80         $user->mailformat = $CFG->defaultpreference_mailformat;
81     }
82     if (!isset($user->maildigest)) {
83         $user->maildigest = $CFG->defaultpreference_maildigest;
84     }
85     if (!isset($user->autosubscribe)) {
86         $user->autosubscribe = $CFG->defaultpreference_autosubscribe;
87     }
88     if (!isset($user->trackforums)) {
89         $user->trackforums = $CFG->defaultpreference_trackforums;
90     }
91     if (!isset($user->lang)) {
92         $user->lang = $CFG->lang;
93     }
95     $user->timecreated = time();
96     $user->timemodified = $user->timecreated;
98     // Insert the user into the database.
99     $newuserid = $DB->insert_record('user', $user);
101     // Create USER context for this user.
102     $usercontext = context_user::instance($newuserid);
104     // Update user password if necessary.
105     if (isset($userpassword)) {
106         // Get full database user row, in case auth is default.
107         $newuser = $DB->get_record('user', array('id' => $newuserid));
108         $authplugin = get_auth_plugin($newuser->auth);
109         $authplugin->user_update_password($newuser, $userpassword);
110     }
112     // Trigger event If required.
113     if ($triggerevent) {
114         \core\event\user_created::create_from_userid($newuserid)->trigger();
115     }
117     return $newuserid;
120 /**
121  * Update a user with a user object (will compare against the ID)
122  *
123  * @throws moodle_exception
124  * @param stdClass $user the user to update
125  * @param bool $updatepassword if true, authentication plugin will update password.
126  * @param bool $triggerevent set false if user_updated event should not be triggred.
127  *             This will not affect user_password_updated event triggering.
128  */
129 function user_update_user($user, $updatepassword = true, $triggerevent = true) {
130     global $DB;
132     // Set the timecreate field to the current time.
133     if (!is_object($user)) {
134         $user = (object) $user;
135     }
137     // Check username.
138     if (isset($user->username)) {
139         if ($user->username !== core_text::strtolower($user->username)) {
140             throw new moodle_exception('usernamelowercase');
141         } else {
142             if ($user->username !== clean_param($user->username, PARAM_USERNAME)) {
143                 throw new moodle_exception('invalidusername');
144             }
145         }
146     }
148     // Unset password here, for updating later, if password update is required.
149     if ($updatepassword && isset($user->password)) {
151         // Check password toward the password policy.
152         if (!check_password_policy($user->password, $errmsg)) {
153             throw new moodle_exception($errmsg);
154         }
156         $passwd = $user->password;
157         unset($user->password);
158     }
160     // Make sure calendartype, if set, is valid.
161     if (!empty($user->calendartype)) {
162         $availablecalendartypes = \core_calendar\type_factory::get_list_of_calendar_types();
163         // If it doesn't exist, then unset this value, we do not want to update the user's value.
164         if (empty($availablecalendartypes[$user->calendartype])) {
165             unset($user->calendartype);
166         }
167     } else {
168         // Unset this variable, must be an empty string, which we do not want to update the calendartype to.
169         unset($user->calendartype);
170     }
172     $user->timemodified = time();
173     $DB->update_record('user', $user);
175     if ($updatepassword) {
176         // Get full user record.
177         $updateduser = $DB->get_record('user', array('id' => $user->id));
179         // If password was set, then update its hash.
180         if (isset($passwd)) {
181             $authplugin = get_auth_plugin($updateduser->auth);
182             if ($authplugin->can_change_password()) {
183                 $authplugin->user_update_password($updateduser, $passwd);
184             }
185         }
186     }
187     // Trigger event if required.
188     if ($triggerevent) {
189         \core\event\user_updated::create_from_userid($user->id)->trigger();
190     }
193 /**
194  * Marks user deleted in internal user database and notifies the auth plugin.
195  * Also unenrols user from all roles and does other cleanup.
196  *
197  * @todo Decide if this transaction is really needed (look for internal TODO:)
198  * @param object $user Userobject before delete    (without system magic quotes)
199  * @return boolean success
200  */
201 function user_delete_user($user) {
202     return delete_user($user);
205 /**
206  * Get users by id
207  *
208  * @param array $userids id of users to retrieve
209  * @return array
210  */
211 function user_get_users_by_id($userids) {
212     global $DB;
213     return $DB->get_records_list('user', 'id', $userids);
216 /**
217  * Returns the list of default 'displayable' fields
218  *
219  * Contains database field names but also names used to generate information, such as enrolledcourses
220  *
221  * @return array of user fields
222  */
223 function user_get_default_fields() {
224     return array( 'id', 'username', 'fullname', 'firstname', 'lastname', 'email',
225         'address', 'phone1', 'phone2', 'icq', 'skype', 'yahoo', 'aim', 'msn', 'department',
226         'institution', 'interests', 'firstaccess', 'lastaccess', 'auth', 'confirmed',
227         'idnumber', 'lang', 'theme', 'timezone', 'mailformat', 'description', 'descriptionformat',
228         'city', 'url', 'country', 'profileimageurlsmall', 'profileimageurl', 'customfields',
229         'groups', 'roles', 'preferences', 'enrolledcourses'
230     );
233 /**
234  *
235  * Give user record from mdl_user, build an array contains all user details.
236  *
237  * Warning: description file urls are 'webservice/pluginfile.php' is use.
238  *          it can be changed with $CFG->moodlewstextformatlinkstoimagesfile
239  *
240  * @throws moodle_exception
241  * @param stdClass $user user record from mdl_user
242  * @param stdClass $course moodle course
243  * @param array $userfields required fields
244  * @return array|null
245  */
246 function user_get_user_details($user, $course = null, array $userfields = array()) {
247     global $USER, $DB, $CFG;
248     require_once($CFG->dirroot . "/user/profile/lib.php"); // Custom field library.
249     require_once($CFG->dirroot . "/lib/filelib.php");      // File handling on description and friends.
251     $defaultfields = user_get_default_fields();
253     if (empty($userfields)) {
254         $userfields = $defaultfields;
255     }
257     foreach ($userfields as $thefield) {
258         if (!in_array($thefield, $defaultfields)) {
259             throw new moodle_exception('invaliduserfield', 'error', '', $thefield);
260         }
261     }
263     // Make sure id and fullname are included.
264     if (!in_array('id', $userfields)) {
265         $userfields[] = 'id';
266     }
268     if (!in_array('fullname', $userfields)) {
269         $userfields[] = 'fullname';
270     }
272     if (!empty($course)) {
273         $context = context_course::instance($course->id);
274         $usercontext = context_user::instance($user->id);
275         $canviewdetailscap = (has_capability('moodle/user:viewdetails', $context) || has_capability('moodle/user:viewdetails', $usercontext));
276     } else {
277         $context = context_user::instance($user->id);
278         $usercontext = $context;
279         $canviewdetailscap = has_capability('moodle/user:viewdetails', $usercontext);
280     }
282     $currentuser = ($user->id == $USER->id);
283     $isadmin = is_siteadmin($USER);
285     $showuseridentityfields = get_extra_user_fields($context);
287     if (!empty($course)) {
288         $canviewhiddenuserfields = has_capability('moodle/course:viewhiddenuserfields', $context);
289     } else {
290         $canviewhiddenuserfields = has_capability('moodle/user:viewhiddendetails', $context);
291     }
292     $canviewfullnames = has_capability('moodle/site:viewfullnames', $context);
293     if (!empty($course)) {
294         $canviewuseremail = has_capability('moodle/course:useremail', $context);
295     } else {
296         $canviewuseremail = false;
297     }
298     $cannotviewdescription   = !empty($CFG->profilesforenrolledusersonly) && !$currentuser && !$DB->record_exists('role_assignments', array('userid' => $user->id));
299     if (!empty($course)) {
300         $canaccessallgroups = has_capability('moodle/site:accessallgroups', $context);
301     } else {
302         $canaccessallgroups = false;
303     }
305     if (!$currentuser && !$canviewdetailscap && !has_coursecontact_role($user->id)) {
306         // Skip this user details.
307         return null;
308     }
310     $userdetails = array();
311     $userdetails['id'] = $user->id;
313     if (($isadmin or $currentuser) and in_array('username', $userfields)) {
314         $userdetails['username'] = $user->username;
315     }
316     if ($isadmin or $canviewfullnames) {
317         if (in_array('firstname', $userfields)) {
318             $userdetails['firstname'] = $user->firstname;
319         }
320         if (in_array('lastname', $userfields)) {
321             $userdetails['lastname'] = $user->lastname;
322         }
323     }
324     $userdetails['fullname'] = fullname($user);
326     if (in_array('customfields', $userfields)) {
327         $fields = $DB->get_recordset_sql("SELECT f.*
328                                             FROM {user_info_field} f
329                                             JOIN {user_info_category} c
330                                                  ON f.categoryid=c.id
331                                         ORDER BY c.sortorder ASC, f.sortorder ASC");
332         $userdetails['customfields'] = array();
333         foreach ($fields as $field) {
334             require_once($CFG->dirroot.'/user/profile/field/'.$field->datatype.'/field.class.php');
335             $newfield = 'profile_field_'.$field->datatype;
336             $formfield = new $newfield($field->id, $user->id);
337             if ($formfield->is_visible() and !$formfield->is_empty()) {
339                 // TODO: Part of MDL-50728, this conditional coding must be moved to
340                 // proper profile fields API so they are self-contained.
341                 // We only use display_data in fields that require text formatting.
342                 if ($field->datatype == 'text' or $field->datatype == 'textarea') {
343                     $fieldvalue = $formfield->display_data();
344                 } else {
345                     // Cases: datetime, checkbox and menu.
346                     $fieldvalue = $formfield->data;
347                 }
349                 $userdetails['customfields'][] =
350                     array('name' => $formfield->field->name, 'value' => $fieldvalue,
351                         'type' => $field->datatype, 'shortname' => $formfield->field->shortname);
352             }
353         }
354         $fields->close();
355         // Unset customfields if it's empty.
356         if (empty($userdetails['customfields'])) {
357             unset($userdetails['customfields']);
358         }
359     }
361     // Profile image.
362     if (in_array('profileimageurl', $userfields)) {
363         $profileimageurl = moodle_url::make_pluginfile_url($usercontext->id, 'user', 'icon', null, '/', 'f1');
364         $userdetails['profileimageurl'] = $profileimageurl->out(false);
365     }
366     if (in_array('profileimageurlsmall', $userfields)) {
367         $profileimageurlsmall = moodle_url::make_pluginfile_url($usercontext->id, 'user', 'icon', null, '/', 'f2');
368         $userdetails['profileimageurlsmall'] = $profileimageurlsmall->out(false);
369     }
371     // Hidden user field.
372     if ($canviewhiddenuserfields) {
373         $hiddenfields = array();
374         // Address, phone1 and phone2 not appears in hidden fields list but require viewhiddenfields capability
375         // according to user/profile.php.
376         if ($user->address && in_array('address', $userfields)) {
377             $userdetails['address'] = $user->address;
378         }
379     } else {
380         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
381     }
383     if ($user->phone1 && in_array('phone1', $userfields) &&
384             (in_array('phone1', $showuseridentityfields) or $canviewhiddenuserfields)) {
385         $userdetails['phone1'] = $user->phone1;
386     }
387     if ($user->phone2 && in_array('phone2', $userfields) &&
388             (in_array('phone2', $showuseridentityfields) or $canviewhiddenuserfields)) {
389         $userdetails['phone2'] = $user->phone2;
390     }
392     if (isset($user->description) &&
393         ((!isset($hiddenfields['description']) && !$cannotviewdescription) or $isadmin)) {
394         if (in_array('description', $userfields)) {
395             // Always return the descriptionformat if description is requested.
396             list($userdetails['description'], $userdetails['descriptionformat']) =
397                     external_format_text($user->description, $user->descriptionformat,
398                             $usercontext->id, 'user', 'profile', null);
399         }
400     }
402     if (in_array('country', $userfields) && (!isset($hiddenfields['country']) or $isadmin) && $user->country) {
403         $userdetails['country'] = $user->country;
404     }
406     if (in_array('city', $userfields) && (!isset($hiddenfields['city']) or $isadmin) && $user->city) {
407         $userdetails['city'] = $user->city;
408     }
410     if (in_array('url', $userfields) && $user->url && (!isset($hiddenfields['webpage']) or $isadmin)) {
411         $url = $user->url;
412         if (strpos($user->url, '://') === false) {
413             $url = 'http://'. $url;
414         }
415         $user->url = clean_param($user->url, PARAM_URL);
416         $userdetails['url'] = $user->url;
417     }
419     if (in_array('icq', $userfields) && $user->icq && (!isset($hiddenfields['icqnumber']) or $isadmin)) {
420         $userdetails['icq'] = $user->icq;
421     }
423     if (in_array('skype', $userfields) && $user->skype && (!isset($hiddenfields['skypeid']) or $isadmin)) {
424         $userdetails['skype'] = $user->skype;
425     }
426     if (in_array('yahoo', $userfields) && $user->yahoo && (!isset($hiddenfields['yahooid']) or $isadmin)) {
427         $userdetails['yahoo'] = $user->yahoo;
428     }
429     if (in_array('aim', $userfields) && $user->aim && (!isset($hiddenfields['aimid']) or $isadmin)) {
430         $userdetails['aim'] = $user->aim;
431     }
432     if (in_array('msn', $userfields) && $user->msn && (!isset($hiddenfields['msnid']) or $isadmin)) {
433         $userdetails['msn'] = $user->msn;
434     }
436     if (in_array('firstaccess', $userfields) && (!isset($hiddenfields['firstaccess']) or $isadmin)) {
437         if ($user->firstaccess) {
438             $userdetails['firstaccess'] = $user->firstaccess;
439         } else {
440             $userdetails['firstaccess'] = 0;
441         }
442     }
443     if (in_array('lastaccess', $userfields) && (!isset($hiddenfields['lastaccess']) or $isadmin)) {
444         if ($user->lastaccess) {
445             $userdetails['lastaccess'] = $user->lastaccess;
446         } else {
447             $userdetails['lastaccess'] = 0;
448         }
449     }
451     if (in_array('email', $userfields) && ($isadmin // The admin is allowed the users email.
452       or $currentuser // Of course the current user is as well.
453       or $canviewuseremail  // This is a capability in course context, it will be false in usercontext.
454       or in_array('email', $showuseridentityfields)
455       or $user->maildisplay == 1
456       or ($user->maildisplay == 2 and enrol_sharing_course($user, $USER)))) {
457         $userdetails['email'] = $user->email;
458     }
460     if (in_array('interests', $userfields) && !empty($CFG->usetags)) {
461         require_once($CFG->dirroot . '/tag/lib.php');
462         if ($interests = tag_get_tags_csv('user', $user->id, TAG_RETURN_TEXT) ) {
463             $userdetails['interests'] = $interests;
464         }
465     }
467     // Departement/Institution/Idnumber are not displayed on any profile, however you can get them from editing profile.
468     if ($isadmin or $currentuser or in_array('idnumber', $showuseridentityfields)) {
469         if (in_array('idnumber', $userfields) && $user->idnumber) {
470             $userdetails['idnumber'] = $user->idnumber;
471         }
472     }
473     if ($isadmin or $currentuser or in_array('institution', $showuseridentityfields)) {
474         if (in_array('institution', $userfields) && $user->institution) {
475             $userdetails['institution'] = $user->institution;
476         }
477     }
478     if ($isadmin or $currentuser or in_array('department', $showuseridentityfields)) {
479         if (in_array('department', $userfields) && isset($user->department)) { // Isset because it's ok to have department 0.
480             $userdetails['department'] = $user->department;
481         }
482     }
484     if (in_array('roles', $userfields) && !empty($course)) {
485         // Not a big secret.
486         $roles = get_user_roles($context, $user->id, false);
487         $userdetails['roles'] = array();
488         foreach ($roles as $role) {
489             $userdetails['roles'][] = array(
490                 'roleid'       => $role->roleid,
491                 'name'         => $role->name,
492                 'shortname'    => $role->shortname,
493                 'sortorder'    => $role->sortorder
494             );
495         }
496     }
498     // If groups are in use and enforced throughout the course, then make sure we can meet in at least one course level group.
499     if (in_array('groups', $userfields) && !empty($course) && $canaccessallgroups) {
500         $usergroups = groups_get_all_groups($course->id, $user->id, $course->defaultgroupingid,
501                 'g.id, g.name,g.description,g.descriptionformat');
502         $userdetails['groups'] = array();
503         foreach ($usergroups as $group) {
504             list($group->description, $group->descriptionformat) =
505                 external_format_text($group->description, $group->descriptionformat,
506                         $context->id, 'group', 'description', $group->id);
507             $userdetails['groups'][] = array('id' => $group->id, 'name' => $group->name,
508                 'description' => $group->description, 'descriptionformat' => $group->descriptionformat);
509         }
510     }
511     // List of courses where the user is enrolled.
512     if (in_array('enrolledcourses', $userfields) && !isset($hiddenfields['mycourses'])) {
513         $enrolledcourses = array();
514         if ($mycourses = enrol_get_users_courses($user->id, true)) {
515             foreach ($mycourses as $mycourse) {
516                 if ($mycourse->category) {
517                     $coursecontext = context_course::instance($mycourse->id);
518                     $enrolledcourse = array();
519                     $enrolledcourse['id'] = $mycourse->id;
520                     $enrolledcourse['fullname'] = format_string($mycourse->fullname, true, array('context' => $coursecontext));
521                     $enrolledcourse['shortname'] = format_string($mycourse->shortname, true, array('context' => $coursecontext));
522                     $enrolledcourses[] = $enrolledcourse;
523                 }
524             }
525             $userdetails['enrolledcourses'] = $enrolledcourses;
526         }
527     }
529     // User preferences.
530     if (in_array('preferences', $userfields) && $currentuser) {
531         $preferences = array();
532         $userpreferences = get_user_preferences();
533         foreach ($userpreferences as $prefname => $prefvalue) {
534             $preferences[] = array('name' => $prefname, 'value' => $prefvalue);
535         }
536         $userdetails['preferences'] = $preferences;
537     }
539     return $userdetails;
542 /**
543  * Tries to obtain user details, either recurring directly to the user's system profile
544  * or through one of the user's course enrollments (course profile).
545  *
546  * @param stdClass $user The user.
547  * @return array if unsuccessful or the allowed user details.
548  */
549 function user_get_user_details_courses($user) {
550     global $USER;
551     $userdetails = null;
553     // Get the courses that the user is enrolled in (only active).
554     $courses = enrol_get_users_courses($user->id, true);
556     $systemprofile = false;
557     if (can_view_user_details_cap($user) || ($user->id == $USER->id) || has_coursecontact_role($user->id)) {
558         $systemprofile = true;
559     }
561     // Try using system profile.
562     if ($systemprofile) {
563         $userdetails = user_get_user_details($user, null);
564     } else {
565         // Try through course profile.
566         foreach ($courses as $course) {
567             if (can_view_user_details_cap($user, $course) || ($user->id == $USER->id) || has_coursecontact_role($user->id)) {
568                 $userdetails = user_get_user_details($user, $course);
569             }
570         }
571     }
573     return $userdetails;
576 /**
577  * Check if $USER have the necessary capabilities to obtain user details.
578  *
579  * @param stdClass $user
580  * @param stdClass $course if null then only consider system profile otherwise also consider the course's profile.
581  * @return bool true if $USER can view user details.
582  */
583 function can_view_user_details_cap($user, $course = null) {
584     // Check $USER has the capability to view the user details at user context.
585     $usercontext = context_user::instance($user->id);
586     $result = has_capability('moodle/user:viewdetails', $usercontext);
587     // Otherwise can $USER see them at course context.
588     if (!$result && !empty($course)) {
589         $context = context_course::instance($course->id);
590         $result = has_capability('moodle/user:viewdetails', $context);
591     }
592     return $result;
595 /**
596  * Return a list of page types
597  * @param string $pagetype current page type
598  * @param stdClass $parentcontext Block's parent context
599  * @param stdClass $currentcontext Current context of block
600  * @return array
601  */
602 function user_page_type_list($pagetype, $parentcontext, $currentcontext) {
603     return array('user-profile' => get_string('page-user-profile', 'pagetype'));
606 /**
607  * Count the number of failed login attempts for the given user, since last successful login.
608  *
609  * @param int|stdclass $user user id or object.
610  * @param bool $reset Resets failed login count, if set to true.
611  *
612  * @return int number of failed login attempts since the last successful login.
613  */
614 function user_count_login_failures($user, $reset = true) {
615     global $DB;
617     if (!is_object($user)) {
618         $user = $DB->get_record('user', array('id' => $user), '*', MUST_EXIST);
619     }
620     if ($user->deleted) {
621         // Deleted user, nothing to do.
622         return 0;
623     }
624     $count = get_user_preferences('login_failed_count_since_success', 0, $user);
625     if ($reset) {
626         set_user_preference('login_failed_count_since_success', 0, $user);
627     }
628     return $count;
631 /**
632  * Converts a string into a flat array of menu items, where each menu items is a
633  * stdClass with fields type, url, title, pix, and imgsrc.
634  *
635  * @param string $text the menu items definition
636  * @param moodle_page $page the current page
637  * @return array
638  */
639 function user_convert_text_to_menu_items($text, $page) {
640     global $OUTPUT, $CFG;
642     $lines = explode("\n", $text);
643     $items = array();
644     $lastchild = null;
645     $lastdepth = null;
646     $lastsort = 0;
647     $children = array();
648     foreach ($lines as $line) {
649         $line = trim($line);
650         $bits = explode('|', $line, 3);
651         $itemtype = 'link';
652         if (preg_match("/^#+$/", $line)) {
653             $itemtype = 'divider';
654         } else if (!array_key_exists(0, $bits) or empty($bits[0])) {
655             // Every item must have a name to be valid.
656             continue;
657         } else {
658             $bits[0] = ltrim($bits[0], '-');
659         }
661         // Create the child.
662         $child = new stdClass();
663         $child->itemtype = $itemtype;
664         if ($itemtype === 'divider') {
665             // Add the divider to the list of children and skip link
666             // processing.
667             $children[] = $child;
668             continue;
669         }
671         // Name processing.
672         $namebits = explode(',', $bits[0], 2);
673         if (count($namebits) == 2) {
674             // Check the validity of the identifier part of the string.
675             if (clean_param($namebits[0], PARAM_STRINGID) !== '') {
676                 // Treat this as a language string.
677                 $child->title = get_string($namebits[0], $namebits[1]);
678             }
679         }
680         if (empty($child->title)) {
681             // Use it as is, don't even clean it.
682             $child->title = $bits[0];
683         }
685         // URL processing.
686         if (!array_key_exists(1, $bits) or empty($bits[1])) {
687             // Set the url to null, and set the itemtype to invalid.
688             $bits[1] = null;
689             $child->itemtype = "invalid";
690         } else {
691             // Nasty hack to replace the grades with the direct url.
692             if (strpos($bits[1], '/grade/report/mygrades.php') !== false) {
693                 $bits[1] = user_mygrades_url();
694             }
696             // Make sure the url is a moodle url.
697             $bits[1] = new moodle_url(trim($bits[1]));
698         }
699         $child->url = $bits[1];
701         // PIX processing.
702         $pixpath = "t/edit";
703         if (!array_key_exists(2, $bits) or empty($bits[2])) {
704             // Use the default.
705             $child->pix = $pixpath;
706         } else {
707             // Check for the specified image existing.
708             $pixpath = "t/" . $bits[2];
709             if ($page->theme->resolve_image_location($pixpath, 'moodle', true)) {
710                 // Use the image.
711                 $child->pix = $pixpath;
712             } else {
713                 // Treat it like a URL.
714                 $child->pix = null;
715                 $child->imgsrc = $bits[2];
716             }
717         }
719         // Add this child to the list of children.
720         $children[] = $child;
721     }
722     return $children;
725 /**
726  * Get a list of essential user navigation items.
727  *
728  * @param stdclass $user user object.
729  * @param moodle_page $page page object.
730  * @return stdClass $returnobj navigation information object, where:
731  *
732  *      $returnobj->navitems    array    array of links where each link is a
733  *                                       stdClass with fields url, title, and
734  *                                       pix
735  *      $returnobj->metadata    array    array of useful user metadata to be
736  *                                       used when constructing navigation;
737  *                                       fields include:
738  *
739  *          ROLE FIELDS
740  *          asotherrole    bool    whether viewing as another role
741  *          rolename       string  name of the role
742  *
743  *          USER FIELDS
744  *          These fields are for the currently-logged in user, or for
745  *          the user that the real user is currently logged in as.
746  *
747  *          userid         int        the id of the user in question
748  *          userfullname   string     the user's full name
749  *          userprofileurl moodle_url the url of the user's profile
750  *          useravatar     string     a HTML fragment - the rendered
751  *                                    user_picture for this user
752  *          userloginfail  string     an error string denoting the number
753  *                                    of login failures since last login
754  *
755  *          "REAL USER" FIELDS
756  *          These fields are for when asotheruser is true, and
757  *          correspond to the underlying "real user".
758  *
759  *          asotheruser        bool    whether viewing as another user
760  *          realuserid         int        the id of the user in question
761  *          realuserfullname   string     the user's full name
762  *          realuserprofileurl moodle_url the url of the user's profile
763  *          realuseravatar     string     a HTML fragment - the rendered
764  *                                        user_picture for this user
765  *
766  *          MNET PROVIDER FIELDS
767  *          asmnetuser            bool   whether viewing as a user from an
768  *                                       MNet provider
769  *          mnetidprovidername    string name of the MNet provider
770  *          mnetidproviderwwwroot string URL of the MNet provider
771  */
772 function user_get_user_navigation_info($user, $page) {
773     global $OUTPUT, $DB, $SESSION, $CFG;
775     $returnobject = new stdClass();
776     $returnobject->navitems = array();
777     $returnobject->metadata = array();
779     $course = $page->course;
781     // Query the environment.
782     $context = context_course::instance($course->id);
784     // Get basic user metadata.
785     $returnobject->metadata['userid'] = $user->id;
786     $returnobject->metadata['userfullname'] = fullname($user, true);
787     $returnobject->metadata['userprofileurl'] = new moodle_url('/user/profile.php', array(
788         'id' => $user->id
789     ));
790     $returnobject->metadata['useravatar'] = $OUTPUT->user_picture (
791         $user,
792         array(
793             'link' => false,
794             'visibletoscreenreaders' => false
795         )
796     );
797     // Build a list of items for a regular user.
799     // Query MNet status.
800     if ($returnobject->metadata['asmnetuser'] = is_mnet_remote_user($user)) {
801         $mnetidprovider = $DB->get_record('mnet_host', array('id' => $user->mnethostid));
802         $returnobject->metadata['mnetidprovidername'] = $mnetidprovider->name;
803         $returnobject->metadata['mnetidproviderwwwroot'] = $mnetidprovider->wwwroot;
804     }
806     // Did the user just log in?
807     if (isset($SESSION->justloggedin)) {
808         // Don't unset this flag as login_info still needs it.
809         if (!empty($CFG->displayloginfailures)) {
810             // We're already in /user/lib.php, so we don't need to include.
811             if ($count = user_count_login_failures($user)) {
813                 // Get login failures string.
814                 $a = new stdClass();
815                 $a->attempts = html_writer::tag('span', $count, array('class' => 'value'));
816                 $returnobject->metadata['userloginfail'] =
817                     get_string('failedloginattempts', '', $a);
819             }
820         }
821     }
823     // Links: Dashboard.
824     $myhome = new stdClass();
825     $myhome->itemtype = 'link';
826     $myhome->url = new moodle_url('/my/');
827     $myhome->title = get_string('mymoodle', 'admin');
828     $myhome->pix = "i/course";
829     $returnobject->navitems[] = $myhome;
831     // Links: My Profile.
832     $myprofile = new stdClass();
833     $myprofile->itemtype = 'link';
834     $myprofile->url = new moodle_url('/user/profile.php', array('id' => $user->id));
835     $myprofile->title = get_string('profile');
836     $myprofile->pix = "i/user";
837     $returnobject->navitems[] = $myprofile;
839     // Links: Role-return or logout link.
840     $lastobj = null;
841     $buildlogout = true;
842     $returnobject->metadata['asotherrole'] = false;
843     if (is_role_switched($course->id)) {
844         if ($role = $DB->get_record('role', array('id' => $user->access['rsw'][$context->path]))) {
845             // Build role-return link instead of logout link.
846             $rolereturn = new stdClass();
847             $rolereturn->itemtype = 'link';
848             $rolereturn->url = new moodle_url('/course/switchrole.php', array(
849                 'id' => $course->id,
850                 'sesskey' => sesskey(),
851                 'switchrole' => 0,
852                 'returnurl' => $page->url->out_as_local_url(false)
853             ));
854             $rolereturn->pix = "a/logout";
855             $rolereturn->title = get_string('switchrolereturn');
856             $lastobj = $rolereturn;
858             $returnobject->metadata['asotherrole'] = true;
859             $returnobject->metadata['rolename'] = role_get_name($role, $context);
861             $buildlogout = false;
862         }
863     }
865     if ($returnobject->metadata['asotheruser'] = \core\session\manager::is_loggedinas()) {
866         $realuser = \core\session\manager::get_realuser();
868         // Save values for the real user, as $user will be full of data for the
869         // user the user is disguised as.
870         $returnobject->metadata['realuserid'] = $realuser->id;
871         $returnobject->metadata['realuserfullname'] = fullname($realuser, true);
872         $returnobject->metadata['realuserprofileurl'] = new moodle_url('/user/profile.php', array(
873             'id' => $realuser->id
874         ));
875         $returnobject->metadata['realuseravatar'] = $OUTPUT->user_picture (
876             $realuser,
877             array(
878                 'link' => false,
879                 'visibletoscreenreaders' => false
880             )
881         );
883         // Build a user-revert link.
884         $userrevert = new stdClass();
885         $userrevert->itemtype = 'link';
886         $userrevert->url = new moodle_url('/course/loginas.php', array(
887             'id' => $course->id,
888             'sesskey' => sesskey()
889         ));
890         $userrevert->pix = "a/logout";
891         $userrevert->title = get_string('logout');
892         $lastobj = $userrevert;
894         $buildlogout = false;
895     }
897     if ($buildlogout) {
898         // Build a logout link.
899         $logout = new stdClass();
900         $logout->itemtype = 'link';
901         $logout->url = new moodle_url('/login/logout.php', array('sesskey' => sesskey()));
902         $logout->pix = "a/logout";
903         $logout->title = get_string('logout');
904         $lastobj = $logout;
905     }
907     // Before we add the last item (usually a logout link), add any
908     // custom-defined items.
909     $customitems = user_convert_text_to_menu_items($CFG->customusermenuitems, $page);
910     foreach ($customitems as $item) {
911         $returnobject->navitems[] = $item;
912     }
914     // Add the last item to the list.
915     if (!is_null($lastobj)) {
916         $returnobject->navitems[] = $lastobj;
917     }
919     return $returnobject;
922 /**
923  * Add password to the list of used hashes for this user.
924  *
925  * This is supposed to be used from:
926  *  1/ change own password form
927  *  2/ password reset process
928  *  3/ user signup in auth plugins if password changing supported
929  *
930  * @param int $userid user id
931  * @param string $password plaintext password
932  * @return void
933  */
934 function user_add_password_history($userid, $password) {
935     global $CFG, $DB;
936     require_once($CFG->libdir.'/password_compat/lib/password.php');
938     if (empty($CFG->passwordreuselimit) or $CFG->passwordreuselimit < 0) {
939         return;
940     }
942     // Note: this is using separate code form normal password hashing because
943     //       we need to have this under control in the future. Also the auth
944     //       plugin might not store the passwords locally at all.
946     $record = new stdClass();
947     $record->userid = $userid;
948     $record->hash = password_hash($password, PASSWORD_DEFAULT);
949     $record->timecreated = time();
950     $DB->insert_record('user_password_history', $record);
952     $i = 0;
953     $records = $DB->get_records('user_password_history', array('userid' => $userid), 'timecreated DESC, id DESC');
954     foreach ($records as $record) {
955         $i++;
956         if ($i > $CFG->passwordreuselimit) {
957             $DB->delete_records('user_password_history', array('id' => $record->id));
958         }
959     }
962 /**
963  * Was this password used before on change or reset password page?
964  *
965  * The $CFG->passwordreuselimit setting determines
966  * how many times different password needs to be used
967  * before allowing previously used password again.
968  *
969  * @param int $userid user id
970  * @param string $password plaintext password
971  * @return bool true if password reused
972  */
973 function user_is_previously_used_password($userid, $password) {
974     global $CFG, $DB;
975     require_once($CFG->libdir.'/password_compat/lib/password.php');
977     if (empty($CFG->passwordreuselimit) or $CFG->passwordreuselimit < 0) {
978         return false;
979     }
981     $reused = false;
983     $i = 0;
984     $records = $DB->get_records('user_password_history', array('userid' => $userid), 'timecreated DESC, id DESC');
985     foreach ($records as $record) {
986         $i++;
987         if ($i > $CFG->passwordreuselimit) {
988             $DB->delete_records('user_password_history', array('id' => $record->id));
989             continue;
990         }
991         // NOTE: this is slow but we cannot compare the hashes directly any more.
992         if (password_verify($password, $record->hash)) {
993             $reused = true;
994         }
995     }
997     return $reused;
1000 /**
1001  * Remove a user device from the Moodle database (for PUSH notifications usually).
1002  *
1003  * @param string $uuid The device UUID.
1004  * @param string $appid The app id. If empty all the devices matching the UUID for the user will be removed.
1005  * @return bool true if removed, false if the device didn't exists in the database
1006  * @since Moodle 2.9
1007  */
1008 function user_remove_user_device($uuid, $appid = "") {
1009     global $DB, $USER;
1011     $conditions = array('uuid' => $uuid, 'userid' => $USER->id);
1012     if (!empty($appid)) {
1013         $conditions['appid'] = $appid;
1014     }
1016     if (!$DB->count_records('user_devices', $conditions)) {
1017         return false;
1018     }
1020     $DB->delete_records('user_devices', $conditions);
1022     return true;
1025 /**
1026  * Trigger user_list_viewed event.
1027  *
1028  * @param stdClass  $course course  object
1029  * @param stdClass  $context course context object
1030  * @since Moodle 2.9
1031  */
1032 function user_list_view($course, $context) {
1034     $event = \core\event\user_list_viewed::create(array(
1035         'objectid' => $course->id,
1036         'courseid' => $course->id,
1037         'context' => $context,
1038         'other' => array(
1039             'courseshortname' => $course->shortname,
1040             'coursefullname' => $course->fullname
1041         )
1042     ));
1043     $event->trigger();
1046 /**
1047  * Returns the url to use for the "Grades" link in the user navigation.
1048  *
1049  * @param int $userid The user's ID.
1050  * @param int $courseid The course ID if available.
1051  * @return mixed A URL to be directed to for "Grades".
1052  */
1053 function user_mygrades_url($userid = null, $courseid = SITEID) {
1054     global $CFG, $USER;
1055     $url = null;
1056     if (isset($CFG->grade_mygrades_report) && $CFG->grade_mygrades_report != 'external') {
1057         if (isset($userid) && $USER->id != $userid) {
1058             // Send to the gradebook report.
1059             $url = new moodle_url('/grade/report/' . $CFG->grade_mygrades_report . '/index.php',
1060                     array('id' => $courseid, 'userid' => $userid));
1061         } else {
1062             $url = new moodle_url('/grade/report/' . $CFG->grade_mygrades_report . '/index.php');
1063         }
1064     } else if (isset($CFG->grade_mygrades_report) && $CFG->grade_mygrades_report == 'external'
1065             && !empty($CFG->gradereport_mygradeurl)) {
1066         $url = $CFG->gradereport_mygradeurl;
1067     } else {
1068         $url = $CFG->wwwroot;
1069     }
1070     return $url;