MDL-60548 profile: Show profile email when 'maildisplay' allows it.
[moodle.git] / user / editlib.php
CommitLineData
8bdc9cac 1<?php
a2ed6e69
SH
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/>.
ad6226fb 16
a2ed6e69
SH
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 */
24
25/**
26 * Cancels the requirement for a user to update their email address.
27 *
28 * @param int $userid
29 */
05c38e2b 30function cancel_email_update($userid) {
31 unset_user_preference('newemail', $userid);
32 unset_user_preference('newemailkey', $userid);
33 unset_user_preference('newemailattemptsleft', $userid);
34}
35
479fa47d
DW
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 */
44function useredit_setup_preference_page($userid, $courseid) {
45 global $PAGE, $SESSION, $DB, $CFG, $OUTPUT, $USER;
46
47 // Guest can not edit.
48 if (isguestuser()) {
49 print_error('guestnoeditprofile');
50 }
51
52 if (!$course = $DB->get_record('course', array('id' => $courseid))) {
53 print_error('invalidcourseid');
54 }
55
56 if ($course->id != SITEID) {
57 require_login($course);
58 } else if (!isloggedin()) {
59 if (empty($SESSION->wantsurl)) {
672f4836 60 $SESSION->wantsurl = $CFG->wwwroot.'/user/preferences.php';
479fa47d
DW
61 }
62 redirect(get_login_url());
63 } else {
64 $PAGE->set_context(context_system::instance());
65 }
66
67 // The user profile we are editing.
68 if (!$user = $DB->get_record('user', array('id' => $userid))) {
69 print_error('invaliduserid');
70 }
71
72 // Guest can not be edited.
73 if (isguestuser($user)) {
74 print_error('guestnoeditprofile');
75 }
76
77 // Remote users cannot be edited.
78 if (is_mnet_remote_user($user)) {
8df850ad 79 if (user_not_fully_set_up($user, false)) {
479fa47d
DW
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 }
85
86 $systemcontext = context_system::instance();
87 $personalcontext = context_user::instance($user->id);
88
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 }
95
96 } else {
97 // Teachers, parents, etc.
98 require_capability('moodle/user:editprofile', $personalcontext);
45367bdf 99
479fa47d
DW
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 }
105
106 if ($user->deleted) {
107 echo $OUTPUT->header();
108 echo $OUTPUT->heading(get_string('userdeleted'));
109 echo $OUTPUT->footer();
110 die;
111 }
112
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 }
122
123 return array($user, $course);
124}
125
a2ed6e69
SH
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 */
05c38e2b 132function useredit_load_preferences(&$user, $reload=true) {
133 global $USER;
14a6b7e1 134
05c38e2b 135 if (!empty($user->id)) {
136 if ($reload and $USER->id == $user->id) {
a2ed6e69 137 // Reload preferences in case it was changed in other session.
05c38e2b 138 unset($USER->preference);
139 }
aa6c1ced 140
05c38e2b 141 if ($preferences = get_user_preferences(null, null, $user->id)) {
a2ed6e69 142 foreach ($preferences as $name => $value) {
05c38e2b 143 $user->{'preference_'.$name} = $value;
144 }
14a6b7e1 145 }
146 }
147}
148
a2ed6e69 149/**
6e65554e 150 * Updates the user preferences for the given user
a2ed6e69 151 *
6e65554e
MG
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_
a2ed6e69 160 */
14a6b7e1 161function useredit_update_user_preference($usernew) {
6e65554e 162 global $USER;
14a6b7e1 163 $ua = (array)$usernew;
6e65554e
MG
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 }
174
a2ed6e69 175 foreach ($ua as $key => $value) {
14a6b7e1 176 if (strpos($key, 'preference_') === 0) {
177 $name = substr($key, strlen('preference_'));
6e65554e
MG
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 }
14a6b7e1 182 }
183 }
184}
185
4125bdc1 186/**
a2ed6e69 187 * Updates the provided users profile picture based upon the expected fields returned from the edit or edit_advanced forms.
4125bdc1 188 *
5407c5b0 189 * @deprecated since Moodle 3.2 MDL-51789 - please use core_user::update_picture() instead.
3584865b 190 * @todo MDL-54858 This will be deleted in Moodle 3.6.
5407c5b0
RS
191 * @see core_user::update_picture()
192 *
4125bdc1
SH
193 * @global moodle_database $DB
194 * @param stdClass $usernew An object that contains some information about the user being updated
5407c5b0 195 * @param moodleform $userform The form that was submitted to edit the form (unused)
a2ed6e69 196 * @param array $filemanageroptions
4125bdc1
SH
197 * @return bool True if the user was updated, false if it stayed the same.
198 */
4e782b32 199function useredit_update_picture(stdClass $usernew, moodleform $userform, $filemanageroptions = array()) {
5407c5b0
RS
200 debugging('useredit_update_picture() is deprecated. Please use core_user::update_picture() instead.', DEBUG_DEVELOPER);
201 return core_user::update_picture($usernew, $filemanageroptions);
14a6b7e1 202}
203
a2ed6e69
SH
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 */
14a6b7e1 210function useredit_update_bounces($user, $usernew) {
211 if (!isset($usernew->email)) {
a2ed6e69 212 // Locked field.
14a6b7e1 213 return;
d8734783 214 }
a9457b54 215 if (!isset($user->email) || $user->email !== $usernew->email) {
a2ed6e69
SH
216 set_bounce_count($usernew, true);
217 set_send_count($usernew, true);
14a6b7e1 218 }
219}
220
a2ed6e69
SH
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 */
14a6b7e1 227function useredit_update_trackforums($user, $usernew) {
228 global $CFG;
229 if (!isset($usernew->trackforums)) {
a2ed6e69 230 // Locked field.
14a6b7e1 231 return;
232 }
a9457b54 233 if ((!isset($user->trackforums) || ($usernew->trackforums != $user->trackforums)) and !$usernew->trackforums) {
14a6b7e1 234 require_once($CFG->dirroot.'/mod/forum/lib.php');
235 forum_tp_delete_read_records($usernew->id);
236 }
237}
238
a2ed6e69
SH
239/**
240 * Updates a users interests.
241 *
242 * @param stdClass $user
243 * @param array $interests
244 */
c060fc6a 245function useredit_update_interests($user, $interests) {
c4e868d5
MG
246 core_tag_tag::set_item_tags('core', 'user', $user->id,
247 context_user::instance($user->id), $interests);
1e1c51a3 248}
249
a2ed6e69
SH
250/**
251 * Powerful function that is used by edit and editadvanced to add common form elements/rules/etc.
252 *
253 * @param moodleform $mform
d6e7a63d
PS
254 * @param array $editoroptions
255 * @param array $filemanageroptions
256 * @param stdClass $user
a2ed6e69 257 */
d6e7a63d 258function useredit_shared_definition(&$mform, $editoroptions, $filemanageroptions, $user) {
d6ace123 259 global $CFG, $USER, $DB;
260
d6e7a63d
PS
261 if ($user->id > 0) {
262 useredit_load_preferences($user, false);
263 }
14a6b7e1 264
265 $strrequired = get_string('required');
e9c27d1e 266 $stringman = get_string_manager();
d8734783 267
1cc3a9ae
AG
268 // Add the necessary names.
269 foreach (useredit_get_required_name_fields() as $fullname) {
a327f25e 270 $mform->addElement('text', $fullname, get_string($fullname), 'maxlength="100" size="30"');
e9c27d1e
DM
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');
a327f25e
AG
277 $mform->setType($fullname, PARAM_NOTAGS);
278 }
d8734783 279
1cc3a9ae
AG
280 $enabledusernamefields = useredit_get_enabled_name_fields();
281 // Add the enabled additional name fields.
282 foreach ($enabledusernamefields as $addname) {
a327f25e
AG
283 $mform->addElement('text', $addname, get_string($addname), 'maxlength="100" size="30"');
284 $mform->setType($addname, PARAM_NOTAGS);
285 }
d8734783 286
a2ed6e69 287 // Do not show email field if change confirmation is pending.
d6e7a63d 288 if ($user->id > 0 and !empty($CFG->emailchangeconfirmation) and !empty($user->preference_newemail)) {
c6a074f8 289 $notice = get_string('emailchangepending', 'auth', $user);
d6ace123 290 $notice .= '<br /><a href="edit.php?cancelemailchange=1&amp;id='.$user->id.'">'
c6a074f8 291 . get_string('emailchangecancel', 'auth') . '</a>';
d6ace123 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');
947ab40b 296 $mform->setType('email', PARAM_RAW_TRIMMED);
d6ace123 297 }
d8734783 298
479fa47d
DW
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);
ac9768fc 304 $mform->setDefault('maildisplay', core_user::get_property_default('maildisplay'));
479fa47d 305
c5c0d2ff 306 $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="21"');
071e68f9 307 $mform->setType('city', PARAM_TEXT);
fa7f750c
PS
308 if (!empty($CFG->defaultcity)) {
309 $mform->setDefault('city', $CFG->defaultcity);
310 }
d8734783 311
0aa759b0 312 $choices = get_string_manager()->get_list_of_countries();
a2ed6e69 313 $choices = array('' => get_string('selectacountry') . '...') + $choices;
d8734783 314 $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
d8734783 315 if (!empty($CFG->country)) {
ac9768fc 316 $mform->setDefault('country', core_user::get_property_default('country'));
d8734783 317 }
318
d6e7a63d
PS
319 if (isset($CFG->forcetimezone) and $CFG->forcetimezone != 99) {
320 $choices = core_date::get_list_of_timezones($CFG->forcetimezone);
d8734783 321 $mform->addElement('static', 'forcedtimezone', get_string('timezone'), $choices[$CFG->forcetimezone]);
d6e7a63d 322 $mform->addElement('hidden', 'timezone');
ac9768fc 323 $mform->setType('timezone', core_user::get_property_type('timezone'));
d8734783 324 } else {
d6e7a63d 325 $choices = core_date::get_list_of_timezones($user->timezone, true);
d8734783 326 $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
d8734783 327 }
328
d8734783 329 if (!empty($CFG->allowuserthemes)) {
ad6226fb 330 $choices = array();
d8734783 331 $choices[''] = get_string('default');
36798745 332 $themes = get_list_of_themes();
a2ed6e69 333 foreach ($themes as $key => $theme) {
36798745 334 if (empty($theme->hidefromselector)) {
d609d962 335 $choices[$key] = get_string('pluginname', 'theme_'.$theme->name);
36798745
SH
336 }
337 }
c3ed4a5a 338 $mform->addElement('select', 'theme', get_string('preferredtheme'), $choices);
d8734783 339 }
ad6226fb 340
8bdc9cac
SH
341 $mform->addElement('editor', 'description_editor', get_string('userdescription'), null, $editoroptions);
342 $mform->setType('description_editor', PARAM_CLEANHTML);
27d1a27c 343 $mform->addHelpButton('description_editor', 'userdescription');
ad6226fb 344
689096bc 345 if (empty($USER->newadminuser)) {
757e89d2 346 $mform->addElement('header', 'moodle_picture', get_string('pictureofuser'));
80ef91ef 347 $mform->setExpanded('moodle_picture', true);
ad6226fb 348
4125bdc1 349 if (!empty($CFG->enablegravatar)) {
ed9e0cb6 350 $mform->addElement('html', html_writer::tag('p', get_string('gravatarenabled')));
4125bdc1
SH
351 }
352
d8734783 353 $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
ad6226fb 354
febd7a62 355 $mform->addElement('checkbox', 'deletepicture', get_string('deletepicture'));
edfd6a5e 356 $mform->setDefault('deletepicture', 0);
ad6226fb 357
4e782b32 358 $mform->addElement('filemanager', 'imagefile', get_string('newpicture'), '', $filemanageroptions);
27d1a27c 359 $mform->addHelpButton('imagefile', 'newpicture');
ad6226fb 360
d8734783 361 $mform->addElement('text', 'imagealt', get_string('imagealt'), 'maxlength="100" size="30"');
071e68f9 362 $mform->setType('imagealt', PARAM_TEXT);
ad6226fb 363
d8734783 364 }
ad6226fb 365
1cc3a9ae
AG
366 // Display user name fields that are not currenlty enabled here if there are any.
367 $disabledusernamefields = useredit_get_disabled_name_fields($enabledusernamefields);
b63f542d 368 if (count($disabledusernamefields) > 0) {
a327f25e 369 $mform->addElement('header', 'moodle_additional_names', get_string('additionalnames'));
1cc3a9ae
AG
370 foreach ($disabledusernamefields as $allname) {
371 $mform->addElement('text', $allname, get_string($allname), 'maxlength="100" size="30"');
372 $mform->setType($allname, PARAM_NOTAGS);
a327f25e 373 }
a327f25e
AG
374 }
375
c4e868d5 376 if (core_tag_tag::is_enabled('core', 'user') and empty($USER->newadminuser)) {
1e1c51a3 377 $mform->addElement('header', 'moodle_interests', get_string('interests'));
c4e868d5 378 $mform->addElement('tags', 'interests', get_string('interestslist'),
4be9c7ad 379 array('itemtype' => 'user', 'component' => 'core'));
27d1a27c 380 $mform->addHelpButton('interests', 'interestslist');
1e1c51a3 381 }
d6ace123 382
a2ed6e69 383 // Moodle optional fields.
c3ed4a5a 384 $mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
ad6226fb 385
d8734783 386 $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
ac9768fc 387 $mform->setType('url', core_user::get_property_type('url'));
ad6226fb 388
d8734783 389 $mform->addElement('text', 'icq', get_string('icqnumber'), 'maxlength="15" size="25"');
ac9768fc 390 $mform->setType('icq', core_user::get_property_type('icq'));
525ef9c8 391 $mform->setForceLtr('icq');
ad6226fb 392
d8734783 393 $mform->addElement('text', 'skype', get_string('skypeid'), 'maxlength="50" size="25"');
ac9768fc 394 $mform->setType('skype', core_user::get_property_type('skype'));
525ef9c8 395 $mform->setForceLtr('skype');
ad6226fb 396
d8734783 397 $mform->addElement('text', 'aim', get_string('aimid'), 'maxlength="50" size="25"');
ac9768fc 398 $mform->setType('aim', core_user::get_property_type('aim'));
525ef9c8 399 $mform->setForceLtr('aim');
ad6226fb 400
d8734783 401 $mform->addElement('text', 'yahoo', get_string('yahooid'), 'maxlength="50" size="25"');
ac9768fc 402 $mform->setType('yahoo', core_user::get_property_type('yahoo'));
525ef9c8 403 $mform->setForceLtr('yahoo');
ad6226fb 404
d8734783 405 $mform->addElement('text', 'msn', get_string('msnid'), 'maxlength="50" size="25"');
ac9768fc 406 $mform->setType('msn', core_user::get_property_type('msn'));
525ef9c8 407 $mform->setForceLtr('msn');
ad6226fb 408
8b9cfac4 409 $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
ac9768fc 410 $mform->setType('idnumber', core_user::get_property_type('idnumber'));
ad6226fb 411
a8fd33b0 412 $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="255" size="25"');
ac9768fc 413 $mform->setType('institution', core_user::get_property_type('institution'));
ad6226fb 414
a8fd33b0 415 $mform->addElement('text', 'department', get_string('department'), 'maxlength="255" size="25"');
ac9768fc 416 $mform->setType('department', core_user::get_property_type('department'));
ad6226fb 417
70fb46c8 418 $mform->addElement('text', 'phone1', get_string('phone1'), 'maxlength="20" size="25"');
ac9768fc 419 $mform->setType('phone1', core_user::get_property_type('phone1'));
525ef9c8 420 $mform->setForceLtr('phone1');
ad6226fb 421
55ac3d6f 422 $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
ac9768fc 423 $mform->setType('phone2', core_user::get_property_type('phone2'));
525ef9c8 424 $mform->setForceLtr('phone2');
ad6226fb 425
a8fd33b0 426 $mform->addElement('text', 'address', get_string('address'), 'maxlength="255" size="25"');
ac9768fc 427 $mform->setType('address', core_user::get_property_type('address'));
14a6b7e1 428}
ad6226fb 429
1cc3a9ae
AG
430/**
431 * Return required user name fields for forms.
432 *
433 * @return array required user name fields in order according to settings.
434 */
435function useredit_get_required_name_fields() {
436 global $CFG;
437
438 // Get the name display format.
439 $nameformat = $CFG->fullnamedisplay;
440
441 // Names that are required fields on user forms.
442 $necessarynames = array('firstname', 'lastname');
443 $languageformat = get_string('fullnamedisplay');
444
445 // Check that the language string and the $nameformat contain the necessary names.
446 foreach ($necessarynames as $necessaryname) {
447 $pattern = "/$necessaryname\b/";
448 if (!preg_match($pattern, $languageformat)) {
449 // If the language string has been altered then fall back on the below order.
450 $languageformat = 'firstname lastname';
451 }
452 if (!preg_match($pattern, $nameformat)) {
453 // If the nameformat doesn't contain the necessary name fields then use the languageformat.
454 $nameformat = $languageformat;
455 }
456 }
457
458 // Order all of the name fields in the postion they are written in the fullnamedisplay setting.
459 $necessarynames = order_in_string($necessarynames, $nameformat);
460 return $necessarynames;
461}
462
463/**
464 * Gets enabled (from fullnameformate setting) user name fields in appropriate order.
465 *
466 * @return array Enabled user name fields.
467 */
468function useredit_get_enabled_name_fields() {
469 global $CFG;
470
471 // Get all of the other name fields which are not ranked as necessary.
472 $additionalusernamefields = array_diff(get_all_user_name_fields(), array('firstname', 'lastname'));
473 // Find out which additional name fields are actually being used from the fullnamedisplay setting.
474 $enabledadditionalusernames = array();
475 foreach ($additionalusernamefields as $enabledname) {
476 if (strpos($CFG->fullnamedisplay, $enabledname) !== false) {
477 $enabledadditionalusernames[] = $enabledname;
478 }
479 }
480
481 // Order all of the name fields in the postion they are written in the fullnamedisplay setting.
482 $enabledadditionalusernames = order_in_string($enabledadditionalusernames, $CFG->fullnamedisplay);
483 return $enabledadditionalusernames;
484}
485
486/**
487 * Gets user name fields not enabled from the setting fullnamedisplay.
488 *
489 * @param array $enabledadditionalusernames Current enabled additional user name fields.
490 * @return array Disabled user name fields.
491 */
492function useredit_get_disabled_name_fields($enabledadditionalusernames = null) {
493 // If we don't have enabled additional user name information then go and fetch it (try to avoid).
494 if (!isset($enabledadditionalusernames)) {
495 $enabledadditionalusernames = useredit_get_enabled_name_fields();
496 }
497
498 // These are the additional fields that are not currently enabled.
499 $nonusednamefields = array_diff(get_all_user_name_fields(),
500 array_merge(array('firstname', 'lastname'), $enabledadditionalusernames));
501 return $nonusednamefields;
502}