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     $nameordercheck = new stdClass();
 133     $nameordercheck->firstname = 'a';
 134     $nameordercheck->lastname  = 'b';
 135     if (fullname($nameordercheck) == 'b a' ) {  // See MDL-4325
 136         $mform->addElement('text', 'lastname',  get_string('lastname'),  'maxlength="100" size="30"');
 137         $mform->addElement('text', 'firstname', get_string('firstname'), 'maxlength="100" size="30"');
 138     } else {
 139         $mform->addElement('text', 'firstname', get_string('firstname'), 'maxlength="100" size="30"');
 140         $mform->addElement('text', 'lastname',  get_string('lastname'),  'maxlength="100" size="30"');
 141     }
 142
 143     $mform->addRule('firstname', $strrequired, 'required', null, 'client');
 144     $mform->setType('firstname', PARAM_NOTAGS);
 145
 146     $mform->addRule('lastname', $strrequired, 'required', null, 'client');
 147     $mform->setType('lastname', PARAM_NOTAGS);
 148
 149     // Do not show email field if change confirmation is pending
 150     if (!empty($CFG->emailchangeconfirmation) and !empty($user->preference_newemail)) {
 151         $notice = get_string('emailchangepending', 'auth', $user);
 152         $notice .= '<br /><a href="edit.php?cancelemailchange=1&amp;id='.$user->id.'">'
 153                 . get_string('emailchangecancel', 'auth') . '</a>';
 154         $mform->addElement('static', 'emailpending', get_string('email'), $notice);
 155     } else {
 156         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="30"');
 157         $mform->addRule('email', $strrequired, 'required', null, 'client');
 158         $mform->setType('email', PARAM_NOTAGS);
 159     }
 160
 161     $choices = array();
 162     $choices['0'] = get_string('emaildisplayno');
 163     $choices['1'] = get_string('emaildisplayyes');
 164     $choices['2'] = get_string('emaildisplaycourse');
 165     $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
 166     $mform->setDefault('maildisplay', 2);
 167
 168     $choices = array();
 169     $choices['0'] = get_string('textformat');
 170     $choices['1'] = get_string('htmlformat');
 171     $mform->addElement('select', 'mailformat', get_string('emailformat'), $choices);
 172     $mform->setDefault('mailformat', 1);
 173
 174     if (!empty($CFG->allowusermailcharset)) {
 175         $choices = array();
 176         $charsets = get_list_of_charsets();
 177         if (!empty($CFG->sitemailcharset)) {
 178             $choices['0'] = get_string('site').' ('.$CFG->sitemailcharset.')';
 179         } else {
 180             $choices['0'] = get_string('site').' (UTF-8)';
 181         }
 182         $choices = array_merge($choices, $charsets);
 183         $mform->addElement('select', 'preference_mailcharset', get_string('emailcharset'), $choices);
 184     }
 185
 186     $choices = array();
 187     $choices['0'] = get_string('emaildigestoff');
 188     $choices['1'] = get_string('emaildigestcomplete');
 189     $choices['2'] = get_string('emaildigestsubjects');
 190     $mform->addElement('select', 'maildigest', get_string('emaildigest'), $choices);
 191     $mform->setDefault('maildigest', 0);
 192
 193     $choices = array();
 194     $choices['1'] = get_string('autosubscribeyes');
 195     $choices['0'] = get_string('autosubscribeno');
 196     $mform->addElement('select', 'autosubscribe', get_string('autosubscribe'), $choices);
 197     $mform->setDefault('autosubscribe', 1);
 198
 199     if (!empty($CFG->forum_trackreadposts)) {
 200         $choices = array();
 201         $choices['0'] = get_string('trackforumsno');
 202         $choices['1'] = get_string('trackforumsyes');
 203         $mform->addElement('select', 'trackforums', get_string('trackforums'), $choices);
 204         $mform->setDefault('trackforums', 0);
 205     }
 206
 207     $editors = editors_get_enabled();
 208     if (count($editors) > 1) {
 209         $choices = array();
 210         $choices['0'] = get_string('texteditor');
 211         $choices['1'] = get_string('htmleditor');
 212         $mform->addElement('select', 'htmleditor', get_string('textediting'), $choices);
 213         $mform->setDefault('htmleditor', 1);
 214     } else {
 215         $mform->addElement('hidden', 'htmleditor');
 216         $mform->setDefault('htmleditor', 1);
 217         $mform->setType('htmleditor', PARAM_INT);
 218     }
 219
 220     $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="21"');
 221     $mform->setType('city', PARAM_TEXT);
 222     $mform->addRule('city', $strrequired, 'required', null, 'client');
 223     if (!empty($CFG->defaultcity)) {
 224         $mform->setDefault('city', $CFG->defaultcity);
 225     }
 226
 227     $choices = get_string_manager()->get_list_of_countries();
 228     $choices= array(''=>get_string('selectacountry').'...') + $choices;
 229     $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
 230     $mform->addRule('country', $strrequired, 'required', null, 'client');
 231     if (!empty($CFG->country)) {
 232         $mform->setDefault('country', $CFG->country);
 233     }
 234
 235     $choices = get_list_of_timezones();
 236     $choices['99'] = get_string('serverlocaltime');
 237     if ($CFG->forcetimezone != 99) {
 238         $mform->addElement('static', 'forcedtimezone', get_string('timezone'), $choices[$CFG->forcetimezone]);
 239     } else {
 240         $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
 241         $mform->setDefault('timezone', '99');
 242     }
 243
 244     $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
 245     $mform->setDefault('lang', $CFG->lang);
 246
 247     if (!empty($CFG->allowuserthemes)) {
 248         $choices = array();
 249         $choices[''] = get_string('default');
 250         $themes = get_list_of_themes();
 251         foreach ($themes as $key=>$theme) {
 252             if (empty($theme->hidefromselector)) {
 253                 $choices[$key] = get_string('pluginname', 'theme_'.$theme->name);
 254             }
 255         }
 256         $mform->addElement('select', 'theme', get_string('preferredtheme'), $choices);
 257     }
 258
 259     $mform->addElement('editor', 'description_editor', get_string('userdescription'), null, $editoroptions);
 260     $mform->setType('description_editor', PARAM_CLEANHTML);
 261     $mform->addHelpButton('description_editor', 'userdescription');
 262
 263     if (!empty($CFG->gdversion) and empty($USER->newadminuser)) {
 264         $mform->addElement('header', 'moodle_picture', get_string('pictureofuser'));
 265
 266         if (!empty($CFG->enablegravatar)) {
 267             $mform->addElement('html', html_writer::tag('p', get_string('gravatarenabled')));
 268         }
 269
 270         $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
 271
 272         $mform->addElement('checkbox', 'deletepicture', get_string('delete'));
 273         $mform->setDefault('deletepicture', 0);
 274
 275         $mform->addElement('filemanager', 'imagefile', get_string('newpicture'), '', $filemanageroptions);
 276         $mform->addHelpButton('imagefile', 'newpicture');
 277
 278         $mform->addElement('text', 'imagealt', get_string('imagealt'), 'maxlength="100" size="30"');
 279         $mform->setType('imagealt', PARAM_TEXT);
 280
 281     }
 282
 283     if (!empty($CFG->usetags) and empty($USER->newadminuser)) {
 284         $mform->addElement('header', 'moodle_interests', get_string('interests'));
 285         $mform->addElement('tags', 'interests', get_string('interestslist'), array('display' => 'noofficial'));
 286         $mform->addHelpButton('interests', 'interestslist');
 287     }
 288
 289     /// Moodle optional fields
 290     $mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
 291
 292     $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
 293     $mform->setType('url', PARAM_URL);
 294
 295     $mform->addElement('text', 'icq', get_string('icqnumber'), 'maxlength="15" size="25"');
 296     $mform->setType('icq', PARAM_NOTAGS);
 297
 298     $mform->addElement('text', 'skype', get_string('skypeid'), 'maxlength="50" size="25"');
 299     $mform->setType('skype', PARAM_NOTAGS);
 300
 301     $mform->addElement('text', 'aim', get_string('aimid'), 'maxlength="50" size="25"');
 302     $mform->setType('aim', PARAM_NOTAGS);
 303
 304     $mform->addElement('text', 'yahoo', get_string('yahooid'), 'maxlength="50" size="25"');
 305     $mform->setType('yahoo', PARAM_NOTAGS);
 306
 307     $mform->addElement('text', 'msn', get_string('msnid'), 'maxlength="50" size="25"');
 308     $mform->setType('msn', PARAM_NOTAGS);
 309
 310     $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
 311     $mform->setType('idnumber', PARAM_NOTAGS);
 312
 313     $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="40" size="25"');
 314     $mform->setType('institution', PARAM_TEXT);
 315
 316     $mform->addElement('text', 'department', get_string('department'), 'maxlength="30" size="25"');
 317     $mform->setType('department', PARAM_TEXT);
 318
 319     $mform->addElement('text', 'phone1', get_string('phone'), 'maxlength="20" size="25"');
 320     $mform->setType('phone1', PARAM_NOTAGS);
 321
 322     $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
 323     $mform->setType('phone2', PARAM_NOTAGS);
 324
 325     $mform->addElement('text', 'address', get_string('address'), 'maxlength="70" size="25"');
 326     $mform->setType('address', PARAM_TEXT);
 327
 328
 329 }
 330
 331