MDL-50646 admin: Use site default lang as new user's preferred lang
[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()) {
338                 $userdetails['customfields'][] =
339                     array('name' => $formfield->field->name, 'value' => $formfield->data,
340                         'type' => $field->datatype, 'shortname' => $formfield->field->shortname);
341             }
342         }
343         $fields->close();
344         // Unset customfields if it's empty.
345         if (empty($userdetails['customfields'])) {
346             unset($userdetails['customfields']);
347         }
348     }
350     // Profile image.
351     if (in_array('profileimageurl', $userfields)) {
352         $profileimageurl = moodle_url::make_pluginfile_url($usercontext->id, 'user', 'icon', null, '/', 'f1');
353         $userdetails['profileimageurl'] = $profileimageurl->out(false);
354     }
355     if (in_array('profileimageurlsmall', $userfields)) {
356         $profileimageurlsmall = moodle_url::make_pluginfile_url($usercontext->id, 'user', 'icon', null, '/', 'f2');
357         $userdetails['profileimageurlsmall'] = $profileimageurlsmall->out(false);
358     }
360     // Hidden user field.
361     if ($canviewhiddenuserfields) {
362         $hiddenfields = array();
363         // Address, phone1 and phone2 not appears in hidden fields list but require viewhiddenfields capability
364         // according to user/profile.php.
365         if ($user->address && in_array('address', $userfields)) {
366             $userdetails['address'] = $user->address;
367         }
368     } else {
369         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
370     }
372     if ($user->phone1 && in_array('phone1', $userfields) &&
373             (in_array('phone1', $showuseridentityfields) or $canviewhiddenuserfields)) {
374         $userdetails['phone1'] = $user->phone1;
375     }
376     if ($user->phone2 && in_array('phone2', $userfields) &&
377             (in_array('phone2', $showuseridentityfields) or $canviewhiddenuserfields)) {
378         $userdetails['phone2'] = $user->phone2;
379     }
381     if (isset($user->description) &&
382         ((!isset($hiddenfields['description']) && !$cannotviewdescription) or $isadmin)) {
383         if (in_array('description', $userfields)) {
384             // Always return the descriptionformat if description is requested.
385             list($userdetails['description'], $userdetails['descriptionformat']) =
386                     external_format_text($user->description, $user->descriptionformat,
387                             $usercontext->id, 'user', 'profile', null);
388         }
389     }
391     if (in_array('country', $userfields) && (!isset($hiddenfields['country']) or $isadmin) && $user->country) {
392         $userdetails['country'] = $user->country;
393     }
395     if (in_array('city', $userfields) && (!isset($hiddenfields['city']) or $isadmin) && $user->city) {
396         $userdetails['city'] = $user->city;
397     }
399     if (in_array('url', $userfields) && $user->url && (!isset($hiddenfields['webpage']) or $isadmin)) {
400         $url = $user->url;
401         if (strpos($user->url, '://') === false) {
402             $url = 'http://'. $url;
403         }
404         $user->url = clean_param($user->url, PARAM_URL);
405         $userdetails['url'] = $user->url;
406     }
408     if (in_array('icq', $userfields) && $user->icq && (!isset($hiddenfields['icqnumber']) or $isadmin)) {
409         $userdetails['icq'] = $user->icq;
410     }
412     if (in_array('skype', $userfields) && $user->skype && (!isset($hiddenfields['skypeid']) or $isadmin)) {
413         $userdetails['skype'] = $user->skype;
414     }
415     if (in_array('yahoo', $userfields) && $user->yahoo && (!isset($hiddenfields['yahooid']) or $isadmin)) {
416         $userdetails['yahoo'] = $user->yahoo;
417     }
418     if (in_array('aim', $userfields) && $user->aim && (!isset($hiddenfields['aimid']) or $isadmin)) {
419         $userdetails['aim'] = $user->aim;
420     }
421     if (in_array('msn', $userfields) && $user->msn && (!isset($hiddenfields['msnid']) or $isadmin)) {
422         $userdetails['msn'] = $user->msn;
423     }
425     if (in_array('firstaccess', $userfields) && (!isset($hiddenfields['firstaccess']) or $isadmin)) {
426         if ($user->firstaccess) {
427             $userdetails['firstaccess'] = $user->firstaccess;
428         } else {
429             $userdetails['firstaccess'] = 0;
430         }
431     }
432     if (in_array('lastaccess', $userfields) && (!isset($hiddenfields['lastaccess']) or $isadmin)) {
433         if ($user->lastaccess) {
434             $userdetails['lastaccess'] = $user->lastaccess;
435         } else {
436             $userdetails['lastaccess'] = 0;
437         }
438     }
440     if (in_array('email', $userfields) && ($isadmin // The admin is allowed the users email.
441       or $currentuser // Of course the current user is as well.
442       or $canviewuseremail  // This is a capability in course context, it will be false in usercontext.
443       or in_array('email', $showuseridentityfields)
444       or $user->maildisplay == 1
445       or ($user->maildisplay == 2 and enrol_sharing_course($user, $USER)))) {
446         $userdetails['email'] = $user->email;
447     }
449     if (in_array('interests', $userfields) && !empty($CFG->usetags)) {
450         require_once($CFG->dirroot . '/tag/lib.php');
451         if ($interests = tag_get_tags_csv('user', $user->id, TAG_RETURN_TEXT) ) {
452             $userdetails['interests'] = $interests;
453         }
454     }
456     // Departement/Institution/Idnumber are not displayed on any profile, however you can get them from editing profile.
457     if ($isadmin or $currentuser or in_array('idnumber', $showuseridentityfields)) {
458         if (in_array('idnumber', $userfields) && $user->idnumber) {
459             $userdetails['idnumber'] = $user->idnumber;
460         }
461     }
462     if ($isadmin or $currentuser or in_array('institution', $showuseridentityfields)) {
463         if (in_array('institution', $userfields) && $user->institution) {
464             $userdetails['institution'] = $user->institution;
465         }
466     }
467     if ($isadmin or $currentuser or in_array('department', $showuseridentityfields)) {
468         if (in_array('department', $userfields) && isset($user->department)) { // Isset because it's ok to have department 0.
469             $userdetails['department'] = $user->department;
470         }
471     }
473     if (in_array('roles', $userfields) && !empty($course)) {
474         // Not a big secret.
475         $roles = get_user_roles($context, $user->id, false);
476         $userdetails['roles'] = array();
477         foreach ($roles as $role) {
478             $userdetails['roles'][] = array(
479                 'roleid'       => $role->roleid,
480                 'name'         => $role->name,
481                 'shortname'    => $role->shortname,
482                 'sortorder'    => $role->sortorder
483             );
484         }
485     }
487     // If groups are in use and enforced throughout the course, then make sure we can meet in at least one course level group.
488     if (in_array('groups', $userfields) && !empty($course) && $canaccessallgroups) {
489         $usergroups = groups_get_all_groups($course->id, $user->id, $course->defaultgroupingid,
490                 'g.id, g.name,g.description,g.descriptionformat');
491         $userdetails['groups'] = array();
492         foreach ($usergroups as $group) {
493             list($group->description, $group->descriptionformat) =
494                 external_format_text($group->description, $group->descriptionformat,
495                         $context->id, 'group', 'description', $group->id);
496             $userdetails['groups'][] = array('id' => $group->id, 'name' => $group->name,
497                 'description' => $group->description, 'descriptionformat' => $group->descriptionformat);
498         }
499     }
500     // List of courses where the user is enrolled.
501     if (in_array('enrolledcourses', $userfields) && !isset($hiddenfields['mycourses'])) {
502         $enrolledcourses = array();
503         if ($mycourses = enrol_get_users_courses($user->id, true)) {
504             foreach ($mycourses as $mycourse) {
505                 if ($mycourse->category) {
506                     $coursecontext = context_course::instance($mycourse->id);
507                     $enrolledcourse = array();
508                     $enrolledcourse['id'] = $mycourse->id;
509                     $enrolledcourse['fullname'] = format_string($mycourse->fullname, true, array('context' => $coursecontext));
510                     $enrolledcourse['shortname'] = format_string($mycourse->shortname, true, array('context' => $coursecontext));
511                     $enrolledcourses[] = $enrolledcourse;
512                 }
513             }
514             $userdetails['enrolledcourses'] = $enrolledcourses;
515         }
516     }
518     // User preferences.
519     if (in_array('preferences', $userfields) && $currentuser) {
520         $preferences = array();
521         $userpreferences = get_user_preferences();
522         foreach ($userpreferences as $prefname => $prefvalue) {
523             $preferences[] = array('name' => $prefname, 'value' => $prefvalue);
524         }
525         $userdetails['preferences'] = $preferences;
526     }
528     return $userdetails;
531 /**
532  * Tries to obtain user details, either recurring directly to the user's system profile
533  * or through one of the user's course enrollments (course profile).
534  *
535  * @param stdClass $user The user.
536  * @return array if unsuccessful or the allowed user details.
537  */
538 function user_get_user_details_courses($user) {
539     global $USER;
540     $userdetails = null;
542     // Get the courses that the user is enrolled in (only active).
543     $courses = enrol_get_users_courses($user->id, true);
545     $systemprofile = false;
546     if (can_view_user_details_cap($user) || ($user->id == $USER->id) || has_coursecontact_role($user->id)) {
547         $systemprofile = true;
548     }
550     // Try using system profile.
551     if ($systemprofile) {
552         $userdetails = user_get_user_details($user, null);
553     } else {
554         // Try through course profile.
555         foreach ($courses as $course) {
556             if (can_view_user_details_cap($user, $course) || ($user->id == $USER->id) || has_coursecontact_role($user->id)) {
557                 $userdetails = user_get_user_details($user, $course);
558             }
559         }
560     }
562     return $userdetails;
565 /**
566  * Check if $USER have the necessary capabilities to obtain user details.
567  *
568  * @param stdClass $user
569  * @param stdClass $course if null then only consider system profile otherwise also consider the course's profile.
570  * @return bool true if $USER can view user details.
571  */
572 function can_view_user_details_cap($user, $course = null) {
573     // Check $USER has the capability to view the user details at user context.
574     $usercontext = context_user::instance($user->id);
575     $result = has_capability('moodle/user:viewdetails', $usercontext);
576     // Otherwise can $USER see them at course context.
577     if (!$result && !empty($course)) {
578         $context = context_course::instance($course->id);
579         $result = has_capability('moodle/user:viewdetails', $context);
580     }
581     return $result;
584 /**
585  * Return a list of page types
586  * @param string $pagetype current page type
587  * @param stdClass $parentcontext Block's parent context
588  * @param stdClass $currentcontext Current context of block
589  * @return array
590  */
591 function user_page_type_list($pagetype, $parentcontext, $currentcontext) {
592     return array('user-profile' => get_string('page-user-profile', 'pagetype'));
595 /**
596  * Count the number of failed login attempts for the given user, since last successful login.
597  *
598  * @param int|stdclass $user user id or object.
599  * @param bool $reset Resets failed login count, if set to true.
600  *
601  * @return int number of failed login attempts since the last successful login.
602  */
603 function user_count_login_failures($user, $reset = true) {
604     global $DB;
606     if (!is_object($user)) {
607         $user = $DB->get_record('user', array('id' => $user), '*', MUST_EXIST);
608     }
609     if ($user->deleted) {
610         // Deleted user, nothing to do.
611         return 0;
612     }
613     $count = get_user_preferences('login_failed_count_since_success', 0, $user);
614     if ($reset) {
615         set_user_preference('login_failed_count_since_success', 0, $user);
616     }
617     return $count;
620 /**
621  * Converts a string into a flat array of menu items, where each menu items is a
622  * stdClass with fields type, url, title, pix, and imgsrc.
623  *
624  * @param string $text the menu items definition
625  * @param moodle_page $page the current page
626  * @return array
627  */
628 function user_convert_text_to_menu_items($text, $page) {
629     global $OUTPUT, $CFG;
631     $lines = explode("\n", $text);
632     $items = array();
633     $lastchild = null;
634     $lastdepth = null;
635     $lastsort = 0;
636     $children = array();
637     foreach ($lines as $line) {
638         $line = trim($line);
639         $bits = explode('|', $line, 3);
640         $itemtype = 'link';
641         if (preg_match("/^#+$/", $line)) {
642             $itemtype = 'divider';
643         } else if (!array_key_exists(0, $bits) or empty($bits[0])) {
644             // Every item must have a name to be valid.
645             continue;
646         } else {
647             $bits[0] = ltrim($bits[0], '-');
648         }
650         // Create the child.
651         $child = new stdClass();
652         $child->itemtype = $itemtype;
653         if ($itemtype === 'divider') {
654             // Add the divider to the list of children and skip link
655             // processing.
656             $children[] = $child;
657             continue;
658         }
660         // Name processing.
661         $namebits = explode(',', $bits[0], 2);
662         if (count($namebits) == 2) {
663             // Check the validity of the identifier part of the string.
664             if (clean_param($namebits[0], PARAM_STRINGID) !== '') {
665                 // Treat this as a language string.
666                 $child->title = get_string($namebits[0], $namebits[1]);
667             }
668         }
669         if (empty($child->title)) {
670             // Use it as is, don't even clean it.
671             $child->title = $bits[0];
672         }
674         // URL processing.
675         if (!array_key_exists(1, $bits) or empty($bits[1])) {
676             // Set the url to null, and set the itemtype to invalid.
677             $bits[1] = null;
678             $child->itemtype = "invalid";
679         } else {
680             // Nasty hack to replace the grades with the direct url.
681             if (strpos($bits[1], '/grade/report/mygrades.php') !== false) {
682                 $bits[1] = user_mygrades_url();
683             }
685             // Make sure the url is a moodle url.
686             $bits[1] = new moodle_url(trim($bits[1]));
687         }
688         $child->url = $bits[1];
690         // PIX processing.
691         $pixpath = "t/edit";
692         if (!array_key_exists(2, $bits) or empty($bits[2])) {
693             // Use the default.
694             $child->pix = $pixpath;
695         } else {
696             // Check for the specified image existing.
697             $pixpath = "t/" . $bits[2];
698             if ($page->theme->resolve_image_location($pixpath, 'moodle', true)) {
699                 // Use the image.
700                 $child->pix = $pixpath;
701             } else {
702                 // Treat it like a URL.
703                 $child->pix = null;
704                 $child->imgsrc = $bits[2];
705             }
706         }
708         // Add this child to the list of children.
709         $children[] = $child;
710     }
711     return $children;
714 /**
715  * Get a list of essential user navigation items.
716  *
717  * @param stdclass $user user object.
718  * @param moodle_page $page page object.
719  * @return stdClass $returnobj navigation information object, where:
720  *
721  *      $returnobj->navitems    array    array of links where each link is a
722  *                                       stdClass with fields url, title, and
723  *                                       pix
724  *      $returnobj->metadata    array    array of useful user metadata to be
725  *                                       used when constructing navigation;
726  *                                       fields include:
727  *
728  *          ROLE FIELDS
729  *          asotherrole    bool    whether viewing as another role
730  *          rolename       string  name of the role
731  *
732  *          USER FIELDS
733  *          These fields are for the currently-logged in user, or for
734  *          the user that the real user is currently logged in as.
735  *
736  *          userid         int        the id of the user in question
737  *          userfullname   string     the user's full name
738  *          userprofileurl moodle_url the url of the user's profile
739  *          useravatar     string     a HTML fragment - the rendered
740  *                                    user_picture for this user
741  *          userloginfail  string     an error string denoting the number
742  *                                    of login failures since last login
743  *
744  *          "REAL USER" FIELDS
745  *          These fields are for when asotheruser is true, and
746  *          correspond to the underlying "real user".
747  *
748  *          asotheruser        bool    whether viewing as another user
749  *          realuserid         int        the id of the user in question
750  *          realuserfullname   string     the user's full name
751  *          realuserprofileurl moodle_url the url of the user's profile
752  *          realuseravatar     string     a HTML fragment - the rendered
753  *                                        user_picture for this user
754  *
755  *          MNET PROVIDER FIELDS
756  *          asmnetuser            bool   whether viewing as a user from an
757  *                                       MNet provider
758  *          mnetidprovidername    string name of the MNet provider
759  *          mnetidproviderwwwroot string URL of the MNet provider
760  */
761 function user_get_user_navigation_info($user, $page) {
762     global $OUTPUT, $DB, $SESSION, $CFG;
764     $returnobject = new stdClass();
765     $returnobject->navitems = array();
766     $returnobject->metadata = array();
768     $course = $page->course;
770     // Query the environment.
771     $context = context_course::instance($course->id);
773     // Get basic user metadata.
774     $returnobject->metadata['userid'] = $user->id;
775     $returnobject->metadata['userfullname'] = fullname($user, true);
776     $returnobject->metadata['userprofileurl'] = new moodle_url('/user/profile.php', array(
777         'id' => $user->id
778     ));
779     $returnobject->metadata['useravatar'] = $OUTPUT->user_picture (
780         $user,
781         array(
782             'link' => false,
783             'visibletoscreenreaders' => false
784         )
785     );
786     // Build a list of items for a regular user.
788     // Query MNet status.
789     if ($returnobject->metadata['asmnetuser'] = is_mnet_remote_user($user)) {
790         $mnetidprovider = $DB->get_record('mnet_host', array('id' => $user->mnethostid));
791         $returnobject->metadata['mnetidprovidername'] = $mnetidprovider->name;
792         $returnobject->metadata['mnetidproviderwwwroot'] = $mnetidprovider->wwwroot;
793     }
795     // Did the user just log in?
796     if (isset($SESSION->justloggedin)) {
797         // Don't unset this flag as login_info still needs it.
798         if (!empty($CFG->displayloginfailures)) {
799             // We're already in /user/lib.php, so we don't need to include.
800             if ($count = user_count_login_failures($user)) {
802                 // Get login failures string.
803                 $a = new stdClass();
804                 $a->attempts = html_writer::tag('span', $count, array('class' => 'value'));
805                 $returnobject->metadata['userloginfail'] =
806                     get_string('failedloginattempts', '', $a);
808             }
809         }
810     }
812     // Links: Dashboard.
813     $myhome = new stdClass();
814     $myhome->itemtype = 'link';
815     $myhome->url = new moodle_url('/my/');
816     $myhome->title = get_string('mymoodle', 'admin');
817     $myhome->pix = "i/course";
818     $returnobject->navitems[] = $myhome;
820     // Links: My Profile.
821     $myprofile = new stdClass();
822     $myprofile->itemtype = 'link';
823     $myprofile->url = new moodle_url('/user/profile.php', array('id' => $user->id));
824     $myprofile->title = get_string('profile');
825     $myprofile->pix = "i/user";
826     $returnobject->navitems[] = $myprofile;
828     // Links: Role-return or logout link.
829     $lastobj = null;
830     $buildlogout = true;
831     $returnobject->metadata['asotherrole'] = false;
832     if (is_role_switched($course->id)) {
833         if ($role = $DB->get_record('role', array('id' => $user->access['rsw'][$context->path]))) {
834             // Build role-return link instead of logout link.
835             $rolereturn = new stdClass();
836             $rolereturn->itemtype = 'link';
837             $rolereturn->url = new moodle_url('/course/switchrole.php', array(
838                 'id' => $course->id,
839                 'sesskey' => sesskey(),
840                 'switchrole' => 0,
841                 'returnurl' => $page->url->out_as_local_url(false)
842             ));
843             $rolereturn->pix = "a/logout";
844             $rolereturn->title = get_string('switchrolereturn');
845             $lastobj = $rolereturn;
847             $returnobject->metadata['asotherrole'] = true;
848             $returnobject->metadata['rolename'] = role_get_name($role, $context);
850             $buildlogout = false;
851         }
852     }
854     if ($returnobject->metadata['asotheruser'] = \core\session\manager::is_loggedinas()) {
855         $realuser = \core\session\manager::get_realuser();
857         // Save values for the real user, as $user will be full of data for the
858         // user the user is disguised as.
859         $returnobject->metadata['realuserid'] = $realuser->id;
860         $returnobject->metadata['realuserfullname'] = fullname($realuser, true);
861         $returnobject->metadata['realuserprofileurl'] = new moodle_url('/user/profile.php', array(
862             'id' => $realuser->id
863         ));
864         $returnobject->metadata['realuseravatar'] = $OUTPUT->user_picture (
865             $realuser,
866             array(
867                 'link' => false,
868                 'visibletoscreenreaders' => false
869             )
870         );
872         // Build a user-revert link.
873         $userrevert = new stdClass();
874         $userrevert->itemtype = 'link';
875         $userrevert->url = new moodle_url('/course/loginas.php', array(
876             'id' => $course->id,
877             'sesskey' => sesskey()
878         ));
879         $userrevert->pix = "a/logout";
880         $userrevert->title = get_string('logout');
881         $lastobj = $userrevert;
883         $buildlogout = false;
884     }
886     if ($buildlogout) {
887         // Build a logout link.
888         $logout = new stdClass();
889         $logout->itemtype = 'link';
890         $logout->url = new moodle_url('/login/logout.php', array('sesskey' => sesskey()));
891         $logout->pix = "a/logout";
892         $logout->title = get_string('logout');
893         $lastobj = $logout;
894     }
896     // Before we add the last item (usually a logout link), add any
897     // custom-defined items.
898     $customitems = user_convert_text_to_menu_items($CFG->customusermenuitems, $page);
899     foreach ($customitems as $item) {
900         $returnobject->navitems[] = $item;
901     }
903     // Add the last item to the list.
904     if (!is_null($lastobj)) {
905         $returnobject->navitems[] = $lastobj;
906     }
908     return $returnobject;
911 /**
912  * Add password to the list of used hashes for this user.
913  *
914  * This is supposed to be used from:
915  *  1/ change own password form
916  *  2/ password reset process
917  *  3/ user signup in auth plugins if password changing supported
918  *
919  * @param int $userid user id
920  * @param string $password plaintext password
921  * @return void
922  */
923 function user_add_password_history($userid, $password) {
924     global $CFG, $DB;
925     require_once($CFG->libdir.'/password_compat/lib/password.php');
927     if (empty($CFG->passwordreuselimit) or $CFG->passwordreuselimit < 0) {
928         return;
929     }
931     // Note: this is using separate code form normal password hashing because
932     //       we need to have this under control in the future. Also the auth
933     //       plugin might not store the passwords locally at all.
935     $record = new stdClass();
936     $record->userid = $userid;
937     $record->hash = password_hash($password, PASSWORD_DEFAULT);
938     $record->timecreated = time();
939     $DB->insert_record('user_password_history', $record);
941     $i = 0;
942     $records = $DB->get_records('user_password_history', array('userid' => $userid), 'timecreated DESC, id DESC');
943     foreach ($records as $record) {
944         $i++;
945         if ($i > $CFG->passwordreuselimit) {
946             $DB->delete_records('user_password_history', array('id' => $record->id));
947         }
948     }
951 /**
952  * Was this password used before on change or reset password page?
953  *
954  * The $CFG->passwordreuselimit setting determines
955  * how many times different password needs to be used
956  * before allowing previously used password again.
957  *
958  * @param int $userid user id
959  * @param string $password plaintext password
960  * @return bool true if password reused
961  */
962 function user_is_previously_used_password($userid, $password) {
963     global $CFG, $DB;
964     require_once($CFG->libdir.'/password_compat/lib/password.php');
966     if (empty($CFG->passwordreuselimit) or $CFG->passwordreuselimit < 0) {
967         return false;
968     }
970     $reused = false;
972     $i = 0;
973     $records = $DB->get_records('user_password_history', array('userid' => $userid), 'timecreated DESC, id DESC');
974     foreach ($records as $record) {
975         $i++;
976         if ($i > $CFG->passwordreuselimit) {
977             $DB->delete_records('user_password_history', array('id' => $record->id));
978             continue;
979         }
980         // NOTE: this is slow but we cannot compare the hashes directly any more.
981         if (password_verify($password, $record->hash)) {
982             $reused = true;
983         }
984     }
986     return $reused;
989 /**
990  * Remove a user device from the Moodle database (for PUSH notifications usually).
991  *
992  * @param string $uuid The device UUID.
993  * @param string $appid The app id. If empty all the devices matching the UUID for the user will be removed.
994  * @return bool true if removed, false if the device didn't exists in the database
995  * @since Moodle 2.9
996  */
997 function user_remove_user_device($uuid, $appid = "") {
998     global $DB, $USER;
1000     $conditions = array('uuid' => $uuid, 'userid' => $USER->id);
1001     if (!empty($appid)) {
1002         $conditions['appid'] = $appid;
1003     }
1005     if (!$DB->count_records('user_devices', $conditions)) {
1006         return false;
1007     }
1009     $DB->delete_records('user_devices', $conditions);
1011     return true;
1014 /**
1015  * Trigger user_list_viewed event.
1016  *
1017  * @param stdClass  $course course  object
1018  * @param stdClass  $context course context object
1019  * @since Moodle 2.9
1020  */
1021 function user_list_view($course, $context) {
1023     $event = \core\event\user_list_viewed::create(array(
1024         'objectid' => $course->id,
1025         'courseid' => $course->id,
1026         'context' => $context,
1027         'other' => array(
1028             'courseshortname' => $course->shortname,
1029             'coursefullname' => $course->fullname
1030         )
1031     ));
1032     $event->trigger();
1035 /**
1036  * Returns the url to use for the "Grades" link in the user navigation.
1037  *
1038  * @param int $userid The user's ID.
1039  * @param int $courseid The course ID if available.
1040  * @return mixed A URL to be directed to for "Grades".
1041  */
1042 function user_mygrades_url($userid = null, $courseid = SITEID) {
1043     global $CFG, $USER;
1044     $url = null;
1045     if (isset($CFG->grade_mygrades_report) && $CFG->grade_mygrades_report != 'external') {
1046         if (isset($userid) && $USER->id != $userid) {
1047             // Send to the gradebook report.
1048             $url = new moodle_url('/grade/report/' . $CFG->grade_mygrades_report . '/index.php',
1049                     array('id' => $courseid, 'userid' => $userid));
1050         } else {
1051             $url = new moodle_url('/grade/report/' . $CFG->grade_mygrades_report . '/index.php');
1052         }
1053     } else if (isset($CFG->grade_mygrades_report) && $CFG->grade_mygrades_report == 'external'
1054             && !empty($CFG->gradereport_mygradeurl)) {
1055         $url = $CFG->gradereport_mygradeurl;
1056     } else {
1057         $url = $CFG->wwwroot;
1058     }
1059     return $url;