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/>.
  16
  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  */
  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 }
  35
  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;
  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)) {
  60             $SESSION->wantsurl = $CFG->wwwroot.'/user/preferences.php';
  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)) {
  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     }
  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);
  99
 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
 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;
 134
 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         }
 140
 141         if ($preferences = get_user_preferences(null, null, $user->id)) {
 142             foreach ($preferences as $name => $value) {
 143                 $user->{'preference_'.$name} = $value;
 144             }
 145         }
 146     }
 147 }
 148
 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     }
 174
 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     }
 184 }
 185
 186 /**
 187  * @deprecated since Moodle 3.2
 188  * @see core_user::update_picture()
 189  */
 190 function useredit_update_picture() {
 191     throw new coding_exception('useredit_update_picture() can not be used anymore. Please use ' .
 192         'core_user::update_picture() instead.');
 193 }
 194
 195 /**
 196  * Updates the user email bounce + send counts when the user is edited.
 197  *
 198  * @param stdClass $user The current user object.
 199  * @param stdClass $usernew The updated user object.
 200  */
 201 function useredit_update_bounces($user, $usernew) {
 202     if (!isset($usernew->email)) {
 203         // Locked field.
 204         return;
 205     }
 206     if (!isset($user->email) || $user->email !== $usernew->email) {
 207         set_bounce_count($usernew, true);
 208         set_send_count($usernew, true);
 209     }
 210 }
 211
 212 /**
 213  * Updates the forums a user is tracking when the user is edited.
 214  *
 215  * @param stdClass $user The original user object.
 216  * @param stdClass $usernew The updated user object.
 217  */
 218 function useredit_update_trackforums($user, $usernew) {
 219     global $CFG;
 220     if (!isset($usernew->trackforums)) {
 221         // Locked field.
 222         return;
 223     }
 224     if ((!isset($user->trackforums) || ($usernew->trackforums != $user->trackforums)) and !$usernew->trackforums) {
 225         require_once($CFG->dirroot.'/mod/forum/lib.php');
 226         forum_tp_delete_read_records($usernew->id);
 227     }
 228 }
 229
 230 /**
 231  * Updates a users interests.
 232  *
 233  * @param stdClass $user
 234  * @param array $interests
 235  */
 236 function useredit_update_interests($user, $interests) {
 237     core_tag_tag::set_item_tags('core', 'user', $user->id,
 238             context_user::instance($user->id), $interests);
 239 }
 240
 241 /**
 242  * Powerful function that is used by edit and editadvanced to add common form elements/rules/etc.
 243  *
 244  * @param moodleform $mform
 245  * @param array $editoroptions
 246  * @param array $filemanageroptions
 247  * @param stdClass $user
 248  */
 249 function useredit_shared_definition(&$mform, $editoroptions, $filemanageroptions, $user) {
 250     global $CFG, $USER, $DB;
 251
 252     if ($user->id > 0) {
 253         useredit_load_preferences($user, false);
 254     }
 255
 256     $strrequired = get_string('required');
 257     $stringman = get_string_manager();
 258
 259     // Add the necessary names.
 260     foreach (useredit_get_required_name_fields() as $fullname) {
 261         $mform->addElement('text', $fullname,  get_string($fullname),  'maxlength="100" size="30"');
 262         if ($stringman->string_exists('missing'.$fullname, 'core')) {
 263             $strmissingfield = get_string('missing'.$fullname, 'core');
 264         } else {
 265             $strmissingfield = $strrequired;
 266         }
 267         $mform->addRule($fullname, $strmissingfield, 'required', null, 'client');
 268         $mform->setType($fullname, PARAM_NOTAGS);
 269     }
 270
 271     $enabledusernamefields = useredit_get_enabled_name_fields();
 272     // Add the enabled additional name fields.
 273     foreach ($enabledusernamefields as $addname) {
 274         $mform->addElement('text', $addname,  get_string($addname), 'maxlength="100" size="30"');
 275         $mform->setType($addname, PARAM_NOTAGS);
 276     }
 277
 278     // Do not show email field if change confirmation is pending.
 279     if ($user->id > 0 and !empty($CFG->emailchangeconfirmation) and !empty($user->preference_newemail)) {
 280         $notice = get_string('emailchangepending', 'auth', $user);
 281         $notice .= '<br /><a href="edit.php?cancelemailchange=1&amp;id='.$user->id.'">'
 282                 . get_string('emailchangecancel', 'auth') . '</a>';
 283         $mform->addElement('static', 'emailpending', get_string('email'), $notice);
 284     } else {
 285         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="30"');
 286         $mform->addRule('email', $strrequired, 'required', null, 'client');
 287         $mform->setType('email', PARAM_RAW_TRIMMED);
 288     }
 289
 290     $choices = array();
 291     $choices['0'] = get_string('emaildisplayno');
 292     $choices['1'] = get_string('emaildisplayyes');
 293     $choices['2'] = get_string('emaildisplaycourse');
 294     $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
 295     $mform->setDefault('maildisplay', core_user::get_property_default('maildisplay'));
 296     $mform->addHelpButton('maildisplay', 'emaildisplay');
 297
 298     $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="21"');
 299     $mform->setType('city', PARAM_TEXT);
 300     if (!empty($CFG->defaultcity)) {
 301         $mform->setDefault('city', $CFG->defaultcity);
 302     }
 303
 304     $choices = get_string_manager()->get_list_of_countries();
 305     $choices = array('' => get_string('selectacountry') . '...') + $choices;
 306     $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
 307     if (!empty($CFG->country)) {
 308         $mform->setDefault('country', core_user::get_property_default('country'));
 309     }
 310
 311     if (isset($CFG->forcetimezone) and $CFG->forcetimezone != 99) {
 312         $choices = core_date::get_list_of_timezones($CFG->forcetimezone);
 313         $mform->addElement('static', 'forcedtimezone', get_string('timezone'), $choices[$CFG->forcetimezone]);
 314         $mform->addElement('hidden', 'timezone');
 315         $mform->setType('timezone', core_user::get_property_type('timezone'));
 316     } else {
 317         $choices = core_date::get_list_of_timezones($user->timezone, true);
 318         $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
 319     }
 320
 321     if ($user->id < 0) {
 322         $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
 323         $lang = empty($user->lang) ? $CFG->lang : $user->lang;
 324         $mform->setDefault('lang', $lang);
 325     }
 326
 327     if (!empty($CFG->allowuserthemes)) {
 328         $choices = array();
 329         $choices[''] = get_string('default');
 330         $themes = get_list_of_themes();
 331         foreach ($themes as $key => $theme) {
 332             if (empty($theme->hidefromselector)) {
 333                 $choices[$key] = get_string('pluginname', 'theme_'.$theme->name);
 334             }
 335         }
 336         $mform->addElement('select', 'theme', get_string('preferredtheme'), $choices);
 337     }
 338
 339     $mform->addElement('editor', 'description_editor', get_string('userdescription'), null, $editoroptions);
 340     $mform->setType('description_editor', PARAM_RAW);
 341     $mform->addHelpButton('description_editor', 'userdescription');
 342
 343     if (empty($USER->newadminuser)) {
 344         $mform->addElement('header', 'moodle_picture', get_string('pictureofuser'));
 345         $mform->setExpanded('moodle_picture', true);
 346
 347         if (!empty($CFG->enablegravatar)) {
 348             $mform->addElement('html', html_writer::tag('p', get_string('gravatarenabled')));
 349         }
 350
 351         $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
 352
 353         $mform->addElement('checkbox', 'deletepicture', get_string('deletepicture'));
 354         $mform->setDefault('deletepicture', 0);
 355
 356         $mform->addElement('filemanager', 'imagefile', get_string('newpicture'), '', $filemanageroptions);
 357         $mform->addHelpButton('imagefile', 'newpicture');
 358
 359         $mform->addElement('text', 'imagealt', get_string('imagealt'), 'maxlength="100" size="30"');
 360         $mform->setType('imagealt', PARAM_TEXT);
 361
 362     }
 363
 364     // Display user name fields that are not currenlty enabled here if there are any.
 365     $disabledusernamefields = useredit_get_disabled_name_fields($enabledusernamefields);
 366     if (count($disabledusernamefields) > 0) {
 367         $mform->addElement('header', 'moodle_additional_names', get_string('additionalnames'));
 368         foreach ($disabledusernamefields as $allname) {
 369             $mform->addElement('text', $allname, get_string($allname), 'maxlength="100" size="30"');
 370             $mform->setType($allname, PARAM_NOTAGS);
 371         }
 372     }
 373
 374     if (core_tag_tag::is_enabled('core', 'user') and empty($USER->newadminuser)) {
 375         $mform->addElement('header', 'moodle_interests', get_string('interests'));
 376         $mform->addElement('tags', 'interests', get_string('interestslist'),
 377             array('itemtype' => 'user', 'component' => 'core'));
 378         $mform->addHelpButton('interests', 'interestslist');
 379     }
 380
 381     // Moodle optional fields.
 382     $mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
 383
 384     $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
 385     $mform->setType('url', core_user::get_property_type('url'));
 386
 387     $mform->addElement('text', 'icq', get_string('icqnumber'), 'maxlength="15" size="25"');
 388     $mform->setType('icq', core_user::get_property_type('icq'));
 389     $mform->setForceLtr('icq');
 390
 391     $mform->addElement('text', 'skype', get_string('skypeid'), 'maxlength="50" size="25"');
 392     $mform->setType('skype', core_user::get_property_type('skype'));
 393     $mform->setForceLtr('skype');
 394
 395     $mform->addElement('text', 'aim', get_string('aimid'), 'maxlength="50" size="25"');
 396     $mform->setType('aim', core_user::get_property_type('aim'));
 397     $mform->setForceLtr('aim');
 398
 399     $mform->addElement('text', 'yahoo', get_string('yahooid'), 'maxlength="50" size="25"');
 400     $mform->setType('yahoo', core_user::get_property_type('yahoo'));
 401     $mform->setForceLtr('yahoo');
 402
 403     $mform->addElement('text', 'msn', get_string('msnid'), 'maxlength="50" size="25"');
 404     $mform->setType('msn', core_user::get_property_type('msn'));
 405     $mform->setForceLtr('msn');
 406
 407     $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
 408     $mform->setType('idnumber', core_user::get_property_type('idnumber'));
 409
 410     $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="255" size="25"');
 411     $mform->setType('institution', core_user::get_property_type('institution'));
 412
 413     $mform->addElement('text', 'department', get_string('department'), 'maxlength="255" size="25"');
 414     $mform->setType('department', core_user::get_property_type('department'));
 415
 416     $mform->addElement('text', 'phone1', get_string('phone1'), 'maxlength="20" size="25"');
 417     $mform->setType('phone1', core_user::get_property_type('phone1'));
 418     $mform->setForceLtr('phone1');
 419
 420     $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
 421     $mform->setType('phone2', core_user::get_property_type('phone2'));
 422     $mform->setForceLtr('phone2');
 423
 424     $mform->addElement('text', 'address', get_string('address'), 'maxlength="255" size="25"');
 425     $mform->setType('address', core_user::get_property_type('address'));
 426 }
 427
 428 /**
 429  * Return required user name fields for forms.
 430  *
 431  * @return array required user name fields in order according to settings.
 432  */
 433 function useredit_get_required_name_fields() {
 434     global $CFG;
 435
 436     // Get the name display format.
 437     $nameformat = $CFG->fullnamedisplay;
 438
 439     // Names that are required fields on user forms.
 440     $necessarynames = array('firstname', 'lastname');
 441     $languageformat = get_string('fullnamedisplay');
 442
 443     // Check that the language string and the $nameformat contain the necessary names.
 444     foreach ($necessarynames as $necessaryname) {
 445         $pattern = "/$necessaryname\b/";
 446         if (!preg_match($pattern, $languageformat)) {
 447             // If the language string has been altered then fall back on the below order.
 448             $languageformat = 'firstname lastname';
 449         }
 450         if (!preg_match($pattern, $nameformat)) {
 451             // If the nameformat doesn't contain the necessary name fields then use the languageformat.
 452             $nameformat = $languageformat;
 453         }
 454     }
 455
 456     // Order all of the name fields in the postion they are written in the fullnamedisplay setting.
 457     $necessarynames = order_in_string($necessarynames, $nameformat);
 458     return $necessarynames;
 459 }
 460
 461 /**
 462  * Gets enabled (from fullnameformate setting) user name fields in appropriate order.
 463  *
 464  * @return array Enabled user name fields.
 465  */
 466 function useredit_get_enabled_name_fields() {
 467     global $CFG;
 468
 469     // Get all of the other name fields which are not ranked as necessary.
 470     $additionalusernamefields = array_diff(get_all_user_name_fields(), array('firstname', 'lastname'));
 471     // Find out which additional name fields are actually being used from the fullnamedisplay setting.
 472     $enabledadditionalusernames = array();
 473     foreach ($additionalusernamefields as $enabledname) {
 474         if (strpos($CFG->fullnamedisplay, $enabledname) !== false) {
 475             $enabledadditionalusernames[] = $enabledname;
 476         }
 477     }
 478
 479     // Order all of the name fields in the postion they are written in the fullnamedisplay setting.
 480     $enabledadditionalusernames = order_in_string($enabledadditionalusernames, $CFG->fullnamedisplay);
 481     return $enabledadditionalusernames;
 482 }
 483
 484 /**
 485  * Gets user name fields not enabled from the setting fullnamedisplay.
 486  *
 487  * @param array $enabledadditionalusernames Current enabled additional user name fields.
 488  * @return array Disabled user name fields.
 489  */
 490 function useredit_get_disabled_name_fields($enabledadditionalusernames = null) {
 491     // If we don't have enabled additional user name information then go and fetch it (try to avoid).
 492     if (!isset($enabledadditionalusernames)) {
 493         $enabledadditionalusernames = useredit_get_enabled_name_fields();
 494     }
 495
 496     // These are the additional fields that are not currently enabled.
 497     $nonusednamefields = array_diff(get_all_user_name_fields(),
 498             array_merge(array('firstname', 'lastname'), $enabledadditionalusernames));
 499     return $nonusednamefields;
 500 }