MDL-22388 Added some checks to kill these scripts dead with an unequivocal notice...
[moodle.git] / admin / uploaduser_form.php
1 <?php
3 if (!defined('MOODLE_INTERNAL')) {
4     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
5 }
7 require_once $CFG->libdir.'/formslib.php';
9 class admin_uploaduser_form1 extends moodleform {
10     function definition (){
11         global $CFG, $USER;
13         $mform =& $this->_form;
15         $this->set_upload_manager(new upload_manager('userfile', false, false, null, false, 0, true, true, false));
17         $mform->addElement('header', 'settingsheader', get_string('upload'));
19         $mform->addElement('file', 'userfile', get_string('file'), 'size="40"');
20         $mform->addRule('userfile', null, 'required');
22         $choices = csv_import_reader::get_delimiter_list();
23         $mform->addElement('select', 'delimiter_name', get_string('csvdelimiter', 'admin'), $choices);
24         if (array_key_exists('cfg', $choices)) {
25             $mform->setDefault('delimiter_name', 'cfg');
26         } else if (get_string('listsep', 'langconfig') == ';') {
27             $mform->setDefault('delimiter_name', 'semicolon');
28         } else {
29             $mform->setDefault('delimiter_name', 'comma');
30         }
32         $textlib = textlib_get_instance();
33         $choices = $textlib->get_encodings();
34         $mform->addElement('select', 'encoding', get_string('encoding', 'admin'), $choices);
35         $mform->setDefault('encoding', 'UTF-8');
37         $choices = array('10'=>10, '20'=>20, '100'=>100, '1000'=>1000, '100000'=>100000);
38         $mform->addElement('select', 'previewrows', get_string('rowpreviewnum', 'admin'), $choices);
39         $mform->setType('previewrows', PARAM_INT);
41         $choices = array(UU_ADDNEW    => get_string('uuoptype_addnew', 'admin'),
42                          UU_ADDINC    => get_string('uuoptype_addinc', 'admin'),
43                          UU_ADD_UPDATE => get_string('uuoptype_addupdate', 'admin'),
44                          UU_UPDATE     => get_string('uuoptype_update', 'admin'));
45         $mform->addElement('select', 'uutype', get_string('uuoptype', 'admin'), $choices);
46         
47         $this->add_action_buttons(false, get_string('uploadusers'));
48     }
49 }
51 class admin_uploaduser_form2 extends moodleform {
52     function definition (){
53         global $CFG, $USER;
55         //no editors here - we need proper empty fields
56         $CFG->htmleditor = null;
58         $mform   =& $this->_form;
59         $columns =& $this->_customdata;
61         // I am the template user, why should it be the administrator? we have roles now, other ppl may use this script ;-)
62         $templateuser = $USER;
64 // upload settings and file
65         $mform->addElement('header', 'settingsheader', get_string('settings'));
66         $mform->addElement('static', 'uutypelabel', get_string('uuoptype', 'admin') );
68         $choices = array(0 => get_string('infilefield', 'auth'), 1 => get_string('createpasswordifneeded', 'auth'));
69         $mform->addElement('select', 'uupasswordnew', get_string('uupasswordnew', 'admin'), $choices);
70         $mform->setDefault('uupasswordnew', 0);
71         $mform->disabledIf('uupasswordnew', 'uutype', 'eq', UU_UPDATE);
73         $choices = array(0 => get_string('nochanges', 'admin'),
74                          1 => get_string('uuupdatefromfile', 'admin'),
75                          2 => get_string('uuupdateall', 'admin'),
76                          3 => get_string('uuupdatemissing', 'admin'));
77         $mform->addElement('select', 'uuupdatetype', get_string('uuupdatetype', 'admin'), $choices);
78         $mform->setDefault('uuupdatetype', 0);
79         $mform->disabledIf('uuupdatetype', 'uutype', 'eq', UU_ADDNEW);
80         $mform->disabledIf('uuupdatetype', 'uutype', 'eq', UU_ADDINC);
82         $choices = array(0 => get_string('nochanges', 'admin'), 1 => get_string('update'));
83         $mform->addElement('select', 'uupasswordold', get_string('uupasswordold', 'admin'), $choices);
84         $mform->setDefault('uupasswordold', 0);
85         $mform->disabledIf('uupasswordold', 'uutype', 'eq', UU_ADDNEW);
86         $mform->disabledIf('uupasswordold', 'uutype', 'eq', UU_ADDINC);
87         $mform->disabledIf('uupasswordold', 'uuupdatetype', 'eq', 0);
88         $mform->disabledIf('uupasswordold', 'uuupdatetype', 'eq', 3);
90         $mform->addElement('selectyesno', 'uuallowrenames', get_string('allowrenames', 'admin'));
91         $mform->setDefault('uuallowrenames', 0);
92         $mform->disabledIf('uuallowrenames', 'uutype', 'eq', UU_ADDNEW);
93         $mform->disabledIf('uuallowrenames', 'uutype', 'eq', UU_ADDINC);
95         $mform->addElement('selectyesno', 'uuallowdeletes', get_string('allowdeletes', 'admin'));
96         $mform->setDefault('uuallowdeletes', 0);
97         $mform->disabledIf('uuallowdeletes', 'uutype', 'eq', UU_ADDNEW);
98         $mform->disabledIf('uuallowdeletes', 'uutype', 'eq', UU_ADDINC);
100         $mform->addElement('selectyesno', 'uunoemailduplicates', get_string('uunoemailduplicates', 'admin'));
101         $mform->setDefault('uunoemailduplicates', 1);
103         $choices = array(0 => get_string('no'),
104                          1 => get_string('uubulknew', 'admin'),
105                          2 => get_string('uubulkupdated', 'admin'),
106                          3 => get_string('uubulkall', 'admin'));
107         $mform->addElement('select', 'uubulk', get_string('uubulk', 'admin'), $choices);
108         $mform->setDefault('uubulk', 0);
110 // roles selection
111         $showroles = false;
112         foreach ($columns as $column) {
113             if (preg_match('/^type\d+$/', $column)) {
114                 $showroles = true;
115                 break;
116             }
117         }
118         if ($showroles) {
119             $mform->addElement('header', 'rolesheader', get_string('roles'));
121             $choices = uu_allowed_roles(true);
123             $choices[0] = get_string('uucoursedefaultrole', 'admin');
124             $mform->addElement('select', 'uulegacy1', get_string('uulegacy1role', 'admin'), $choices);
125             $mform->setDefault('uulegacy1', 0);
126             unset($choices[0]);
128             $mform->addElement('select', 'uulegacy2', get_string('uulegacy2role', 'admin'), $choices);
129             if ($editteacherroles = get_archetype_roles('editingteacher')) {
130                 $editteacherrole = array_shift($editteacherroles);   /// Take the first one
131                 $mform->setDefault('uulegacy2', $editteacherrole->id);
132                 unset($editteacherroles);
133             } else {
134                 $mform->setDefault('uulegacy2', $CFG->defaultcourseroleid);
135             }
137             $mform->addElement('select', 'uulegacy3', get_string('uulegacy3role', 'admin'), $choices);
138             if ($teacherroles = get_archetype_roles('teacher')) {
139                 $teacherrole = array_shift($teacherroles);   /// Take the first one
140                 $mform->setDefault('uulegacy3', $teacherrole->id);
141                 unset($teacherroles);
142             } else {
143                 $mform->setDefault('uulegacy3', $CFG->defaultcourseroleid);
144             }
145         }
147 // default values
148         $mform->addElement('header', 'defaultheader', get_string('defaultvalues', 'admin'));
150         $mform->addElement('text', 'username', get_string('username'), 'size="20"');
151         $mform->addRule('username', get_string('requiredtemplate', 'admin'), 'required', null, 'client');
153         // only enabled and known to work plugins
154         $choices = uu_allowed_auths();
155         $mform->addElement('select', 'auth', get_string('chooseauthmethod','auth'), $choices);
156         $mform->setDefault('auth', 'manual'); // manual is a sensible backwards compatible default
157         $mform->addHelpButton('auth', 'chooseauthmethod', 'auth');
158         $mform->setAdvanced('auth');
160         $mform->addElement('text', 'email', get_string('email'), 'maxlength="100" size="30"');
162         $choices = array(0 => get_string('emaildisplayno'), 1 => get_string('emaildisplayyes'), 2 => get_string('emaildisplaycourse'));
163         $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
164         $mform->setDefault('maildisplay', 2);
166         $choices = array(0 => get_string('emailenable'), 1 => get_string('emaildisable'));
167         $mform->addElement('select', 'emailstop', get_string('emailactive'), $choices);
169         $choices = array(0 => get_string('textformat'), 1 => get_string('htmlformat'));
170         $mform->addElement('select', 'mailformat', get_string('emailformat'), $choices);
171         $mform->setDefault('mailformat', 1);
172         $mform->setAdvanced('mailformat');
174         $choices = array(0 => get_string('emaildigestoff'), 1 => get_string('emaildigestcomplete'), 2 => get_string('emaildigestsubjects'));
175         $mform->addElement('select', 'maildigest', get_string('emaildigest'), $choices);
176         $mform->setDefault('maildigest', 0);
177         $mform->setAdvanced('maildigest');
179         $choices = array(0 => get_string('autosubscribeyes'), 1 => get_string('autosubscribeno'));
180         $mform->addElement('select', 'autosubscribe', get_string('autosubscribe'), $choices);
181         $mform->setDefault('autosubscribe', 1);
183 /* TODO: reimplement editor preferences
184         if ($CFG->htmleditor) {
185             $choices = array(0 => get_string('texteditor'), 1 => get_string('htmleditor'));
186             $mform->addElement('select', 'htmleditor', get_string('textediting'), $choices);
187             $mform->setDefault('htmleditor', 1);
188         } else {
189             $mform->addElement('static', 'htmleditor', get_string('textediting'), get_string('texteditor'));
190         }
191         $mform->setAdvanced('htmleditor');
192 */
194         if (empty($CFG->enableajax)) {
195             $mform->addElement('static', 'ajax', get_string('ajaxuse'), get_string('ajaxno'));
196         } else {
197             $choices = array( 0 => get_string('ajaxno'), 1 => get_string('ajaxyes'));
198             $mform->addElement('select', 'ajax', get_string('ajaxuse'), $choices);
199             $mform->setDefault('ajax', 1);
200         }
201         $mform->setAdvanced('ajax');
203         $mform->addElement('text', 'city', get_string('city'), 'maxlength="100" size="25"');
204         $mform->setType('city', PARAM_MULTILANG);
205         $mform->setDefault('city', $templateuser->city);
207         $mform->addElement('select', 'country', get_string('selectacountry'), get_string_manager()->get_list_of_countries());
208         $mform->setDefault('country', $templateuser->country);
209         $mform->setAdvanced('country');
211         $choices = get_list_of_timezones();
212         $choices['99'] = get_string('serverlocaltime');
213         $mform->addElement('select', 'timezone', get_string('timezone'), $choices);
214         $mform->setDefault('timezone', $templateuser->timezone);
215         $mform->setAdvanced('timezone');
217         $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
218         $mform->setDefault('lang', $templateuser->lang);
219         $mform->setAdvanced('lang');
221         $editoroptions = array('maxfiles'=>0, 'maxbytes'=>0, 'trusttext'=>false, 'forcehttps'=>false);
222         $mform->addElement('editor', 'description', get_string('userdescription'), null, $editoroptions);
223         $mform->setType('description', PARAM_CLEANHTML);
224         $mform->addHelpButton('description', 'userdescription');
225         $mform->setAdvanced('description');
227         $mform->addElement('text', 'url', get_string('webpage'), 'maxlength="255" size="50"');
228         $mform->setAdvanced('url');
230         $mform->addElement('text', 'idnumber', get_string('idnumber'), 'maxlength="64" size="25"');
231         $mform->setType('idnumber', PARAM_CLEAN);
233         $mform->addElement('text', 'institution', get_string('institution'), 'maxlength="40" size="25"');
234         $mform->setType('institution', PARAM_MULTILANG);
235         $mform->setDefault('institution', $templateuser->institution);
237         $mform->addElement('text', 'department', get_string('department'), 'maxlength="30" size="25"');
238         $mform->setType('department', PARAM_MULTILANG);
239         $mform->setDefault('department', $templateuser->department);
241         $mform->addElement('text', 'phone1', get_string('phone'), 'maxlength="20" size="25"');
242         $mform->setType('phone1', PARAM_CLEAN);
243         $mform->setAdvanced('phone1');
245         $mform->addElement('text', 'phone2', get_string('phone2'), 'maxlength="20" size="25"');
246         $mform->setType('phone2', PARAM_CLEAN);
247         $mform->setAdvanced('phone2');
249         $mform->addElement('text', 'address', get_string('address'), 'maxlength="70" size="25"');
250         $mform->setType('address', PARAM_MULTILANG);
251         $mform->setAdvanced('address');
253         /// Next the profile defaults
254         profile_definition($mform);
256 // hidden fields
257         $mform->addElement('hidden', 'iid');
258         $mform->setType('iid', PARAM_INT);
260         $mform->addElement('hidden', 'previewrows');
261         $mform->setType('previewrows', PARAM_INT);
263         $mform->addElement('hidden', 'readcount');
264         $mform->setType('readcount', PARAM_INT);
266         $mform->addElement('hidden', 'uutype');
267         $mform->setType('uutype', PARAM_INT);
269         $this->add_action_buttons(true, get_string('uploadusers'));
270     }
272     /**
273      * Form tweaks that depend on current data.
274      */
275     function definition_after_data() {
276         $mform   =& $this->_form;
277         $columns =& $this->_customdata;
279         foreach ($columns as $column) {
280             if ($mform->elementExists($column)) {
281                 $mform->removeElement($column);
282             }
283         }
284     }
286     /**
287      * Server side validation.
288      */
289     function validation($data, $files) {
290         $errors = parent::validation($data, $files);
291         $columns =& $this->_customdata;
292         $optype  = $data['uutype'];
294         // detect if password column needed in file
295         if (!in_array('password', $columns)) {
296             switch ($optype) {
297                 case UU_UPDATE:
298                     if (!empty($data['uupasswordold'])) {
299                         $errors['uupasswordold'] = get_string('missingfield', 'error', 'password');
300                     }
301                     break;
303                 case UU_ADD_UPDATE:
304                     if (empty($data['uupasswordnew'])) {
305                         $errors['uupasswordnew'] = get_string('missingfield', 'error', 'password');
306                     }
307                     if  (!empty($data['uupasswordold'])) {
308                         $errors['uupasswordold'] = get_string('missingfield', 'error', 'password');
309                     }
310                     break;
312                 case UU_ADDNEW:
313                 case UU_ADDINC:
314                     if (empty($data['uupasswordnew'])) {
315                         $errors['uupasswordnew'] = get_string('missingfield', 'error', 'password');
316                     }
317                     break;
318              }
319         }
321         // look for other required data
322         if ($optype != UU_UPDATE) {
323             if (!in_array('firstname', $columns)) {
324                 $errors['uutype'] = get_string('missingfield', 'error', 'firstname');
325             }
327             if (!in_array('lastname', $columns)) {
328                 if (isset($errors['uutype'])) {
329                     $errors['uutype'] = '';
330                 } else {
331                     $errors['uutype'] = ' ';
332                 }
333                 $errors['uutype'] .= get_string('missingfield', 'error', 'lastname');
334             }
336             if (!in_array('email', $columns) and empty($data['email'])) {
337                 $errors['email'] = get_string('requiredtemplate', 'admin');
338             }
340             if (!in_array('city', $columns) and empty($data['city'])) {
341                 $errors['city'] = get_string('required');
342             }
343         }
345         return $errors;
346     }
348     /**
349      * Used to reformat the data from the editor component
350      *
351      * @return stdClass
352      */
353     function get_data() {
354         $data = parent::get_data();
356         if ($data !== null) {
357             $data->descriptionformat = $data->description['format'];
358             $data->description = $data->description['text'];
359         }
361         return $data;
362     }
365 class admin_uploaduser_form3 extends moodleform {
366     function definition (){
367         global $CFG, $USER;
368         $mform =& $this->_form;               
369         $this->add_action_buttons(false, get_string('uploadnewfile'));
370     }