MDL-20636 Finish off converting question import.
[moodle.git] / question / import_form.php
index 30408a6..7ed0097 100644 (file)
@@ -1,33 +1,68 @@
 <?php
 
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Defines the import questions form.
+ *
+ * @package    moodlecore
+ * @subpackage questionbank
+ * @copyright  2007 Jamie Pratt me@jamiep.org
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
 if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
 }
 
-require_once($CFG->libdir.'/formslib.php');
+require_once($CFG->libdir . '/formslib.php');
+
 
+/**
+ * Form to import questions into the question bank.
+ *
+ * @copyright  2007 Jamie Pratt me@jamiep.org
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 class question_import_form extends moodleform {
 
     function definition() {
         global $COURSE;
-        $mform    =& $this->_form;
+        $mform = $this->_form;
 
-        $defaultcategory   = $this->_customdata['defaultcategory'];
-        $contexts   = $this->_customdata['contexts'];
+        $defaultcategory = $this->_customdata['defaultcategory'];
+        $contexts = $this->_customdata['contexts'];
+
+        // Choice of import format, with help icons.
+        $mform->addElement('header', 'fileformat', get_string('fileformat', 'question'));
 
-//--------------------------------------------------------------------------------
-        $mform->addElement('header','fileformat', get_string('fileformat','quiz'));
         $fileformatnames = get_import_export_formats('import');
+        $radioarray = array();
         $i = 0 ;
         foreach ($fileformatnames as $shortname => $fileformatname) {
             $currentgrp1 = array();
-            $currentgrp1[] = &$mform->createElement('radio','format','',$fileformatname,$shortname);
-            $mform->addGroup($currentgrp1,"formathelp[$i]",'',array('<br />'),false);
-            $mform->addHelpButton("formathelp[$i]", $shortname, 'qformat_'.$shortname);
+            $currentgrp1[] = $mform->createElement('radio', 'format', '', $fileformatname, $shortname);
+            $mform->addGroup($currentgrp1, "formathelp[$i]", '', array('<br />'), false);
+            $mform->addHelpButton("formathelp[$i]", $shortname, 'qformat_' . $shortname);
             $i++ ;
         }
-        $mform->addRule("formathelp[0]", null, 'required', null, 'client' );
-//--------------------------------------------------------------------------------
+        $mform->addRule("formathelp[0]", null, 'required', null, 'client');
+
+        // Import options.
         $mform->addElement('header','general', get_string('general', 'form'));
 
         $mform->addElement('questioncategory', 'category', get_string('importcategory', 'question'), compact('contexts'));
@@ -35,17 +70,16 @@ class question_import_form extends moodleform {
         $mform->addHelpButton('category', 'importcategory', 'question');
 
         $categorygroup = array();
-        $categorygroup[] =& $mform->createElement('checkbox', 'catfromfile', '', get_string('getcategoryfromfile', 'question'));
-        $categorygroup[] =& $mform->createElement('checkbox', 'contextfromfile', '', get_string('getcontextfromfile', 'question'));
+        $categorygroup[] = $mform->createElement('checkbox', 'catfromfile', '', get_string('getcategoryfromfile', 'question'));
+        $categorygroup[] = $mform->createElement('checkbox', 'contextfromfile', '', get_string('getcontextfromfile', 'question'));
         $mform->addGroup($categorygroup, 'categorygroup', '', '', false);
         $mform->disabledIf('categorygroup', 'catfromfile', 'notchecked');
         $mform->setDefault('catfromfile', 1);
         $mform->setDefault('contextfromfile', 1);
 
-
         $matchgrades = array();
-        $matchgrades['error'] = get_string('matchgradeserror','quiz');
-        $matchgrades['nearest'] = get_string('matchgradesnearest','quiz');
+        $matchgrades['error'] = get_string('matchgradeserror', 'question');
+        $matchgrades['nearest'] = get_string('matchgradesnearest', 'question');
         $mform->addElement('select', 'matchgrades', get_string('matchgrades', 'question'), $matchgrades);
         $mform->addHelpButton('matchgrades', 'matchgrades', 'question');
         $mform->setDefault('matchgrades', 'error');
@@ -54,47 +88,63 @@ class question_import_form extends moodleform {
         $mform->setDefault('stoponerror', 1);
         $mform->addHelpButton('stoponerror', 'stoponerror', 'question');
 
-//--------------------------------------------------------------------------------
-        $mform->addElement('header', 'importfileupload', get_string('importfromthisfile','quiz'));
-
-        $mform->addElement('filepicker', 'newfile', get_string('import', 'quiz'));
-//--------------------------------------------------------------------------------
-        $mform->addElement('submit', 'submitbutton', get_string('import', 'quiz'));
-
-//--------------------------------------------------------------------------------
-        //if (has_capability('moodle/course:managefiles', get_context_instance(CONTEXT_COURSE, $COURSE->id))){
-            //$mform->addElement('header', 'importfilearea', get_string('importfilearea','quiz'));
-            //TODO: MDL-16094
-            //$mform->addElement('choosecoursefile', 'choosefile', get_string('choosefile','quiz'));
-//--------------------------------------------------------------------------------
-            //$mform->addElement('submit', 'submitbutton', get_string('importfromthisfile','quiz'));
-        //}
-//--------------------------------------------------------------------------------
-        $mform->addElement('static', 'dummy', '');
-        $mform->closeHeaderBefore('dummy');
-
-        // set a template for the format select elements
-        $renderer =& $mform->defaultRenderer();
+        // The file to import
+        $mform->addElement('header', 'importfileupload', get_string('importquestions', 'question'));
+
+        $mform->addElement('filepicker', 'newfile', get_string('import'));
+        $mform->addRule('newfile', null, 'required', null, 'client');
+
+        // Submit button.
+        $mform->addElement('submit', 'submitbutton', get_string('import'));
+
+        // Set a template for the format select elements
+        $renderer = $mform->defaultRenderer();
         $template = "{help} {element}\n";
         $renderer->setGroupElementTemplate($template, 'format');
     }
 
-    public function validation($data, $files){
-        $errors = parent::validation($data, $files);
-        return $errors; // TODO.
-        // If a file is uploaded return
-        if ($data['choosefile'] || $files['newfile']) {
+    /**
+     * Checks that a file has been uploaded, and that it is of a plausible type.
+     * @param array $data the submitted data.
+     * @param array $errors the errors so far.
+     * @return array the updated errors.
+     */
+    protected function validate_uploaded_file($data, $errors) {
+        if (empty($data['newfile'])) {
+            $errors['newfile'] = get_string('required');
             return $errors;
         }
-        // If file is not uploaded from  file upload
-        if (!$files['newfile']) {
-            $errors['newfile'] = get_string('importfromupload', 'question');
+
+        $files = $this->get_draft_files('newfile');
+        if (count($files) < 1) {
+            $errors['newfile'] = get_string('required');
+            return $errors;
         }
-        // If filke is not imported from course files
-        if (!$data['choosefile'] && !$files['newfile']) {
-            $errors['choosefile'] = get_string('importfromcoursefiles', 'question');
+
+        $formatfile = 'format/' . $data['format'] . '/format.php';
+        if (!is_readable($formatfile)) {
+            throw new moodle_exception('formatnotfound', 'quiz', '', $data['format']);
+        }
+
+        require_once($formatfile);
+
+        $classname = 'qformat_' . $data['format'];
+        $qformat = new $classname();
+
+        $file = reset($files);
+        if ($file->get_mimetype() != $qformat->mime_type()) {
+            $a = new stdClass();
+            $a->actualtype = $file->get_mimetype();
+            $a->expectedtype = $qformat->mime_type();
+            $errors['newfile'] = get_string('importwrongfiletype', 'question', $a);
         }
+
         return $errors;
     }
-}
 
+    public function validation($data, $files) {
+        $errors = parent::validation($data, $files);
+        $errors = $this->validate_uploaded_file($data, $errors);
+        return $errors;
+    }
+}