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     $nameformat = $CFG->fullnamedisplay;
 133     if ($nameformat == 'language') {
 134         $nameformat = get_string('fullnamedisplay');
 135     }
 136
 137     $necessarynames = array('firstname', 'lastname');
 138     $enablednames = array_diff(get_all_user_name_fields(), $necessarynames);
 139     // Get a list of all of the enabled names.
 140     $enabledadditionalusernames = array();
 141     foreach ($enablednames as $enabledname) {
 142         if (strpos($CFG->fullnamedisplay, $enabledname) !== false) {
 143             $enabledadditionalusernames[] = $enabledname;
 144         }
 145     }
 146
 147     $combinednames = array_merge($necessarynames, $enabledadditionalusernames);
 148     $requirednames = order_in_string($combinednames, $nameformat);
 149     foreach ($necessarynames as $necessaryname) {
 150         if (!in_array($necessaryname, $requirednames)) {
 151             $requirednames = order_in_string($combinednames, get_string('fullnamedisplay'));
 152         }
 153     }
 154     foreach ($requirednames as $fullname) {
 155         $mform->addElement('text', $fullname,  get_string($fullname),  'maxlength="100" size="30"');
 156         $mform->setType($fullname, PARAM_NOTAGS);
 157     }
 158
 159     $mform->addRule('firstname', $strrequired, 'required', null, 'client');
 160     $mform->addRule('lastname', $strrequired, 'required', null, 'client');
 161
 162     $morenames = array_diff($enabledadditionalusernames, $requirednames);
 163     foreach ($morenames as $addname) {
 164         $mform->addElement('text', $addname,  get_string($addname), 'maxlength="100" size="30"');
 165         $mform->setType($addname, PARAM_NOTAGS);
 166     }
 167
 168     // Do not show email field if change confirmation is pending
 169     if (!empty($CFG->emailchangeconfirmation) and !empty($user->preference_newemail)) {
 170         $notice = get_string('emailchangepending', 'auth', $user);
 171         $notice .= '<br /><a href="edit.php?cancelemailchange=1&amp;id='.$user->id.'">'
 172                 . get_string('emailchangecancel', 'auth') . '</a>';
 173         $mform->addElement('static', 'emailpending', get_string('email'), $notice);
 174     } else {
 175         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="30"');
 176         $mform->addRule('email', $strrequired, 'required', null, 'client');
 177         $mform->setType('email', PARAM_EMAIL);
 178     }
 179
 180     $choices = array();
 181     $choices['0'] = get_string('emaildisplayno');
 182     $choices['1'] = get_string('emaildisplayyes');
 183     $choices['2'] = get_string('emaildisplaycourse');
 184     $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
 185     $mform->setDefault('maildisplay', 2);
 186
 187     $choices = array();
 188     $choices['0'] = get_string('textformat');
 189     $choices['1'] = get_string('htmlformat');
 190     $mform->addElement('select', 'mailformat', get_string('emailformat'), $choices);
 191     $mform->setDefault('mailformat', 1);
 192
 193     if (!empty($CFG->allowusermailcharset)) {
 194         $choices = array();
 195         $charsets = get_list_of_charsets();
 196         if (!empty($CFG->sitemailcharset)) {
 197             $choices['0'] = get_string('site').' ('.$CFG->sitemailcharset.')';
 198         } else {
 199             $choices['0'] = get_string('site').' (UTF-8)';
 200         }
 201         $choices = array_merge($choices, $charsets);
 202         $mform->addElement('select', 'preference_mailcharset', get_string('emailcharset'), $choices);
 203     }
 204
 205     $choices = array();
 206     $choices['0'] = get_string('emaildigestoff');
 207     $choices['1'] = get_string('emaildigestcomplete');
 208     $choices['2'] = get_string('emaildigestsubjects');
 209     $mform->addElement('select', 'maildigest', get_string('emaildigest'), $choices);
 210     $mform->setDefault('maildigest', 0);
 211     $mform->addHelpButton('maildigest', 'emaildigest');
 212
 213     $choices = array();
 214     $choices['1'] = get_string('autosubscribeyes');
 215     $choices['0'] = get_string('autosubscribeno');
 216     $mform->addElement('select', 'autosubscribe', get_string('autosubscribe'), $choices);
 217     $mform->setDefault('autosubscribe', 1);
 218
 219     if (!empty($CFG->forum_trackreadposts)) {
 220         $choices = array();
 221         $choices['0'] = get_string('trackforumsno');
 222         $choices['1'] = get_string('trackforumsyes');
 223         $mform->addElement('select', 'trackforums', get_string('trackforums'), $choices);
 224         $mform->setDefault('trackforums', 0);
 225     }
 226
 227     $editors = editors_get_enabled();
 228     if (count($editors) > 1) {
 229         $choices = array('' => get_string('defaulteditor'));
 230         $firsteditor = '';
 231         foreach (array_keys($editors) as $editor) {
 232             if (!$firsteditor) {
 233                 $firsteditor = $editor;
 234             }
 235             $choices[$editor] = get_string('pluginname', 'editor_' . $editor);
 236         }
 237         $mform->addElement('select', 'preference_htmleditor', get_string('textediting'), $choices);
 238         $mform->setDefault('preference_htmleditor', '');
 239     } else {
 240         // Empty string means use the first chosen text editor.
 241         $mform->addElement('hidden', 'preference_htmleditor');
 242         $mform->setDefault('preference_htmleditor', '');
 243         $mform->setType('preference_htmleditor', PARAM_PLUGIN);
 244     }
 245
 246     $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="21"');
 247     $mform->setType('city', PARAM_TEXT);
 248     if (!empty($CFG->defaultcity)) {
 249         $mform->setDefault('city', $CFG->defaultcity);
 250     }
 251
 252     $choices = get_string_manager()->get_list_of_countries();
 253     $choices= array(''=>get_string('selectacountry').'...') + $choices;
 254     $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
 255     if (!empty($CFG->country)) {
 256         $mform->setDefault('country', $CFG->country);
 257     }
 258
 259     $choices = get_list_of_timezones();
 260     $choices['99'] = get_string('serverlocaltime');
 261     if ($CFG->forcetimezone != 99) {
 262         $mform->addElement('static', 'forcedtimezone', get_string('timezone'), $choices[$CFG->forcetimezone]);
 263     } else {
 264         $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
 265         $mform->setDefault('timezone', '99');
 266     }
 267
 268     $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
 269     $mform->setDefault('lang', $CFG->lang);
 270
 271     // Multi-Calendar Support - see MDL-18375.
 272     $calendartypes = \core_calendar\type_factory::get_list_of_calendar_types();
 273     // We do not want to show this option unless there is more than one calendar type to display.
 274     if (count($calendartypes) > 1) {
 275         $mform->addElement('select', 'calendartype', get_string('preferredcalendar', 'calendar'), $calendartypes);
 276     }
 277
 278     if (!empty($CFG->allowuserthemes)) {
 279         $choices = array();
 280         $choices[''] = get_string('default');
 281         $themes = get_list_of_themes();
 282         foreach ($themes as $key=>$theme) {
 283             if (empty($theme->hidefromselector)) {
 284                 $choices[$key] = get_string('pluginname', 'theme_'.$theme->name);
 285             }
 286         }
 287         $mform->addElement('select', 'theme', get_string('preferredtheme'), $choices);
 288     }
 289
 290     $mform->addElement('editor', 'description_editor', get_string('userdescription'), null, $editoroptions);
 291     $mform->setType('description_editor', PARAM_CLEANHTML);
 292     $mform->addHelpButton('description_editor', 'userdescription');
 293
 294     if (empty($USER->newadminuser)) {
 295         $mform->addElement('header', 'moodle_picture', get_string('pictureofuser'));
 296
 297         if (!empty($CFG->enablegravatar)) {
 298             $mform->addElement('html', html_writer::tag('p', get_string('gravatarenabled')));
 299         }
 300
 301         $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
 302
 303         $mform->addElement('checkbox', 'deletepicture', get_string('delete'));
 304         $mform->setDefault('deletepicture', 0);
 305
 306         $mform->addElement('filemanager', 'imagefile', get_string('newpicture'), '', $filemanageroptions);
 307         $mform->addHelpButton('imagefile', 'newpicture');
 308
 309         $mform->addElement('text', 'imagealt', get_string('imagealt'), 'maxlength="100" size="30"');
 310         $mform->setType('imagealt', PARAM_TEXT);
 311
 312     }
 313
 314     $alladditionalnames = array_diff(get_all_user_name_fields(), $necessarynames);
 315     if (count($enabledadditionalusernames) < count($alladditionalnames)) {
 316         $mform->addElement('header', 'moodle_additional_names', get_string('additionalnames'));
 317         foreach ($alladditionalnames as $allname) {
 318             if (!in_array($allname, $enabledadditionalusernames)) {
 319                 $mform->addElement('text', $allname, get_string($allname), 'maxlength="100" size="30"');
 320                 $mform->setType($allname, PARAM_NOTAGS);
 321             }
 322         }
 323
 324     }
 325
 326     if (!empty($CFG->usetags) and empty($USER->newadminuser)) {
 327         $mform->addElement('header', 'moodle_interests', get_string('interests'));
 328         $mform->addElement('tags', 'interests', get_string('interestslist'), array('display' => 'noofficial'));
 329         $mform->addHelpButton('interests', 'interestslist');
 330     }
 331
 332     /// Moodle optional fields
 333     $mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
 334
 335     $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
 336     $mform->setType('url', PARAM_URL);
 337
 338     $mform->addElement('text', 'icq', get_string('icqnumber'), 'maxlength="15" size="25"');
 339     $mform->setType('icq', PARAM_NOTAGS);
 340
 341     $mform->addElement('text', 'skype', get_string('skypeid'), 'maxlength="50" size="25"');
 342     $mform->setType('skype', PARAM_NOTAGS);
 343
 344     $mform->addElement('text', 'aim', get_string('aimid'), 'maxlength="50" size="25"');
 345     $mform->setType('aim', PARAM_NOTAGS);
 346
 347     $mform->addElement('text', 'yahoo', get_string('yahooid'), 'maxlength="50" size="25"');
 348     $mform->setType('yahoo', PARAM_NOTAGS);
 349
 350     $mform->addElement('text', 'msn', get_string('msnid'), 'maxlength="50" size="25"');
 351     $mform->setType('msn', PARAM_NOTAGS);
 352
 353     $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
 354     $mform->setType('idnumber', PARAM_NOTAGS);
 355
 356     $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="255" size="25"');
 357     $mform->setType('institution', PARAM_TEXT);
 358
 359     $mform->addElement('text', 'department', get_string('department'), 'maxlength="255" size="25"');
 360     $mform->setType('department', PARAM_TEXT);
 361
 362     $mform->addElement('text', 'phone1', get_string('phone'), 'maxlength="20" size="25"');
 363     $mform->setType('phone1', PARAM_NOTAGS);
 364
 365     $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
 366     $mform->setType('phone2', PARAM_NOTAGS);
 367
 368     $mform->addElement('text', 'address', get_string('address'), 'maxlength="255" size="25"');
 369     $mform->setType('address', PARAM_TEXT);
 370
 371
 372 }
 373
 374