MDL-41847 core_user: Add preferred lang field to the user creation form
[moodle.git] / user / editlib.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  * This file contains function used when editing a users profile and preferences.
19  *
20  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
21  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  * @package core_user
23  */
25 /**
26  * Cancels the requirement for a user to update their email address.
27  *
28  * @param int $userid
29  */
30 function cancel_email_update($userid) {
31     unset_user_preference('newemail', $userid);
32     unset_user_preference('newemailkey', $userid);
33     unset_user_preference('newemailattemptsleft', $userid);
34 }
36 /**
37  * Performs the common access checks and page setup for all
38  * user preference pages.
39  *
40  * @param int $userid The user id to edit taken from the page params.
41  * @param int $courseid The optional course id if we came from a course context.
42  * @return array containing the user and course records.
43  */
44 function useredit_setup_preference_page($userid, $courseid) {
45     global $PAGE, $SESSION, $DB, $CFG, $OUTPUT, $USER;
47     // Guest can not edit.
48     if (isguestuser()) {
49         print_error('guestnoeditprofile');
50     }
52     if (!$course = $DB->get_record('course', array('id' => $courseid))) {
53         print_error('invalidcourseid');
54     }
56     if ($course->id != SITEID) {
57         require_login($course);
58     } else if (!isloggedin()) {
59         if (empty($SESSION->wantsurl)) {
60             $SESSION->wantsurl = $CFG->wwwroot.'/user/preferences.php';
61         }
62         redirect(get_login_url());
63     } else {
64         $PAGE->set_context(context_system::instance());
65     }
67     // The user profile we are editing.
68     if (!$user = $DB->get_record('user', array('id' => $userid))) {
69         print_error('invaliduserid');
70     }
72     // Guest can not be edited.
73     if (isguestuser($user)) {
74         print_error('guestnoeditprofile');
75     }
77     // Remote users cannot be edited.
78     if (is_mnet_remote_user($user)) {
79         if (user_not_fully_set_up($user, false)) {
80             $hostwwwroot = $DB->get_field('mnet_host', 'wwwroot', array('id' => $user->mnethostid));
81             print_error('usernotfullysetup', 'mnet', '', $hostwwwroot);
82         }
83         redirect($CFG->wwwroot . "/user/view.php?course={$course->id}");
84     }
86     $systemcontext   = context_system::instance();
87     $personalcontext = context_user::instance($user->id);
89     // Check access control.
90     if ($user->id == $USER->id) {
91         // Editing own profile - require_login() MUST NOT be used here, it would result in infinite loop!
92         if (!has_capability('moodle/user:editownprofile', $systemcontext)) {
93             print_error('cannotedityourprofile');
94         }
96     } else {
97         // Teachers, parents, etc.
98         require_capability('moodle/user:editprofile', $personalcontext);
100         // No editing of primary admin!
101         if (is_siteadmin($user) and !is_siteadmin($USER)) {  // Only admins may edit other admins.
102             print_error('useradmineditadmin');
103         }
104     }
106     if ($user->deleted) {
107         echo $OUTPUT->header();
108         echo $OUTPUT->heading(get_string('userdeleted'));
109         echo $OUTPUT->footer();
110         die;
111     }
113     $PAGE->set_pagelayout('admin');
114     $PAGE->set_context($personalcontext);
115     if ($USER->id != $user->id) {
116         $PAGE->navigation->extend_for_user($user);
117     } else {
118         if ($node = $PAGE->navigation->find('myprofile', navigation_node::TYPE_ROOTNODE)) {
119             $node->force_open();
120         }
121     }
123     return array($user, $course);
126 /**
127  * Loads the given users preferences into the given user object.
128  *
129  * @param stdClass $user The user object, modified by reference.
130  * @param bool $reload
131  */
132 function useredit_load_preferences(&$user, $reload=true) {
133     global $USER;
135     if (!empty($user->id)) {
136         if ($reload and $USER->id == $user->id) {
137             // Reload preferences in case it was changed in other session.
138             unset($USER->preference);
139         }
141         if ($preferences = get_user_preferences(null, null, $user->id)) {
142             foreach ($preferences as $name => $value) {
143                 $user->{'preference_'.$name} = $value;
144             }
145         }
146     }
149 /**
150  * Updates the user preferences for the given user
151  *
152  * Only preference that can be updated directly will be updated here. This method is called from various WS
153  * updating users and should be used when updating user details. Plugins may whitelist preferences that can
154  * be updated by defining 'user_preferences' callback, {@see core_user::fill_preferences_cache()}
155  *
156  * Some parts of code may use user preference table to store internal data, in these cases it is acceptable
157  * to call set_user_preference()
158  *
159  * @param stdClass|array $usernew object or array that has user preferences as attributes with keys starting with preference_
160  */
161 function useredit_update_user_preference($usernew) {
162     global $USER;
163     $ua = (array)$usernew;
164     if (is_object($usernew) && isset($usernew->id) && isset($usernew->deleted) && isset($usernew->confirmed)) {
165         // This is already a full user object, maybe not completely full but these fields are enough.
166         $user = $usernew;
167     } else if (empty($ua['id']) || $ua['id'] == $USER->id) {
168         // We are updating current user.
169         $user = $USER;
170     } else {
171         // Retrieve user object.
172         $user = core_user::get_user($ua['id'], '*', MUST_EXIST);
173     }
175     foreach ($ua as $key => $value) {
176         if (strpos($key, 'preference_') === 0) {
177             $name = substr($key, strlen('preference_'));
178             if (core_user::can_edit_preference($name, $user)) {
179                 $value = core_user::clean_preference($value, $name);
180                 set_user_preference($name, $value, $user->id);
181             }
182         }
183     }
186 /**
187  * Updates the provided users profile picture based upon the expected fields returned from the edit or edit_advanced forms.
188  *
189  * @deprecated since Moodle 3.2 MDL-51789 - please use core_user::update_picture() instead.
190  * @todo MDL-54858 This will be deleted in Moodle 3.6.
191  * @see core_user::update_picture()
192  *
193  * @global moodle_database $DB
194  * @param stdClass $usernew An object that contains some information about the user being updated
195  * @param moodleform $userform The form that was submitted to edit the form (unused)
196  * @param array $filemanageroptions
197  * @return bool True if the user was updated, false if it stayed the same.
198  */
199 function useredit_update_picture(stdClass $usernew, moodleform $userform, $filemanageroptions = array()) {
200     debugging('useredit_update_picture() is deprecated. Please use core_user::update_picture() instead.', DEBUG_DEVELOPER);
201     return core_user::update_picture($usernew, $filemanageroptions);
204 /**
205  * Updates the user email bounce + send counts when the user is edited.
206  *
207  * @param stdClass $user The current user object.
208  * @param stdClass $usernew The updated user object.
209  */
210 function useredit_update_bounces($user, $usernew) {
211     if (!isset($usernew->email)) {
212         // Locked field.
213         return;
214     }
215     if (!isset($user->email) || $user->email !== $usernew->email) {
216         set_bounce_count($usernew, true);
217         set_send_count($usernew, true);
218     }
221 /**
222  * Updates the forums a user is tracking when the user is edited.
223  *
224  * @param stdClass $user The original user object.
225  * @param stdClass $usernew The updated user object.
226  */
227 function useredit_update_trackforums($user, $usernew) {
228     global $CFG;
229     if (!isset($usernew->trackforums)) {
230         // Locked field.
231         return;
232     }
233     if ((!isset($user->trackforums) || ($usernew->trackforums != $user->trackforums)) and !$usernew->trackforums) {
234         require_once($CFG->dirroot.'/mod/forum/lib.php');
235         forum_tp_delete_read_records($usernew->id);
236     }
239 /**
240  * Updates a users interests.
241  *
242  * @param stdClass $user
243  * @param array $interests
244  */
245 function useredit_update_interests($user, $interests) {
246     core_tag_tag::set_item_tags('core', 'user', $user->id,
247             context_user::instance($user->id), $interests);
250 /**
251  * Powerful function that is used by edit and editadvanced to add common form elements/rules/etc.
252  *
253  * @param moodleform $mform
254  * @param array $editoroptions
255  * @param array $filemanageroptions
256  * @param stdClass $user
257  */
258 function useredit_shared_definition(&$mform, $editoroptions, $filemanageroptions, $user) {
259     global $CFG, $USER, $DB;
261     if ($user->id > 0) {
262         useredit_load_preferences($user, false);
263     }
265     $strrequired = get_string('required');
266     $stringman = get_string_manager();
268     // Add the necessary names.
269     foreach (useredit_get_required_name_fields() as $fullname) {
270         $mform->addElement('text', $fullname,  get_string($fullname),  'maxlength="100" size="30"');
271         if ($stringman->string_exists('missing'.$fullname, 'core')) {
272             $strmissingfield = get_string('missing'.$fullname, 'core');
273         } else {
274             $strmissingfield = $strrequired;
275         }
276         $mform->addRule($fullname, $strmissingfield, 'required', null, 'client');
277         $mform->setType($fullname, PARAM_NOTAGS);
278     }
280     $enabledusernamefields = useredit_get_enabled_name_fields();
281     // Add the enabled additional name fields.
282     foreach ($enabledusernamefields as $addname) {
283         $mform->addElement('text', $addname,  get_string($addname), 'maxlength="100" size="30"');
284         $mform->setType($addname, PARAM_NOTAGS);
285     }
287     // Do not show email field if change confirmation is pending.
288     if ($user->id > 0 and !empty($CFG->emailchangeconfirmation) and !empty($user->preference_newemail)) {
289         $notice = get_string('emailchangepending', 'auth', $user);
290         $notice .= '<br /><a href="edit.php?cancelemailchange=1&amp;id='.$user->id.'">'
291                 . get_string('emailchangecancel', 'auth') . '</a>';
292         $mform->addElement('static', 'emailpending', get_string('email'), $notice);
293     } else {
294         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="30"');
295         $mform->addRule('email', $strrequired, 'required', null, 'client');
296         $mform->setType('email', PARAM_RAW_TRIMMED);
297     }
299     $choices = array();
300     $choices['0'] = get_string('emaildisplayno');
301     $choices['1'] = get_string('emaildisplayyes');
302     $choices['2'] = get_string('emaildisplaycourse');
303     $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
304     $mform->setDefault('maildisplay', core_user::get_property_default('maildisplay'));
305     $mform->addHelpButton('maildisplay', 'emaildisplay');
307     $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="21"');
308     $mform->setType('city', PARAM_TEXT);
309     if (!empty($CFG->defaultcity)) {
310         $mform->setDefault('city', $CFG->defaultcity);
311     }
313     $choices = get_string_manager()->get_list_of_countries();
314     $choices = array('' => get_string('selectacountry') . '...') + $choices;
315     $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
316     if (!empty($CFG->country)) {
317         $mform->setDefault('country', core_user::get_property_default('country'));
318     }
320     if (isset($CFG->forcetimezone) and $CFG->forcetimezone != 99) {
321         $choices = core_date::get_list_of_timezones($CFG->forcetimezone);
322         $mform->addElement('static', 'forcedtimezone', get_string('timezone'), $choices[$CFG->forcetimezone]);
323         $mform->addElement('hidden', 'timezone');
324         $mform->setType('timezone', core_user::get_property_type('timezone'));
325     } else {
326         $choices = core_date::get_list_of_timezones($user->timezone, true);
327         $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
328     }
330     if ($user->id < 0) {
331         $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
332         $lang = empty($user->lang) ? $CFG->lang : $user->lang;
333         $mform->setDefault('lang', $lang);
334     }
336     if (!empty($CFG->allowuserthemes)) {
337         $choices = array();
338         $choices[''] = get_string('default');
339         $themes = get_list_of_themes();
340         foreach ($themes as $key => $theme) {
341             if (empty($theme->hidefromselector)) {
342                 $choices[$key] = get_string('pluginname', 'theme_'.$theme->name);
343             }
344         }
345         $mform->addElement('select', 'theme', get_string('preferredtheme'), $choices);
346     }
348     $mform->addElement('editor', 'description_editor', get_string('userdescription'), null, $editoroptions);
349     $mform->setType('description_editor', PARAM_RAW);
350     $mform->addHelpButton('description_editor', 'userdescription');
352     if (empty($USER->newadminuser)) {
353         $mform->addElement('header', 'moodle_picture', get_string('pictureofuser'));
354         $mform->setExpanded('moodle_picture', true);
356         if (!empty($CFG->enablegravatar)) {
357             $mform->addElement('html', html_writer::tag('p', get_string('gravatarenabled')));
358         }
360         $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
362         $mform->addElement('checkbox', 'deletepicture', get_string('deletepicture'));
363         $mform->setDefault('deletepicture', 0);
365         $mform->addElement('filemanager', 'imagefile', get_string('newpicture'), '', $filemanageroptions);
366         $mform->addHelpButton('imagefile', 'newpicture');
368         $mform->addElement('text', 'imagealt', get_string('imagealt'), 'maxlength="100" size="30"');
369         $mform->setType('imagealt', PARAM_TEXT);
371     }
373     // Display user name fields that are not currenlty enabled here if there are any.
374     $disabledusernamefields = useredit_get_disabled_name_fields($enabledusernamefields);
375     if (count($disabledusernamefields) > 0) {
376         $mform->addElement('header', 'moodle_additional_names', get_string('additionalnames'));
377         foreach ($disabledusernamefields as $allname) {
378             $mform->addElement('text', $allname, get_string($allname), 'maxlength="100" size="30"');
379             $mform->setType($allname, PARAM_NOTAGS);
380         }
381     }
383     if (core_tag_tag::is_enabled('core', 'user') and empty($USER->newadminuser)) {
384         $mform->addElement('header', 'moodle_interests', get_string('interests'));
385         $mform->addElement('tags', 'interests', get_string('interestslist'),
386             array('itemtype' => 'user', 'component' => 'core'));
387         $mform->addHelpButton('interests', 'interestslist');
388     }
390     // Moodle optional fields.
391     $mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
393     $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
394     $mform->setType('url', core_user::get_property_type('url'));
396     $mform->addElement('text', 'icq', get_string('icqnumber'), 'maxlength="15" size="25"');
397     $mform->setType('icq', core_user::get_property_type('icq'));
398     $mform->setForceLtr('icq');
400     $mform->addElement('text', 'skype', get_string('skypeid'), 'maxlength="50" size="25"');
401     $mform->setType('skype', core_user::get_property_type('skype'));
402     $mform->setForceLtr('skype');
404     $mform->addElement('text', 'aim', get_string('aimid'), 'maxlength="50" size="25"');
405     $mform->setType('aim', core_user::get_property_type('aim'));
406     $mform->setForceLtr('aim');
408     $mform->addElement('text', 'yahoo', get_string('yahooid'), 'maxlength="50" size="25"');
409     $mform->setType('yahoo', core_user::get_property_type('yahoo'));
410     $mform->setForceLtr('yahoo');
412     $mform->addElement('text', 'msn', get_string('msnid'), 'maxlength="50" size="25"');
413     $mform->setType('msn', core_user::get_property_type('msn'));
414     $mform->setForceLtr('msn');
416     $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
417     $mform->setType('idnumber', core_user::get_property_type('idnumber'));
419     $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="255" size="25"');
420     $mform->setType('institution', core_user::get_property_type('institution'));
422     $mform->addElement('text', 'department', get_string('department'), 'maxlength="255" size="25"');
423     $mform->setType('department', core_user::get_property_type('department'));
425     $mform->addElement('text', 'phone1', get_string('phone1'), 'maxlength="20" size="25"');
426     $mform->setType('phone1', core_user::get_property_type('phone1'));
427     $mform->setForceLtr('phone1');
429     $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
430     $mform->setType('phone2', core_user::get_property_type('phone2'));
431     $mform->setForceLtr('phone2');
433     $mform->addElement('text', 'address', get_string('address'), 'maxlength="255" size="25"');
434     $mform->setType('address', core_user::get_property_type('address'));
437 /**
438  * Return required user name fields for forms.
439  *
440  * @return array required user name fields in order according to settings.
441  */
442 function useredit_get_required_name_fields() {
443     global $CFG;
445     // Get the name display format.
446     $nameformat = $CFG->fullnamedisplay;
448     // Names that are required fields on user forms.
449     $necessarynames = array('firstname', 'lastname');
450     $languageformat = get_string('fullnamedisplay');
452     // Check that the language string and the $nameformat contain the necessary names.
453     foreach ($necessarynames as $necessaryname) {
454         $pattern = "/$necessaryname\b/";
455         if (!preg_match($pattern, $languageformat)) {
456             // If the language string has been altered then fall back on the below order.
457             $languageformat = 'firstname lastname';
458         }
459         if (!preg_match($pattern, $nameformat)) {
460             // If the nameformat doesn't contain the necessary name fields then use the languageformat.
461             $nameformat = $languageformat;
462         }
463     }
465     // Order all of the name fields in the postion they are written in the fullnamedisplay setting.
466     $necessarynames = order_in_string($necessarynames, $nameformat);
467     return $necessarynames;
470 /**
471  * Gets enabled (from fullnameformate setting) user name fields in appropriate order.
472  *
473  * @return array Enabled user name fields.
474  */
475 function useredit_get_enabled_name_fields() {
476     global $CFG;
478     // Get all of the other name fields which are not ranked as necessary.
479     $additionalusernamefields = array_diff(get_all_user_name_fields(), array('firstname', 'lastname'));
480     // Find out which additional name fields are actually being used from the fullnamedisplay setting.
481     $enabledadditionalusernames = array();
482     foreach ($additionalusernamefields as $enabledname) {
483         if (strpos($CFG->fullnamedisplay, $enabledname) !== false) {
484             $enabledadditionalusernames[] = $enabledname;
485         }
486     }
488     // Order all of the name fields in the postion they are written in the fullnamedisplay setting.
489     $enabledadditionalusernames = order_in_string($enabledadditionalusernames, $CFG->fullnamedisplay);
490     return $enabledadditionalusernames;
493 /**
494  * Gets user name fields not enabled from the setting fullnamedisplay.
495  *
496  * @param array $enabledadditionalusernames Current enabled additional user name fields.
497  * @return array Disabled user name fields.
498  */
499 function useredit_get_disabled_name_fields($enabledadditionalusernames = null) {
500     // If we don't have enabled additional user name information then go and fetch it (try to avoid).
501     if (!isset($enabledadditionalusernames)) {
502         $enabledadditionalusernames = useredit_get_enabled_name_fields();
503     }
505     // These are the additional fields that are not currently enabled.
506     $nonusednamefields = array_diff(get_all_user_name_fields(),
507             array_merge(array('firstname', 'lastname'), $enabledadditionalusernames));
508     return $nonusednamefields;