Merge branch 'install_310_STABLE' of https://git.in.moodle.com/amosbot/moodle-install...
[moodle.git] / question / import_form.php
CommitLineData
aeb15530 1<?php
f7c1dfaf
TH
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/>.
16
17/**
18 * Defines the import questions form.
19 *
20 * @package moodlecore
21 * @subpackage questionbank
22 * @copyright 2007 Jamie Pratt me@jamiep.org
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
26
a17b297d 27defined('MOODLE_INTERNAL') || die();
bfebaf64 28
f7c1dfaf
TH
29require_once($CFG->libdir . '/formslib.php');
30
515ed4c3 31
f7c1dfaf
TH
32/**
33 * Form to import questions into the question bank.
34 *
35 * @copyright 2007 Jamie Pratt me@jamiep.org
36 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37 */
515ed4c3 38class question_import_form extends moodleform {
39
c7df5006 40 protected function definition() {
f06eacd9
TH
41 global $OUTPUT;
42
f7c1dfaf 43 $mform = $this->_form;
515ed4c3 44
f7c1dfaf
TH
45 $defaultcategory = $this->_customdata['defaultcategory'];
46 $contexts = $this->_customdata['contexts'];
47
48 // Choice of import format, with help icons.
49 $mform->addElement('header', 'fileformat', get_string('fileformat', 'question'));
45b68eef 50
45b68eef 51 $fileformatnames = get_import_export_formats('import');
f7c1dfaf 52 $radioarray = array();
f06eacd9 53 $separators = array();
f94902db 54 foreach ($fileformatnames as $shortname => $fileformatname) {
f06eacd9 55 $radioarray[] = $mform->createElement('radio', 'format', '', $fileformatname, $shortname);
64679179 56
f06eacd9 57 $separator = '';
64679179 58 if (get_string_manager()->string_exists('pluginname_help', 'qformat_' . $shortname)) {
f06eacd9 59 $separator .= $OUTPUT->help_icon('pluginname', 'qformat_' . $shortname);
64679179 60 }
02955a84 61 $separator .= '<div class="w-100"></div>';
f06eacd9 62 $separators[] = $separator;
45b68eef 63 }
f06eacd9
TH
64
65 $radioarray[] = $mform->createElement('static', 'makelasthelpiconshowup', '');
66 $mform->addGroup($radioarray, "formatchoices", '', $separators, false);
67 $mform->addRule("formatchoices", null, 'required', null, 'client');
f7c1dfaf
TH
68
69 // Import options.
515ed4c3 70 $mform->addElement('header','general', get_string('general', 'form'));
71
5fcefc97 72 $mform->addElement('questioncategory', 'category', get_string('importcategory', 'question'), compact('contexts'));
515ed4c3 73 $mform->setDefault('category', $defaultcategory);
5fcefc97 74 $mform->addHelpButton('category', 'importcategory', 'question');
515ed4c3 75
76 $categorygroup = array();
f7c1dfaf
TH
77 $categorygroup[] = $mform->createElement('checkbox', 'catfromfile', '', get_string('getcategoryfromfile', 'question'));
78 $categorygroup[] = $mform->createElement('checkbox', 'contextfromfile', '', get_string('getcontextfromfile', 'question'));
515ed4c3 79 $mform->addGroup($categorygroup, 'categorygroup', '', '', false);
80 $mform->disabledIf('categorygroup', 'catfromfile', 'notchecked');
81 $mform->setDefault('catfromfile', 1);
82 $mform->setDefault('contextfromfile', 1);
83
515ed4c3 84 $matchgrades = array();
f7c1dfaf
TH
85 $matchgrades['error'] = get_string('matchgradeserror', 'question');
86 $matchgrades['nearest'] = get_string('matchgradesnearest', 'question');
5fcefc97
DM
87 $mform->addElement('select', 'matchgrades', get_string('matchgrades', 'question'), $matchgrades);
88 $mform->addHelpButton('matchgrades', 'matchgrades', 'question');
515ed4c3 89 $mform->setDefault('matchgrades', 'error');
90
5fcefc97 91 $mform->addElement('selectyesno', 'stoponerror', get_string('stoponerror', 'question'));
515ed4c3 92 $mform->setDefault('stoponerror', 1);
5fcefc97 93 $mform->addHelpButton('stoponerror', 'stoponerror', 'question');
15b83581 94
f7c1dfaf
TH
95 // The file to import
96 $mform->addElement('header', 'importfileupload', get_string('importquestions', 'question'));
97
98 $mform->addElement('filepicker', 'newfile', get_string('import'));
99 $mform->addRule('newfile', null, 'required', null, 'client');
100
101 // Submit button.
102 $mform->addElement('submit', 'submitbutton', get_string('import'));
103
104 // Set a template for the format select elements
105 $renderer = $mform->defaultRenderer();
79e3dd8e 106 $template = "{help} {element}\n";
107 $renderer->setGroupElementTemplate($template, 'format');
515ed4c3 108 }
d1b7e03d 109
f7c1dfaf
TH
110 /**
111 * Checks that a file has been uploaded, and that it is of a plausible type.
112 * @param array $data the submitted data.
113 * @param array $errors the errors so far.
114 * @return array the updated errors.
c7ac83ca 115 * @throws moodle_exception
f7c1dfaf
TH
116 */
117 protected function validate_uploaded_file($data, $errors) {
118 if (empty($data['newfile'])) {
119 $errors['newfile'] = get_string('required');
d1b7e03d
TH
120 return $errors;
121 }
f7c1dfaf
TH
122
123 $files = $this->get_draft_files('newfile');
c7ac83ca 124 if (!is_array($files) || count($files) < 1) {
f7c1dfaf
TH
125 $errors['newfile'] = get_string('required');
126 return $errors;
d1b7e03d 127 }
f7c1dfaf 128
4c2fcbfc
MG
129 if (empty($data['format'])) {
130 $errors['format'] = get_string('required');
131 return $errors;
132 }
133
f7c1dfaf
TH
134 $formatfile = 'format/' . $data['format'] . '/format.php';
135 if (!is_readable($formatfile)) {
5e8a85aa 136 throw new moodle_exception('formatnotfound', 'question', '', $data['format']);
f7c1dfaf
TH
137 }
138
139 require_once($formatfile);
140
141 $classname = 'qformat_' . $data['format'];
142 $qformat = new $classname();
143
144 $file = reset($files);
7da7bfa1 145 if (!$qformat->can_import_file($file)) {
f7c1dfaf
TH
146 $a = new stdClass();
147 $a->actualtype = $file->get_mimetype();
148 $a->expectedtype = $qformat->mime_type();
149 $errors['newfile'] = get_string('importwrongfiletype', 'question', $a);
d1b7e03d 150 }
f7c1dfaf 151
d1b7e03d
TH
152 return $errors;
153 }
aeb15530 154
f7c1dfaf
TH
155 public function validation($data, $files) {
156 $errors = parent::validation($data, $files);
157 $errors = $this->validate_uploaded_file($data, $errors);
158 return $errors;
159 }
160}