MDL-20636 Finish off converting question import.
[moodle.git] / question / import_form.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Defines the import questions form.
20  *
21  * @package    moodlecore
22  * @subpackage questionbank
23  * @copyright  2007 Jamie Pratt me@jamiep.org
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
28 if (!defined('MOODLE_INTERNAL')) {
29     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
30 }
32 require_once($CFG->libdir . '/formslib.php');
35 /**
36  * Form to import questions into the question bank.
37  *
38  * @copyright  2007 Jamie Pratt me@jamiep.org
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class question_import_form extends moodleform {
43     function definition() {
44         global $COURSE;
45         $mform = $this->_form;
47         $defaultcategory = $this->_customdata['defaultcategory'];
48         $contexts = $this->_customdata['contexts'];
50         // Choice of import format, with help icons.
51         $mform->addElement('header', 'fileformat', get_string('fileformat', 'question'));
53         $fileformatnames = get_import_export_formats('import');
54         $radioarray = array();
55         $i = 0 ;
56         foreach ($fileformatnames as $shortname => $fileformatname) {
57             $currentgrp1 = array();
58             $currentgrp1[] = $mform->createElement('radio', 'format', '', $fileformatname, $shortname);
59             $mform->addGroup($currentgrp1, "formathelp[$i]", '', array('<br />'), false);
60             $mform->addHelpButton("formathelp[$i]", $shortname, 'qformat_' . $shortname);
61             $i++ ;
62         }
63         $mform->addRule("formathelp[0]", null, 'required', null, 'client');
65         // Import options.
66         $mform->addElement('header','general', get_string('general', 'form'));
68         $mform->addElement('questioncategory', 'category', get_string('importcategory', 'question'), compact('contexts'));
69         $mform->setDefault('category', $defaultcategory);
70         $mform->addHelpButton('category', 'importcategory', 'question');
72         $categorygroup = array();
73         $categorygroup[] = $mform->createElement('checkbox', 'catfromfile', '', get_string('getcategoryfromfile', 'question'));
74         $categorygroup[] = $mform->createElement('checkbox', 'contextfromfile', '', get_string('getcontextfromfile', 'question'));
75         $mform->addGroup($categorygroup, 'categorygroup', '', '', false);
76         $mform->disabledIf('categorygroup', 'catfromfile', 'notchecked');
77         $mform->setDefault('catfromfile', 1);
78         $mform->setDefault('contextfromfile', 1);
80         $matchgrades = array();
81         $matchgrades['error'] = get_string('matchgradeserror', 'question');
82         $matchgrades['nearest'] = get_string('matchgradesnearest', 'question');
83         $mform->addElement('select', 'matchgrades', get_string('matchgrades', 'question'), $matchgrades);
84         $mform->addHelpButton('matchgrades', 'matchgrades', 'question');
85         $mform->setDefault('matchgrades', 'error');
87         $mform->addElement('selectyesno', 'stoponerror', get_string('stoponerror', 'question'));
88         $mform->setDefault('stoponerror', 1);
89         $mform->addHelpButton('stoponerror', 'stoponerror', 'question');
91         // The file to import
92         $mform->addElement('header', 'importfileupload', get_string('importquestions', 'question'));
94         $mform->addElement('filepicker', 'newfile', get_string('import'));
95         $mform->addRule('newfile', null, 'required', null, 'client');
97         // Submit button.
98         $mform->addElement('submit', 'submitbutton', get_string('import'));
100         // Set a template for the format select elements
101         $renderer = $mform->defaultRenderer();
102         $template = "{help} {element}\n";
103         $renderer->setGroupElementTemplate($template, 'format');
104     }
106     /**
107      * Checks that a file has been uploaded, and that it is of a plausible type.
108      * @param array $data the submitted data.
109      * @param array $errors the errors so far.
110      * @return array the updated errors.
111      */
112     protected function validate_uploaded_file($data, $errors) {
113         if (empty($data['newfile'])) {
114             $errors['newfile'] = get_string('required');
115             return $errors;
116         }
118         $files = $this->get_draft_files('newfile');
119         if (count($files) < 1) {
120             $errors['newfile'] = get_string('required');
121             return $errors;
122         }
124         $formatfile = 'format/' . $data['format'] . '/format.php';
125         if (!is_readable($formatfile)) {
126             throw new moodle_exception('formatnotfound', 'quiz', '', $data['format']);
127         }
129         require_once($formatfile);
131         $classname = 'qformat_' . $data['format'];
132         $qformat = new $classname();
134         $file = reset($files);
135         if ($file->get_mimetype() != $qformat->mime_type()) {
136             $a = new stdClass();
137             $a->actualtype = $file->get_mimetype();
138             $a->expectedtype = $qformat->mime_type();
139             $errors['newfile'] = get_string('importwrongfiletype', 'question', $a);
140         }
142         return $errors;
143     }
145     public function validation($data, $files) {
146         $errors = parent::validation($data, $files);
147         $errors = $this->validate_uploaded_file($data, $errors);
148         return $errors;
149     }