32a4634532f55fb9c6da301d661588f302c30cda
[moodle.git] / user / editlib.php
1 <?php
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 }
9 function useredit_load_preferences(&$user, $reload=true) {
10     global $USER;
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         }
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 }
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 }
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");
49     $context = context_user::instance($usernew->id, MUST_EXIST);
50     $user = $DB->get_record('user', array('id'=>$usernew->id), 'id, picture', MUST_EXIST);
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;
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     }
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 }
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     }
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     }
120 function useredit_update_interests($user, $interests) {
121     tag_set('user', $user->id, $interests);
124 function useredit_shared_definition(&$mform, $editoroptions = null, $filemanageroptions = null) {
125     global $CFG, $USER, $DB;
127     $user = $DB->get_record('user', array('id' => $USER->id));
128     useredit_load_preferences($user, false);
130     $strrequired = get_string('required');
132     $nameformat = $CFG->fullnamedisplay;
133     if ($nameformat == 'language') {
134         $nameformat = get_string('fullnamedisplay');
135     }
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     }
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     }
159     $mform->addRule('firstname', $strrequired, 'required', null, 'client');
160     $mform->addRule('lastname', $strrequired, 'required', null, 'client');
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     }
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     }
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);
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);
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     }
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');
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);
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     }
227     $editors = editors_get_enabled();
228     if (count($editors) > 1) {
229         $choices = array();
230         $choices['0'] = get_string('texteditor');
231         $choices['1'] = get_string('htmleditor');
232         $mform->addElement('select', 'htmleditor', get_string('textediting'), $choices);
233         $mform->setDefault('htmleditor', 1);
234     } else {
235         $mform->addElement('hidden', 'htmleditor');
236         $mform->setDefault('htmleditor', 1);
237         $mform->setType('htmleditor', PARAM_INT);
238     }
240     $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="21"');
241     $mform->setType('city', PARAM_TEXT);
242     if (!empty($CFG->defaultcity)) {
243         $mform->setDefault('city', $CFG->defaultcity);
244     }
246     $choices = get_string_manager()->get_list_of_countries();
247     $choices= array(''=>get_string('selectacountry').'...') + $choices;
248     $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
249     if (!empty($CFG->country)) {
250         $mform->setDefault('country', $CFG->country);
251     }
253     $choices = get_list_of_timezones();
254     $choices['99'] = get_string('serverlocaltime');
255     if ($CFG->forcetimezone != 99) {
256         $mform->addElement('static', 'forcedtimezone', get_string('timezone'), $choices[$CFG->forcetimezone]);
257     } else {
258         $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
259         $mform->setDefault('timezone', '99');
260     }
262     $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
263     $mform->setDefault('lang', $CFG->lang);
265     // Multi-Calendar Support - see MDL-18375.
266     $calendartypes = \core_calendar\type_factory::get_list_of_calendar_types();
267     // We do not want to show this option unless there is more than one calendar type to display.
268     if (count($calendartypes) > 1) {
269         $mform->addElement('select', 'calendartype', get_string('preferredcalendar', 'calendar'), $calendartypes);
270     }
272     if (!empty($CFG->allowuserthemes)) {
273         $choices = array();
274         $choices[''] = get_string('default');
275         $themes = get_list_of_themes();
276         foreach ($themes as $key=>$theme) {
277             if (empty($theme->hidefromselector)) {
278                 $choices[$key] = get_string('pluginname', 'theme_'.$theme->name);
279             }
280         }
281         $mform->addElement('select', 'theme', get_string('preferredtheme'), $choices);
282     }
284     $mform->addElement('editor', 'description_editor', get_string('userdescription'), null, $editoroptions);
285     $mform->setType('description_editor', PARAM_CLEANHTML);
286     $mform->addHelpButton('description_editor', 'userdescription');
288     if (empty($USER->newadminuser)) {
289         $mform->addElement('header', 'moodle_picture', get_string('pictureofuser'));
291         if (!empty($CFG->enablegravatar)) {
292             $mform->addElement('html', html_writer::tag('p', get_string('gravatarenabled')));
293         }
295         $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
297         $mform->addElement('checkbox', 'deletepicture', get_string('delete'));
298         $mform->setDefault('deletepicture', 0);
300         $mform->addElement('filemanager', 'imagefile', get_string('newpicture'), '', $filemanageroptions);
301         $mform->addHelpButton('imagefile', 'newpicture');
303         $mform->addElement('text', 'imagealt', get_string('imagealt'), 'maxlength="100" size="30"');
304         $mform->setType('imagealt', PARAM_TEXT);
306     }
308     $alladditionalnames = array_diff(get_all_user_name_fields(), $necessarynames);
309     if (count($enabledadditionalusernames) < count($alladditionalnames)) {
310         $mform->addElement('header', 'moodle_additional_names', get_string('additionalnames'));
311         foreach ($alladditionalnames as $allname) {
312             if (!in_array($allname, $enabledadditionalusernames)) {
313                 $mform->addElement('text', $allname, get_string($allname), 'maxlength="100" size="30"');
314                 $mform->setType($allname, PARAM_NOTAGS);
315             }
316         }
318     }
320     if (!empty($CFG->usetags) and empty($USER->newadminuser)) {
321         $mform->addElement('header', 'moodle_interests', get_string('interests'));
322         $mform->addElement('tags', 'interests', get_string('interestslist'), array('display' => 'noofficial'));
323         $mform->addHelpButton('interests', 'interestslist');
324     }
326     /// Moodle optional fields
327     $mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
329     $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
330     $mform->setType('url', PARAM_URL);
332     $mform->addElement('text', 'icq', get_string('icqnumber'), 'maxlength="15" size="25"');
333     $mform->setType('icq', PARAM_NOTAGS);
335     $mform->addElement('text', 'skype', get_string('skypeid'), 'maxlength="50" size="25"');
336     $mform->setType('skype', PARAM_NOTAGS);
338     $mform->addElement('text', 'aim', get_string('aimid'), 'maxlength="50" size="25"');
339     $mform->setType('aim', PARAM_NOTAGS);
341     $mform->addElement('text', 'yahoo', get_string('yahooid'), 'maxlength="50" size="25"');
342     $mform->setType('yahoo', PARAM_NOTAGS);
344     $mform->addElement('text', 'msn', get_string('msnid'), 'maxlength="50" size="25"');
345     $mform->setType('msn', PARAM_NOTAGS);
347     $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
348     $mform->setType('idnumber', PARAM_NOTAGS);
350     $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="40" size="25"');
351     $mform->setType('institution', PARAM_TEXT);
353     $mform->addElement('text', 'department', get_string('department'), 'maxlength="30" size="25"');
354     $mform->setType('department', PARAM_TEXT);
356     $mform->addElement('text', 'phone1', get_string('phone'), 'maxlength="20" size="25"');
357     $mform->setType('phone1', PARAM_NOTAGS);
359     $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
360     $mform->setType('phone2', PARAM_NOTAGS);
362     $mform->addElement('text', 'address', get_string('address'), 'maxlength="70" size="25"');
363     $mform->setType('address', PARAM_TEXT);