7ec15b11af12dfdc8b2bd028c4bd370135d3246a
[moodle.git] / question / format.php
1 <?php
2 /**
3  * Base class for question import and export formats.
4  *
5  * @author Martin Dougiamas, Howard Miller, and many others.
6  *         {@link http://moodle.org}
7  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
8  * @package questionbank
9  * @subpackage importexport
10  */
11 class qformat_default {
13     public $displayerrors = true;
14     public $category = NULL;
15     public $questions = array();
16     public $course = NULL;
17     public $filename = '';
18     public $realfilename = '';
19     public $matchgrades = 'error';
20     public $catfromfile = 0;
21     public $contextfromfile = 0;
22     public $cattofile = 0;
23     public $contexttofile = 0;
24     public $questionids = array();
25     public $importerrors = 0;
26     public $stoponerror = true;
27     public $translator = null;
28     public $canaccessbackupdata = true;
30     protected $importcontext = null;
32 // functions to indicate import/export functionality
33 // override to return true if implemented
35     /** @return boolean whether this plugin provides import functionality. */
36     function provide_import() {
37         return false;
38     }
40     /** @return boolean whether this plugin provides export functionality. */
41     function provide_export() {
42         return false;
43     }
45     /** The string mime-type of the files that this plugin reads or writes. */
46     function mime_type() {
47         return mimeinfo('type', $this->export_file_extension());
48     }
50     /**
51      * @return string the file extension (including .) that is normally used for
52      * files handled by this plugin.
53      */
54     function export_file_extension() {
55         return '.txt';
56     }
58 // Accessor methods
60     /**
61      * set the category
62      * @param object category the category object
63      */
64     function setCategory($category) {
65         if (count($this->questions)) {
66             debugging('You shouldn\'t call setCategory after setQuestions');
67         }
68         $this->category = $category;
69     }
71     /**
72      * Set the specific questions to export. Should not include questions with
73      * parents (sub questions of cloze question type).
74      * Only used for question export.
75      * @param array of question objects
76      */
77     function setQuestions($questions) {
78         if ($this->category !== null) {
79             debugging('You shouldn\'t call setQuestions after setCategory');
80         }
81         $this->questions = $questions;
82     }
84     /**
85      * set the course class variable
86      * @param course object Moodle course variable
87      */
88     function setCourse($course) {
89         $this->course = $course;
90     }
92     /**
93      * set an array of contexts.
94      * @param array $contexts Moodle course variable
95      */
96     function setContexts($contexts) {
97         $this->contexts = $contexts;
98         $this->translator = new context_to_string_translator($this->contexts);
99     }
101     /**
102      * set the filename
103      * @param string filename name of file to import/export
104      */
105     function setFilename($filename) {
106         $this->filename = $filename;
107     }
109     /**
110      * set the "real" filename
111      * (this is what the user typed, regardless of wha happened next)
112      * @param string realfilename name of file as typed by user
113      */
114     function setRealfilename($realfilename) {
115         $this->realfilename = $realfilename;
116     }
118     /**
119      * set matchgrades
120      * @param string matchgrades error or nearest for grades
121      */
122     function setMatchgrades($matchgrades) {
123         $this->matchgrades = $matchgrades;
124     }
126     /**
127      * set catfromfile
128      * @param bool catfromfile allow categories embedded in import file
129      */
130     function setCatfromfile($catfromfile) {
131         $this->catfromfile = $catfromfile;
132     }
134     /**
135      * set contextfromfile
136      * @param bool $contextfromfile allow contexts embedded in import file
137      */
138     function setContextfromfile($contextfromfile) {
139         $this->contextfromfile = $contextfromfile;
140     }
142     /**
143      * set cattofile
144      * @param bool cattofile exports categories within export file
145      */
146     function setCattofile($cattofile) {
147         $this->cattofile = $cattofile;
148     }
150     /**
151      * set contexttofile
152      * @param bool cattofile exports categories within export file
153      */
154     function setContexttofile($contexttofile) {
155         $this->contexttofile = $contexttofile;
156     }
158     /**
159      * set stoponerror
160      * @param bool stoponerror stops database write if any errors reported
161      */
162     function setStoponerror($stoponerror) {
163         $this->stoponerror = $stoponerror;
164     }
166     /**
167      * @param boolean $canaccess Whether the current use can access the backup data folder. Determines
168      * where export files are saved.
169      */
170     function set_can_access_backupdata($canaccess) {
171         $this->canaccessbackupdata = $canaccess;
172     }
174 /***********************
175  * IMPORTING FUNCTIONS
176  ***********************/
178     /**
179      * Handle parsing error
180      */
181     function error($message, $text='', $questionname='') {
182         $importerrorquestion = get_string('importerrorquestion','quiz');
184         echo "<div class=\"importerror\">\n";
185         echo "<strong>$importerrorquestion $questionname</strong>";
186         if (!empty($text)) {
187             $text = s($text);
188             echo "<blockquote>$text</blockquote>\n";
189         }
190         echo "<strong>$message</strong>\n";
191         echo "</div>";
193          $this->importerrors++;
194     }
196     /**
197      * Import for questiontype plugins
198      * Do not override.
199      * @param data mixed The segment of data containing the question
200      * @param question object processed (so far) by standard import code if appropriate
201      * @param extra mixed any additional format specific data that may be passed by the format
202      * @param qtypehint hint about a question type from format
203      * @return object question object suitable for save_options() or false if cannot handle
204      */
205     function try_importing_using_qtypes($data, $question = null, $extra = null,
206             $qtypehint = '') {
208         // work out what format we are using
209         $formatname = substr(get_class($this), strlen('qformat_'));
210         $methodname = "import_from_$formatname";
212         //first try importing using a hint from format
213         if (!empty($qtypehint)) {
214             $qtype = question_bank::get_qtype($qtypehint, false);
215             if (is_object($qtype) && method_exists($qtype, $methodname)) {
216                 $question = $qtype->$methodname($data, $question, $this, $extra);
217                 if ($question) {
218                     return $question;
219                 }
220             }
221         }
223         // loop through installed questiontypes checking for
224         // function to handle this question
225         foreach (question_bank::get_all_qtypes() as $qtype) {
226             if (method_exists($qtype, $methodname)) {
227                 if ($question = $qtype->$methodname($data, $question, $this, $extra)) {
228                     return $question;
229                 }
230             }
231         }
232         return false;
233     }
235     /**
236      * Perform any required pre-processing
237      * @return boolean success
238      */
239     function importpreprocess() {
240         return true;
241     }
243     /**
244      * Process the file
245      * This method should not normally be overidden
246      * @param object $category
247      * @return boolean success
248      */
249     function importprocess($category) {
250         global $USER, $CFG, $DB, $OUTPUT, $QTYPES;
252         $context = $category->context;
253         $this->importcontext = $context;
255         // reset the timer in case file upload was slow
256         set_time_limit(0);
258         // STAGE 1: Parse the file
259         echo $OUTPUT->notification(get_string('parsingquestions','quiz'));
261         if (! $lines = $this->readdata($this->filename)) {
262             echo $OUTPUT->notification(get_string('cannotread','quiz'));
263             return false;
264         }
266         if (!$questions = $this->readquestions($lines, $context)) {   // Extract all the questions
267             echo $OUTPUT->notification(get_string('noquestionsinfile','quiz'));
268             return false;
269         }
271         // STAGE 2: Write data to database
272         echo $OUTPUT->notification(get_string('importingquestions','quiz',$this->count_questions($questions)));
274         // check for errors before we continue
275         if ($this->stoponerror and ($this->importerrors>0)) {
276             echo $OUTPUT->notification(get_string('importparseerror','quiz'));
277             return true;
278         }
280         // get list of valid answer grades
281         $grades = get_grade_options();
282         $gradeoptionsfull = $grades->gradeoptionsfull;
284         // check answer grades are valid
285         // (now need to do this here because of 'stop on error': MDL-10689)
286         $gradeerrors = 0;
287         $goodquestions = array();
288         foreach ($questions as $question) {
289             if (!empty($question->fraction) and (is_array($question->fraction))) {
290                 $fractions = $question->fraction;
291                 $answersvalid = true; // in case they are!
292                 foreach ($fractions as $key => $fraction) {
293                     $newfraction = match_grade_options($gradeoptionsfull, $fraction, $this->matchgrades);
294                     if ($newfraction===false) {
295                         $answersvalid = false;
296                     }
297                     else {
298                         $fractions[$key] = $newfraction;
299                     }
300                 }
301                 if (!$answersvalid) {
302                     echo $OUTPUT->notification(get_string('matcherror', 'quiz'));
303                     ++$gradeerrors;
304                     continue;
305                 }
306                 else {
307                     $question->fraction = $fractions;
308                 }
309             }
310             $goodquestions[] = $question;
311         }
312         $questions = $goodquestions;
314         // check for errors before we continue
315         if ($this->stoponerror and ($gradeerrors>0)) {
316             return false;
317         }
319         // count number of questions processed
320         $count = 0;
322         foreach ($questions as $question) {   // Process and store each question
324             // reset the php timeout
325             set_time_limit(0);
327             // check for category modifiers
328             if ($question->qtype == 'category') {
329                 if ($this->catfromfile) {
330                     // find/create category object
331                     $catpath = $question->category;
332                     $newcategory = $this->create_category_path($catpath);
333                     if (!empty($newcategory)) {
334                         $this->category = $newcategory;
335                     }
336                 }
337                 continue;
338             }
339             $question->context = $context;
341             $count++;
343             echo "<hr /><p><b>$count</b>. ".$this->format_question_text($question)."</p>";
345             $question->category = $this->category->id;
346             $question->stamp = make_unique_id_code();  // Set the unique code (not to be changed)
348             $question->createdby = $USER->id;
349             $question->timecreated = time();
351             $question->id = $DB->insert_record('question', $question);
352             if (isset($question->questiontextfiles)) {
353                 foreach ($question->questiontextfiles as $file) {
354                     $QTYPES[$question->qtype]->import_file($context, 'question', 'questiontext', $question->id, $file);
355                 }
356             }
357             if (isset($question->generalfeedbackfiles)) {
358                 foreach ($question->generalfeedbackfiles as $file) {
359                     $QTYPES[$question->qtype]->import_file($context, 'question', 'generalfeedback', $question->id, $file);
360                 }
361             }
363             $this->questionids[] = $question->id;
365             // Now to save all the answers and type-specific options
367             $result = $QTYPES[$question->qtype]->save_question_options($question);
369             if (!empty($CFG->usetags) && isset($question->tags)) {
370                 require_once($CFG->dirroot . '/tag/lib.php');
371                 tag_set('question', $question->id, $question->tags);
372             }
374             if (!empty($result->error)) {
375                 echo $OUTPUT->notification($result->error);
376                 return false;
377             }
379             if (!empty($result->notice)) {
380                 echo $OUTPUT->notification($result->notice);
381                 return true;
382             }
384             // Give the question a unique version stamp determined by question_hash()
385             $DB->set_field('question', 'version', question_hash($question), array('id'=>$question->id));
386         }
387         return true;
388     }
390     /**
391      * Count all non-category questions in the questions array.
392      *
393      * @param array questions An array of question objects.
394      * @return int The count.
395      *
396      */
397     function count_questions($questions) {
398         $count = 0;
399         if (!is_array($questions)) {
400             return $count;
401         }
402         foreach ($questions as $question) {
403             if (!is_object($question) || !isset($question->qtype) || ($question->qtype == 'category')) {
404                 continue;
405             }
406             $count++;
407         }
408         return $count;
409     }
411     /**
412      * find and/or create the category described by a delimited list
413      * e.g. $course$/tom/dick/harry or tom/dick/harry
414      *
415      * removes any context string no matter whether $getcontext is set
416      * but if $getcontext is set then ignore the context and use selected category context.
417      *
418      * @param string catpath delimited category path
419      * @param int courseid course to search for categories
420      * @return mixed category object or null if fails
421      */
422     function create_category_path($catpath) {
423         global $DB;
424         $catnames = $this->split_category_path($catpath);
425         $parent = 0;
426         $category = null;
428         // check for context id in path, it might not be there in pre 1.9 exports
429         $matchcount = preg_match('/^\$([a-z]+)\$$/', $catnames[0], $matches);
430         if ($matchcount == 1) {
431             $contextid = $this->translator->string_to_context($matches[1]);
432             array_shift($catnames);
433         } else {
434             $contextid = false;
435         }
437         if ($this->contextfromfile && $contextid !== false) {
438             $context = get_context_instance_by_id($contextid);
439             require_capability('moodle/question:add', $context);
440         } else {
441             $context = get_context_instance_by_id($this->category->contextid);
442         }
444         // Now create any categories that need to be created.
445         foreach ($catnames as $catname) {
446             if ($category = $DB->get_record('question_categories', array('name' => $catname, 'contextid' => $context->id, 'parent' => $parent))) {
447                 $parent = $category->id;
448             } else {
449                 require_capability('moodle/question:managecategory', $context);
450                 // create the new category
451                 $category = new stdClass();
452                 $category->contextid = $context->id;
453                 $category->name = $catname;
454                 $category->info = '';
455                 $category->parent = $parent;
456                 $category->sortorder = 999;
457                 $category->stamp = make_unique_id_code();
458                 $id = $DB->insert_record('question_categories', $category);
459                 $category->id = $id;
460                 $parent = $id;
461             }
462         }
463         return $category;
464     }
466     /**
467      * Return complete file within an array, one item per line
468      * @param string filename name of file
469      * @return mixed contents array or false on failure
470      */
471     function readdata($filename) {
472         if (is_readable($filename)) {
473             $filearray = file($filename);
475             /// Check for Macintosh OS line returns (ie file on one line), and fix
476             if (preg_match("~\r~", $filearray[0]) AND !preg_match("~\n~", $filearray[0])) {
477                 return explode("\r", $filearray[0]);
478             } else {
479                 return $filearray;
480             }
481         }
482         return false;
483     }
485     /**
486      * Parses an array of lines into an array of questions,
487      * where each item is a question object as defined by
488      * readquestion().   Questions are defined as anything
489      * between blank lines.
490      *
491      * If your format does not use blank lines as a delimiter
492      * then you will need to override this method. Even then
493      * try to use readquestion for each question
494      * @param array lines array of lines from readdata
495      * @param object $context
496      * @return array array of question objects
497      */
498     function readquestions($lines, $context) {
500         $questions = array();
501         $currentquestion = array();
503         foreach ($lines as $line) {
504             $line = trim($line);
505             if (empty($line)) {
506                 if (!empty($currentquestion)) {
507                     if ($question = $this->readquestion($currentquestion)) {
508                         $questions[] = $question;
509                     }
510                     $currentquestion = array();
511                 }
512             } else {
513                 $currentquestion[] = $line;
514             }
515         }
517         if (!empty($currentquestion)) {  // There may be a final question
518             if ($question = $this->readquestion($currentquestion, $context)) {
519                 $questions[] = $question;
520             }
521         }
523         return $questions;
524     }
526     /**
527      * return an "empty" question
528      * Somewhere to specify question parameters that are not handled
529      * by import but are required db fields.
530      * This should not be overridden.
531      * @return object default question
532      */
533     function defaultquestion() {
534         global $CFG;
535         static $defaultshuffleanswers = null;
536         if (is_null($defaultshuffleanswers)) {
537             $defaultshuffleanswers = get_config('quiz', 'shuffleanswers');
538         }
540         $question = new stdClass();
541         $question->shuffleanswers = $defaultshuffleanswers;
542         $question->defaultmark = 1;
543         $question->image = "";
544         $question->usecase = 0;
545         $question->multiplier = array();
546         $question->generalfeedback = '';
547         $question->correctfeedback = '';
548         $question->partiallycorrectfeedback = '';
549         $question->incorrectfeedback = '';
550         $question->answernumbering = 'abc';
551         $question->penalty = 0.3333333;
552         $question->length = 1;
554         // this option in case the questiontypes class wants
555         // to know where the data came from
556         $question->export_process = true;
557         $question->import_process = true;
559         return $question;
560     }
562     /**
563      * Given the data known to define a question in
564      * this format, this function converts it into a question
565      * object suitable for processing and insertion into Moodle.
566      *
567      * If your format does not use blank lines to delimit questions
568      * (e.g. an XML format) you must override 'readquestions' too
569      * @param $lines mixed data that represents question
570      * @return object question object
571      */
572     function readquestion($lines) {
574         $formatnotimplemented = get_string('formatnotimplemented','quiz');
575         echo "<p>$formatnotimplemented</p>";
577         return NULL;
578     }
580     /**
581      * Override if any post-processing is required
582      * @return boolean success
583      */
584     function importpostprocess() {
585         return true;
586     }
589 /*******************
590  * EXPORT FUNCTIONS
591  *******************/
593     /**
594      * Provide export functionality for plugin questiontypes
595      * Do not override
596      * @param name questiontype name
597      * @param question object data to export
598      * @param extra mixed any addition format specific data needed
599      * @return string the data to append to export or false if error (or unhandled)
600      */
601     function try_exporting_using_qtypes($name, $question, $extra=null) {
602         global $QTYPES;
604         // work out the name of format in use
605         $formatname = substr(get_class($this), strlen('qformat_'));
606         $methodname = "export_to_$formatname";
608         if (array_key_exists($name, $QTYPES)) {
609             $qtype = $QTYPES[ $name ];
610             if (method_exists($qtype, $methodname)) {
611                 if ($data = $qtype->$methodname($question, $this, $extra)) {
612                     return $data;
613                 }
614             }
615         }
616         return false;
617     }
619     /**
620      * Do any pre-processing that may be required
621      * @param boolean success
622      */
623     function exportpreprocess() {
624         return true;
625     }
627     /**
628      * Enable any processing to be done on the content
629      * just prior to the file being saved
630      * default is to do nothing
631      * @param string output text
632      * @param string processed output text
633      */
634     function presave_process($content) {
635         return $content;
636     }
638     /**
639      * Do the export
640      * For most types this should not need to be overrided
641      * @return stored_file
642      */
643     function exportprocess() {
644         global $CFG, $OUTPUT, $DB, $USER;
646         // get the questions (from database) in this category
647         // only get q's with no parents (no cloze subquestions specifically)
648         if ($this->category) {
649             $questions = get_questions_category($this->category, true);
650         } else {
651             $questions = $this->questions;
652         }
654         $count = 0;
656         // results are first written into string (and then to a file)
657         // so create/initialize the string here
658         $expout = "";
660         // track which category questions are in
661         // if it changes we will record the category change in the output
662         // file if selected. 0 means that it will get printed before the 1st question
663         $trackcategory = 0;
665         // iterate through questions
666         foreach($questions as $question) {
667             // used by file api
668             $contextid = $DB->get_field('question_categories', 'contextid', array('id'=>$question->category));
669             $question->contextid = $contextid;
671             // do not export hidden questions
672             if (!empty($question->hidden)) {
673                 continue;
674             }
676             // do not export random questions
677             if ($question->qtype==RANDOM) {
678                 continue;
679             }
681             // check if we need to record category change
682             if ($this->cattofile) {
683                 if ($question->category != $trackcategory) {
684                     $trackcategory = $question->category;
685                     $categoryname = $this->get_category_path($trackcategory, $this->contexttofile);
687                     // create 'dummy' question for category export
688                     $dummyquestion = new stdClass();
689                     $dummyquestion->qtype = 'category';
690                     $dummyquestion->category = $categoryname;
691                     $dummyquestion->name = 'Switch category to ' . $categoryname;
692                     $dummyquestion->id = 0;
693                     $dummyquestion->questiontextformat = '';
694                     $dummyquestion->contextid = 0;
695                     $expout .= $this->writequestion($dummyquestion) . "\n";
696                 }
697             }
699             // export the question displaying message
700             $count++;
702             if (question_has_capability_on($question, 'view', $question->category)) {
703                 $expout .= $this->writequestion($question, $contextid) . "\n";
704             }
705         }
707         // continue path for following error checks
708         $course = $this->course;
709         $continuepath = "$CFG->wwwroot/question/export.php?courseid=$course->id";
711         // did we actually process anything
712         if ($count==0) {
713             print_error('noquestions', 'quiz', $continuepath);
714         }
716         // final pre-process on exported data
717         $expout = $this->presave_process($expout);
718         return $expout;
719     }
721     /**
722      * get the category as a path (e.g., tom/dick/harry)
723      * @param int id the id of the most nested catgory
724      * @return string the path
725      */
726     function get_category_path($id, $includecontext = true) {
727         global $DB;
729         if (!$category = $DB->get_record('question_categories',array('id' =>$id))) {
730             print_error('cannotfindcategory', 'error', '', $id);
731         }
732         $contextstring = $this->translator->context_to_string($category->contextid);
734         $pathsections = array();
735         do {
736             $pathsections[] = $category->name;
737             $id = $category->parent;
738         } while ($category = $DB->get_record('question_categories', array('id' => $id)));
740         if ($includecontext) {
741             $pathsections[] = '$' . $contextstring . '$';
742         }
744         $path = $this->assemble_category_path(array_reverse($pathsections));
746         return $path;
747     }
749     /**
750      * Convert a list of category names, possibly preceeded by one of the
751      * context tokens like $course$, into a string representation of the
752      * category path.
753      *
754      * Names are separated by / delimiters. And /s in the name are replaced by //.
755      *
756      * To reverse the process and split the paths into names, use
757      * {@link split_category_path()}.
758      *
759      * @param array $names
760      * @return string
761      */
762     protected function assemble_category_path($names) {
763         $escapednames = array();
764         foreach ($names as $name) {
765             $escapedname = str_replace('/', '//', $name);
766             if (substr($escapedname, 0, 1) == '/') {
767                 $escapedname = ' ' . $escapedname;
768             }
769             if (substr($escapedname, -1) == '/') {
770                 $escapedname = $escapedname . ' ';
771             }
772             $escapednames[] = $escapedname;
773         }
774         return implode('/', $escapednames);
775     }
777     /**
778      * Convert a string, as returned by {@link assemble_category_path()},
779      * back into an array of category names.
780      *
781      * Each category name is cleaned by a call to clean_param(, PARAM_MULTILANG),
782      * which matches the cleaning in question/category_form.php.
783      *
784      * @param string $path
785      * @return array of category names.
786      */
787     protected function split_category_path($path) {
788         $rawnames = preg_split('~(?<!/)/(?!/)~', $path);
789         $names = array();
790         foreach ($rawnames as $rawname) {
791             $names[] = clean_param(trim(str_replace('//', '/', $rawname)), PARAM_MULTILANG);
792         }
793         return $names;
794     }
796     /**
797      * Do an post-processing that may be required
798      * @return boolean success
799      */
800     function exportpostprocess() {
801         return true;
802     }
804     /**
805      * convert a single question object into text output in the given
806      * format.
807      * This must be overriden
808      * @param object question question object
809      * @return mixed question export text or null if not implemented
810      */
811     function writequestion($question) {
812         // if not overidden, then this is an error.
813         $formatnotimplemented = get_string('formatnotimplemented','quiz');
814         echo "<p>$formatnotimplemented</p>";
815         return NULL;
816     }
818     /**
819      * get directory into which export is going
820      * @return string file path
821      */
822     function question_get_export_dir() {
823         global $USER;
824         if ($this->canaccessbackupdata) {
825             $dirname = get_string("exportfilename","quiz");
826             $path = $this->course->id.'/backupdata/'.$dirname; // backupdata is protected directory
827         } else {
828             $path = 'temp/questionexport/' . $USER->id;
829         }
830         return $path;
831     }
833     /**
834      * Convert the question text to plain text, so it can safely be displayed
835      * during import to let the user see roughly what is going on.
836      */
837     function format_question_text($question) {
838         global $DB;
839         $formatoptions = new stdClass;
840         $formatoptions->noclean = true;
841         $formatoptions->para = false;
842         if (empty($question->questiontextformat)) {
843             $format = FORMAT_MOODLE;
844         } else {
845             $format = $question->questiontextformat;
846         }
847         $text = $question->questiontext;
848         return format_text(html_to_text($text, 0, false), $format, $formatoptions);
849     }
851     /**
852      * convert files into text output in the given format.
853      * @param array
854      * @param string encoding method
855      * @return string $string
856      */
857     function writefiles($files, $encoding='base64') {
858         if (empty($files)) {
859             return '';
860         }
861         $string = '';
862         foreach ($files as $file) {
863             if ($file->is_directory()) {
864                 continue;
865             }
866             $string .= '<file name="' . $file->get_filename() . '" encoding="' . $encoding . '">';
867             $string .= base64_encode($file->get_content());
868             $string .= '</file>';
869         }
870         return $string;
871     }