weekly release 2.5dev
[moodle.git] / user / editlib.php
CommitLineData
8bdc9cac 1<?php
ad6226fb 2
05c38e2b 3function cancel_email_update($userid) {
4 unset_user_preference('newemail', $userid);
5 unset_user_preference('newemailkey', $userid);
6 unset_user_preference('newemailattemptsleft', $userid);
7}
8
9function useredit_load_preferences(&$user, $reload=true) {
10 global $USER;
14a6b7e1 11
05c38e2b 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 }
aa6c1ced 17
05c38e2b 18 if ($preferences = get_user_preferences(null, null, $user->id)) {
19 foreach($preferences as $name=>$value) {
20 $user->{'preference_'.$name} = $value;
21 }
14a6b7e1 22 }
23 }
24}
25
26function 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
4125bdc1
SH
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 */
4e782b32 45function useredit_update_picture(stdClass $usernew, moodleform $userform, $filemanageroptions = array()) {
a5d424df 46 global $CFG, $DB;
e88dd876 47 require_once("$CFG->libdir/gdlib.php");
9d85247d 48
43731030 49 $context = context_user::instance($usernew->id, MUST_EXIST);
4d254790
PS
50 $user = $DB->get_record('user', array('id'=>$usernew->id), 'id, picture', MUST_EXIST);
51
52 $newpicture = $user->picture;
4e782b32
RT
53 // Get file_storage to process files.
54 $fs = get_file_storage();
4125bdc1
SH
55 if (!empty($usernew->deletepicture)) {
56 // The user has chosen to delete the selected users picture
4d254790
PS
57 $fs->delete_area_files($context->id, 'user', 'icon'); // drop all images in area
58 $newpicture = 0;
59
4e782b32
RT
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 }
14a6b7e1 87 }
4125bdc1 88
4d254790
PS
89 if ($newpicture != $user->picture) {
90 $DB->set_field('user', 'picture', $newpicture, array('id' => $user->id));
4125bdc1 91 return true;
4d254790
PS
92 } else {
93 return false;
4125bdc1 94 }
14a6b7e1 95}
96
97function useredit_update_bounces($user, $usernew) {
98 if (!isset($usernew->email)) {
99 //locked field
100 return;
d8734783 101 }
a9457b54 102 if (!isset($user->email) || $user->email !== $usernew->email) {
14a6b7e1 103 set_bounce_count($usernew,true);
104 set_send_count($usernew,true);
105 }
106}
107
108function useredit_update_trackforums($user, $usernew) {
109 global $CFG;
110 if (!isset($usernew->trackforums)) {
111 //locked field
112 return;
113 }
a9457b54 114 if ((!isset($user->trackforums) || ($usernew->trackforums != $user->trackforums)) and !$usernew->trackforums) {
14a6b7e1 115 require_once($CFG->dirroot.'/mod/forum/lib.php');
116 forum_tp_delete_read_records($usernew->id);
117 }
118}
119
c060fc6a 120function useredit_update_interests($user, $interests) {
121 tag_set('user', $user->id, $interests);
1e1c51a3 122}
123
4e782b32 124function useredit_shared_definition(&$mform, $editoroptions = null, $filemanageroptions = null) {
d6ace123 125 global $CFG, $USER, $DB;
126
127 $user = $DB->get_record('user', array('id' => $USER->id));
05c38e2b 128 useredit_load_preferences($user, false);
14a6b7e1 129
130 $strrequired = get_string('required');
d8734783 131
bf718f50 132 $nameordercheck = new stdClass();
baacc970 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
d8734783 143 $mform->addRule('firstname', $strrequired, 'required', null, 'client');
144 $mform->setType('firstname', PARAM_NOTAGS);
145
d8734783 146 $mform->addRule('lastname', $strrequired, 'required', null, 'client');
147 $mform->setType('lastname', PARAM_NOTAGS);
148
d6ace123 149 // Do not show email field if change confirmation is pending
775f811a 150 if (!empty($CFG->emailchangeconfirmation) and !empty($user->preference_newemail)) {
c6a074f8 151 $notice = get_string('emailchangepending', 'auth', $user);
d6ace123 152 $notice .= '<br /><a href="edit.php?cancelemailchange=1&amp;id='.$user->id.'">'
c6a074f8 153 . get_string('emailchangecancel', 'auth') . '</a>';
d6ace123 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 }
d8734783 159
160 $choices = array();
161 $choices['0'] = get_string('emaildisplayno');
162 $choices['1'] = get_string('emaildisplayyes');
163 $choices['2'] = get_string('emaildisplaycourse');
164 $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
e61f8701 165 $mform->setDefault('maildisplay', 2);
d8734783 166
d8734783 167 $choices = array();
168 $choices['0'] = get_string('textformat');
169 $choices['1'] = get_string('htmlformat');
170 $mform->addElement('select', 'mailformat', get_string('emailformat'), $choices);
c3ed4a5a 171 $mform->setDefault('mailformat', 1);
d8734783 172
173 if (!empty($CFG->allowusermailcharset)) {
ad6226fb 174 $choices = array();
d8734783 175 $charsets = get_list_of_charsets();
176 if (!empty($CFG->sitemailcharset)) {
177 $choices['0'] = get_string('site').' ('.$CFG->sitemailcharset.')';
178 } else {
9152fc99 179 $choices['0'] = get_string('site').' (UTF-8)';
ad6226fb 180 }
d8734783 181 $choices = array_merge($choices, $charsets);
c3ed4a5a 182 $mform->addElement('select', 'preference_mailcharset', get_string('emailcharset'), $choices);
d8734783 183 }
184
185 $choices = array();
186 $choices['0'] = get_string('emaildigestoff');
187 $choices['1'] = get_string('emaildigestcomplete');
188 $choices['2'] = get_string('emaildigestsubjects');
189 $mform->addElement('select', 'maildigest', get_string('emaildigest'), $choices);
190 $mform->setDefault('maildigest', 0);
d8734783 191
192 $choices = array();
193 $choices['1'] = get_string('autosubscribeyes');
194 $choices['0'] = get_string('autosubscribeno');
195 $mform->addElement('select', 'autosubscribe', get_string('autosubscribe'), $choices);
e61f8701 196 $mform->setDefault('autosubscribe', 1);
d8734783 197
198 if (!empty($CFG->forum_trackreadposts)) {
ad6226fb 199 $choices = array();
d8734783 200 $choices['0'] = get_string('trackforumsno');
201 $choices['1'] = get_string('trackforumsyes');
202 $mform->addElement('select', 'trackforums', get_string('trackforums'), $choices);
203 $mform->setDefault('trackforums', 0);
d8734783 204 }
c3ed4a5a 205
20e5da7d
PS
206 $editors = editors_get_enabled();
207 if (count($editors) > 1) {
ad6226fb 208 $choices = array();
d8734783 209 $choices['0'] = get_string('texteditor');
210 $choices['1'] = get_string('htmleditor');
211 $mform->addElement('select', 'htmleditor', get_string('textediting'), $choices);
212 $mform->setDefault('htmleditor', 1);
20e5da7d
PS
213 } else {
214 $mform->addElement('hidden', 'htmleditor');
215 $mform->setDefault('htmleditor', 1);
216 $mform->setType('htmleditor', PARAM_INT);
d8734783 217 }
c3ed4a5a 218
c5c0d2ff 219 $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="21"');
071e68f9 220 $mform->setType('city', PARAM_TEXT);
d8734783 221 $mform->addRule('city', $strrequired, 'required', null, 'client');
fa7f750c
PS
222 if (!empty($CFG->defaultcity)) {
223 $mform->setDefault('city', $CFG->defaultcity);
224 }
d8734783 225
0aa759b0 226 $choices = get_string_manager()->get_list_of_countries();
d8734783 227 $choices= array(''=>get_string('selectacountry').'...') + $choices;
228 $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
229 $mform->addRule('country', $strrequired, 'required', null, 'client');
230 if (!empty($CFG->country)) {
231 $mform->setDefault('country', $CFG->country);
232 }
233
234 $choices = get_list_of_timezones();
235 $choices['99'] = get_string('serverlocaltime');
236 if ($CFG->forcetimezone != 99) {
237 $mform->addElement('static', 'forcedtimezone', get_string('timezone'), $choices[$CFG->forcetimezone]);
238 } else {
239 $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
240 $mform->setDefault('timezone', '99');
241 }
242
1f96e907 243 $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
ca80f999 244 $mform->setDefault('lang', $CFG->lang);
d8734783 245
246 if (!empty($CFG->allowuserthemes)) {
ad6226fb 247 $choices = array();
d8734783 248 $choices[''] = get_string('default');
36798745
SH
249 $themes = get_list_of_themes();
250 foreach ($themes as $key=>$theme) {
251 if (empty($theme->hidefromselector)) {
d609d962 252 $choices[$key] = get_string('pluginname', 'theme_'.$theme->name);
36798745
SH
253 }
254 }
c3ed4a5a 255 $mform->addElement('select', 'theme', get_string('preferredtheme'), $choices);
d8734783 256 }
ad6226fb 257
8bdc9cac
SH
258 $mform->addElement('editor', 'description_editor', get_string('userdescription'), null, $editoroptions);
259 $mform->setType('description_editor', PARAM_CLEANHTML);
27d1a27c 260 $mform->addHelpButton('description_editor', 'userdescription');
ad6226fb 261
de2d81fa 262 if (!empty($CFG->gdversion) and empty($USER->newadminuser)) {
757e89d2 263 $mform->addElement('header', 'moodle_picture', get_string('pictureofuser'));
ad6226fb 264
4125bdc1 265 if (!empty($CFG->enablegravatar)) {
ed9e0cb6 266 $mform->addElement('html', html_writer::tag('p', get_string('gravatarenabled')));
4125bdc1
SH
267 }
268
d8734783 269 $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
ad6226fb 270
d8734783 271 $mform->addElement('checkbox', 'deletepicture', get_string('delete'));
edfd6a5e 272 $mform->setDefault('deletepicture', 0);
ad6226fb 273
4e782b32 274 $mform->addElement('filemanager', 'imagefile', get_string('newpicture'), '', $filemanageroptions);
27d1a27c 275 $mform->addHelpButton('imagefile', 'newpicture');
ad6226fb 276
d8734783 277 $mform->addElement('text', 'imagealt', get_string('imagealt'), 'maxlength="100" size="30"');
071e68f9 278 $mform->setType('imagealt', PARAM_TEXT);
ad6226fb 279
d8734783 280 }
ad6226fb 281
de2d81fa 282 if (!empty($CFG->usetags) and empty($USER->newadminuser)) {
1e1c51a3 283 $mform->addElement('header', 'moodle_interests', get_string('interests'));
c060fc6a 284 $mform->addElement('tags', 'interests', get_string('interestslist'), array('display' => 'noofficial'));
27d1a27c 285 $mform->addHelpButton('interests', 'interestslist');
1e1c51a3 286 }
d6ace123 287
d8734783 288 /// Moodle optional fields
c3ed4a5a 289 $mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
ad6226fb 290
d8734783 291 $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
292 $mform->setType('url', PARAM_URL);
ad6226fb 293
d8734783 294 $mform->addElement('text', 'icq', get_string('icqnumber'), 'maxlength="15" size="25"');
93de0ac2 295 $mform->setType('icq', PARAM_NOTAGS);
ad6226fb 296
d8734783 297 $mform->addElement('text', 'skype', get_string('skypeid'), 'maxlength="50" size="25"');
93de0ac2 298 $mform->setType('skype', PARAM_NOTAGS);
ad6226fb 299
d8734783 300 $mform->addElement('text', 'aim', get_string('aimid'), 'maxlength="50" size="25"');
93de0ac2 301 $mform->setType('aim', PARAM_NOTAGS);
ad6226fb 302
d8734783 303 $mform->addElement('text', 'yahoo', get_string('yahooid'), 'maxlength="50" size="25"');
93de0ac2 304 $mform->setType('yahoo', PARAM_NOTAGS);
ad6226fb 305
d8734783 306 $mform->addElement('text', 'msn', get_string('msnid'), 'maxlength="50" size="25"');
93de0ac2 307 $mform->setType('msn', PARAM_NOTAGS);
ad6226fb 308
8b9cfac4 309 $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
93de0ac2 310 $mform->setType('idnumber', PARAM_NOTAGS);
ad6226fb 311
d8734783 312 $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="40" size="25"');
071e68f9 313 $mform->setType('institution', PARAM_TEXT);
ad6226fb 314
d8734783 315 $mform->addElement('text', 'department', get_string('department'), 'maxlength="30" size="25"');
071e68f9 316 $mform->setType('department', PARAM_TEXT);
ad6226fb 317
d8734783 318 $mform->addElement('text', 'phone1', get_string('phone'), 'maxlength="20" size="25"');
93de0ac2 319 $mform->setType('phone1', PARAM_NOTAGS);
ad6226fb 320
55ac3d6f 321 $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
93de0ac2 322 $mform->setType('phone2', PARAM_NOTAGS);
ad6226fb 323
d8734783 324 $mform->addElement('text', 'address', get_string('address'), 'maxlength="70" size="25"');
071e68f9 325 $mform->setType('address', PARAM_TEXT);
d6ace123 326
327
14a6b7e1 328}
ad6226fb 329
aa6c1ced 330