user/editlib.php

   1 <?php
   2
   3 function cancel_email_update($userid) {
   4     unset_user_preference('newemail', $userid);
   5     unset_user_preference('newemailkey', $userid);
   6     unset_user_preference('newemailattemptsleft', $userid);
   7 }
   8
   9 function useredit_load_preferences(&$user, $reload=true) {
  10     global $USER;
  11
  12     if (!empty($user->id)) {
  13         if ($reload and $USER->id == $user->id) {
  14             // reload preferences in case it was changed in other session
  15             unset($USER->preference);
  16         }
  17
  18         if ($preferences = get_user_preferences(null, null, $user->id)) {
  19             foreach($preferences as $name=>$value) {
  20                 $user->{'preference_'.$name} = $value;
  21             }
  22         }
  23     }
  24 }
  25
  26 function useredit_update_user_preference($usernew) {
  27     $ua = (array)$usernew;
  28     foreach($ua as $key=>$value) {
  29         if (strpos($key, 'preference_') === 0) {
  30             $name = substr($key, strlen('preference_'));
  31             set_user_preference($name, $value, $usernew->id);
  32         }
  33     }
  34 }
  35
  36 /**
  37  * Updates the provided users profile picture based upon the expected fields
  38  * returned from the edit or edit_advanced forms.
  39  *
  40  * @global moodle_database $DB
  41  * @param stdClass $usernew An object that contains some information about the user being updated
  42  * @param moodleform $userform The form that was submitted to edit the form
  43  * @return bool True if the user was updated, false if it stayed the same.
  44  */
  45 function useredit_update_picture(stdClass $usernew, moodleform $userform, $filemanageroptions = array()) {
  46     global $CFG, $DB;
  47     require_once("$CFG->libdir/gdlib.php");
  48
  49     $context = context_user::instance($usernew->id, MUST_EXIST);
  50     $user = $DB->get_record('user', array('id'=>$usernew->id), 'id, picture', MUST_EXIST);
  51
  52     $newpicture = $user->picture;
  53     // Get file_storage to process files.
  54     $fs = get_file_storage();
  55     if (!empty($usernew->deletepicture)) {
  56         // The user has chosen to delete the selected users picture
  57         $fs->delete_area_files($context->id, 'user', 'icon'); // drop all images in area
  58         $newpicture = 0;
  59
  60     } else {
  61         // Save newly uploaded file, this will avoid context mismatch for newly created users.
  62         file_save_draft_area_files($usernew->imagefile, $context->id, 'user', 'newicon', 0, $filemanageroptions);
  63         if (($iconfiles = $fs->get_area_files($context->id, 'user', 'newicon')) && count($iconfiles) == 2) {
  64             // Get file which was uploaded in draft area
  65             foreach ($iconfiles as $file) {
  66                 if (!$file->is_directory()) {
  67                     break;
  68                 }
  69             }
  70             // Copy file to temporary location and the send it for processing icon
  71             if ($iconfile = $file->copy_content_to_temp()) {
  72                 // There is a new image that has been uploaded
  73                 // Process the new image and set the user to make use of it.
  74                 // NOTE: Uploaded images always take over Gravatar
  75                 $newpicture = (int)process_new_icon($context, 'user', 'icon', 0, $iconfile);
  76                 // Delete temporary file
  77                 @unlink($iconfile);
  78                 // Remove uploaded file.
  79                 $fs->delete_area_files($context->id, 'user', 'newicon');
  80             } else {
  81                 // Something went wrong while creating temp file.
  82                 // Remove uploaded file.
  83                 $fs->delete_area_files($context->id, 'user', 'newicon');
  84                 return false;
  85             }
  86         }
  87     }
  88
  89     if ($newpicture != $user->picture) {
  90         $DB->set_field('user', 'picture', $newpicture, array('id' => $user->id));
  91         return true;
  92     } else {
  93         return false;
  94     }
  95 }
  96
  97 function useredit_update_bounces($user, $usernew) {
  98     if (!isset($usernew->email)) {
  99         //locked field
 100         return;
 101     }
 102     if (!isset($user->email) || $user->email !== $usernew->email) {
 103         set_bounce_count($usernew,true);
 104         set_send_count($usernew,true);
 105     }
 106 }
 107
 108 function useredit_update_trackforums($user, $usernew) {
 109     global $CFG;
 110     if (!isset($usernew->trackforums)) {
 111         //locked field
 112         return;
 113     }
 114     if ((!isset($user->trackforums) || ($usernew->trackforums != $user->trackforums)) and !$usernew->trackforums) {
 115         require_once($CFG->dirroot.'/mod/forum/lib.php');
 116         forum_tp_delete_read_records($usernew->id);
 117     }
 118 }
 119
 120 function useredit_update_interests($user, $interests) {
 121     tag_set('user', $user->id, $interests);
 122 }
 123
 124 function useredit_shared_definition(&$mform, $editoroptions = null, $filemanageroptions = null) {
 125     global $CFG, $USER, $DB;
 126
 127     $user = $DB->get_record('user', array('id' => $USER->id));
 128     useredit_load_preferences($user, false);
 129
 130     $strrequired = get_string('required');
 131
 132     // Add the necessary names.
 133     foreach (useredit_get_required_name_fields() as $fullname) {
 134         $mform->addElement('text', $fullname,  get_string($fullname),  'maxlength="100" size="30"');
 135         $mform->addRule($fullname, $strrequired, 'required', null, 'client');
 136         $mform->setType($fullname, PARAM_NOTAGS);
 137     }
 138
 139     $enabledusernamefields = useredit_get_enabled_name_fields();
 140     // Add the enabled additional name fields.
 141     foreach ($enabledusernamefields as $addname) {
 142         $mform->addElement('text', $addname,  get_string($addname), 'maxlength="100" size="30"');
 143         $mform->setType($addname, PARAM_NOTAGS);
 144     }
 145
 146     // Do not show email field if change confirmation is pending
 147     if (!empty($CFG->emailchangeconfirmation) and !empty($user->preference_newemail)) {
 148         $notice = get_string('emailchangepending', 'auth', $user);
 149         $notice .= '<br /><a href="edit.php?cancelemailchange=1&amp;id='.$user->id.'">'
 150                 . get_string('emailchangecancel', 'auth') . '</a>';
 151         $mform->addElement('static', 'emailpending', get_string('email'), $notice);
 152     } else {
 153         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="30"');
 154         $mform->addRule('email', $strrequired, 'required', null, 'client');
 155         $mform->setType('email', PARAM_EMAIL);
 156     }
 157
 158     $choices = array();
 159     $choices['0'] = get_string('emaildisplayno');
 160     $choices['1'] = get_string('emaildisplayyes');
 161     $choices['2'] = get_string('emaildisplaycourse');
 162     $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
 163     $mform->setDefault('maildisplay', 2);
 164
 165     $choices = array();
 166     $choices['0'] = get_string('textformat');
 167     $choices['1'] = get_string('htmlformat');
 168     $mform->addElement('select', 'mailformat', get_string('emailformat'), $choices);
 169     $mform->setDefault('mailformat', 1);
 170
 171     if (!empty($CFG->allowusermailcharset)) {
 172         $choices = array();
 173         $charsets = get_list_of_charsets();
 174         if (!empty($CFG->sitemailcharset)) {
 175             $choices['0'] = get_string('site').' ('.$CFG->sitemailcharset.')';
 176         } else {
 177             $choices['0'] = get_string('site').' (UTF-8)';
 178         }
 179         $choices = array_merge($choices, $charsets);
 180         $mform->addElement('select', 'preference_mailcharset', get_string('emailcharset'), $choices);
 181     }
 182
 183     $choices = array();
 184     $choices['0'] = get_string('emaildigestoff');
 185     $choices['1'] = get_string('emaildigestcomplete');
 186     $choices['2'] = get_string('emaildigestsubjects');
 187     $mform->addElement('select', 'maildigest', get_string('emaildigest'), $choices);
 188     $mform->setDefault('maildigest', 0);
 189     $mform->addHelpButton('maildigest', 'emaildigest');
 190
 191     $choices = array();
 192     $choices['1'] = get_string('autosubscribeyes');
 193     $choices['0'] = get_string('autosubscribeno');
 194     $mform->addElement('select', 'autosubscribe', get_string('autosubscribe'), $choices);
 195     $mform->setDefault('autosubscribe', 1);
 196
 197     if (!empty($CFG->forum_trackreadposts)) {
 198         $choices = array();
 199         $choices['0'] = get_string('trackforumsno');
 200         $choices['1'] = get_string('trackforumsyes');
 201         $mform->addElement('select', 'trackforums', get_string('trackforums'), $choices);
 202         $mform->setDefault('trackforums', 0);
 203     }
 204
 205     $editors = editors_get_enabled();
 206     if (count($editors) > 1) {
 207         $choices = array('' => get_string('defaulteditor'));
 208         $firsteditor = '';
 209         foreach (array_keys($editors) as $editor) {
 210             if (!$firsteditor) {
 211                 $firsteditor = $editor;
 212             }
 213             $choices[$editor] = get_string('pluginname', 'editor_' . $editor);
 214         }
 215         $mform->addElement('select', 'preference_htmleditor', get_string('textediting'), $choices);
 216         $mform->setDefault('preference_htmleditor', '');
 217     } else {
 218         // Empty string means use the first chosen text editor.
 219         $mform->addElement('hidden', 'preference_htmleditor');
 220         $mform->setDefault('preference_htmleditor', '');
 221         $mform->setType('preference_htmleditor', PARAM_PLUGIN);
 222     }
 223
 224     $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="21"');
 225     $mform->setType('city', PARAM_TEXT);
 226     if (!empty($CFG->defaultcity)) {
 227         $mform->setDefault('city', $CFG->defaultcity);
 228     }
 229
 230     $choices = get_string_manager()->get_list_of_countries();
 231     $choices= array(''=>get_string('selectacountry').'...') + $choices;
 232     $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
 233     if (!empty($CFG->country)) {
 234         $mform->setDefault('country', $CFG->country);
 235     }
 236
 237     $choices = get_list_of_timezones();
 238     $choices['99'] = get_string('serverlocaltime');
 239     if ($CFG->forcetimezone != 99) {
 240         $mform->addElement('static', 'forcedtimezone', get_string('timezone'), $choices[$CFG->forcetimezone]);
 241     } else {
 242         $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
 243         $mform->setDefault('timezone', '99');
 244     }
 245
 246     $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
 247     $mform->setDefault('lang', $CFG->lang);
 248
 249     // Multi-Calendar Support - see MDL-18375.
 250     $calendartypes = \core_calendar\type_factory::get_list_of_calendar_types();
 251     // We do not want to show this option unless there is more than one calendar type to display.
 252     if (count($calendartypes) > 1) {
 253         $mform->addElement('select', 'calendartype', get_string('preferredcalendar', 'calendar'), $calendartypes);
 254     }
 255
 256     if (!empty($CFG->allowuserthemes)) {
 257         $choices = array();
 258         $choices[''] = get_string('default');
 259         $themes = get_list_of_themes();
 260         foreach ($themes as $key=>$theme) {
 261             if (empty($theme->hidefromselector)) {
 262                 $choices[$key] = get_string('pluginname', 'theme_'.$theme->name);
 263             }
 264         }
 265         $mform->addElement('select', 'theme', get_string('preferredtheme'), $choices);
 266     }
 267
 268     $mform->addElement('editor', 'description_editor', get_string('userdescription'), null, $editoroptions);
 269     $mform->setType('description_editor', PARAM_CLEANHTML);
 270     $mform->addHelpButton('description_editor', 'userdescription');
 271
 272     if (empty($USER->newadminuser)) {
 273         $mform->addElement('header', 'moodle_picture', get_string('pictureofuser'));
 274
 275         if (!empty($CFG->enablegravatar)) {
 276             $mform->addElement('html', html_writer::tag('p', get_string('gravatarenabled')));
 277         }
 278
 279         $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
 280
 281         $mform->addElement('checkbox', 'deletepicture', get_string('delete'));
 282         $mform->setDefault('deletepicture', 0);
 283
 284         $mform->addElement('filemanager', 'imagefile', get_string('newpicture'), '', $filemanageroptions);
 285         $mform->addHelpButton('imagefile', 'newpicture');
 286
 287         $mform->addElement('text', 'imagealt', get_string('imagealt'), 'maxlength="100" size="30"');
 288         $mform->setType('imagealt', PARAM_TEXT);
 289
 290     }
 291
 292     // Display user name fields that are not currenlty enabled here if there are any.
 293     $disabledusernamefields = useredit_get_disabled_name_fields($enabledusernamefields);
 294     if (count($disabledusernamefields) > 0) {
 295         $mform->addElement('header', 'moodle_additional_names', get_string('additionalnames'));
 296         foreach ($disabledusernamefields as $allname) {
 297             $mform->addElement('text', $allname, get_string($allname), 'maxlength="100" size="30"');
 298             $mform->setType($allname, PARAM_NOTAGS);
 299         }
 300     }
 301
 302     if (!empty($CFG->usetags) and empty($USER->newadminuser)) {
 303         $mform->addElement('header', 'moodle_interests', get_string('interests'));
 304         $mform->addElement('tags', 'interests', get_string('interestslist'), array('display' => 'noofficial'));
 305         $mform->addHelpButton('interests', 'interestslist');
 306     }
 307
 308     /// Moodle optional fields
 309     $mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
 310
 311     $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
 312     $mform->setType('url', PARAM_URL);
 313
 314     $mform->addElement('text', 'icq', get_string('icqnumber'), 'maxlength="15" size="25"');
 315     $mform->setType('icq', PARAM_NOTAGS);
 316
 317     $mform->addElement('text', 'skype', get_string('skypeid'), 'maxlength="50" size="25"');
 318     $mform->setType('skype', PARAM_NOTAGS);
 319
 320     $mform->addElement('text', 'aim', get_string('aimid'), 'maxlength="50" size="25"');
 321     $mform->setType('aim', PARAM_NOTAGS);
 322
 323     $mform->addElement('text', 'yahoo', get_string('yahooid'), 'maxlength="50" size="25"');
 324     $mform->setType('yahoo', PARAM_NOTAGS);
 325
 326     $mform->addElement('text', 'msn', get_string('msnid'), 'maxlength="50" size="25"');
 327     $mform->setType('msn', PARAM_NOTAGS);
 328
 329     $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
 330     $mform->setType('idnumber', PARAM_NOTAGS);
 331
 332     $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="255" size="25"');
 333     $mform->setType('institution', PARAM_TEXT);
 334
 335     $mform->addElement('text', 'department', get_string('department'), 'maxlength="255" size="25"');
 336     $mform->setType('department', PARAM_TEXT);
 337
 338     $mform->addElement('text', 'phone1', get_string('phone'), 'maxlength="20" size="25"');
 339     $mform->setType('phone1', PARAM_NOTAGS);
 340
 341     $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
 342     $mform->setType('phone2', PARAM_NOTAGS);
 343
 344     $mform->addElement('text', 'address', get_string('address'), 'maxlength="255" size="25"');
 345     $mform->setType('address', PARAM_TEXT);
 346
 347
 348 }
 349
 350 /**
 351  * Return required user name fields for forms.
 352  *
 353  * @return array required user name fields in order according to settings.
 354  */
 355 function useredit_get_required_name_fields() {
 356     global $CFG;
 357
 358     // Get the name display format.
 359     $nameformat = $CFG->fullnamedisplay;
 360
 361     // Names that are required fields on user forms.
 362     $necessarynames = array('firstname', 'lastname');
 363     $languageformat = get_string('fullnamedisplay');
 364
 365     // Check that the language string and the $nameformat contain the necessary names.
 366     foreach ($necessarynames as $necessaryname) {
 367         $pattern = "/$necessaryname\b/";
 368         if (!preg_match($pattern, $languageformat)) {
 369             // If the language string has been altered then fall back on the below order.
 370             $languageformat = 'firstname lastname';
 371         }
 372         if (!preg_match($pattern, $nameformat)) {
 373             // If the nameformat doesn't contain the necessary name fields then use the languageformat.
 374             $nameformat = $languageformat;
 375         }
 376     }
 377
 378     // Order all of the name fields in the postion they are written in the fullnamedisplay setting.
 379     $necessarynames = order_in_string($necessarynames, $nameformat);
 380     return $necessarynames;
 381 }
 382
 383 /**
 384  * Gets enabled (from fullnameformate setting) user name fields in appropriate order.
 385  *
 386  * @return array Enabled user name fields.
 387  */
 388 function useredit_get_enabled_name_fields() {
 389     global $CFG;
 390
 391     // Get all of the other name fields which are not ranked as necessary.
 392     $additionalusernamefields = array_diff(get_all_user_name_fields(), array('firstname', 'lastname'));
 393     // Find out which additional name fields are actually being used from the fullnamedisplay setting.
 394     $enabledadditionalusernames = array();
 395     foreach ($additionalusernamefields as $enabledname) {
 396         if (strpos($CFG->fullnamedisplay, $enabledname) !== false) {
 397             $enabledadditionalusernames[] = $enabledname;
 398         }
 399     }
 400
 401     // Order all of the name fields in the postion they are written in the fullnamedisplay setting.
 402     $enabledadditionalusernames = order_in_string($enabledadditionalusernames, $CFG->fullnamedisplay);
 403     return $enabledadditionalusernames;
 404 }
 405
 406 /**
 407  * Gets user name fields not enabled from the setting fullnamedisplay.
 408  *
 409  * @param array $enabledadditionalusernames Current enabled additional user name fields.
 410  * @return array Disabled user name fields.
 411  */
 412 function useredit_get_disabled_name_fields($enabledadditionalusernames = null) {
 413     // If we don't have enabled additional user name information then go and fetch it (try to avoid).
 414     if (!isset($enabledadditionalusernames)) {
 415         $enabledadditionalusernames = useredit_get_enabled_name_fields();
 416     }
 417
 418     // These are the additional fields that are not currently enabled.
 419     $nonusednamefields = array_diff(get_all_user_name_fields(),
 420             array_merge(array('firstname', 'lastname'), $enabledadditionalusernames));
 421     return $nonusednamefields;
 422 }
 423
 424