MDL-14589 user icons now stored in file storage pool
[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 function useredit_update_picture(&$usernew, $userform) {
37     global $CFG, $DB;
39     $fs = get_file_storage();
40     $context = get_context_instance(CONTEXT_USER, $usernew->id, MUST_EXIST);
42     if (isset($usernew->deletepicture) and $usernew->deletepicture) {
43         $fs->delete_area_files($context->id, 'user', 'icon'); // drop all areas
44         $DB->set_field('user', 'picture', 0, array('id'=>$usernew->id));
46     } else if ($iconfile = $userform->save_temp_file('imagefile')) {
47         if (process_new_icon($context, 'user', 'icon', 0, $iconfile)) {
48             $DB->set_field('user', 'picture', 1, array('id'=>$usernew->id));
49         }
50         @unlink($iconfile);
51     }
52 }
54 function useredit_update_bounces($user, $usernew) {
55     if (!isset($usernew->email)) {
56         //locked field
57         return;
58     }
59     if (!isset($user->email) || $user->email !== $usernew->email) {
60         set_bounce_count($usernew,true);
61         set_send_count($usernew,true);
62     }
63 }
65 function useredit_update_trackforums($user, $usernew) {
66     global $CFG;
67     if (!isset($usernew->trackforums)) {
68         //locked field
69         return;
70     }
71     if ((!isset($user->trackforums) || ($usernew->trackforums != $user->trackforums)) and !$usernew->trackforums) {
72         require_once($CFG->dirroot.'/mod/forum/lib.php');
73         forum_tp_delete_read_records($usernew->id);
74     }
75 }
77 function useredit_update_interests($user, $interests) {
78     tag_set('user', $user->id, $interests);
79 }
81 function useredit_shared_definition(&$mform, $editoroptions = null) {
82     global $CFG, $USER, $DB;
84     $user = $DB->get_record('user', array('id' => $USER->id));
85     useredit_load_preferences($user, false);
87     $strrequired = get_string('required');
89     $nameordercheck = new object();
90     $nameordercheck->firstname = 'a';
91     $nameordercheck->lastname  = 'b';
92     if (fullname($nameordercheck) == 'b a' ) {  // See MDL-4325
93         $mform->addElement('text', 'lastname',  get_string('lastname'),  'maxlength="100" size="30"');
94         $mform->addElement('text', 'firstname', get_string('firstname'), 'maxlength="100" size="30"');
95     } else {
96         $mform->addElement('text', 'firstname', get_string('firstname'), 'maxlength="100" size="30"');
97         $mform->addElement('text', 'lastname',  get_string('lastname'),  'maxlength="100" size="30"');
98     }
100     $mform->addRule('firstname', $strrequired, 'required', null, 'client');
101     $mform->setType('firstname', PARAM_NOTAGS);
103     $mform->addRule('lastname', $strrequired, 'required', null, 'client');
104     $mform->setType('lastname', PARAM_NOTAGS);
106     // Do not show email field if change confirmation is pending
107     if (!empty($CFG->emailchangeconfirmation) and !empty($user->preference_newemail)) {
108         $notice = get_string('auth_emailchangepending', 'auth_email', $user);
109         $notice .= '<br /><a href="edit.php?cancelemailchange=1&amp;id='.$user->id.'">'
110                 . get_string('auth_emailchangecancel', 'auth_email') . '</a>';
111         $mform->addElement('static', 'emailpending', get_string('email'), $notice);
112     } else {
113         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="30"');
114         $mform->addRule('email', $strrequired, 'required', null, 'client');
115     }
117     $choices = array();
118     $choices['0'] = get_string('emaildisplayno');
119     $choices['1'] = get_string('emaildisplayyes');
120     $choices['2'] = get_string('emaildisplaycourse');
121     $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
122     $mform->setDefault('maildisplay', 2);
124     $choices = array();
125     $choices['0'] = get_string('emailenable');
126     $choices['1'] = get_string('emaildisable');
127     $mform->addElement('select', 'emailstop', get_string('emailactive'), $choices);
128     $mform->setDefault('emailstop', 0);
130     $choices = array();
131     $choices['0'] = get_string('textformat');
132     $choices['1'] = get_string('htmlformat');
133     $mform->addElement('select', 'mailformat', get_string('emailformat'), $choices);
134     $mform->setDefault('mailformat', 1);
136     if (!empty($CFG->allowusermailcharset)) {
137         $choices = array();
138         $charsets = get_list_of_charsets();
139         if (!empty($CFG->sitemailcharset)) {
140             $choices['0'] = get_string('site').' ('.$CFG->sitemailcharset.')';
141         } else {
142             $choices['0'] = get_string('site').' (UTF-8)';
143         }
144         $choices = array_merge($choices, $charsets);
145         $mform->addElement('select', 'preference_mailcharset', get_string('emailcharset'), $choices);
146     }
148     $choices = array();
149     $choices['0'] = get_string('emaildigestoff');
150     $choices['1'] = get_string('emaildigestcomplete');
151     $choices['2'] = get_string('emaildigestsubjects');
152     $mform->addElement('select', 'maildigest', get_string('emaildigest'), $choices);
153     $mform->setDefault('maildigest', 0);
155     $choices = array();
156     $choices['1'] = get_string('autosubscribeyes');
157     $choices['0'] = get_string('autosubscribeno');
158     $mform->addElement('select', 'autosubscribe', get_string('autosubscribe'), $choices);
159     $mform->setDefault('autosubscribe', 1);
161     if (!empty($CFG->forum_trackreadposts)) {
162         $choices = array();
163         $choices['0'] = get_string('trackforumsno');
164         $choices['1'] = get_string('trackforumsyes');
165         $mform->addElement('select', 'trackforums', get_string('trackforums'), $choices);
166         $mform->setDefault('trackforums', 0);
167     }
169     $editors = editors_get_enabled();
170     if (count($editors) > 1) {
171         $choices = array();
172         $choices['0'] = get_string('texteditor');
173         $choices['1'] = get_string('htmleditor');
174         $mform->addElement('select', 'htmleditor', get_string('textediting'), $choices);
175         $mform->setDefault('htmleditor', 1);
176     } else {
177         $mform->addElement('hidden', 'htmleditor');
178         $mform->setDefault('htmleditor', 1);
179         $mform->setType('htmleditor', PARAM_INT);
180     }
182     if (empty($CFG->enableajax)) {
183         $mform->addElement('static', 'ajaxdisabled', get_string('ajaxuse'), get_string('ajaxno'));
184     } else {
185         $choices = array();
186         $choices['0'] = get_string('ajaxno');
187         $choices['1'] = get_string('ajaxyes');
188         $mform->addElement('select', 'ajax', get_string('ajaxuse'), $choices);
189         $mform->setDefault('ajax', 0);
190     }
192     $choices = array();
193     $choices['0'] = get_string('screenreaderno');
194     $choices['1'] = get_string('screenreaderyes');
195     $mform->addElement('select', 'screenreader', get_string('screenreaderuse'), $choices);
196     $mform->setDefault('screenreader', 0);
197     $mform->addHelpButton('screenreader', 'screenreaderuse');
199     $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="21"');
200     $mform->setType('city', PARAM_MULTILANG);
201     $mform->addRule('city', $strrequired, 'required', null, 'client');
204     $choices = get_string_manager()->get_list_of_countries();
205     $choices= array(''=>get_string('selectacountry').'...') + $choices;
206     $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
207     $mform->addRule('country', $strrequired, 'required', null, 'client');
208     if (!empty($CFG->country)) {
209         $mform->setDefault('country', $CFG->country);
210     }
212     $choices = get_list_of_timezones();
213     $choices['99'] = get_string('serverlocaltime');
214     if ($CFG->forcetimezone != 99) {
215         $mform->addElement('static', 'forcedtimezone', get_string('timezone'), $choices[$CFG->forcetimezone]);
216     } else {
217         $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
218         $mform->setDefault('timezone', '99');
219     }
221     $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
222     $mform->setDefault('lang', $CFG->lang);
224     if (!empty($CFG->allowuserthemes)) {
225         $choices = array();
226         $choices[''] = get_string('default');
227         $themes = get_list_of_themes();
228         foreach ($themes as $key=>$theme) {
229             if (empty($theme->hidefromselector)) {
230                 $choices[$key] = $theme->name;
231             }
232         }
233         $mform->addElement('select', 'theme', get_string('preferredtheme'), $choices);
234     }
236     $mform->addElement('editor', 'description_editor', get_string('userdescription'), null, $editoroptions);
237     $mform->setType('description_editor', PARAM_CLEANHTML);
238     $mform->addHelpButton('description_editor', 'userdescription');
240     if (!empty($CFG->gdversion)) {
241         $mform->addElement('header', 'moodle_picture', get_string('pictureofuser'));
243         $mform->addElement('static', 'currentpicture', get_string('currentpicture'));
245         $mform->addElement('checkbox', 'deletepicture', get_string('delete'));
246         $mform->setDefault('deletepicture', 0);
248         $mform->addElement('filepicker', 'imagefile', get_string('newpicture'));
249         $mform->addHelpButton('imagefile', 'newpicture');
251         $mform->addElement('text', 'imagealt', get_string('imagealt'), 'maxlength="100" size="30"');
252         $mform->setType('imagealt', PARAM_MULTILANG);
254     }
256     if (!empty($CFG->usetags)) {
257         $mform->addElement('header', 'moodle_interests', get_string('interests'));
258         $mform->addElement('tags', 'interests', get_string('interestslist'), array('display' => 'noofficial'));
259         $mform->addHelpButton('interests', 'interestslist');
260     }
262     /// Moodle optional fields
263     $mform->addElement('header', 'moodle_optional', get_string('optional', 'form'));
265     $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
266     $mform->setType('url', PARAM_URL);
268     $mform->addElement('text', 'icq', get_string('icqnumber'), 'maxlength="15" size="25"');
269     $mform->setType('icq', PARAM_CLEAN);
271     $mform->addElement('text', 'skype', get_string('skypeid'), 'maxlength="50" size="25"');
272     $mform->setType('skype', PARAM_CLEAN);
274     $mform->addElement('text', 'aim', get_string('aimid'), 'maxlength="50" size="25"');
275     $mform->setType('aim', PARAM_CLEAN);
277     $mform->addElement('text', 'yahoo', get_string('yahooid'), 'maxlength="50" size="25"');
278     $mform->setType('yahoo', PARAM_CLEAN);
280     $mform->addElement('text', 'msn', get_string('msnid'), 'maxlength="50" size="25"');
281     $mform->setType('msn', PARAM_CLEAN);
283     $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
284     $mform->setType('idnumber', PARAM_CLEAN);
286     $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="40" size="25"');
287     $mform->setType('institution', PARAM_MULTILANG);
289     $mform->addElement('text', 'department', get_string('department'), 'maxlength="30" size="25"');
290     $mform->setType('department', PARAM_MULTILANG);
292     $mform->addElement('text', 'phone1', get_string('phone'), 'maxlength="20" size="25"');
293     $mform->setType('phone1', PARAM_CLEAN);
295     $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
296     $mform->setType('phone2', PARAM_CLEAN);
298     $mform->addElement('text', 'address', get_string('address'), 'maxlength="70" size="25"');
299     $mform->setType('address', PARAM_MULTILANG);