MDL-41715 Increase size of char fiels in user table
[moodle.git] / admin / tool / uploaduser / user_form.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Bulk user upload forms
19  *
20  * @package    tool
21  * @subpackage uploaduser
22  * @copyright  2007 Dan Poltawski
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 require_once $CFG->libdir.'/formslib.php';
31 /**
32  * Upload a file CVS file with user information.
33  *
34  * @copyright  2007 Petr Skoda  {@link http://skodak.org}
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class admin_uploaduser_form1 extends moodleform {
38     function definition () {
39         $mform = $this->_form;
41         $mform->addElement('header', 'settingsheader', get_string('upload'));
43         $mform->addElement('filepicker', 'userfile', get_string('file'));
44         $mform->addRule('userfile', null, 'required');
46         $choices = csv_import_reader::get_delimiter_list();
47         $mform->addElement('select', 'delimiter_name', get_string('csvdelimiter', 'tool_uploaduser'), $choices);
48         if (array_key_exists('cfg', $choices)) {
49             $mform->setDefault('delimiter_name', 'cfg');
50         } else if (get_string('listsep', 'langconfig') == ';') {
51             $mform->setDefault('delimiter_name', 'semicolon');
52         } else {
53             $mform->setDefault('delimiter_name', 'comma');
54         }
56         $choices = core_text::get_encodings();
57         $mform->addElement('select', 'encoding', get_string('encoding', 'tool_uploaduser'), $choices);
58         $mform->setDefault('encoding', 'UTF-8');
60         $choices = array('10'=>10, '20'=>20, '100'=>100, '1000'=>1000, '100000'=>100000);
61         $mform->addElement('select', 'previewrows', get_string('rowpreviewnum', 'tool_uploaduser'), $choices);
62         $mform->setType('previewrows', PARAM_INT);
64         $this->add_action_buttons(false, get_string('uploadusers', 'tool_uploaduser'));
65     }
66 }
69 /**
70  * Specify user upload details
71  *
72  * @copyright  2007 Petr Skoda  {@link http://skodak.org}
73  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
74  */
75 class admin_uploaduser_form2 extends moodleform {
76     function definition () {
77         global $CFG, $USER;
79         $mform   = $this->_form;
80         $columns = $this->_customdata['columns'];
81         $data    = $this->_customdata['data'];
83         // I am the template user, why should it be the administrator? we have roles now, other ppl may use this script ;-)
84         $templateuser = $USER;
86         // upload settings and file
87         $mform->addElement('header', 'settingsheader', get_string('settings'));
89         $choices = array(UU_USER_ADDNEW     => get_string('uuoptype_addnew', 'tool_uploaduser'),
90                          UU_USER_ADDINC     => get_string('uuoptype_addinc', 'tool_uploaduser'),
91                          UU_USER_ADD_UPDATE => get_string('uuoptype_addupdate', 'tool_uploaduser'),
92                          UU_USER_UPDATE     => get_string('uuoptype_update', 'tool_uploaduser'));
93         $mform->addElement('select', 'uutype', get_string('uuoptype', 'tool_uploaduser'), $choices);
95         $choices = array(0 => get_string('infilefield', 'auth'), 1 => get_string('createpasswordifneeded', 'auth'));
96         $mform->addElement('select', 'uupasswordnew', get_string('uupasswordnew', 'tool_uploaduser'), $choices);
97         $mform->setDefault('uupasswordnew', 1);
98         $mform->disabledIf('uupasswordnew', 'uutype', 'eq', UU_USER_UPDATE);
100         $choices = array(UU_UPDATE_NOCHANGES    => get_string('nochanges', 'tool_uploaduser'),
101                          UU_UPDATE_FILEOVERRIDE => get_string('uuupdatefromfile', 'tool_uploaduser'),
102                          UU_UPDATE_ALLOVERRIDE  => get_string('uuupdateall', 'tool_uploaduser'),
103                          UU_UPDATE_MISSING      => get_string('uuupdatemissing', 'tool_uploaduser'));
104         $mform->addElement('select', 'uuupdatetype', get_string('uuupdatetype', 'tool_uploaduser'), $choices);
105         $mform->setDefault('uuupdatetype', UU_UPDATE_NOCHANGES);
106         $mform->disabledIf('uuupdatetype', 'uutype', 'eq', UU_USER_ADDNEW);
107         $mform->disabledIf('uuupdatetype', 'uutype', 'eq', UU_USER_ADDINC);
109         $choices = array(0 => get_string('nochanges', 'tool_uploaduser'), 1 => get_string('update'));
110         $mform->addElement('select', 'uupasswordold', get_string('uupasswordold', 'tool_uploaduser'), $choices);
111         $mform->setDefault('uupasswordold', 0);
112         $mform->disabledIf('uupasswordold', 'uutype', 'eq', UU_USER_ADDNEW);
113         $mform->disabledIf('uupasswordold', 'uutype', 'eq', UU_USER_ADDINC);
114         $mform->disabledIf('uupasswordold', 'uuupdatetype', 'eq', 0);
115         $mform->disabledIf('uupasswordold', 'uuupdatetype', 'eq', 3);
117         $choices = array(UU_PWRESET_WEAK => get_string('usersweakpassword', 'tool_uploaduser'),
118                          UU_PWRESET_NONE => get_string('none'),
119                          UU_PWRESET_ALL  => get_string('all'));
120         if (empty($CFG->passwordpolicy)) {
121             unset($choices[UU_PWRESET_WEAK]);
122         }
123         $mform->addElement('select', 'uuforcepasswordchange', get_string('forcepasswordchange', 'core'), $choices);
126         $mform->addElement('selectyesno', 'uuallowrenames', get_string('allowrenames', 'tool_uploaduser'));
127         $mform->setDefault('uuallowrenames', 0);
128         $mform->disabledIf('uuallowrenames', 'uutype', 'eq', UU_USER_ADDNEW);
129         $mform->disabledIf('uuallowrenames', 'uutype', 'eq', UU_USER_ADDINC);
131         $mform->addElement('selectyesno', 'uuallowdeletes', get_string('allowdeletes', 'tool_uploaduser'));
132         $mform->setDefault('uuallowdeletes', 0);
133         $mform->disabledIf('uuallowdeletes', 'uutype', 'eq', UU_USER_ADDNEW);
134         $mform->disabledIf('uuallowdeletes', 'uutype', 'eq', UU_USER_ADDINC);
136         $mform->addElement('selectyesno', 'uuallowsuspends', get_string('allowsuspends', 'tool_uploaduser'));
137         $mform->setDefault('uuallowsuspends', 1);
138         $mform->disabledIf('uuallowsuspends', 'uutype', 'eq', UU_USER_ADDNEW);
139         $mform->disabledIf('uuallowsuspends', 'uutype', 'eq', UU_USER_ADDINC);
141         $mform->addElement('selectyesno', 'uunoemailduplicates', get_string('uunoemailduplicates', 'tool_uploaduser'));
142         $mform->setDefault('uunoemailduplicates', 1);
144         $mform->addElement('selectyesno', 'uustandardusernames', get_string('uustandardusernames', 'tool_uploaduser'));
145         $mform->setDefault('uustandardusernames', 1);
147         $choices = array(UU_BULK_NONE    => get_string('no'),
148                          UU_BULK_NEW     => get_string('uubulknew', 'tool_uploaduser'),
149                          UU_BULK_UPDATED => get_string('uubulkupdated', 'tool_uploaduser'),
150                          UU_BULK_ALL     => get_string('uubulkall', 'tool_uploaduser'));
151         $mform->addElement('select', 'uubulk', get_string('uubulk', 'tool_uploaduser'), $choices);
152         $mform->setDefault('uubulk', 0);
154         // roles selection
155         $showroles = false;
156         foreach ($columns as $column) {
157             if (preg_match('/^type\d+$/', $column)) {
158                 $showroles = true;
159                 break;
160             }
161         }
162         if ($showroles) {
163             $mform->addElement('header', 'rolesheader', get_string('roles'));
165             $choices = uu_allowed_roles(true);
167             $mform->addElement('select', 'uulegacy1', get_string('uulegacy1role', 'tool_uploaduser'), $choices);
168             if ($studentroles = get_archetype_roles('student')) {
169                 foreach ($studentroles as $role) {
170                     if (isset($choices[$role->id])) {
171                         $mform->setDefault('uulegacy1', $role->id);
172                         break;
173                     }
174                 }
175                 unset($studentroles);
176             }
178             $mform->addElement('select', 'uulegacy2', get_string('uulegacy2role', 'tool_uploaduser'), $choices);
179             if ($editteacherroles = get_archetype_roles('editingteacher')) {
180                 foreach ($editteacherroles as $role) {
181                     if (isset($choices[$role->id])) {
182                         $mform->setDefault('uulegacy2', $role->id);
183                         break;
184                     }
185                 }
186                 unset($editteacherroles);
187             }
189             $mform->addElement('select', 'uulegacy3', get_string('uulegacy3role', 'tool_uploaduser'), $choices);
190             if ($teacherroles = get_archetype_roles('teacher')) {
191                 foreach ($teacherroles as $role) {
192                     if (isset($choices[$role->id])) {
193                         $mform->setDefault('uulegacy3', $role->id);
194                         break;
195                     }
196                 }
197                 unset($teacherroles);
198             }
199         }
201         // default values
202         $mform->addElement('header', 'defaultheader', get_string('defaultvalues', 'tool_uploaduser'));
204         $mform->addElement('text', 'username', get_string('uuusernametemplate', 'tool_uploaduser'), 'size="20"');
205         $mform->setType('username', PARAM_RAW); // No cleaning here. The process verifies it later.
206         $mform->addRule('username', get_string('requiredtemplate', 'tool_uploaduser'), 'required', null, 'client');
207         $mform->disabledIf('username', 'uutype', 'eq', UU_USER_ADD_UPDATE);
208         $mform->disabledIf('username', 'uutype', 'eq', UU_USER_UPDATE);
210         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="30"');
211         $mform->setType('email', PARAM_RAW); // No cleaning here. The process verifies it later.
212         $mform->disabledIf('email', 'uutype', 'eq', UU_USER_ADD_UPDATE);
213         $mform->disabledIf('email', 'uutype', 'eq', UU_USER_UPDATE);
215         // only enabled and known to work plugins
216         $choices = uu_supported_auths();
217         $mform->addElement('select', 'auth', get_string('chooseauthmethod','auth'), $choices);
218         $mform->setDefault('auth', 'manual'); // manual is a sensible backwards compatible default
219         $mform->addHelpButton('auth', 'chooseauthmethod', 'auth');
220         $mform->setAdvanced('auth');
222         $choices = array(0 => get_string('emaildisplayno'), 1 => get_string('emaildisplayyes'), 2 => get_string('emaildisplaycourse'));
223         $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
224         $mform->setDefault('maildisplay', 2);
226         $choices = array(0 => get_string('textformat'), 1 => get_string('htmlformat'));
227         $mform->addElement('select', 'mailformat', get_string('emailformat'), $choices);
228         $mform->setDefault('mailformat', 1);
229         $mform->setAdvanced('mailformat');
231         $choices = array(0 => get_string('emaildigestoff'), 1 => get_string('emaildigestcomplete'), 2 => get_string('emaildigestsubjects'));
232         $mform->addElement('select', 'maildigest', get_string('emaildigest'), $choices);
233         $mform->setDefault('maildigest', 0);
234         $mform->setAdvanced('maildigest');
236         $choices = array(1 => get_string('autosubscribeyes'), 0 => get_string('autosubscribeno'));
237         $mform->addElement('select', 'autosubscribe', get_string('autosubscribe'), $choices);
238         $mform->setDefault('autosubscribe', 1);
240         $editors = editors_get_enabled();
241         if (count($editors) > 1) {
242             $choices = array();
243             $choices['0'] = get_string('texteditor');
244             $choices['1'] = get_string('htmleditor');
245             $mform->addElement('select', 'htmleditor', get_string('textediting'), $choices);
246             $mform->setDefault('htmleditor', 1);
247         } else {
248             $mform->addElement('hidden', 'htmleditor');
249             $mform->setDefault('htmleditor', 1);
250             $mform->setType('htmleditor', PARAM_INT);
251         }
253         $mform->addElement('text', 'city', get_string('city'), 'maxlength="120" size="25"');
254         $mform->setType('city', PARAM_TEXT);
255         if (empty($CFG->defaultcity)) {
256             $mform->setDefault('city', $templateuser->city);
257         } else {
258             $mform->setDefault('city', $CFG->defaultcity);
259         }
261         $choices = get_string_manager()->get_list_of_countries();
262         $choices = array(''=>get_string('selectacountry').'...') + $choices;
263         $mform->addElement('select', 'country', get_string('selectacountry'), $choices);
264         if (empty($CFG->country)) {
265             $mform->setDefault('country', $templateuser->country);
266         } else {
267             $mform->setDefault('country', $CFG->country);
268         }
269         $mform->setAdvanced('country');
271         $choices = get_list_of_timezones();
272         $choices['99'] = get_string('serverlocaltime');
273         $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
274         $mform->setDefault('timezone', $templateuser->timezone);
275         $mform->setAdvanced('timezone');
277         $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
278         $mform->setDefault('lang', $templateuser->lang);
279         $mform->setAdvanced('lang');
281         $editoroptions = array('maxfiles'=>0, 'maxbytes'=>0, 'trusttext'=>false, 'forcehttps'=>false);
282         $mform->addElement('editor', 'description', get_string('userdescription'), null, $editoroptions);
283         $mform->setType('description', PARAM_CLEANHTML);
284         $mform->addHelpButton('description', 'userdescription');
285         $mform->setAdvanced('description');
287         $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
288         $mform->setType('url', PARAM_URL);
289         $mform->setAdvanced('url');
291         $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="255" size="25"');
292         $mform->setType('idnumber', PARAM_NOTAGS);
294         $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="255" size="25"');
295         $mform->setType('institution', PARAM_TEXT);
296         $mform->setDefault('institution', $templateuser->institution);
298         $mform->addElement('text', 'department', get_string('department'), 'maxlength="255" size="25"');
299         $mform->setType('department', PARAM_TEXT);
300         $mform->setDefault('department', $templateuser->department);
302         $mform->addElement('text', 'phone1', get_string('phone'), 'maxlength="20" size="25"');
303         $mform->setType('phone1', PARAM_NOTAGS);
304         $mform->setAdvanced('phone1');
306         $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
307         $mform->setType('phone2', PARAM_NOTAGS);
308         $mform->setAdvanced('phone2');
310         $mform->addElement('text', 'address', get_string('address'), 'maxlength="255" size="25"');
311         $mform->setType('address', PARAM_TEXT);
312         $mform->setAdvanced('address');
314         // Next the profile defaults
315         profile_definition($mform);
317         // hidden fields
318         $mform->addElement('hidden', 'iid');
319         $mform->setType('iid', PARAM_INT);
321         $mform->addElement('hidden', 'previewrows');
322         $mform->setType('previewrows', PARAM_INT);
324         $this->add_action_buttons(true, get_string('uploadusers', 'tool_uploaduser'));
326         $this->set_data($data);
327     }
329     /**
330      * Form tweaks that depend on current data.
331      */
332     function definition_after_data() {
333         $mform   = $this->_form;
334         $columns = $this->_customdata['columns'];
336         foreach ($columns as $column) {
337             if ($mform->elementExists($column)) {
338                 $mform->removeElement($column);
339             }
340         }
342         if (!in_array('password', $columns)) {
343             // password resetting makes sense only if password specified in csv file
344             if ($mform->elementExists('uuforcepasswordchange')) {
345                 $mform->removeElement('uuforcepasswordchange');
346             }
347         }
348     }
350     /**
351      * Server side validation.
352      */
353     function validation($data, $files) {
354         $errors = parent::validation($data, $files);
355         $columns = $this->_customdata['columns'];
356         $optype  = $data['uutype'];
358         // detect if password column needed in file
359         if (!in_array('password', $columns)) {
360             switch ($optype) {
361                 case UU_USER_UPDATE:
362                     if (!empty($data['uupasswordold'])) {
363                         $errors['uupasswordold'] = get_string('missingfield', 'error', 'password');
364                     }
365                     break;
367                 case UU_USER_ADD_UPDATE:
368                     if (empty($data['uupasswordnew'])) {
369                         $errors['uupasswordnew'] = get_string('missingfield', 'error', 'password');
370                     }
371                     if  (!empty($data['uupasswordold'])) {
372                         $errors['uupasswordold'] = get_string('missingfield', 'error', 'password');
373                     }
374                     break;
376                 case UU_USER_ADDNEW:
377                     if (empty($data['uupasswordnew'])) {
378                         $errors['uupasswordnew'] = get_string('missingfield', 'error', 'password');
379                     }
380                     break;
381                 case UU_USER_ADDINC:
382                     if (empty($data['uupasswordnew'])) {
383                         $errors['uupasswordnew'] = get_string('missingfield', 'error', 'password');
384                     }
385                     break;
386              }
387         }
389         // look for other required data
390         if ($optype != UU_USER_UPDATE) {
391             if (!in_array('firstname', $columns)) {
392                 $errors['uutype'] = get_string('missingfield', 'error', 'firstname');
393             }
395             if (!in_array('lastname', $columns)) {
396                 if (isset($errors['uutype'])) {
397                     $errors['uutype'] = '';
398                 } else {
399                     $errors['uutype'] = ' ';
400                 }
401                 $errors['uutype'] .= get_string('missingfield', 'error', 'lastname');
402             }
404             if (!in_array('email', $columns) and empty($data['email'])) {
405                 $errors['email'] = get_string('requiredtemplate', 'tool_uploaduser');
406             }
407         }
409         return $errors;
410     }
412     /**
413      * Used to reformat the data from the editor component
414      *
415      * @return stdClass
416      */
417     function get_data() {
418         $data = parent::get_data();
420         if ($data !== null and isset($data->description)) {
421             $data->descriptionformat = $data->description['format'];
422             $data->description = $data->description['text'];
423         }
425         return $data;
426     }