weekly release 2.3dev
[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() {
515ed4c3 41 global $COURSE;
f7c1dfaf 42 $mform = $this->_form;
515ed4c3 43
f7c1dfaf
TH
44 $defaultcategory = $this->_customdata['defaultcategory'];
45 $contexts = $this->_customdata['contexts'];
46
47 // Choice of import format, with help icons.
48 $mform->addElement('header', 'fileformat', get_string('fileformat', 'question'));
45b68eef 49
45b68eef 50 $fileformatnames = get_import_export_formats('import');
f7c1dfaf 51 $radioarray = array();
a387e8ac 52 $i = 0 ;
f94902db 53 foreach ($fileformatnames as $shortname => $fileformatname) {
a387e8ac 54 $currentgrp1 = array();
f7c1dfaf 55 $currentgrp1[] = $mform->createElement('radio', 'format', '', $fileformatname, $shortname);
64679179
TH
56 $mform->addGroup($currentgrp1, "formathelp[$i]", '&#160;', array('<br />'), false);
57
58 if (get_string_manager()->string_exists('pluginname_help', 'qformat_' . $shortname)) {
59 $mform->addHelpButton("formathelp[$i]", 'pluginname', 'qformat_' . $shortname);
60 }
61
a387e8ac 62 $i++ ;
45b68eef 63 }
f7c1dfaf
TH
64 $mform->addRule("formathelp[0]", null, 'required', null, 'client');
65
66 // Import options.
515ed4c3 67 $mform->addElement('header','general', get_string('general', 'form'));
68
5fcefc97 69 $mform->addElement('questioncategory', 'category', get_string('importcategory', 'question'), compact('contexts'));
515ed4c3 70 $mform->setDefault('category', $defaultcategory);
5fcefc97 71 $mform->addHelpButton('category', 'importcategory', 'question');
515ed4c3 72
73 $categorygroup = array();
f7c1dfaf
TH
74 $categorygroup[] = $mform->createElement('checkbox', 'catfromfile', '', get_string('getcategoryfromfile', 'question'));
75 $categorygroup[] = $mform->createElement('checkbox', 'contextfromfile', '', get_string('getcontextfromfile', 'question'));
515ed4c3 76 $mform->addGroup($categorygroup, 'categorygroup', '', '', false);
77 $mform->disabledIf('categorygroup', 'catfromfile', 'notchecked');
78 $mform->setDefault('catfromfile', 1);
79 $mform->setDefault('contextfromfile', 1);
80
515ed4c3 81 $matchgrades = array();
f7c1dfaf
TH
82 $matchgrades['error'] = get_string('matchgradeserror', 'question');
83 $matchgrades['nearest'] = get_string('matchgradesnearest', 'question');
5fcefc97
DM
84 $mform->addElement('select', 'matchgrades', get_string('matchgrades', 'question'), $matchgrades);
85 $mform->addHelpButton('matchgrades', 'matchgrades', 'question');
515ed4c3 86 $mform->setDefault('matchgrades', 'error');
87
5fcefc97 88 $mform->addElement('selectyesno', 'stoponerror', get_string('stoponerror', 'question'));
515ed4c3 89 $mform->setDefault('stoponerror', 1);
5fcefc97 90 $mform->addHelpButton('stoponerror', 'stoponerror', 'question');
15b83581 91
f7c1dfaf
TH
92 // The file to import
93 $mform->addElement('header', 'importfileupload', get_string('importquestions', 'question'));
94
95 $mform->addElement('filepicker', 'newfile', get_string('import'));
96 $mform->addRule('newfile', null, 'required', null, 'client');
97
98 // Submit button.
99 $mform->addElement('submit', 'submitbutton', get_string('import'));
100
101 // Set a template for the format select elements
102 $renderer = $mform->defaultRenderer();
79e3dd8e 103 $template = "{help} {element}\n";
104 $renderer->setGroupElementTemplate($template, 'format');
515ed4c3 105 }
d1b7e03d 106
f7c1dfaf
TH
107 /**
108 * Checks that a file has been uploaded, and that it is of a plausible type.
109 * @param array $data the submitted data.
110 * @param array $errors the errors so far.
111 * @return array the updated errors.
112 */
113 protected function validate_uploaded_file($data, $errors) {
114 if (empty($data['newfile'])) {
115 $errors['newfile'] = get_string('required');
d1b7e03d
TH
116 return $errors;
117 }
f7c1dfaf
TH
118
119 $files = $this->get_draft_files('newfile');
120 if (count($files) < 1) {
121 $errors['newfile'] = get_string('required');
122 return $errors;
d1b7e03d 123 }
f7c1dfaf
TH
124
125 $formatfile = 'format/' . $data['format'] . '/format.php';
126 if (!is_readable($formatfile)) {
5e8a85aa 127 throw new moodle_exception('formatnotfound', 'question', '', $data['format']);
f7c1dfaf
TH
128 }
129
130 require_once($formatfile);
131
132 $classname = 'qformat_' . $data['format'];
133 $qformat = new $classname();
134
135 $file = reset($files);
136 if ($file->get_mimetype() != $qformat->mime_type()) {
137 $a = new stdClass();
138 $a->actualtype = $file->get_mimetype();
139 $a->expectedtype = $qformat->mime_type();
140 $errors['newfile'] = get_string('importwrongfiletype', 'question', $a);
d1b7e03d 141 }
f7c1dfaf 142
d1b7e03d
TH
143 return $errors;
144 }
aeb15530 145
f7c1dfaf
TH
146 public function validation($data, $files) {
147 $errors = parent::validation($data, $files);
148 $errors = $this->validate_uploaded_file($data, $errors);
149 return $errors;
150 }
151}