Merge branch 'MDL-30335' of git://github.com/timhunt/moodle
[moodle.git] / lib / formslib.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  * formslib.php - library of classes for creating forms in Moodle, based on PEAR QuickForms.
19  *
20  * To use formslib then you will want to create a new file purpose_form.php eg. edit_form.php
21  * and you want to name your class something like {modulename}_{purpose}_form. Your class will
22  * extend moodleform overriding abstract classes definition and optionally defintion_after_data
23  * and validation.
24  *
25  * See examples of use of this library in course/edit.php and course/edit_form.php
26  *
27  * A few notes :
28  *      form definition is used for both printing of form and processing and should be the same
29  *              for both or you may lose some submitted data which won't be let through.
30  *      you should be using setType for every form element except select, radio or checkbox
31  *              elements, these elements clean themselves.
32  *
33  *
34  * @copyright  Jamie Pratt <me@jamiep.org>
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  * @package    core
37  * @subpackage form
38  */
40 defined('MOODLE_INTERNAL') || die();
42 /** setup.php includes our hacked pear libs first */
43 require_once 'HTML/QuickForm.php';
44 require_once 'HTML/QuickForm/DHTMLRulesTableless.php';
45 require_once 'HTML/QuickForm/Renderer/Tableless.php';
46 require_once 'HTML/QuickForm/Rule.php';
48 require_once $CFG->libdir.'/filelib.php';
50 define('EDITOR_UNLIMITED_FILES', -1);
52 /**
53  * Callback called when PEAR throws an error
54  *
55  * @param PEAR_Error $error
56  */
57 function pear_handle_error($error){
58     echo '<strong>'.$error->GetMessage().'</strong> '.$error->getUserInfo();
59     echo '<br /> <strong>Backtrace </strong>:';
60     print_object($error->backtrace);
61 }
63 if (!empty($CFG->debug) and $CFG->debug >= DEBUG_ALL){
64     PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'pear_handle_error');
65 }
67 /**
68  *
69  * @staticvar bool $done
70  * @global moodle_page $PAGE
71  */
72 function form_init_date_js() {
73     global $PAGE;
74     static $done = false;
75     if (!$done) {
76         $module   = 'moodle-form-dateselector';
77         $function = 'M.form.dateselector.init_date_selectors';
78         $config = array(array('firstdayofweek'=>get_string('firstdayofweek', 'langconfig')));
79         $PAGE->requires->yui_module($module, $function, $config);
80         $done = true;
81     }
82 }
84 /**
85  * Moodle specific wrapper that separates quickforms syntax from moodle code. You won't directly
86  * use this class you should write a class definition which extends this class or a more specific
87  * subclass such a moodleform_mod for each form you want to display and/or process with formslib.
88  *
89  * You will write your own definition() method which performs the form set up.
90  *
91  * @package   moodlecore
92  * @copyright Jamie Pratt <me@jamiep.org>
93  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
94  */
95 abstract class moodleform {
96     /** @var string */
97     protected $_formname;       // form name
98     /**
99      * quickform object definition
100      *
101      * @var MoodleQuickForm MoodleQuickForm
102      */
103     protected $_form;
104     /**
105      * globals workaround
106      *
107      * @var array
108      */
109     protected $_customdata;
110     /**
111      * definition_after_data executed flag
112      * @var object definition_finalized
113      */
114     protected $_definition_finalized = false;
116     /**
117      * The constructor function calls the abstract function definition() and it will then
118      * process and clean and attempt to validate incoming data.
119      *
120      * It will call your custom validate method to validate data and will also check any rules
121      * you have specified in definition using addRule
122      *
123      * The name of the form (id attribute of the form) is automatically generated depending on
124      * the name you gave the class extending moodleform. You should call your class something
125      * like
126      *
127      * @param mixed $action the action attribute for the form. If empty defaults to auto detect the
128      *                  current url. If a moodle_url object then outputs params as hidden variables.
129      * @param array $customdata if your form defintion method needs access to data such as $course
130      *               $cm, etc. to construct the form definition then pass it in this array. You can
131      *               use globals for somethings.
132      * @param string $method if you set this to anything other than 'post' then _GET and _POST will
133      *               be merged and used as incoming data to the form.
134      * @param string $target target frame for form submission. You will rarely use this. Don't use
135      *                  it if you don't need to as the target attribute is deprecated in xhtml
136      *                  strict.
137      * @param mixed $attributes you can pass a string of html attributes here or an array.
138      * @param bool $editable
139      * @return object moodleform
140      */
141     function moodleform($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) {
142         if (empty($action)){
143             $action = strip_querystring(qualified_me());
144         }
145         // Assign custom data first, so that get_form_identifier can use it.
146         $this->_customdata = $customdata;
147         $this->_formname = $this->get_form_identifier();
149         $this->_form = new MoodleQuickForm($this->_formname, $method, $action, $target, $attributes);
150         if (!$editable){
151             $this->_form->hardFreeze();
152         }
154         $this->definition();
156         $this->_form->addElement('hidden', 'sesskey', null); // automatic sesskey protection
157         $this->_form->setType('sesskey', PARAM_RAW);
158         $this->_form->setDefault('sesskey', sesskey());
159         $this->_form->addElement('hidden', '_qf__'.$this->_formname, null);   // form submission marker
160         $this->_form->setType('_qf__'.$this->_formname, PARAM_RAW);
161         $this->_form->setDefault('_qf__'.$this->_formname, 1);
162         $this->_form->_setDefaultRuleMessages();
164         // we have to know all input types before processing submission ;-)
165         $this->_process_submission($method);
166     }
168     /**
169      * It should returns unique identifier for the form.
170      * Currently it will return class name, but in case two same forms have to be
171      * rendered on same page then override function to get unique form identifier.
172      * e.g This is used on multiple self enrollments page.
173      *
174      * @return string form identifier.
175      */
176     protected function get_form_identifier() {
177         return get_class($this);
178     }
180     /**
181      * To autofocus on first form element or first element with error.
182      *
183      * @param string $name if this is set then the focus is forced to a field with this name
184      *
185      * @return string  javascript to select form element with first error or
186      *                  first element if no errors. Use this as a parameter
187      *                  when calling print_header
188      */
189     function focus($name=NULL) {
190         $form =& $this->_form;
191         $elkeys = array_keys($form->_elementIndex);
192         $error = false;
193         if (isset($form->_errors) &&  0 != count($form->_errors)){
194             $errorkeys = array_keys($form->_errors);
195             $elkeys = array_intersect($elkeys, $errorkeys);
196             $error = true;
197         }
199         if ($error or empty($name)) {
200             $names = array();
201             while (empty($names) and !empty($elkeys)) {
202                 $el = array_shift($elkeys);
203                 $names = $form->_getElNamesRecursive($el);
204             }
205             if (!empty($names)) {
206                 $name = array_shift($names);
207             }
208         }
210         $focus = '';
211         if (!empty($name)) {
212             $focus = 'forms[\''.$form->getAttribute('id').'\'].elements[\''.$name.'\']';
213         }
215         return $focus;
216      }
218     /**
219      * Internal method. Alters submitted data to be suitable for quickforms processing.
220      * Must be called when the form is fully set up.
221      *
222      * @param string $method
223      */
224     function _process_submission($method) {
225         $submission = array();
226         if ($method == 'post') {
227             if (!empty($_POST)) {
228                 $submission = $_POST;
229             }
230         } else {
231             $submission = array_merge_recursive($_GET, $_POST); // emulate handling of parameters in xxxx_param()
232         }
234         // following trick is needed to enable proper sesskey checks when using GET forms
235         // the _qf__.$this->_formname serves as a marker that form was actually submitted
236         if (array_key_exists('_qf__'.$this->_formname, $submission) and $submission['_qf__'.$this->_formname] == 1) {
237             if (!confirm_sesskey()) {
238                 print_error('invalidsesskey');
239             }
240             $files = $_FILES;
241         } else {
242             $submission = array();
243             $files = array();
244         }
246         $this->_form->updateSubmission($submission, $files);
247     }
249     /**
250      * Internal method. Validates all old-style deprecated uploaded files.
251      * The new way is to upload files via repository api.
252      *
253      * @global object
254      * @global object
255      * @param array $files
256      * @return bool|array Success or an array of errors
257      */
258     function _validate_files(&$files) {
259         global $CFG, $COURSE;
261         $files = array();
263         if (empty($_FILES)) {
264             // we do not need to do any checks because no files were submitted
265             // note: server side rules do not work for files - use custom verification in validate() instead
266             return true;
267         }
269         $errors = array();
270         $filenames = array();
272         // now check that we really want each file
273         foreach ($_FILES as $elname=>$file) {
274             $required = $this->_form->isElementRequired($elname);
276             if ($file['error'] == 4 and $file['size'] == 0) {
277                 if ($required) {
278                     $errors[$elname] = get_string('required');
279                 }
280                 unset($_FILES[$elname]);
281                 continue;
282             }
284             if (!empty($file['error'])) {
285                 $errors[$elname] = file_get_upload_error($file['error']);
286                 unset($_FILES[$elname]);
287                 continue;
288             }
290             if (!is_uploaded_file($file['tmp_name'])) {
291                 // TODO: improve error message
292                 $errors[$elname] = get_string('error');
293                 unset($_FILES[$elname]);
294                 continue;
295             }
297             if (!$this->_form->elementExists($elname) or !$this->_form->getElementType($elname)=='file') {
298                 // hmm, this file was not requested
299                 unset($_FILES[$elname]);
300                 continue;
301             }
303 /*
304   // TODO: rethink the file scanning MDL-19380
305             if ($CFG->runclamonupload) {
306                 if (!clam_scan_moodle_file($_FILES[$elname], $COURSE)) {
307                     $errors[$elname] = $_FILES[$elname]['uploadlog'];
308                     unset($_FILES[$elname]);
309                     continue;
310                 }
311             }
312 */
313             $filename = clean_param($_FILES[$elname]['name'], PARAM_FILE);
314             if ($filename === '') {
315                 // TODO: improve error message - wrong chars
316                 $errors[$elname] = get_string('error');
317                 unset($_FILES[$elname]);
318                 continue;
319             }
320             if (in_array($filename, $filenames)) {
321                 // TODO: improve error message - duplicate name
322                 $errors[$elname] = get_string('error');
323                 unset($_FILES[$elname]);
324                 continue;
325             }
326             $filenames[] = $filename;
327             $_FILES[$elname]['name'] = $filename;
329             $files[$elname] = $_FILES[$elname]['tmp_name'];
330         }
332         // return errors if found
333         if (count($errors) == 0){
334             return true;
336         } else {
337             $files = array();
338             return $errors;
339         }
340     }
342     /**
343      * Internal method. Validates filepicker and filemanager files if they are
344      * set as required fields. Also, sets the error message if encountered one.
345      *
346      * @return bool/array with errors
347      */
348     protected function validate_draft_files() {
349         global $USER;
350         $mform =& $this->_form;
352         $errors = array();
353         //Go through all the required elements and make sure you hit filepicker or
354         //filemanager element.
355         foreach ($mform->_rules as $elementname => $rules) {
356             $elementtype = $mform->getElementType($elementname);
357             //If element is of type filepicker then do validation
358             if (($elementtype == 'filepicker') || ($elementtype == 'filemanager')){
359                 //Check if rule defined is required rule
360                 foreach ($rules as $rule) {
361                     if ($rule['type'] == 'required') {
362                         $draftid = (int)$mform->getSubmitValue($elementname);
363                         $fs = get_file_storage();
364                         $context = get_context_instance(CONTEXT_USER, $USER->id);
365                         if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
366                             $errors[$elementname] = $rule['message'];
367                         }
368                     }
369                 }
370             }
371         }
372         if (empty($errors)) {
373             return true;
374         } else {
375             return $errors;
376         }
377     }
379     /**
380      * Load in existing data as form defaults. Usually new entry defaults are stored directly in
381      * form definition (new entry form); this function is used to load in data where values
382      * already exist and data is being edited (edit entry form).
383      *
384      * note: $slashed param removed
385      *
386      * @param mixed $default_values object or array of default values
387      */
388     function set_data($default_values) {
389         if (is_object($default_values)) {
390             $default_values = (array)$default_values;
391         }
392         $this->_form->setDefaults($default_values);
393     }
395     /**
396      * @deprecated
397      */
398     function set_upload_manager($um=false) {
399         debugging('Old file uploads can not be used any more, please use new filepicker element');
400     }
402     /**
403      * Check that form was submitted. Does not check validity of submitted data.
404      *
405      * @return bool true if form properly submitted
406      */
407     function is_submitted() {
408         return $this->_form->isSubmitted();
409     }
411     /**
412      * @staticvar bool $nosubmit
413      */
414     function no_submit_button_pressed(){
415         static $nosubmit = null; // one check is enough
416         if (!is_null($nosubmit)){
417             return $nosubmit;
418         }
419         $mform =& $this->_form;
420         $nosubmit = false;
421         if (!$this->is_submitted()){
422             return false;
423         }
424         foreach ($mform->_noSubmitButtons as $nosubmitbutton){
425             if (optional_param($nosubmitbutton, 0, PARAM_RAW)){
426                 $nosubmit = true;
427                 break;
428             }
429         }
430         return $nosubmit;
431     }
434     /**
435      * Check that form data is valid.
436      * You should almost always use this, rather than {@see validate_defined_fields}
437      *
438      * @staticvar bool $validated
439      * @return bool true if form data valid
440      */
441     function is_validated() {
442         //finalize the form definition before any processing
443         if (!$this->_definition_finalized) {
444             $this->_definition_finalized = true;
445             $this->definition_after_data();
446         }
448         return $this->validate_defined_fields();
449     }
451     /**
452      * Validate the form.
453      *
454      * You almost always want to call {@see is_validated} instead of this
455      * because it calls {@see definition_after_data} first, before validating the form,
456      * which is what you want in 99% of cases.
457      *
458      * This is provided as a separate function for those special cases where
459      * you want the form validated before definition_after_data is called
460      * for example, to selectively add new elements depending on a no_submit_button press,
461      * but only when the form is valid when the no_submit_button is pressed,
462      *
463      * @param boolean $validateonnosubmit optional, defaults to false.  The default behaviour
464      *                is NOT to validate the form when a no submit button has been pressed.
465      *                pass true here to override this behaviour
466      *
467      * @return bool true if form data valid
468      */
469     function validate_defined_fields($validateonnosubmit=false) {
470         static $validated = null; // one validation is enough
471         $mform =& $this->_form;
472         if ($this->no_submit_button_pressed() && empty($validateonnosubmit)){
473             return false;
474         } elseif ($validated === null) {
475             $internal_val = $mform->validate();
477             $files = array();
478             $file_val = $this->_validate_files($files);
479             //check draft files for validation and flag them if required files
480             //are not in draft area.
481             $draftfilevalue = $this->validate_draft_files();
483             if ($file_val !== true && $draftfilevalue !== true) {
484                 $file_val = array_merge($file_val, $draftfilevalue);
485             } else if ($draftfilevalue !== true) {
486                 $file_val = $draftfilevalue;
487             } //default is file_val, so no need to assign.
489             if ($file_val !== true) {
490                 if (!empty($file_val)) {
491                     foreach ($file_val as $element=>$msg) {
492                         $mform->setElementError($element, $msg);
493                     }
494                 }
495                 $file_val = false;
496             }
498             $data = $mform->exportValues();
499             $moodle_val = $this->validation($data, $files);
500             if ((is_array($moodle_val) && count($moodle_val)!==0)) {
501                 // non-empty array means errors
502                 foreach ($moodle_val as $element=>$msg) {
503                     $mform->setElementError($element, $msg);
504                 }
505                 $moodle_val = false;
507             } else {
508                 // anything else means validation ok
509                 $moodle_val = true;
510             }
512             $validated = ($internal_val and $moodle_val and $file_val);
513         }
514         return $validated;
515     }
517     /**
518      * Return true if a cancel button has been pressed resulting in the form being submitted.
519      *
520      * @return boolean true if a cancel button has been pressed
521      */
522     function is_cancelled(){
523         $mform =& $this->_form;
524         if ($mform->isSubmitted()){
525             foreach ($mform->_cancelButtons as $cancelbutton){
526                 if (optional_param($cancelbutton, 0, PARAM_RAW)){
527                     return true;
528                 }
529             }
530         }
531         return false;
532     }
534     /**
535      * Return submitted data if properly submitted or returns NULL if validation fails or
536      * if there is no submitted data.
537      *
538      * note: $slashed param removed
539      *
540      * @return object submitted data; NULL if not valid or not submitted or cancelled
541      */
542     function get_data() {
543         $mform =& $this->_form;
545         if (!$this->is_cancelled() and $this->is_submitted() and $this->is_validated()) {
546             $data = $mform->exportValues();
547             unset($data['sesskey']); // we do not need to return sesskey
548             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
549             if (empty($data)) {
550                 return NULL;
551             } else {
552                 return (object)$data;
553             }
554         } else {
555             return NULL;
556         }
557     }
559     /**
560      * Return submitted data without validation or NULL if there is no submitted data.
561      * note: $slashed param removed
562      *
563      * @return object submitted data; NULL if not submitted
564      */
565     function get_submitted_data() {
566         $mform =& $this->_form;
568         if ($this->is_submitted()) {
569             $data = $mform->exportValues();
570             unset($data['sesskey']); // we do not need to return sesskey
571             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
572             if (empty($data)) {
573                 return NULL;
574             } else {
575                 return (object)$data;
576             }
577         } else {
578             return NULL;
579         }
580     }
582     /**
583      * Save verified uploaded files into directory. Upload process can be customised from definition()
584      * NOTE: please use save_stored_file() or save_file()
585      *
586      * @return bool Always false
587      */
588     function save_files($destination) {
589         debugging('Not used anymore, please fix code! Use save_stored_file() or save_file() instead');
590         return false;
591     }
593     /**
594      * Returns name of uploaded file.
595      *
596      * @global object
597      * @param string $elname, first element if null
598      * @return mixed false in case of failure, string if ok
599      */
600     function get_new_filename($elname=null) {
601         global $USER;
603         if (!$this->is_submitted() or !$this->is_validated()) {
604             return false;
605         }
607         if (is_null($elname)) {
608             if (empty($_FILES)) {
609                 return false;
610             }
611             reset($_FILES);
612             $elname = key($_FILES);
613         }
615         if (empty($elname)) {
616             return false;
617         }
619         $element = $this->_form->getElement($elname);
621         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
622             $values = $this->_form->exportValues($elname);
623             if (empty($values[$elname])) {
624                 return false;
625             }
626             $draftid = $values[$elname];
627             $fs = get_file_storage();
628             $context = get_context_instance(CONTEXT_USER, $USER->id);
629             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
630                 return false;
631             }
632             $file = reset($files);
633             return $file->get_filename();
634         }
636         if (!isset($_FILES[$elname])) {
637             return false;
638         }
640         return $_FILES[$elname]['name'];
641     }
643     /**
644      * Save file to standard filesystem
645      *
646      * @global object
647      * @param string $elname name of element
648      * @param string $pathname full path name of file
649      * @param bool $override override file if exists
650      * @return bool success
651      */
652     function save_file($elname, $pathname, $override=false) {
653         global $USER;
655         if (!$this->is_submitted() or !$this->is_validated()) {
656             return false;
657         }
658         if (file_exists($pathname)) {
659             if ($override) {
660                 if (!@unlink($pathname)) {
661                     return false;
662                 }
663             } else {
664                 return false;
665             }
666         }
668         $element = $this->_form->getElement($elname);
670         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
671             $values = $this->_form->exportValues($elname);
672             if (empty($values[$elname])) {
673                 return false;
674             }
675             $draftid = $values[$elname];
676             $fs = get_file_storage();
677             $context = get_context_instance(CONTEXT_USER, $USER->id);
678             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
679                 return false;
680             }
681             $file = reset($files);
683             return $file->copy_content_to($pathname);
685         } else if (isset($_FILES[$elname])) {
686             return copy($_FILES[$elname]['tmp_name'], $pathname);
687         }
689         return false;
690     }
692     /**
693      * Returns a temporary file, do not forget to delete after not needed any more.
694      *
695      * @param string $elname
696      * @return string or false
697      */
698     function save_temp_file($elname) {
699         if (!$this->get_new_filename($elname)) {
700             return false;
701         }
702         if (!$dir = make_temp_directory('forms')) {
703             return false;
704         }
705         if (!$tempfile = tempnam($dir, 'tempup_')) {
706             return false;
707         }
708         if (!$this->save_file($elname, $tempfile, true)) {
709             // something went wrong
710             @unlink($tempfile);
711             return false;
712         }
714         return $tempfile;
715     }
717     /**
718      * Get draft files of a form element
719      * This is a protected method which will be used only inside moodleforms
720      *
721      * @global object $USER
722      * @param string $elname name of element
723      * @return array
724      */
725     protected function get_draft_files($elname) {
726         global $USER;
728         if (!$this->is_submitted()) {
729             return false;
730         }
732         $element = $this->_form->getElement($elname);
734         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
735             $values = $this->_form->exportValues($elname);
736             if (empty($values[$elname])) {
737                 return false;
738             }
739             $draftid = $values[$elname];
740             $fs = get_file_storage();
741             $context = get_context_instance(CONTEXT_USER, $USER->id);
742             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
743                 return null;
744             }
745             return $files;
746         }
747         return null;
748     }
750     /**
751      * Save file to local filesystem pool
752      *
753      * @global object
754      * @param string $elname name of element
755      * @param int $newcontextid
756      * @param string $newfilearea
757      * @param string $newfilepath
758      * @param string $newfilename - use specified filename, if not specified name of uploaded file used
759      * @param bool $overwrite  - overwrite file if exists
760      * @param int $newuserid - new userid if required
761      * @return mixed stored_file object or false if error; may throw exception if duplicate found
762      */
763     function save_stored_file($elname, $newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath='/',
764                               $newfilename=null, $overwrite=false, $newuserid=null) {
765         global $USER;
767         if (!$this->is_submitted() or !$this->is_validated()) {
768             return false;
769         }
771         if (empty($newuserid)) {
772             $newuserid = $USER->id;
773         }
775         $element = $this->_form->getElement($elname);
776         $fs = get_file_storage();
778         if ($element instanceof MoodleQuickForm_filepicker) {
779             $values = $this->_form->exportValues($elname);
780             if (empty($values[$elname])) {
781                 return false;
782             }
783             $draftid = $values[$elname];
784             $context = get_context_instance(CONTEXT_USER, $USER->id);
785             if (!$files = $fs->get_area_files($context->id, 'user' ,'draft', $draftid, 'id DESC', false)) {
786                 return false;
787             }
788             $file = reset($files);
789             if (is_null($newfilename)) {
790                 $newfilename = $file->get_filename();
791             }
793             if ($overwrite) {
794                 if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
795                     if (!$oldfile->delete()) {
796                         return false;
797                     }
798                 }
799             }
801             $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
802                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
803             return $fs->create_file_from_storedfile($file_record, $file);
805         } else if (isset($_FILES[$elname])) {
806             $filename = is_null($newfilename) ? $_FILES[$elname]['name'] : $newfilename;
808             if ($overwrite) {
809                 if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
810                     if (!$oldfile->delete()) {
811                         return false;
812                     }
813                 }
814             }
816             $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
817                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
818             return $fs->create_file_from_pathname($file_record, $_FILES[$elname]['tmp_name']);
819         }
821         return false;
822     }
824     /**
825      * Get content of uploaded file.
826      *
827      * @global object
828      * @param $element name of file upload element
829      * @return mixed false in case of failure, string if ok
830      */
831     function get_file_content($elname) {
832         global $USER;
834         if (!$this->is_submitted() or !$this->is_validated()) {
835             return false;
836         }
838         $element = $this->_form->getElement($elname);
840         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
841             $values = $this->_form->exportValues($elname);
842             if (empty($values[$elname])) {
843                 return false;
844             }
845             $draftid = $values[$elname];
846             $fs = get_file_storage();
847             $context = get_context_instance(CONTEXT_USER, $USER->id);
848             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
849                 return false;
850             }
851             $file = reset($files);
853             return $file->get_content();
855         } else if (isset($_FILES[$elname])) {
856             return file_get_contents($_FILES[$elname]['tmp_name']);
857         }
859         return false;
860     }
862     /**
863      * Print html form.
864      */
865     function display() {
866         //finalize the form definition if not yet done
867         if (!$this->_definition_finalized) {
868             $this->_definition_finalized = true;
869             $this->definition_after_data();
870         }
871         $this->_form->display();
872     }
874     /**
875      * Abstract method - always override!
876      */
877     protected abstract function definition();
879     /**
880      * Dummy stub method - override if you need to setup the form depending on current
881      * values. This method is called after definition(), data submission and set_data().
882      * All form setup that is dependent on form values should go in here.
883      */
884     function definition_after_data(){
885     }
887     /**
888      * Dummy stub method - override if you needed to perform some extra validation.
889      * If there are errors return array of errors ("fieldname"=>"error message"),
890      * otherwise true if ok.
891      *
892      * Server side rules do not work for uploaded files, implement serverside rules here if needed.
893      *
894      * @param array $data array of ("fieldname"=>value) of submitted data
895      * @param array $files array of uploaded files "element_name"=>tmp_file_path
896      * @return array of "element_name"=>"error_description" if there are errors,
897      *               or an empty array if everything is OK (true allowed for backwards compatibility too).
898      */
899     function validation($data, $files) {
900         return array();
901     }
903     /**
904      * Helper used by {@link repeat_elements()}.
905      * @param int $i the index of this element.
906      * @param HTML_QuickForm_element $elementclone
907      */
908     function repeat_elements_fix_clone($i, $elementclone, &$namecloned) {
909         $name = $elementclone->getName();
910         $namecloned[] = $name;
912         if (!empty($name)) {
913             $elementclone->setName($name."[$i]");
914         }
916         if (is_a($elementclone, 'HTML_QuickForm_header')) {
917             $value = $elementclone->_text;
918             $elementclone->setValue(str_replace('{no}', ($i+1), $value));
920         } else {
921             $value=$elementclone->getLabel();
922             $elementclone->setLabel(str_replace('{no}', ($i+1), $value));
923         }
924     }
926     /**
927      * Method to add a repeating group of elements to a form.
928      *
929      * @param array $elementobjs Array of elements or groups of elements that are to be repeated
930      * @param integer $repeats no of times to repeat elements initially
931      * @param array $options Array of options to apply to elements. Array keys are element names.
932      *                      This is an array of arrays. The second sets of keys are the option types
933      *                      for the elements :
934      *                          'default' - default value is value
935      *                          'type' - PARAM_* constant is value
936      *                          'helpbutton' - helpbutton params array is value
937      *                          'disabledif' - last three moodleform::disabledIf()
938      *                                           params are value as an array
939      * @param string $repeathiddenname name for hidden element storing no of repeats in this form
940      * @param string $addfieldsname name for button to add more fields
941      * @param int $addfieldsno how many fields to add at a time
942      * @param string $addstring name of button, {no} is replaced by no of blanks that will be added.
943      * @param boolean $addbuttoninside if true, don't call closeHeaderBefore($addfieldsname). Default false.
944      * @return int no of repeats of element in this page
945      */
946     function repeat_elements($elementobjs, $repeats, $options, $repeathiddenname,
947             $addfieldsname, $addfieldsno=5, $addstring=null, $addbuttoninside=false){
948         if ($addstring===null){
949             $addstring = get_string('addfields', 'form', $addfieldsno);
950         } else {
951             $addstring = str_ireplace('{no}', $addfieldsno, $addstring);
952         }
953         $repeats = optional_param($repeathiddenname, $repeats, PARAM_INT);
954         $addfields = optional_param($addfieldsname, '', PARAM_TEXT);
955         if (!empty($addfields)){
956             $repeats += $addfieldsno;
957         }
958         $mform =& $this->_form;
959         $mform->registerNoSubmitButton($addfieldsname);
960         $mform->addElement('hidden', $repeathiddenname, $repeats);
961         $mform->setType($repeathiddenname, PARAM_INT);
962         //value not to be overridden by submitted value
963         $mform->setConstants(array($repeathiddenname=>$repeats));
964         $namecloned = array();
965         for ($i = 0; $i < $repeats; $i++) {
966             foreach ($elementobjs as $elementobj){
967                 $elementclone = fullclone($elementobj);
968                 $this->repeat_elements_fix_clone($i, $elementclone, $namecloned);
970                 if ($elementclone instanceof HTML_QuickForm_group && !$elementclone->_appendName) {
971                     foreach ($elementclone->getElements() as $el) {
972                         $this->repeat_elements_fix_clone($i, $el, $namecloned);
973                     }
974                     $elementclone->setLabel(str_replace('{no}', $i + 1, $elementclone->getLabel()));
975                 }
977                 $mform->addElement($elementclone);
978             }
979         }
980         for ($i=0; $i<$repeats; $i++) {
981             foreach ($options as $elementname => $elementoptions){
982                 $pos=strpos($elementname, '[');
983                 if ($pos!==FALSE){
984                     $realelementname = substr($elementname, 0, $pos+1)."[$i]";
985                     $realelementname .= substr($elementname, $pos+1);
986                 }else {
987                     $realelementname = $elementname."[$i]";
988                 }
989                 foreach ($elementoptions as  $option => $params){
991                     switch ($option){
992                         case 'default' :
993                             $mform->setDefault($realelementname, $params);
994                             break;
995                         case 'helpbutton' :
996                             $params = array_merge(array($realelementname), $params);
997                             call_user_func_array(array(&$mform, 'addHelpButton'), $params);
998                             break;
999                         case 'disabledif' :
1000                             foreach ($namecloned as $num => $name){
1001                                 if ($params[0] == $name){
1002                                     $params[0] = $params[0]."[$i]";
1003                                     break;
1004                                 }
1005                             }
1006                             $params = array_merge(array($realelementname), $params);
1007                             call_user_func_array(array(&$mform, 'disabledIf'), $params);
1008                             break;
1009                         case 'rule' :
1010                             if (is_string($params)){
1011                                 $params = array(null, $params, null, 'client');
1012                             }
1013                             $params = array_merge(array($realelementname), $params);
1014                             call_user_func_array(array(&$mform, 'addRule'), $params);
1015                             break;
1017                     }
1018                 }
1019             }
1020         }
1021         $mform->addElement('submit', $addfieldsname, $addstring);
1023         if (!$addbuttoninside) {
1024             $mform->closeHeaderBefore($addfieldsname);
1025         }
1027         return $repeats;
1028     }
1030     /**
1031      * Adds a link/button that controls the checked state of a group of checkboxes.
1032      *
1033      * @global object
1034      * @param int    $groupid The id of the group of advcheckboxes this element controls
1035      * @param string $text The text of the link. Defaults to selectallornone ("select all/none")
1036      * @param array  $attributes associative array of HTML attributes
1037      * @param int    $originalValue The original general state of the checkboxes before the user first clicks this element
1038      */
1039     function add_checkbox_controller($groupid, $text = null, $attributes = null, $originalValue = 0) {
1040         global $CFG;
1042         // Set the default text if none was specified
1043         if (empty($text)) {
1044             $text = get_string('selectallornone', 'form');
1045         }
1047         $mform = $this->_form;
1048         $select_value = optional_param('checkbox_controller'. $groupid, null, PARAM_INT);
1050         if ($select_value == 0 || is_null($select_value)) {
1051             $new_select_value = 1;
1052         } else {
1053             $new_select_value = 0;
1054         }
1056         $mform->addElement('hidden', "checkbox_controller$groupid");
1057         $mform->setType("checkbox_controller$groupid", PARAM_INT);
1058         $mform->setConstants(array("checkbox_controller$groupid" => $new_select_value));
1060         $checkbox_controller_name = 'nosubmit_checkbox_controller' . $groupid;
1061         $mform->registerNoSubmitButton($checkbox_controller_name);
1063         // Prepare Javascript for submit element
1064         $js = "\n//<![CDATA[\n";
1065         if (!defined('HTML_QUICKFORM_CHECKBOXCONTROLLER_EXISTS')) {
1066             $js .= <<<EOS
1067 function html_quickform_toggle_checkboxes(group) {
1068     var checkboxes = document.getElementsByClassName('checkboxgroup' + group);
1069     var newvalue = false;
1070     var global = eval('html_quickform_checkboxgroup' + group + ';');
1071     if (global == 1) {
1072         eval('html_quickform_checkboxgroup' + group + ' = 0;');
1073         newvalue = '';
1074     } else {
1075         eval('html_quickform_checkboxgroup' + group + ' = 1;');
1076         newvalue = 'checked';
1077     }
1079     for (i = 0; i < checkboxes.length; i++) {
1080         checkboxes[i].checked = newvalue;
1081     }
1083 EOS;
1084             define('HTML_QUICKFORM_CHECKBOXCONTROLLER_EXISTS', true);
1085         }
1086         $js .= "\nvar html_quickform_checkboxgroup$groupid=$originalValue;\n";
1088         $js .= "//]]>\n";
1090         require_once("$CFG->libdir/form/submitlink.php");
1091         $submitlink = new MoodleQuickForm_submitlink($checkbox_controller_name, $attributes);
1092         $submitlink->_js = $js;
1093         $submitlink->_onclick = "html_quickform_toggle_checkboxes($groupid); return false;";
1094         $mform->addElement($submitlink);
1095         $mform->setDefault($checkbox_controller_name, $text);
1096     }
1098     /**
1099      * Use this method to a cancel and submit button to the end of your form. Pass a param of false
1100      * if you don't want a cancel button in your form. If you have a cancel button make sure you
1101      * check for it being pressed using is_cancelled() and redirecting if it is true before trying to
1102      * get data with get_data().
1103      *
1104      * @param boolean $cancel whether to show cancel button, default true
1105      * @param string $submitlabel label for submit button, defaults to get_string('savechanges')
1106      */
1107     function add_action_buttons($cancel = true, $submitlabel=null){
1108         if (is_null($submitlabel)){
1109             $submitlabel = get_string('savechanges');
1110         }
1111         $mform =& $this->_form;
1112         if ($cancel){
1113             //when two elements we need a group
1114             $buttonarray=array();
1115             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
1116             $buttonarray[] = &$mform->createElement('cancel');
1117             $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
1118             $mform->closeHeaderBefore('buttonar');
1119         } else {
1120             //no group needed
1121             $mform->addElement('submit', 'submitbutton', $submitlabel);
1122             $mform->closeHeaderBefore('submitbutton');
1123         }
1124     }
1126     /**
1127      * Adds an initialisation call for a standard JavaScript enhancement.
1128      *
1129      * This function is designed to add an initialisation call for a JavaScript
1130      * enhancement that should exist within javascript-static M.form.init_{enhancementname}.
1131      *
1132      * Current options:
1133      *  - Selectboxes
1134      *      - smartselect:  Turns a nbsp indented select box into a custom drop down
1135      *                      control that supports multilevel and category selection.
1136      *                      $enhancement = 'smartselect';
1137      *                      $options = array('selectablecategories' => true|false)
1138      *
1139      * @since 2.0
1140      * @param string|element $element
1141      * @param string $enhancement
1142      * @param array $options
1143      * @param array $strings
1144      */
1145     function init_javascript_enhancement($element, $enhancement, array $options=array(), array $strings=null) {
1146         global $PAGE;
1147         if (is_string($element)) {
1148             $element = $this->_form->getElement($element);
1149         }
1150         if (is_object($element)) {
1151             $element->_generateId();
1152             $elementid = $element->getAttribute('id');
1153             $PAGE->requires->js_init_call('M.form.init_'.$enhancement, array($elementid, $options));
1154             if (is_array($strings)) {
1155                 foreach ($strings as $string) {
1156                     if (is_array($string)) {
1157                         call_user_method_array('string_for_js', $PAGE->requires, $string);
1158                     } else {
1159                         $PAGE->requires->string_for_js($string, 'moodle');
1160                     }
1161                 }
1162             }
1163         }
1164     }
1166     /**
1167      * Returns a JS module definition for the mforms JS
1168      * @return array
1169      */
1170     public static function get_js_module() {
1171         global $CFG;
1172         return array(
1173             'name' => 'mform',
1174             'fullpath' => '/lib/form/form.js',
1175             'requires' => array('base', 'node'),
1176             'strings' => array(
1177                 array('showadvanced', 'form'),
1178                 array('hideadvanced', 'form')
1179             )
1180         );
1181     }
1184 /**
1185  * You never extend this class directly. The class methods of this class are available from
1186  * the private $this->_form property on moodleform and its children. You generally only
1187  * call methods on this class from within abstract methods that you override on moodleform such
1188  * as definition and definition_after_data
1189  *
1190  * @package   moodlecore
1191  * @copyright Jamie Pratt <me@jamiep.org>
1192  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1193  */
1194 class MoodleQuickForm extends HTML_QuickForm_DHTMLRulesTableless {
1195     /** @var array */
1196     var $_types = array();
1197     var $_dependencies = array();
1198     /**
1199      * Array of buttons that if pressed do not result in the processing of the form.
1200      *
1201      * @var array
1202      */
1203     var $_noSubmitButtons=array();
1204     /**
1205      * Array of buttons that if pressed do not result in the processing of the form.
1206      *
1207      * @var array
1208      */
1209     var $_cancelButtons=array();
1211     /**
1212      * Array whose keys are element names. If the key exists this is a advanced element
1213      *
1214      * @var array
1215      */
1216     var $_advancedElements = array();
1218     /**
1219      * Whether to display advanced elements (on page load)
1220      *
1221      * @var boolean
1222      */
1223     var $_showAdvanced = null;
1225     /**
1226      * The form name is derived from the class name of the wrapper minus the trailing form
1227      * It is a name with words joined by underscores whereas the id attribute is words joined by
1228      * underscores.
1229      *
1230      * @var unknown_type
1231      */
1232     var $_formName = '';
1234     /**
1235      * String with the html for hidden params passed in as part of a moodle_url object for the action. Output in the form.
1236      *
1237      * @var string
1238      */
1239     var $_pageparams = '';
1241     /**
1242      * Class constructor - same parameters as HTML_QuickForm_DHTMLRulesTableless
1243      *
1244      * @global object
1245      * @staticvar int $formcounter
1246      * @param    string      $formName          Form's name.
1247      * @param    string      $method            (optional)Form's method defaults to 'POST'
1248      * @param    mixed      $action             (optional)Form's action - string or moodle_url
1249      * @param    string      $target            (optional)Form's target defaults to none
1250      * @param    mixed       $attributes        (optional)Extra attributes for <form> tag
1251      * @access   public
1252      */
1253     function MoodleQuickForm($formName, $method, $action, $target='', $attributes=null){
1254         global $CFG, $OUTPUT;
1256         static $formcounter = 1;
1258         HTML_Common::HTML_Common($attributes);
1259         $target = empty($target) ? array() : array('target' => $target);
1260         $this->_formName = $formName;
1261         if (is_a($action, 'moodle_url')){
1262             $this->_pageparams = html_writer::input_hidden_params($action);
1263             $action = $action->out_omit_querystring();
1264         } else {
1265             $this->_pageparams = '';
1266         }
1267         //no 'name' atttribute for form in xhtml strict :
1268         $attributes = array('action'=>$action, 'method'=>$method,
1269                 'accept-charset'=>'utf-8', 'id'=>'mform'.$formcounter) + $target;
1270         $formcounter++;
1271         $this->updateAttributes($attributes);
1273         //this is custom stuff for Moodle :
1274         $oldclass=   $this->getAttribute('class');
1275         if (!empty($oldclass)){
1276             $this->updateAttributes(array('class'=>$oldclass.' mform'));
1277         }else {
1278             $this->updateAttributes(array('class'=>'mform'));
1279         }
1280         $this->_reqHTML = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />';
1281         $this->_advancedHTML = '<img class="adv" title="'.get_string('advancedelement', 'form').'" alt="'.get_string('advancedelement', 'form').'" src="'.$OUTPUT->pix_url('adv') .'" />';
1282         $this->setRequiredNote(get_string('somefieldsrequired', 'form', '<img alt="'.get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />'));
1283     }
1285     /**
1286      * Use this method to indicate an element in a form is an advanced field. If items in a form
1287      * are marked as advanced then 'Hide/Show Advanced' buttons will automatically be displayed in the
1288      * form so the user can decide whether to display advanced form controls.
1289      *
1290      * If you set a header element to advanced then all elements it contains will also be set as advanced.
1291      *
1292      * @param string $elementName group or element name (not the element name of something inside a group).
1293      * @param boolean $advanced default true sets the element to advanced. False removes advanced mark.
1294      */
1295     function setAdvanced($elementName, $advanced=true){
1296         if ($advanced){
1297             $this->_advancedElements[$elementName]='';
1298         } elseif (isset($this->_advancedElements[$elementName])) {
1299             unset($this->_advancedElements[$elementName]);
1300         }
1301         if ($advanced && $this->getElementType('mform_showadvanced_last')===false){
1302             $this->setShowAdvanced();
1303             $this->registerNoSubmitButton('mform_showadvanced');
1305             $this->addElement('hidden', 'mform_showadvanced_last');
1306             $this->setType('mform_showadvanced_last', PARAM_INT);
1307         }
1308     }
1309     /**
1310      * Set whether to show advanced elements in the form on first displaying form. Default is not to
1311      * display advanced elements in the form until 'Show Advanced' is pressed.
1312      *
1313      * You can get the last state of the form and possibly save it for this user by using
1314      * value 'mform_showadvanced_last' in submitted data.
1315      *
1316      * @param boolean $showadvancedNow
1317      */
1318     function setShowAdvanced($showadvancedNow = null){
1319         if ($showadvancedNow === null){
1320             if ($this->_showAdvanced !== null){
1321                 return;
1322             } else { //if setShowAdvanced is called without any preference
1323                      //make the default to not show advanced elements.
1324                 $showadvancedNow = get_user_preferences(
1325                                 moodle_strtolower($this->_formName.'_showadvanced', 0));
1326             }
1327         }
1328         //value of hidden element
1329         $hiddenLast = optional_param('mform_showadvanced_last', -1, PARAM_INT);
1330         //value of button
1331         $buttonPressed = optional_param('mform_showadvanced', 0, PARAM_RAW);
1332         //toggle if button pressed or else stay the same
1333         if ($hiddenLast == -1) {
1334             $next = $showadvancedNow;
1335         } elseif ($buttonPressed) { //toggle on button press
1336             $next = !$hiddenLast;
1337         } else {
1338             $next = $hiddenLast;
1339         }
1340         $this->_showAdvanced = $next;
1341         if ($showadvancedNow != $next){
1342             set_user_preference($this->_formName.'_showadvanced', $next);
1343         }
1344         $this->setConstants(array('mform_showadvanced_last'=>$next));
1345     }
1346     function getShowAdvanced(){
1347         return $this->_showAdvanced;
1348     }
1351    /**
1352     * Accepts a renderer
1353     *
1354     * @param object $renderer HTML_QuickForm_Renderer  An HTML_QuickForm_Renderer object
1355     * @access public
1356     * @return void
1357     */
1358     function accept(&$renderer) {
1359         if (method_exists($renderer, 'setAdvancedElements')){
1360             //check for visible fieldsets where all elements are advanced
1361             //and mark these headers as advanced as well.
1362             //And mark all elements in a advanced header as advanced
1363             $stopFields = $renderer->getStopFieldSetElements();
1364             $lastHeader = null;
1365             $lastHeaderAdvanced = false;
1366             $anyAdvanced = false;
1367             foreach (array_keys($this->_elements) as $elementIndex){
1368                 $element =& $this->_elements[$elementIndex];
1370                 // if closing header and any contained element was advanced then mark it as advanced
1371                 if ($element->getType()=='header' || in_array($element->getName(), $stopFields)){
1372                     if ($anyAdvanced && !is_null($lastHeader)){
1373                         $this->setAdvanced($lastHeader->getName());
1374                     }
1375                     $lastHeaderAdvanced = false;
1376                     unset($lastHeader);
1377                     $lastHeader = null;
1378                 } elseif ($lastHeaderAdvanced) {
1379                     $this->setAdvanced($element->getName());
1380                 }
1382                 if ($element->getType()=='header'){
1383                     $lastHeader =& $element;
1384                     $anyAdvanced = false;
1385                     $lastHeaderAdvanced = isset($this->_advancedElements[$element->getName()]);
1386                 } elseif (isset($this->_advancedElements[$element->getName()])){
1387                     $anyAdvanced = true;
1388                 }
1389             }
1390             // the last header may not be closed yet...
1391             if ($anyAdvanced && !is_null($lastHeader)){
1392                 $this->setAdvanced($lastHeader->getName());
1393             }
1394             $renderer->setAdvancedElements($this->_advancedElements);
1396         }
1397         parent::accept($renderer);
1398     }
1400     /**
1401      * @param string $elementName
1402      */
1403     function closeHeaderBefore($elementName){
1404         $renderer =& $this->defaultRenderer();
1405         $renderer->addStopFieldsetElements($elementName);
1406     }
1408     /**
1409      * Should be used for all elements of a form except for select, radio and checkboxes which
1410      * clean their own data.
1411      *
1412      * @param string $elementname
1413      * @param integer $paramtype use the constants PARAM_*.
1414      *     *  PARAM_CLEAN is deprecated and you should try to use a more specific type.
1415      *     *  PARAM_TEXT should be used for cleaning data that is expected to be plain text.
1416      *          It will strip all html tags. But will still let tags for multilang support
1417      *          through.
1418      *     *  PARAM_RAW means no cleaning whatsoever, it is used mostly for data from the
1419      *          html editor. Data from the editor is later cleaned before display using
1420      *          format_text() function. PARAM_RAW can also be used for data that is validated
1421      *          by some other way or printed by p() or s().
1422      *     *  PARAM_INT should be used for integers.
1423      *     *  PARAM_ACTION is an alias of PARAM_ALPHA and is used for hidden fields specifying
1424      *          form actions.
1425      */
1426     function setType($elementname, $paramtype) {
1427         $this->_types[$elementname] = $paramtype;
1428     }
1430     /**
1431      * See description of setType above. This can be used to set several types at once.
1432      *
1433      * @param array $paramtypes
1434      */
1435     function setTypes($paramtypes) {
1436         $this->_types = $paramtypes + $this->_types;
1437     }
1439     /**
1440      * @param array $submission
1441      * @param array $files
1442      */
1443     function updateSubmission($submission, $files) {
1444         $this->_flagSubmitted = false;
1446         if (empty($submission)) {
1447             $this->_submitValues = array();
1448         } else {
1449             foreach ($submission as $key=>$s) {
1450                 if (array_key_exists($key, $this->_types)) {
1451                     $type = $this->_types[$key];
1452                 } else {
1453                     $type = PARAM_RAW;
1454                 }
1455                 if (is_array($s)) {
1456                     $submission[$key] = clean_param_array($s, $type, true);
1457                 } else {
1458                     $submission[$key] = clean_param($s, $type);
1459                 }
1460             }
1461             $this->_submitValues = $submission;
1462             $this->_flagSubmitted = true;
1463         }
1465         if (empty($files)) {
1466             $this->_submitFiles = array();
1467         } else {
1468             $this->_submitFiles = $files;
1469             $this->_flagSubmitted = true;
1470         }
1472         // need to tell all elements that they need to update their value attribute.
1473          foreach (array_keys($this->_elements) as $key) {
1474              $this->_elements[$key]->onQuickFormEvent('updateValue', null, $this);
1475          }
1476     }
1478     /**
1479      * @return string
1480      */
1481     function getReqHTML(){
1482         return $this->_reqHTML;
1483     }
1485     /**
1486      * @return string
1487      */
1488     function getAdvancedHTML(){
1489         return $this->_advancedHTML;
1490     }
1492     /**
1493      * Initializes a default form value. Used to specify the default for a new entry where
1494      * no data is loaded in using moodleform::set_data()
1495      *
1496      * note: $slashed param removed
1497      *
1498      * @param     string   $elementname        element name
1499      * @param     mixed    $values             values for that element name
1500      * @access    public
1501      * @return    void
1502      */
1503     function setDefault($elementName, $defaultValue){
1504         $this->setDefaults(array($elementName=>$defaultValue));
1505     } // end func setDefault
1506     /**
1507      * Add an array of buttons to the form
1508      * @param    array       $buttons          An associative array representing help button to attach to
1509      *                                          to the form. keys of array correspond to names of elements in form.
1510      * @deprecated since Moodle 2.0 - use addHelpButton() call on each element manually
1511      * @param bool $suppresscheck
1512      * @param string $function
1513      * @access   public
1514     */
1515     function setHelpButtons($buttons, $suppresscheck=false, $function='helpbutton'){
1517         debugging('function moodle_form::setHelpButtons() is deprecated');
1518         //foreach ($buttons as $elementname => $button){
1519         //    $this->setHelpButton($elementname, $button, $suppresscheck, $function);
1520         //}
1521     }
1522     /**
1523      * Add a single button.
1524      *
1525      * @deprecated use addHelpButton() instead
1526      * @param string $elementname name of the element to add the item to
1527      * @param array $button arguments to pass to function $function
1528      * @param boolean $suppresscheck whether to throw an error if the element
1529      *                                  doesn't exist.
1530      * @param string $function - function to generate html from the arguments in $button
1531      * @param string $function
1532      */
1533     function setHelpButton($elementname, $buttonargs, $suppresscheck=false, $function='helpbutton'){
1534         global $OUTPUT;
1536         debugging('function moodle_form::setHelpButton() is deprecated');
1537         if ($function !== 'helpbutton') {
1538             //debugging('parameter $function in moodle_form::setHelpButton() is not supported any more');
1539         }
1541         $buttonargs = (array)$buttonargs;
1543         if (array_key_exists($elementname, $this->_elementIndex)) {
1544             //_elements has a numeric index, this code accesses the elements by name
1545             $element = $this->_elements[$this->_elementIndex[$elementname]];
1547             $page     = isset($buttonargs[0]) ? $buttonargs[0] : null;
1548             $text     = isset($buttonargs[1]) ? $buttonargs[1] : null;
1549             $module   = isset($buttonargs[2]) ? $buttonargs[2] : 'moodle';
1550             $linktext = isset($buttonargs[3]) ? $buttonargs[3] : false;
1552             $element->_helpbutton = $OUTPUT->old_help_icon($page, $text, $module, $linktext);
1554         } else if (!$suppresscheck) {
1555             print_error('nonexistentformelements', 'form', '', $elementname);
1556         }
1557     }
1559     /**
1560      * Add a help button to element, only one button per element is allowed.
1561      *
1562      * This is new, simplified and preferable method of setting a help icon on form elements.
1563      * It uses the new $OUTPUT->help_icon().
1564      *
1565      * Typically, you will provide the same identifier and the component as you have used for the
1566      * label of the element. The string identifier with the _help suffix added is then used
1567      * as the help string.
1568      *
1569      * There has to be two strings defined:
1570      *   1/ get_string($identifier, $component) - the title of the help page
1571      *   2/ get_string($identifier.'_help', $component) - the actual help page text
1572      *
1573      * @since 2.0
1574      * @param string $elementname name of the element to add the item to
1575      * @param string $identifier help string identifier without _help suffix
1576      * @param string $component component name to look the help string in
1577      * @param string $linktext optional text to display next to the icon
1578      * @param boolean $suppresscheck set to true if the element may not exist
1579      * @return void
1580      */
1581     function addHelpButton($elementname, $identifier, $component = 'moodle', $linktext = '', $suppresscheck = false) {
1582         global $OUTPUT;
1583         if (array_key_exists($elementname, $this->_elementIndex)) {
1584             $element = $this->_elements[$this->_elementIndex[$elementname]];
1585             $element->_helpbutton = $OUTPUT->help_icon($identifier, $component, $linktext);
1586         } else if (!$suppresscheck) {
1587             debugging(get_string('nonexistentformelements', 'form', $elementname));
1588         }
1589     }
1591     /**
1592      * Set constant value not overridden by _POST or _GET
1593      * note: this does not work for complex names with [] :-(
1594      *
1595      * @param string $elname name of element
1596      * @param mixed $value
1597      * @return void
1598      */
1599     function setConstant($elname, $value) {
1600         $this->_constantValues = HTML_QuickForm::arrayMerge($this->_constantValues, array($elname=>$value));
1601         $element =& $this->getElement($elname);
1602         $element->onQuickFormEvent('updateValue', null, $this);
1603     }
1605     /**
1606      * @param string $elementList
1607      */
1608     function exportValues($elementList = null){
1609         $unfiltered = array();
1610         if (null === $elementList) {
1611             // iterate over all elements, calling their exportValue() methods
1612             $emptyarray = array();
1613             foreach (array_keys($this->_elements) as $key) {
1614                 if ($this->_elements[$key]->isFrozen() && !$this->_elements[$key]->_persistantFreeze){
1615                     $value = $this->_elements[$key]->exportValue($emptyarray, true);
1616                 } else {
1617                     $value = $this->_elements[$key]->exportValue($this->_submitValues, true);
1618                 }
1620                 if (is_array($value)) {
1621                     // This shit throws a bogus warning in PHP 4.3.x
1622                     $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
1623                 }
1624             }
1625         } else {
1626             if (!is_array($elementList)) {
1627                 $elementList = array_map('trim', explode(',', $elementList));
1628             }
1629             foreach ($elementList as $elementName) {
1630                 $value = $this->exportValue($elementName);
1631                 if (PEAR::isError($value)) {
1632                     return $value;
1633                 }
1634                 //oh, stock QuickFOrm was returning array of arrays!
1635                 $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
1636             }
1637         }
1639         if (is_array($this->_constantValues)) {
1640             $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $this->_constantValues);
1641         }
1643         return $unfiltered;
1644     }
1645     /**
1646      * Adds a validation rule for the given field
1647      *
1648      * If the element is in fact a group, it will be considered as a whole.
1649      * To validate grouped elements as separated entities,
1650      * use addGroupRule instead of addRule.
1651      *
1652      * @param    string     $element       Form element name
1653      * @param    string     $message       Message to display for invalid data
1654      * @param    string     $type          Rule type, use getRegisteredRules() to get types
1655      * @param    string     $format        (optional)Required for extra rule data
1656      * @param    string     $validation    (optional)Where to perform validation: "server", "client"
1657      * @param    boolean    $reset         Client-side validation: reset the form element to its original value if there is an error?
1658      * @param    boolean    $force         Force the rule to be applied, even if the target form element does not exist
1659      * @access   public
1660      */
1661     function addRule($element, $message, $type, $format=null, $validation='server', $reset = false, $force = false)
1662     {
1663         parent::addRule($element, $message, $type, $format, $validation, $reset, $force);
1664         if ($validation == 'client') {
1665             $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1666         }
1668     } // end func addRule
1669     /**
1670      * Adds a validation rule for the given group of elements
1671      *
1672      * Only groups with a name can be assigned a validation rule
1673      * Use addGroupRule when you need to validate elements inside the group.
1674      * Use addRule if you need to validate the group as a whole. In this case,
1675      * the same rule will be applied to all elements in the group.
1676      * Use addRule if you need to validate the group against a function.
1677      *
1678      * @param    string     $group         Form group name
1679      * @param    mixed      $arg1          Array for multiple elements or error message string for one element
1680      * @param    string     $type          (optional)Rule type use getRegisteredRules() to get types
1681      * @param    string     $format        (optional)Required for extra rule data
1682      * @param    int        $howmany       (optional)How many valid elements should be in the group
1683      * @param    string     $validation    (optional)Where to perform validation: "server", "client"
1684      * @param    bool       $reset         Client-side: whether to reset the element's value to its original state if validation failed.
1685      * @access   public
1686      */
1687     function addGroupRule($group, $arg1, $type='', $format=null, $howmany=0, $validation = 'server', $reset = false)
1688     {
1689         parent::addGroupRule($group, $arg1, $type, $format, $howmany, $validation, $reset);
1690         if (is_array($arg1)) {
1691              foreach ($arg1 as $rules) {
1692                 foreach ($rules as $rule) {
1693                     $validation = (isset($rule[3]) && 'client' == $rule[3])? 'client': 'server';
1695                     if ('client' == $validation) {
1696                         $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1697                     }
1698                 }
1699             }
1700         } elseif (is_string($arg1)) {
1702             if ($validation == 'client') {
1703                 $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1704             }
1705         }
1706     } // end func addGroupRule
1708     // }}}
1709     /**
1710      * Returns the client side validation script
1711      *
1712      * The code here was copied from HTML_QuickForm_DHTMLRulesTableless who copied it from  HTML_QuickForm
1713      * and slightly modified to run rules per-element
1714      * Needed to override this because of an error with client side validation of grouped elements.
1715      *
1716      * @access    public
1717      * @return    string    Javascript to perform validation, empty string if no 'client' rules were added
1718      */
1719     function getValidationScript()
1720     {
1721         if (empty($this->_rules) || empty($this->_attributes['onsubmit'])) {
1722             return '';
1723         }
1725         include_once('HTML/QuickForm/RuleRegistry.php');
1726         $registry =& HTML_QuickForm_RuleRegistry::singleton();
1727         $test = array();
1728         $js_escape = array(
1729             "\r"    => '\r',
1730             "\n"    => '\n',
1731             "\t"    => '\t',
1732             "'"     => "\\'",
1733             '"'     => '\"',
1734             '\\'    => '\\\\'
1735         );
1737         foreach ($this->_rules as $elementName => $rules) {
1738             foreach ($rules as $rule) {
1739                 if ('client' == $rule['validation']) {
1740                     unset($element); //TODO: find out how to properly initialize it
1742                     $dependent  = isset($rule['dependent']) && is_array($rule['dependent']);
1743                     $rule['message'] = strtr($rule['message'], $js_escape);
1745                     if (isset($rule['group'])) {
1746                         $group    =& $this->getElement($rule['group']);
1747                         // No JavaScript validation for frozen elements
1748                         if ($group->isFrozen()) {
1749                             continue 2;
1750                         }
1751                         $elements =& $group->getElements();
1752                         foreach (array_keys($elements) as $key) {
1753                             if ($elementName == $group->getElementName($key)) {
1754                                 $element =& $elements[$key];
1755                                 break;
1756                             }
1757                         }
1758                     } elseif ($dependent) {
1759                         $element   =  array();
1760                         $element[] =& $this->getElement($elementName);
1761                         foreach ($rule['dependent'] as $elName) {
1762                             $element[] =& $this->getElement($elName);
1763                         }
1764                     } else {
1765                         $element =& $this->getElement($elementName);
1766                     }
1767                     // No JavaScript validation for frozen elements
1768                     if (is_object($element) && $element->isFrozen()) {
1769                         continue 2;
1770                     } elseif (is_array($element)) {
1771                         foreach (array_keys($element) as $key) {
1772                             if ($element[$key]->isFrozen()) {
1773                                 continue 3;
1774                             }
1775                         }
1776                     }
1777                     //for editor element, [text] is appended to the name.
1778                     if ($element->getType() == 'editor') {
1779                         $elementName .= '[text]';
1780                         //Add format to rule as moodleform check which format is supported by browser
1781                         //it is not set anywhere... So small hack to make sure we pass it down to quickform
1782                         if (is_null($rule['format'])) {
1783                             $rule['format'] = $element->getFormat();
1784                         }
1785                     }
1786                     // Fix for bug displaying errors for elements in a group
1787                     $test[$elementName][0][] = $registry->getValidationScript($element, $elementName, $rule);
1788                     $test[$elementName][1]=$element;
1789                     //end of fix
1790                 }
1791             }
1792         }
1794         // Fix for MDL-9524. If you don't do this, then $element may be left as a reference to one of the fields in
1795         // the form, and then that form field gets corrupted by the code that follows.
1796         unset($element);
1798         $js = '
1799 <script type="text/javascript">
1800 //<![CDATA[
1802 var skipClientValidation = false;
1804 function qf_errorHandler(element, _qfMsg) {
1805   div = element.parentNode;
1807   if ((div == undefined) || (element.name == undefined)) {
1808     //no checking can be done for undefined elements so let server handle it.
1809     return true;
1810   }
1812   if (_qfMsg != \'\') {
1813     var errorSpan = document.getElementById(\'id_error_\'+element.name);
1814     if (!errorSpan) {
1815       errorSpan = document.createElement("span");
1816       errorSpan.id = \'id_error_\'+element.name;
1817       errorSpan.className = "error";
1818       element.parentNode.insertBefore(errorSpan, element.parentNode.firstChild);
1819     }
1821     while (errorSpan.firstChild) {
1822       errorSpan.removeChild(errorSpan.firstChild);
1823     }
1825     errorSpan.appendChild(document.createTextNode(_qfMsg.substring(3)));
1826     errorSpan.appendChild(document.createElement("br"));
1828     if (div.className.substr(div.className.length - 6, 6) != " error"
1829         && div.className != "error") {
1830       div.className += " error";
1831     }
1833     return false;
1834   } else {
1835     var errorSpan = document.getElementById(\'id_error_\'+element.name);
1836     if (errorSpan) {
1837       errorSpan.parentNode.removeChild(errorSpan);
1838     }
1840     if (div.className.substr(div.className.length - 6, 6) == " error") {
1841       div.className = div.className.substr(0, div.className.length - 6);
1842     } else if (div.className == "error") {
1843       div.className = "";
1844     }
1846     return true;
1847   }
1848 }';
1849         $validateJS = '';
1850         foreach ($test as $elementName => $jsandelement) {
1851             // Fix for bug displaying errors for elements in a group
1852             //unset($element);
1853             list($jsArr,$element)=$jsandelement;
1854             //end of fix
1855             $escapedElementName = preg_replace_callback(
1856                 '/[_\[\]]/',
1857                 create_function('$matches', 'return sprintf("_%2x",ord($matches[0]));'),
1858                 $elementName);
1859             $js .= '
1860 function validate_' . $this->_formName . '_' . $escapedElementName . '(element) {
1861   if (undefined == element) {
1862      //required element was not found, then let form be submitted without client side validation
1863      return true;
1864   }
1865   var value = \'\';
1866   var errFlag = new Array();
1867   var _qfGroups = {};
1868   var _qfMsg = \'\';
1869   var frm = element.parentNode;
1870   if ((undefined != element.name) && (frm != undefined)) {
1871       while (frm && frm.nodeName.toUpperCase() != "FORM") {
1872         frm = frm.parentNode;
1873       }
1874     ' . join("\n", $jsArr) . '
1875       return qf_errorHandler(element, _qfMsg);
1876   } else {
1877     //element name should be defined else error msg will not be displayed.
1878     return true;
1879   }
1881 ';
1882             $validateJS .= '
1883   ret = validate_' . $this->_formName . '_' . $escapedElementName.'(frm.elements[\''.$elementName.'\']) && ret;
1884   if (!ret && !first_focus) {
1885     first_focus = true;
1886     frm.elements[\''.$elementName.'\'].focus();
1887   }
1888 ';
1890             // Fix for bug displaying errors for elements in a group
1891             //unset($element);
1892             //$element =& $this->getElement($elementName);
1893             //end of fix
1894             $valFunc = 'validate_' . $this->_formName . '_' . $escapedElementName . '(this)';
1895             $onBlur = $element->getAttribute('onBlur');
1896             $onChange = $element->getAttribute('onChange');
1897             $element->updateAttributes(array('onBlur' => $onBlur . $valFunc,
1898                                              'onChange' => $onChange . $valFunc));
1899         }
1900 //  do not rely on frm function parameter, because htmlarea breaks it when overloading the onsubmit method
1901         $js .= '
1902 function validate_' . $this->_formName . '(frm) {
1903   if (skipClientValidation) {
1904      return true;
1905   }
1906   var ret = true;
1908   var frm = document.getElementById(\''. $this->_attributes['id'] .'\')
1909   var first_focus = false;
1910 ' . $validateJS . ';
1911   return ret;
1913 //]]>
1914 </script>';
1915         return $js;
1916     } // end func getValidationScript
1917     function _setDefaultRuleMessages(){
1918         foreach ($this->_rules as $field => $rulesarr){
1919             foreach ($rulesarr as $key => $rule){
1920                 if ($rule['message']===null){
1921                     $a=new stdClass();
1922                     $a->format=$rule['format'];
1923                     $str=get_string('err_'.$rule['type'], 'form', $a);
1924                     if (strpos($str, '[[')!==0){
1925                         $this->_rules[$field][$key]['message']=$str;
1926                     }
1927                 }
1928             }
1929         }
1930     }
1932     function getLockOptionObject(){
1933         $result = array();
1934         foreach ($this->_dependencies as $dependentOn => $conditions){
1935             $result[$dependentOn] = array();
1936             foreach ($conditions as $condition=>$values) {
1937                 $result[$dependentOn][$condition] = array();
1938                 foreach ($values as $value=>$dependents) {
1939                     $result[$dependentOn][$condition][$value] = array();
1940                     $i = 0;
1941                     foreach ($dependents as $dependent) {
1942                         $elements = $this->_getElNamesRecursive($dependent);
1943                         if (empty($elements)) {
1944                             // probably element inside of some group
1945                             $elements = array($dependent);
1946                         }
1947                         foreach($elements as $element) {
1948                             if ($element == $dependentOn) {
1949                                 continue;
1950                             }
1951                             $result[$dependentOn][$condition][$value][] = $element;
1952                         }
1953                     }
1954                 }
1955             }
1956         }
1957         return array($this->getAttribute('id'), $result);
1958     }
1960     /**
1961      * @param mixed $element
1962      * @return array
1963      */
1964     function _getElNamesRecursive($element) {
1965         if (is_string($element)) {
1966             if (!$this->elementExists($element)) {
1967                 return array();
1968             }
1969             $element = $this->getElement($element);
1970         }
1972         if (is_a($element, 'HTML_QuickForm_group')) {
1973             $elsInGroup = $element->getElements();
1974             $elNames = array();
1975             foreach ($elsInGroup as $elInGroup){
1976                 if (is_a($elInGroup, 'HTML_QuickForm_group')) {
1977                     // not sure if this would work - groups nested in groups
1978                     $elNames = array_merge($elNames, $this->_getElNamesRecursive($elInGroup));
1979                 } else {
1980                     $elNames[] = $element->getElementName($elInGroup->getName());
1981                 }
1982             }
1984         } else if (is_a($element, 'HTML_QuickForm_header')) {
1985             return array();
1987         } else if (is_a($element, 'HTML_QuickForm_hidden')) {
1988             return array();
1990         } else if (method_exists($element, 'getPrivateName') &&
1991                 !($element instanceof HTML_QuickForm_advcheckbox)) {
1992             // The advcheckbox element implements a method called getPrivateName,
1993             // but in a way that is not compatible with the generic API, so we
1994             // have to explicitly exclude it.
1995             return array($element->getPrivateName());
1997         } else {
1998             $elNames = array($element->getName());
1999         }
2001         return $elNames;
2002     }
2004     /**
2005      * Adds a dependency for $elementName which will be disabled if $condition is met.
2006      * If $condition = 'notchecked' (default) then the condition is that the $dependentOn element
2007      * is not checked. If $condition = 'checked' then the condition is that the $dependentOn element
2008      * is checked. If $condition is something else (like "eq" for equals) then it is checked to see if the value
2009      * of the $dependentOn element is $condition (such as equal) to $value.
2010      *
2011      * @param string $elementName the name of the element which will be disabled
2012      * @param string $dependentOn the name of the element whose state will be checked for
2013      *                            condition
2014      * @param string $condition the condition to check
2015      * @param mixed $value used in conjunction with condition.
2016      */
2017     function disabledIf($elementName, $dependentOn, $condition = 'notchecked', $value='1'){
2018         if (!array_key_exists($dependentOn, $this->_dependencies)) {
2019             $this->_dependencies[$dependentOn] = array();
2020         }
2021         if (!array_key_exists($condition, $this->_dependencies[$dependentOn])) {
2022             $this->_dependencies[$dependentOn][$condition] = array();
2023         }
2024         if (!array_key_exists($value, $this->_dependencies[$dependentOn][$condition])) {
2025             $this->_dependencies[$dependentOn][$condition][$value] = array();
2026         }
2027         $this->_dependencies[$dependentOn][$condition][$value][] = $elementName;
2028     }
2030     function registerNoSubmitButton($buttonname){
2031         $this->_noSubmitButtons[]=$buttonname;
2032     }
2034     /**
2035      * @param string $buttonname
2036      * @return mixed
2037      */
2038     function isNoSubmitButton($buttonname){
2039         return (array_search($buttonname, $this->_noSubmitButtons)!==FALSE);
2040     }
2042     /**
2043      * @param string $buttonname
2044      */
2045     function _registerCancelButton($addfieldsname){
2046         $this->_cancelButtons[]=$addfieldsname;
2047     }
2048     /**
2049      * Displays elements without HTML input tags.
2050      * This method is different to freeze() in that it makes sure no hidden
2051      * elements are included in the form.
2052      * Note: If you want to make sure the submitted value is ignored, please use setDefaults().
2053      *
2054      * This function also removes all previously defined rules.
2055      *
2056      * @param    mixed   $elementList       array or string of element(s) to be frozen
2057      * @access   public
2058      */
2059     function hardFreeze($elementList=null)
2060     {
2061         if (!isset($elementList)) {
2062             $this->_freezeAll = true;
2063             $elementList = array();
2064         } else {
2065             if (!is_array($elementList)) {
2066                 $elementList = preg_split('/[ ]*,[ ]*/', $elementList);
2067             }
2068             $elementList = array_flip($elementList);
2069         }
2071         foreach (array_keys($this->_elements) as $key) {
2072             $name = $this->_elements[$key]->getName();
2073             if ($this->_freezeAll || isset($elementList[$name])) {
2074                 $this->_elements[$key]->freeze();
2075                 $this->_elements[$key]->setPersistantFreeze(false);
2076                 unset($elementList[$name]);
2078                 // remove all rules
2079                 $this->_rules[$name] = array();
2080                 // if field is required, remove the rule
2081                 $unset = array_search($name, $this->_required);
2082                 if ($unset !== false) {
2083                     unset($this->_required[$unset]);
2084                 }
2085             }
2086         }
2088         if (!empty($elementList)) {
2089             return PEAR::raiseError(null, QUICKFORM_NONEXIST_ELEMENT, null, E_USER_WARNING, "Nonexistant element(s): '" . implode("', '", array_keys($elementList)) . "' in HTML_QuickForm::freeze()", 'HTML_QuickForm_Error', true);
2090         }
2091         return true;
2092     }
2093     /**
2094      * Hard freeze all elements in a form except those whose names are in $elementList or hidden elements in a form.
2095      *
2096      * This function also removes all previously defined rules of elements it freezes.
2097      *
2098      * throws   HTML_QuickForm_Error
2099      *
2100      * @param    array   $elementList       array or string of element(s) not to be frozen
2101      * @access   public
2102      */
2103     function hardFreezeAllVisibleExcept($elementList)
2104     {
2105         $elementList = array_flip($elementList);
2106         foreach (array_keys($this->_elements) as $key) {
2107             $name = $this->_elements[$key]->getName();
2108             $type = $this->_elements[$key]->getType();
2110             if ($type == 'hidden'){
2111                 // leave hidden types as they are
2112             } elseif (!isset($elementList[$name])) {
2113                 $this->_elements[$key]->freeze();
2114                 $this->_elements[$key]->setPersistantFreeze(false);
2116                 // remove all rules
2117                 $this->_rules[$name] = array();
2118                 // if field is required, remove the rule
2119                 $unset = array_search($name, $this->_required);
2120                 if ($unset !== false) {
2121                     unset($this->_required[$unset]);
2122                 }
2123             }
2124         }
2125         return true;
2126     }
2127    /**
2128     * Tells whether the form was already submitted
2129     *
2130     * This is useful since the _submitFiles and _submitValues arrays
2131     * may be completely empty after the trackSubmit value is removed.
2132     *
2133     * @access public
2134     * @return bool
2135     */
2136     function isSubmitted()
2137     {
2138         return parent::isSubmitted() && (!$this->isFrozen());
2139     }
2143 /**
2144  * A renderer for MoodleQuickForm that only uses XHTML and CSS and no
2145  * table tags, extends PEAR class HTML_QuickForm_Renderer_Tableless
2146  *
2147  * Stylesheet is part of standard theme and should be automatically included.
2148  *
2149  * @package   moodlecore
2150  * @copyright Jamie Pratt <me@jamiep.org>
2151  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2152  */
2153 class MoodleQuickForm_Renderer extends HTML_QuickForm_Renderer_Tableless{
2155     /**
2156     * Element template array
2157     * @var      array
2158     * @access   private
2159     */
2160     var $_elementTemplates;
2161     /**
2162     * Template used when opening a hidden fieldset
2163     * (i.e. a fieldset that is opened when there is no header element)
2164     * @var      string
2165     * @access   private
2166     */
2167     var $_openHiddenFieldsetTemplate = "\n\t<fieldset class=\"hidden\"><div>";
2168    /**
2169     * Header Template string
2170     * @var      string
2171     * @access   private
2172     */
2173     var $_headerTemplate =
2174        "\n\t\t<legend class=\"ftoggler\">{header}</legend>\n\t\t<div class=\"advancedbutton\">{advancedimg}{button}</div><div class=\"fcontainer clearfix\">\n\t\t";
2176    /**
2177     * Template used when opening a fieldset
2178     * @var      string
2179     * @access   private
2180     */
2181     var $_openFieldsetTemplate = "\n\t<fieldset class=\"clearfix\" {id}>";
2183     /**
2184     * Template used when closing a fieldset
2185     * @var      string
2186     * @access   private
2187     */
2188     var $_closeFieldsetTemplate = "\n\t\t</div></fieldset>";
2190    /**
2191     * Required Note template string
2192     * @var      string
2193     * @access   private
2194     */
2195     var $_requiredNoteTemplate =
2196         "\n\t\t<div class=\"fdescription required\">{requiredNote}</div>";
2198     var $_advancedElements = array();
2200     /**
2201      * Whether to display advanced elements (on page load)
2202      *
2203      * @var integer 1 means show 0 means hide
2204      */
2205     var $_showAdvanced;
2207     function MoodleQuickForm_Renderer(){
2208         // switch next two lines for ol li containers for form items.
2209         //        $this->_elementTemplates=array('default'=>"\n\t\t".'<li class="fitem"><label>{label}{help}<!-- BEGIN required -->{req}<!-- END required --></label><div class="qfelement<!-- BEGIN error --> error<!-- END error --> {type}"><!-- BEGIN error --><span class="error">{error}</span><br /><!-- END error -->{element}</div></li>');
2210         $this->_elementTemplates = array(
2211         'default'=>"\n\t\t".'<div class="fitem {advanced}<!-- BEGIN required --> required<!-- END required -->"><div class="fitemtitle"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg} {help}</label></div><div class="felement {type}<!-- BEGIN error --> error<!-- END error -->"><!-- BEGIN error --><span class="error">{error}</span><br /><!-- END error -->{element}</div></div>',
2213         'fieldset'=>"\n\t\t".'<div class="fitem {advanced}<!-- BEGIN required --> required<!-- END required -->"><div class="fitemtitle"><div class="fgrouplabel"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg} {help}</label></div></div><fieldset class="felement {type}<!-- BEGIN error --> error<!-- END error -->"><!-- BEGIN error --><span class="error">{error}</span><br /><!-- END error -->{element}</fieldset></div>',
2215         'static'=>"\n\t\t".'<div class="fitem {advanced}"><div class="fitemtitle"><div class="fstaticlabel"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg} {help}</label></div></div><div class="felement fstatic <!-- BEGIN error --> error<!-- END error -->"><!-- BEGIN error --><span class="error">{error}</span><br /><!-- END error -->{element}&nbsp;</div></div>',
2217 'warning'=>"\n\t\t".'<div class="fitem {advanced}">{element}</div>',
2219         'nodisplay'=>'');
2221         parent::HTML_QuickForm_Renderer_Tableless();
2222     }
2224     /**
2225      * @param array $elements
2226      */
2227     function setAdvancedElements($elements){
2228         $this->_advancedElements = $elements;
2229     }
2231     /**
2232      * What to do when starting the form
2233      *
2234      * @param object $form MoodleQuickForm
2235      */
2236     function startForm(&$form){
2237         $this->_reqHTML = $form->getReqHTML();
2238         $this->_elementTemplates = str_replace('{req}', $this->_reqHTML, $this->_elementTemplates);
2239         $this->_advancedHTML = $form->getAdvancedHTML();
2240         $this->_showAdvanced = $form->getShowAdvanced();
2241         parent::startForm($form);
2242         if ($form->isFrozen()){
2243             $this->_formTemplate = "\n<div class=\"mform frozen\">\n{content}\n</div>";
2244         } else {
2245             $this->_formTemplate = "\n<form{attributes}>\n\t<div style=\"display: none;\">{hidden}</div>\n{content}\n</form>";
2246             $this->_hiddenHtml .= $form->_pageparams;
2247         }
2250     }
2252     /**
2253      * @param object $group Passed by reference
2254      * @param mixed $required
2255      * @param mixed $error
2256      */
2257     function startGroup(&$group, $required, $error){
2258         if (method_exists($group, 'getElementTemplateType')){
2259             $html = $this->_elementTemplates[$group->getElementTemplateType()];
2260         }else{
2261             $html = $this->_elementTemplates['default'];
2263         }
2264         if ($this->_showAdvanced){
2265             $advclass = ' advanced';
2266         } else {
2267             $advclass = ' advanced hide';
2268         }
2269         if (isset($this->_advancedElements[$group->getName()])){
2270             $html =str_replace(' {advanced}', $advclass, $html);
2271             $html =str_replace('{advancedimg}', $this->_advancedHTML, $html);
2272         } else {
2273             $html =str_replace(' {advanced}', '', $html);
2274             $html =str_replace('{advancedimg}', '', $html);
2275         }
2276         if (method_exists($group, 'getHelpButton')){
2277             $html =str_replace('{help}', $group->getHelpButton(), $html);
2278         }else{
2279             $html =str_replace('{help}', '', $html);
2280         }
2281         $html =str_replace('{name}', $group->getName(), $html);
2282         $html =str_replace('{type}', 'fgroup', $html);
2284         $this->_templates[$group->getName()]=$html;
2285         // Fix for bug in tableless quickforms that didn't allow you to stop a
2286         // fieldset before a group of elements.
2287         // if the element name indicates the end of a fieldset, close the fieldset
2288         if (   in_array($group->getName(), $this->_stopFieldsetElements)
2289             && $this->_fieldsetsOpen > 0
2290            ) {
2291             $this->_html .= $this->_closeFieldsetTemplate;
2292             $this->_fieldsetsOpen--;
2293         }
2294         parent::startGroup($group, $required, $error);
2295     }
2296     /**
2297      * @param object $element
2298      * @param mixed $required
2299      * @param mixed $error
2300      */
2301     function renderElement(&$element, $required, $error){
2302         //manipulate id of all elements before rendering
2303         if (!is_null($element->getAttribute('id'))) {
2304             $id = $element->getAttribute('id');
2305         } else {
2306             $id = $element->getName();
2307         }
2308         //strip qf_ prefix and replace '[' with '_' and strip ']'
2309         $id = preg_replace(array('/^qf_|\]/', '/\[/'), array('', '_'), $id);
2310         if (strpos($id, 'id_') !== 0){
2311             $element->updateAttributes(array('id'=>'id_'.$id));
2312         }
2314         //adding stuff to place holders in template
2315         //check if this is a group element first
2316         if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
2317             // so it gets substitutions for *each* element
2318             $html = $this->_groupElementTemplate;
2319         }
2320         elseif (method_exists($element, 'getElementTemplateType')){
2321             $html = $this->_elementTemplates[$element->getElementTemplateType()];
2322         }else{
2323             $html = $this->_elementTemplates['default'];
2324         }
2325         if ($this->_showAdvanced){
2326             $advclass = ' advanced';
2327         } else {
2328             $advclass = ' advanced hide';
2329         }
2330         if (isset($this->_advancedElements[$element->getName()])){
2331             $html =str_replace(' {advanced}', $advclass, $html);
2332         } else {
2333             $html =str_replace(' {advanced}', '', $html);
2334         }
2335         if (isset($this->_advancedElements[$element->getName()])||$element->getName() == 'mform_showadvanced'){
2336             $html =str_replace('{advancedimg}', $this->_advancedHTML, $html);
2337         } else {
2338             $html =str_replace('{advancedimg}', '', $html);
2339         }
2340         $html =str_replace('{type}', 'f'.$element->getType(), $html);
2341         $html =str_replace('{name}', $element->getName(), $html);
2342         if (method_exists($element, 'getHelpButton')){
2343             $html = str_replace('{help}', $element->getHelpButton(), $html);
2344         }else{
2345             $html = str_replace('{help}', '', $html);
2347         }
2348         if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
2349             $this->_groupElementTemplate = $html;
2350         }
2351         elseif (!isset($this->_templates[$element->getName()])) {
2352             $this->_templates[$element->getName()] = $html;
2353         }
2355         parent::renderElement($element, $required, $error);
2356     }
2358     /**
2359      * @global moodle_page $PAGE
2360      * @param object $form Passed by reference
2361      */
2362     function finishForm(&$form){
2363         global $PAGE;
2364         if ($form->isFrozen()){
2365             $this->_hiddenHtml = '';
2366         }
2367         parent::finishForm($form);
2368         if (!$form->isFrozen()) {
2369             $args = $form->getLockOptionObject();
2370             if (count($args[1]) > 0) {
2371                 $PAGE->requires->js_init_call('M.form.initFormDependencies', $args, true, moodleform::get_js_module());
2372             }
2373         }
2374     }
2375    /**
2376     * Called when visiting a header element
2377     *
2378     * @param    object  $header   An HTML_QuickForm_header element being visited
2379     * @access   public
2380     * @return   void
2381     * @global moodle_page $PAGE
2382     */
2383     function renderHeader(&$header) {
2384         global $PAGE;
2386         $name = $header->getName();
2388         $id = empty($name) ? '' : ' id="' . $name . '"';
2389         $id = preg_replace(array('/\]/', '/\[/'), array('', '_'), $id);
2390         if (is_null($header->_text)) {
2391             $header_html = '';
2392         } elseif (!empty($name) && isset($this->_templates[$name])) {
2393             $header_html = str_replace('{header}', $header->toHtml(), $this->_templates[$name]);
2394         } else {
2395             $header_html = str_replace('{header}', $header->toHtml(), $this->_headerTemplate);
2396         }
2398         if (isset($this->_advancedElements[$name])){
2399             $header_html =str_replace('{advancedimg}', $this->_advancedHTML, $header_html);
2400             $elementName='mform_showadvanced';
2401             if ($this->_showAdvanced==0){
2402                 $buttonlabel = get_string('showadvanced', 'form');
2403             } else {
2404                 $buttonlabel = get_string('hideadvanced', 'form');
2405             }
2406             $button = '<input name="'.$elementName.'" class="showadvancedbtn" value="'.$buttonlabel.'" type="submit" />';
2407             $PAGE->requires->js_init_call('M.form.initShowAdvanced', array(), false, moodleform::get_js_module());
2408             $header_html = str_replace('{button}', $button, $header_html);
2409         } else {
2410             $header_html =str_replace('{advancedimg}', '', $header_html);
2411             $header_html = str_replace('{button}', '', $header_html);
2412         }
2414         if ($this->_fieldsetsOpen > 0) {
2415             $this->_html .= $this->_closeFieldsetTemplate;
2416             $this->_fieldsetsOpen--;
2417         }
2419         $openFieldsetTemplate = str_replace('{id}', $id, $this->_openFieldsetTemplate);
2420         if ($this->_showAdvanced){
2421             $advclass = ' class="advanced"';
2422         } else {
2423             $advclass = ' class="advanced hide"';
2424         }
2425         if (isset($this->_advancedElements[$name])){
2426             $openFieldsetTemplate = str_replace('{advancedclass}', $advclass, $openFieldsetTemplate);
2427         } else {
2428             $openFieldsetTemplate = str_replace('{advancedclass}', '', $openFieldsetTemplate);
2429         }
2430         $this->_html .= $openFieldsetTemplate . $header_html;
2431         $this->_fieldsetsOpen++;
2432     } // end func renderHeader
2434     function getStopFieldsetElements(){
2435         return $this->_stopFieldsetElements;
2436     }
2439 /**
2440  * Required elements validation
2441  * This class overrides QuickForm validation since it allowed space or empty tag as a value
2442  */
2443 class MoodleQuickForm_Rule_Required extends HTML_QuickForm_Rule {
2444     /**
2445      * Checks if an element is not empty.
2446      * This is a server-side validation, it works for both text fields and editor fields
2447      *
2448      * @param     string    $value      Value to check
2449      * @param     mixed     $options    Not used yet
2450      * @return    boolean   true if value is not empty
2451      */
2452     function validate($value, $options = null) {
2453         global $CFG;
2454         if (is_array($value) && array_key_exists('text', $value)) {
2455             $value = $value['text'];
2456         }
2457         $stripvalues = array(
2458             '#</?(?!img|canvas|hr).*?>#im', // all tags except img, canvas and hr
2459             '#(\xc2|\xa0|\s|&nbsp;)#', //any whitespaces actually
2460         );
2461         if (!empty($CFG->strictformsrequired)) {
2462             $value = preg_replace($stripvalues, '', (string)$value);
2463         }
2464         if ((string)$value == '') {
2465             return false;
2466         }
2467         return true;
2468     }
2470     /**
2471      * This function returns Javascript code used to build client-side validation.
2472      * It checks if an element is not empty.
2473      *
2474      * @param int $format
2475      * @return array
2476      */
2477     function getValidationScript($format = null) {
2478         global $CFG;
2479         if (!empty($CFG->strictformsrequired)) {
2480             if (!empty($format) && $format == FORMAT_HTML) {
2481                 return array('', "{jsVar}.replace(/(<[^img|hr|canvas]+>)|&nbsp;|\s+/ig, '') == ''");
2482             } else {
2483                 return array('', "{jsVar}.replace(/^\s+$/g, '') == ''");
2484             }
2485         } else {
2486             return array('', "{jsVar} == ''");
2487         }
2488     }
2491 /**
2492  * @global object $GLOBALS['_HTML_QuickForm_default_renderer']
2493  * @name $_HTML_QuickForm_default_renderer
2494  */
2495 $GLOBALS['_HTML_QuickForm_default_renderer'] = new MoodleQuickForm_Renderer();
2497 /** Please keep this list in alphabetical order. */
2498 MoodleQuickForm::registerElementType('advcheckbox', "$CFG->libdir/form/advcheckbox.php", 'MoodleQuickForm_advcheckbox');
2499 MoodleQuickForm::registerElementType('button', "$CFG->libdir/form/button.php", 'MoodleQuickForm_button');
2500 MoodleQuickForm::registerElementType('cancel', "$CFG->libdir/form/cancel.php", 'MoodleQuickForm_cancel');
2501 MoodleQuickForm::registerElementType('searchableselector', "$CFG->libdir/form/searchableselector.php", 'MoodleQuickForm_searchableselector');
2502 MoodleQuickForm::registerElementType('checkbox', "$CFG->libdir/form/checkbox.php", 'MoodleQuickForm_checkbox');
2503 MoodleQuickForm::registerElementType('date_selector', "$CFG->libdir/form/dateselector.php", 'MoodleQuickForm_date_selector');
2504 MoodleQuickForm::registerElementType('date_time_selector', "$CFG->libdir/form/datetimeselector.php", 'MoodleQuickForm_date_time_selector');
2505 MoodleQuickForm::registerElementType('duration', "$CFG->libdir/form/duration.php", 'MoodleQuickForm_duration');
2506 MoodleQuickForm::registerElementType('editor', "$CFG->libdir/form/editor.php", 'MoodleQuickForm_editor');
2507 MoodleQuickForm::registerElementType('file', "$CFG->libdir/form/file.php", 'MoodleQuickForm_file');
2508 MoodleQuickForm::registerElementType('filemanager', "$CFG->libdir/form/filemanager.php", 'MoodleQuickForm_filemanager');
2509 MoodleQuickForm::registerElementType('filepicker', "$CFG->libdir/form/filepicker.php", 'MoodleQuickForm_filepicker');
2510 MoodleQuickForm::registerElementType('format', "$CFG->libdir/form/format.php", 'MoodleQuickForm_format');
2511 MoodleQuickForm::registerElementType('grading', "$CFG->libdir/form/grading.php", 'MoodleQuickForm_grading');
2512 MoodleQuickForm::registerElementType('group', "$CFG->libdir/form/group.php", 'MoodleQuickForm_group');
2513 MoodleQuickForm::registerElementType('header', "$CFG->libdir/form/header.php", 'MoodleQuickForm_header');
2514 MoodleQuickForm::registerElementType('hidden', "$CFG->libdir/form/hidden.php", 'MoodleQuickForm_hidden');
2515 MoodleQuickForm::registerElementType('htmleditor', "$CFG->libdir/form/htmleditor.php", 'MoodleQuickForm_htmleditor');
2516 MoodleQuickForm::registerElementType('modgrade', "$CFG->libdir/form/modgrade.php", 'MoodleQuickForm_modgrade');
2517 MoodleQuickForm::registerElementType('modvisible', "$CFG->libdir/form/modvisible.php", 'MoodleQuickForm_modvisible');
2518 MoodleQuickForm::registerElementType('password', "$CFG->libdir/form/password.php", 'MoodleQuickForm_password');
2519 MoodleQuickForm::registerElementType('passwordunmask', "$CFG->libdir/form/passwordunmask.php", 'MoodleQuickForm_passwordunmask');
2520 MoodleQuickForm::registerElementType('questioncategory', "$CFG->libdir/form/questioncategory.php", 'MoodleQuickForm_questioncategory');
2521 MoodleQuickForm::registerElementType('radio', "$CFG->libdir/form/radio.php", 'MoodleQuickForm_radio');
2522 MoodleQuickForm::registerElementType('recaptcha', "$CFG->libdir/form/recaptcha.php", 'MoodleQuickForm_recaptcha');
2523 MoodleQuickForm::registerElementType('select', "$CFG->libdir/form/select.php", 'MoodleQuickForm_select');
2524 MoodleQuickForm::registerElementType('selectgroups', "$CFG->libdir/form/selectgroups.php", 'MoodleQuickForm_selectgroups');
2525 MoodleQuickForm::registerElementType('selectwithlink', "$CFG->libdir/form/selectwithlink.php", 'MoodleQuickForm_selectwithlink');
2526 MoodleQuickForm::registerElementType('selectyesno', "$CFG->libdir/form/selectyesno.php", 'MoodleQuickForm_selectyesno');
2527 MoodleQuickForm::registerElementType('static', "$CFG->libdir/form/static.php", 'MoodleQuickForm_static');
2528 MoodleQuickForm::registerElementType('submit', "$CFG->libdir/form/submit.php", 'MoodleQuickForm_submit');
2529 MoodleQuickForm::registerElementType('submitlink', "$CFG->libdir/form/submitlink.php", 'MoodleQuickForm_submitlink');
2530 MoodleQuickForm::registerElementType('tags', "$CFG->libdir/form/tags.php", 'MoodleQuickForm_tags');
2531 MoodleQuickForm::registerElementType('text', "$CFG->libdir/form/text.php", 'MoodleQuickForm_text');
2532 MoodleQuickForm::registerElementType('textarea', "$CFG->libdir/form/textarea.php", 'MoodleQuickForm_textarea');
2533 MoodleQuickForm::registerElementType('url', "$CFG->libdir/form/url.php", 'MoodleQuickForm_url');
2534 MoodleQuickForm::registerElementType('warning', "$CFG->libdir/form/warning.php", 'MoodleQuickForm_warning');
2536 MoodleQuickForm::registerRule('required', null, 'MoodleQuickForm_Rule_Required', "$CFG->libdir/formslib.php");