MDL-36088 questions: Add new events
[moodle.git] / question / format.php
1 <?php
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/>.
17 /**
18  * Defines the base class for question import and export formats.
19  *
20  * @package    moodlecore
21  * @subpackage questionbank
22  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
30 /**
31  * Base class for question import and export formats.
32  *
33  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class qformat_default {
38     public $displayerrors = true;
39     public $category = null;
40     public $questions = array();
41     public $course = null;
42     public $filename = '';
43     public $realfilename = '';
44     public $matchgrades = 'error';
45     public $catfromfile = 0;
46     public $contextfromfile = 0;
47     public $cattofile = 0;
48     public $contexttofile = 0;
49     public $questionids = array();
50     public $importerrors = 0;
51     public $stoponerror = true;
52     public $translator = null;
53     public $canaccessbackupdata = true;
54     protected $importcontext = null;
55     /** @var bool $displayprogress Whether to display progress. */
56     public $displayprogress = true;
58     // functions to indicate import/export functionality
59     // override to return true if implemented
61     /** @return bool whether this plugin provides import functionality. */
62     public function provide_import() {
63         return false;
64     }
66     /** @return bool whether this plugin provides export functionality. */
67     public function provide_export() {
68         return false;
69     }
71     /** The string mime-type of the files that this plugin reads or writes. */
72     public function mime_type() {
73         return mimeinfo('type', $this->export_file_extension());
74     }
76     /**
77      * @return string the file extension (including .) that is normally used for
78      * files handled by this plugin.
79      */
80     public function export_file_extension() {
81         return '.txt';
82     }
84     /**
85      * Check if the given file is capable of being imported by this plugin.
86      *
87      * Note that expensive or detailed integrity checks on the file should
88      * not be performed by this method. Simple file type or magic-number tests
89      * would be suitable.
90      *
91      * @param stored_file $file the file to check
92      * @return bool whether this plugin can import the file
93      */
94     public function can_import_file($file) {
95         return ($file->get_mimetype() == $this->mime_type());
96     }
98     // Accessor methods
100     /**
101      * set the category
102      * @param object category the category object
103      */
104     public function setCategory($category) {
105         if (count($this->questions)) {
106             debugging('You shouldn\'t call setCategory after setQuestions');
107         }
108         $this->category = $category;
109         $this->importcontext = context::instance_by_id($this->category->contextid);
110     }
112     /**
113      * Set the specific questions to export. Should not include questions with
114      * parents (sub questions of cloze question type).
115      * Only used for question export.
116      * @param array of question objects
117      */
118     public function setQuestions($questions) {
119         if ($this->category !== null) {
120             debugging('You shouldn\'t call setQuestions after setCategory');
121         }
122         $this->questions = $questions;
123     }
125     /**
126      * set the course class variable
127      * @param course object Moodle course variable
128      */
129     public function setCourse($course) {
130         $this->course = $course;
131     }
133     /**
134      * set an array of contexts.
135      * @param array $contexts Moodle course variable
136      */
137     public function setContexts($contexts) {
138         $this->contexts = $contexts;
139         $this->translator = new context_to_string_translator($this->contexts);
140     }
142     /**
143      * set the filename
144      * @param string filename name of file to import/export
145      */
146     public function setFilename($filename) {
147         $this->filename = $filename;
148     }
150     /**
151      * set the "real" filename
152      * (this is what the user typed, regardless of wha happened next)
153      * @param string realfilename name of file as typed by user
154      */
155     public function setRealfilename($realfilename) {
156         $this->realfilename = $realfilename;
157     }
159     /**
160      * set matchgrades
161      * @param string matchgrades error or nearest for grades
162      */
163     public function setMatchgrades($matchgrades) {
164         $this->matchgrades = $matchgrades;
165     }
167     /**
168      * set catfromfile
169      * @param bool catfromfile allow categories embedded in import file
170      */
171     public function setCatfromfile($catfromfile) {
172         $this->catfromfile = $catfromfile;
173     }
175     /**
176      * set contextfromfile
177      * @param bool $contextfromfile allow contexts embedded in import file
178      */
179     public function setContextfromfile($contextfromfile) {
180         $this->contextfromfile = $contextfromfile;
181     }
183     /**
184      * set cattofile
185      * @param bool cattofile exports categories within export file
186      */
187     public function setCattofile($cattofile) {
188         $this->cattofile = $cattofile;
189     }
191     /**
192      * set contexttofile
193      * @param bool cattofile exports categories within export file
194      */
195     public function setContexttofile($contexttofile) {
196         $this->contexttofile = $contexttofile;
197     }
199     /**
200      * set stoponerror
201      * @param bool stoponerror stops database write if any errors reported
202      */
203     public function setStoponerror($stoponerror) {
204         $this->stoponerror = $stoponerror;
205     }
207     /**
208      * @param bool $canaccess Whether the current use can access the backup data folder. Determines
209      * where export files are saved.
210      */
211     public function set_can_access_backupdata($canaccess) {
212         $this->canaccessbackupdata = $canaccess;
213     }
215     /**
216      * Change whether to display progress messages.
217      * There is normally no need to use this function as the
218      * default for $displayprogress is true.
219      * Set to false for unit tests.
220      * @param bool $displayprogress
221      */
222     public function set_display_progress($displayprogress) {
223         $this->displayprogress = $displayprogress;
224     }
226     /***********************
227      * IMPORTING FUNCTIONS
228      ***********************/
230     /**
231      * Handle parsing error
232      */
233     protected function error($message, $text='', $questionname='') {
234         $importerrorquestion = get_string('importerrorquestion', 'question');
236         echo "<div class=\"importerror\">\n";
237         echo "<strong>{$importerrorquestion} {$questionname}</strong>";
238         if (!empty($text)) {
239             $text = s($text);
240             echo "<blockquote>{$text}</blockquote>\n";
241         }
242         echo "<strong>{$message}</strong>\n";
243         echo "</div>";
245         $this->importerrors++;
246     }
248     /**
249      * Import for questiontype plugins
250      * Do not override.
251      * @param data mixed The segment of data containing the question
252      * @param question object processed (so far) by standard import code if appropriate
253      * @param extra mixed any additional format specific data that may be passed by the format
254      * @param qtypehint hint about a question type from format
255      * @return object question object suitable for save_options() or false if cannot handle
256      */
257     public function try_importing_using_qtypes($data, $question = null, $extra = null,
258             $qtypehint = '') {
260         // work out what format we are using
261         $formatname = substr(get_class($this), strlen('qformat_'));
262         $methodname = "import_from_{$formatname}";
264         //first try importing using a hint from format
265         if (!empty($qtypehint)) {
266             $qtype = question_bank::get_qtype($qtypehint, false);
267             if (is_object($qtype) && method_exists($qtype, $methodname)) {
268                 $question = $qtype->$methodname($data, $question, $this, $extra);
269                 if ($question) {
270                     return $question;
271                 }
272             }
273         }
275         // loop through installed questiontypes checking for
276         // function to handle this question
277         foreach (question_bank::get_all_qtypes() as $qtype) {
278             if (method_exists($qtype, $methodname)) {
279                 if ($question = $qtype->$methodname($data, $question, $this, $extra)) {
280                     return $question;
281                 }
282             }
283         }
284         return false;
285     }
287     /**
288      * Perform any required pre-processing
289      * @return bool success
290      */
291     public function importpreprocess() {
292         return true;
293     }
295     /**
296      * Process the file
297      * This method should not normally be overidden
298      * @return bool success
299      */
300     public function importprocess() {
301         global $USER, $DB, $OUTPUT;
303         // Raise time and memory, as importing can be quite intensive.
304         core_php_time_limit::raise();
305         raise_memory_limit(MEMORY_EXTRA);
307         // STAGE 1: Parse the file
308         if ($this->displayprogress) {
309             echo $OUTPUT->notification(get_string('parsingquestions', 'question'), 'notifysuccess');
310         }
312         if (! $lines = $this->readdata($this->filename)) {
313             echo $OUTPUT->notification(get_string('cannotread', 'question'));
314             return false;
315         }
317         if (!$questions = $this->readquestions($lines)) {   // Extract all the questions
318             echo $OUTPUT->notification(get_string('noquestionsinfile', 'question'));
319             return false;
320         }
322         // STAGE 2: Write data to database
323         if ($this->displayprogress) {
324             echo $OUTPUT->notification(get_string('importingquestions', 'question',
325                     $this->count_questions($questions)), 'notifysuccess');
326         }
328         // check for errors before we continue
329         if ($this->stoponerror and ($this->importerrors>0)) {
330             echo $OUTPUT->notification(get_string('importparseerror', 'question'));
331             return true;
332         }
334         // get list of valid answer grades
335         $gradeoptionsfull = question_bank::fraction_options_full();
337         // check answer grades are valid
338         // (now need to do this here because of 'stop on error': MDL-10689)
339         $gradeerrors = 0;
340         $goodquestions = array();
341         foreach ($questions as $question) {
342             if (!empty($question->fraction) and (is_array($question->fraction))) {
343                 $fractions = $question->fraction;
344                 $invalidfractions = array();
345                 foreach ($fractions as $key => $fraction) {
346                     $newfraction = match_grade_options($gradeoptionsfull, $fraction,
347                             $this->matchgrades);
348                     if ($newfraction === false) {
349                         $invalidfractions[] = $fraction;
350                     } else {
351                         $fractions[$key] = $newfraction;
352                     }
353                 }
354                 if ($invalidfractions) {
355                     echo $OUTPUT->notification(get_string('invalidgrade', 'question',
356                             implode(', ', $invalidfractions)));
357                     ++$gradeerrors;
358                     continue;
359                 } else {
360                     $question->fraction = $fractions;
361                 }
362             }
363             $goodquestions[] = $question;
364         }
365         $questions = $goodquestions;
367         // check for errors before we continue
368         if ($this->stoponerror && $gradeerrors > 0) {
369             return false;
370         }
372         // count number of questions processed
373         $count = 0;
375         foreach ($questions as $question) {   // Process and store each question
376             $transaction = $DB->start_delegated_transaction();
378             // reset the php timeout
379             core_php_time_limit::raise();
381             // check for category modifiers
382             if ($question->qtype == 'category') {
383                 if ($this->catfromfile) {
384                     // find/create category object
385                     $catpath = $question->category;
386                     $newcategory = $this->create_category_path($catpath, $question);
387                     if (!empty($newcategory)) {
388                         $this->category = $newcategory;
389                     }
390                 }
391                 $transaction->allow_commit();
392                 continue;
393             }
394             $question->context = $this->importcontext;
396             $count++;
398             if ($this->displayprogress) {
399                 echo "<hr /><p><b>{$count}</b>. " . $this->format_question_text($question) . "</p>";
400             }
402             $question->category = $this->category->id;
403             $question->stamp = make_unique_id_code();  // Set the unique code (not to be changed)
405             $question->createdby = $USER->id;
406             $question->timecreated = time();
407             $question->modifiedby = $USER->id;
408             $question->timemodified = time();
409             if (isset($question->idnumber)) {
410                 if ((string) $question->idnumber === '') {
411                     // Id number not really set. Get rid of it.
412                     unset($question->idnumber);
413                 } else {
414                     if ($DB->record_exists('question',
415                             ['idnumber' => $question->idnumber, 'category' => $question->category])) {
416                         // We cannot have duplicate idnumbers in a category. Just remove it.
417                         unset($question->idnumber);
418                     }
419                 }
420             }
422             $fileoptions = array(
423                     'subdirs' => true,
424                     'maxfiles' => -1,
425                     'maxbytes' => 0,
426                 );
428             $question->id = $DB->insert_record('question', $question);
429             $event = \core\event\question_created::create_from_question_instance($question, $this->importcontext);
430             $event->trigger();
432             if (isset($question->questiontextitemid)) {
433                 $question->questiontext = file_save_draft_area_files($question->questiontextitemid,
434                         $this->importcontext->id, 'question', 'questiontext', $question->id,
435                         $fileoptions, $question->questiontext);
436             } else if (isset($question->questiontextfiles)) {
437                 foreach ($question->questiontextfiles as $file) {
438                     question_bank::get_qtype($question->qtype)->import_file(
439                             $this->importcontext, 'question', 'questiontext', $question->id, $file);
440                 }
441             }
442             if (isset($question->generalfeedbackitemid)) {
443                 $question->generalfeedback = file_save_draft_area_files($question->generalfeedbackitemid,
444                         $this->importcontext->id, 'question', 'generalfeedback', $question->id,
445                         $fileoptions, $question->generalfeedback);
446             } else if (isset($question->generalfeedbackfiles)) {
447                 foreach ($question->generalfeedbackfiles as $file) {
448                     question_bank::get_qtype($question->qtype)->import_file(
449                             $this->importcontext, 'question', 'generalfeedback', $question->id, $file);
450                 }
451             }
452             $DB->update_record('question', $question);
454             $this->questionids[] = $question->id;
456             // Now to save all the answers and type-specific options
458             $result = question_bank::get_qtype($question->qtype)->save_question_options($question);
460             if (core_tag_tag::is_enabled('core_question', 'question')) {
461                 // Is the current context we're importing in a course context?
462                 $importingcontext = $this->importcontext;
463                 $importingcoursecontext = $importingcontext->get_course_context(false);
464                 $isimportingcontextcourseoractivity = !empty($importingcoursecontext);
466                 if (!empty($question->coursetags)) {
467                     if ($isimportingcontextcourseoractivity) {
468                         $mergedtags = array_merge($question->coursetags, $question->tags);
470                         core_tag_tag::set_item_tags('core_question', 'question', $question->id,
471                             $question->context, $mergedtags);
472                     } else {
473                         core_tag_tag::set_item_tags('core_question', 'question', $question->id,
474                             context_course::instance($this->course->id), $question->coursetags);
476                         if (!empty($question->tags)) {
477                             core_tag_tag::set_item_tags('core_question', 'question', $question->id,
478                                 $importingcontext, $question->tags);
479                         }
480                     }
481                 } else if (!empty($question->tags)) {
482                     core_tag_tag::set_item_tags('core_question', 'question', $question->id,
483                         $question->context, $question->tags);
484                 }
485             }
487             if (!empty($result->error)) {
488                 echo $OUTPUT->notification($result->error);
489                 // Can't use $transaction->rollback(); since it requires an exception,
490                 // and I don't want to rewrite this code to change the error handling now.
491                 $DB->force_transaction_rollback();
492                 return false;
493             }
495             $transaction->allow_commit();
497             if (!empty($result->notice)) {
498                 echo $OUTPUT->notification($result->notice);
499                 return true;
500             }
502             // Give the question a unique version stamp determined by question_hash()
503             $DB->set_field('question', 'version', question_hash($question),
504                     array('id' => $question->id));
505         }
506         return true;
507     }
509     /**
510      * Count all non-category questions in the questions array.
511      *
512      * @param array questions An array of question objects.
513      * @return int The count.
514      *
515      */
516     protected function count_questions($questions) {
517         $count = 0;
518         if (!is_array($questions)) {
519             return $count;
520         }
521         foreach ($questions as $question) {
522             if (!is_object($question) || !isset($question->qtype) ||
523                     ($question->qtype == 'category')) {
524                 continue;
525             }
526             $count++;
527         }
528         return $count;
529     }
531     /**
532      * find and/or create the category described by a delimited list
533      * e.g. $course$/tom/dick/harry or tom/dick/harry
534      *
535      * removes any context string no matter whether $getcontext is set
536      * but if $getcontext is set then ignore the context and use selected category context.
537      *
538      * @param string catpath delimited category path
539      * @param object $lastcategoryinfo Contains category information
540      * @return mixed category object or null if fails
541      */
542     protected function create_category_path($catpath, $lastcategoryinfo = null) {
543         global $DB;
544         $catnames = $this->split_category_path($catpath);
545         $parent = 0;
546         $category = null;
548         // check for context id in path, it might not be there in pre 1.9 exports
549         $matchcount = preg_match('/^\$([a-z]+)\$$/', $catnames[0], $matches);
550         if ($matchcount == 1) {
551             $contextid = $this->translator->string_to_context($matches[1]);
552             array_shift($catnames);
553         } else {
554             $contextid = false;
555         }
557         // Before 3.5, question categories could be created at top level.
558         // From 3.5 onwards, all question categories should be a child of a special category called the "top" category.
559         if (isset($catnames[0]) && (($catnames[0] != 'top') || (count($catnames) < 3))) {
560             array_unshift($catnames, 'top');
561         }
563         if ($this->contextfromfile && $contextid !== false) {
564             $context = context::instance_by_id($contextid);
565             require_capability('moodle/question:add', $context);
566         } else {
567             $context = context::instance_by_id($this->category->contextid);
568         }
569         $this->importcontext = $context;
571         // Now create any categories that need to be created.
572         foreach ($catnames as $key => $catname) {
573             if ($parent == 0) {
574                 $category = question_get_top_category($context->id, true);
575                 $parent = $category->id;
576             } else if ($category = $DB->get_record('question_categories',
577                     array('name' => $catname, 'contextid' => $context->id, 'parent' => $parent))) {
578                 // Do nothing unless the child category appears before the parent category
579                 // in the imported xml file. Because the parent was created without info being available
580                 // at that time, this allows the info to be added from the xml data.
581                 if ($key == (count($catnames) - 1) && $lastcategoryinfo && isset($lastcategoryinfo->info) &&
582                         $lastcategoryinfo->info !== '' && $category->info === '') {
583                     $category->info = $lastcategoryinfo->info;
584                     if (isset($lastcategoryinfo->infoformat) && $lastcategoryinfo->infoformat !== '') {
585                         $category->infoformat = $lastcategoryinfo->infoformat;
586                     }
587                     $DB->update_record('question_categories', $category);
588                 }
589                 $parent = $category->id;
590             } else {
591                 if ($catname == 'top') {
592                     // Should not happen, but if it does just move on.
593                     // Occurs when there has been some import/export that has created
594                     // multiple nested 'top' categories (due to old bug solved by MDL-63165).
595                     // This basically silently cleans up old errors. Not throwing an exception here.
596                     continue;
597                 }
598                 require_capability('moodle/question:managecategory', $context);
599                 // Create the new category. This will create all the categories in the catpath,
600                 // though only the final category will have any info added if available.
601                 $category = new stdClass();
602                 $category->contextid = $context->id;
603                 $category->name = $catname;
604                 $category->info = '';
605                 // Only add info (category description) for the final category in the catpath.
606                 if ($key == (count($catnames) - 1) && $lastcategoryinfo && isset($lastcategoryinfo->info) &&
607                         $lastcategoryinfo->info !== '') {
608                     $category->info = $lastcategoryinfo->info;
609                     if (isset($lastcategoryinfo->infoformat) && $lastcategoryinfo->infoformat !== '') {
610                         $category->infoformat = $lastcategoryinfo->infoformat;
611                     }
612                 }
613                 $category->parent = $parent;
614                 $category->sortorder = 999;
615                 $category->stamp = make_unique_id_code();
616                 $category->id = $DB->insert_record('question_categories', $category);
617                 $parent = $category->id;
618                 $event = \core\event\question_category_created::create_from_question_category_instance($category, $context);
619                 $event->trigger();
620             }
621         }
622         return $category;
623     }
625     /**
626      * Return complete file within an array, one item per line
627      * @param string filename name of file
628      * @return mixed contents array or false on failure
629      */
630     protected function readdata($filename) {
631         if (is_readable($filename)) {
632             $filearray = file($filename);
634             // If the first line of the file starts with a UTF-8 BOM, remove it.
635             $filearray[0] = core_text::trim_utf8_bom($filearray[0]);
637             // Check for Macintosh OS line returns (ie file on one line), and fix.
638             if (preg_match("~\r~", $filearray[0]) AND !preg_match("~\n~", $filearray[0])) {
639                 return explode("\r", $filearray[0]);
640             } else {
641                 return $filearray;
642             }
643         }
644         return false;
645     }
647     /**
648      * Parses an array of lines into an array of questions,
649      * where each item is a question object as defined by
650      * readquestion().   Questions are defined as anything
651      * between blank lines.
652      *
653      * NOTE this method used to take $context as a second argument. However, at
654      * the point where this method was called, it was impossible to know what
655      * context the quetsions were going to be saved into, so the value could be
656      * wrong. Also, none of the standard question formats were using this argument,
657      * so it was removed. See MDL-32220.
658      *
659      * If your format does not use blank lines as a delimiter
660      * then you will need to override this method. Even then
661      * try to use readquestion for each question
662      * @param array lines array of lines from readdata
663      * @return array array of question objects
664      */
665     protected function readquestions($lines) {
667         $questions = array();
668         $currentquestion = array();
670         foreach ($lines as $line) {
671             $line = trim($line);
672             if (empty($line)) {
673                 if (!empty($currentquestion)) {
674                     if ($question = $this->readquestion($currentquestion)) {
675                         $questions[] = $question;
676                     }
677                     $currentquestion = array();
678                 }
679             } else {
680                 $currentquestion[] = $line;
681             }
682         }
684         if (!empty($currentquestion)) {  // There may be a final question
685             if ($question = $this->readquestion($currentquestion)) {
686                 $questions[] = $question;
687             }
688         }
690         return $questions;
691     }
693     /**
694      * return an "empty" question
695      * Somewhere to specify question parameters that are not handled
696      * by import but are required db fields.
697      * This should not be overridden.
698      * @return object default question
699      */
700     protected function defaultquestion() {
701         global $CFG;
702         static $defaultshuffleanswers = null;
703         if (is_null($defaultshuffleanswers)) {
704             $defaultshuffleanswers = get_config('quiz', 'shuffleanswers');
705         }
707         $question = new stdClass();
708         $question->shuffleanswers = $defaultshuffleanswers;
709         $question->defaultmark = 1;
710         $question->image = '';
711         $question->usecase = 0;
712         $question->multiplier = array();
713         $question->questiontextformat = FORMAT_MOODLE;
714         $question->generalfeedback = '';
715         $question->generalfeedbackformat = FORMAT_MOODLE;
716         $question->answernumbering = 'abc';
717         $question->penalty = 0.3333333;
718         $question->length = 1;
720         // this option in case the questiontypes class wants
721         // to know where the data came from
722         $question->export_process = true;
723         $question->import_process = true;
725         $this->add_blank_combined_feedback($question);
727         return $question;
728     }
730     /**
731      * Construct a reasonable default question name, based on the start of the question text.
732      * @param string $questiontext the question text.
733      * @param string $default default question name to use if the constructed one comes out blank.
734      * @return string a reasonable question name.
735      */
736     public function create_default_question_name($questiontext, $default) {
737         $name = $this->clean_question_name(shorten_text($questiontext, 80));
738         if ($name) {
739             return $name;
740         } else {
741             return $default;
742         }
743     }
745     /**
746      * Ensure that a question name does not contain anything nasty, and will fit in the DB field.
747      * @param string $name the raw question name.
748      * @return string a safe question name.
749      */
750     public function clean_question_name($name) {
751         $name = clean_param($name, PARAM_TEXT); // Matches what the question editing form does.
752         $name = trim($name);
753         $trimlength = 251;
754         while (core_text::strlen($name) > 255 && $trimlength > 0) {
755             $name = shorten_text($name, $trimlength);
756             $trimlength -= 10;
757         }
758         return $name;
759     }
761     /**
762      * Add a blank combined feedback to a question object.
763      * @param object question
764      * @return object question
765      */
766     protected function add_blank_combined_feedback($question) {
767         $question->correctfeedback = [
768             'text' => '',
769             'format' => $question->questiontextformat,
770             'files' => []
771         ];
772         $question->partiallycorrectfeedback = [
773             'text' => '',
774             'format' => $question->questiontextformat,
775             'files' => []
776         ];
777         $question->incorrectfeedback = [
778             'text' => '',
779             'format' => $question->questiontextformat,
780             'files' => []
781         ];
782         return $question;
783     }
785     /**
786      * Given the data known to define a question in
787      * this format, this function converts it into a question
788      * object suitable for processing and insertion into Moodle.
789      *
790      * If your format does not use blank lines to delimit questions
791      * (e.g. an XML format) you must override 'readquestions' too
792      * @param $lines mixed data that represents question
793      * @return object question object
794      */
795     protected function readquestion($lines) {
796         // We should never get there unless the qformat plugin is broken.
797         throw new coding_exception('Question format plugin is missing important code: readquestion.');
799         return null;
800     }
802     /**
803      * Override if any post-processing is required
804      * @return bool success
805      */
806     public function importpostprocess() {
807         return true;
808     }
810     /*******************
811      * EXPORT FUNCTIONS
812      *******************/
814     /**
815      * Provide export functionality for plugin questiontypes
816      * Do not override
817      * @param name questiontype name
818      * @param question object data to export
819      * @param extra mixed any addition format specific data needed
820      * @return string the data to append to export or false if error (or unhandled)
821      */
822     protected function try_exporting_using_qtypes($name, $question, $extra=null) {
823         // work out the name of format in use
824         $formatname = substr(get_class($this), strlen('qformat_'));
825         $methodname = "export_to_{$formatname}";
827         $qtype = question_bank::get_qtype($name, false);
828         if (method_exists($qtype, $methodname)) {
829             return $qtype->$methodname($question, $this, $extra);
830         }
831         return false;
832     }
834     /**
835      * Do any pre-processing that may be required
836      * @param bool success
837      */
838     public function exportpreprocess() {
839         return true;
840     }
842     /**
843      * Enable any processing to be done on the content
844      * just prior to the file being saved
845      * default is to do nothing
846      * @param string output text
847      * @param string processed output text
848      */
849     protected function presave_process($content) {
850         return $content;
851     }
853     /**
854      * Perform the export.
855      * For most types this should not need to be overrided.
856      *
857      * @param   bool    $checkcapabilities Whether to check capabilities when exporting the questions.
858      * @return  string  The content of the export.
859      */
860     public function exportprocess($checkcapabilities = true) {
861         global $CFG, $DB;
863         // Get the parents (from database) for this category.
864         $parents = [];
865         if ($this->category) {
866             $parents = question_categorylist_parents($this->category->id);
867         }
869         // get the questions (from database) in this category
870         // only get q's with no parents (no cloze subquestions specifically)
871         if ($this->category) {
872             $questions = get_questions_category($this->category, true);
873         } else {
874             $questions = $this->questions;
875         }
877         $count = 0;
879         // results are first written into string (and then to a file)
880         // so create/initialize the string here
881         $expout = '';
883         // track which category questions are in
884         // if it changes we will record the category change in the output
885         // file if selected. 0 means that it will get printed before the 1st question
886         $trackcategory = 0;
888         // Array of categories written to file.
889         $writtencategories = [];
891         foreach ($questions as $question) {
892             // used by file api
893             $contextid = $DB->get_field('question_categories', 'contextid',
894                     array('id' => $question->category));
895             $question->contextid = $contextid;
897             // do not export hidden questions
898             if (!empty($question->hidden)) {
899                 continue;
900             }
902             // do not export random questions
903             if ($question->qtype == 'random') {
904                 continue;
905             }
907             // check if we need to record category change
908             if ($this->cattofile) {
909                 $addnewcat = false;
910                 if ($question->category != $trackcategory) {
911                     $addnewcat = true;
912                     $trackcategory = $question->category;
913                 }
914                 $trackcategoryparents = question_categorylist_parents($trackcategory);
915                 // Check if we need to record empty parents categories.
916                 foreach ($trackcategoryparents as $trackcategoryparent) {
917                     // If parent wasn't written.
918                     if (!in_array($trackcategoryparent, $writtencategories)) {
919                         // If parent is empty.
920                         if (!count($DB->get_records('question', array('category' => $trackcategoryparent)))) {
921                             $categoryname = $this->get_category_path($trackcategoryparent, $this->contexttofile);
922                             $categoryinfo = $DB->get_record('question_categories', array('id' => $trackcategoryparent),
923                                 'name, info, infoformat', MUST_EXIST);
924                             if ($categoryinfo->name != 'top') {
925                                 // Create 'dummy' question for parent category.
926                                 $dummyquestion = $this->create_dummy_question_representing_category($categoryname, $categoryinfo);
927                                 $expout .= $this->writequestion($dummyquestion) . "\n";
928                                 $writtencategories[] = $trackcategoryparent;
929                             }
930                         }
931                     }
932                 }
933                 if ($addnewcat && !in_array($trackcategory, $writtencategories)) {
934                     $categoryname = $this->get_category_path($trackcategory, $this->contexttofile);
935                     $categoryinfo = $DB->get_record('question_categories', array('id' => $trackcategory),
936                             'info, infoformat', MUST_EXIST);
937                     // Create 'dummy' question for category.
938                     $dummyquestion = $this->create_dummy_question_representing_category($categoryname, $categoryinfo);
939                     $expout .= $this->writequestion($dummyquestion) . "\n";
940                     $writtencategories[] = $trackcategory;
941                 }
942             }
944             // Add the question to result.
945             if (!$checkcapabilities || question_has_capability_on($question, 'view')) {
946                 $expquestion = $this->writequestion($question, $contextid);
947                 // Don't add anything if witequestion returned nothing.
948                 // This will permit qformat plugins to exclude some questions.
949                 if ($expquestion !== null) {
950                     $expout .= $expquestion . "\n";
951                     $count++;
952                 }
953             }
954         }
956         // continue path for following error checks
957         $course = $this->course;
958         $continuepath = "{$CFG->wwwroot}/question/export.php?courseid={$course->id}";
960         // did we actually process anything
961         if ($count==0) {
962             print_error('noquestions', 'question', $continuepath);
963         }
965         // final pre-process on exported data
966         $expout = $this->presave_process($expout);
967         return $expout;
968     }
970     /**
971      * Create 'dummy' question for category export.
972      * @param string $categoryname the name of the category
973      * @param object $categoryinfo description of the category
974      * @return stdClass 'dummy' question for category
975      */
976     protected function create_dummy_question_representing_category(string $categoryname, $categoryinfo) {
977         $dummyquestion = new stdClass();
978         $dummyquestion->qtype = 'category';
979         $dummyquestion->category = $categoryname;
980         $dummyquestion->id = 0;
981         $dummyquestion->questiontextformat = '';
982         $dummyquestion->contextid = 0;
983         $dummyquestion->info = $categoryinfo->info;
984         $dummyquestion->infoformat = $categoryinfo->infoformat;
985         $dummyquestion->name = 'Switch category to ' . $categoryname;
986         return $dummyquestion;
987     }
989     /**
990      * get the category as a path (e.g., tom/dick/harry)
991      * @param int id the id of the most nested catgory
992      * @return string the path
993      */
994     protected function get_category_path($id, $includecontext = true) {
995         global $DB;
997         if (!$category = $DB->get_record('question_categories', array('id' => $id))) {
998             print_error('cannotfindcategory', 'error', '', $id);
999         }
1000         $contextstring = $this->translator->context_to_string($category->contextid);
1002         $pathsections = array();
1003         do {
1004             $pathsections[] = $category->name;
1005             $id = $category->parent;
1006         } while ($category = $DB->get_record('question_categories', array('id' => $id)));
1008         if ($includecontext) {
1009             $pathsections[] = '$' . $contextstring . '$';
1010         }
1012         $path = $this->assemble_category_path(array_reverse($pathsections));
1014         return $path;
1015     }
1017     /**
1018      * Convert a list of category names, possibly preceeded by one of the
1019      * context tokens like $course$, into a string representation of the
1020      * category path.
1021      *
1022      * Names are separated by / delimiters. And /s in the name are replaced by //.
1023      *
1024      * To reverse the process and split the paths into names, use
1025      * {@link split_category_path()}.
1026      *
1027      * @param array $names
1028      * @return string
1029      */
1030     protected function assemble_category_path($names) {
1031         $escapednames = array();
1032         foreach ($names as $name) {
1033             $escapedname = str_replace('/', '//', $name);
1034             if (substr($escapedname, 0, 1) == '/') {
1035                 $escapedname = ' ' . $escapedname;
1036             }
1037             if (substr($escapedname, -1) == '/') {
1038                 $escapedname = $escapedname . ' ';
1039             }
1040             $escapednames[] = $escapedname;
1041         }
1042         return implode('/', $escapednames);
1043     }
1045     /**
1046      * Convert a string, as returned by {@link assemble_category_path()},
1047      * back into an array of category names.
1048      *
1049      * Each category name is cleaned by a call to clean_param(, PARAM_TEXT),
1050      * which matches the cleaning in question/category_form.php.
1051      *
1052      * @param string $path
1053      * @return array of category names.
1054      */
1055     protected function split_category_path($path) {
1056         $rawnames = preg_split('~(?<!/)/(?!/)~', $path);
1057         $names = array();
1058         foreach ($rawnames as $rawname) {
1059             $names[] = clean_param(trim(str_replace('//', '/', $rawname)), PARAM_TEXT);
1060         }
1061         return $names;
1062     }
1064     /**
1065      * Do an post-processing that may be required
1066      * @return bool success
1067      */
1068     protected function exportpostprocess() {
1069         return true;
1070     }
1072     /**
1073      * convert a single question object into text output in the given
1074      * format.
1075      * This must be overriden
1076      * @param object question question object
1077      * @return mixed question export text or null if not implemented
1078      */
1079     protected function writequestion($question) {
1080         // if not overidden, then this is an error.
1081         throw new coding_exception('Question format plugin is missing important code: writequestion.');
1082         return null;
1083     }
1085     /**
1086      * Convert the question text to plain text, so it can safely be displayed
1087      * during import to let the user see roughly what is going on.
1088      */
1089     protected function format_question_text($question) {
1090         return s(question_utils::to_plain_text($question->questiontext,
1091                 $question->questiontextformat));
1092     }
1095 class qformat_based_on_xml extends qformat_default {
1097     /**
1098      * A lot of imported files contain unwanted entities.
1099      * This method tries to clean up all known problems.
1100      * @param string str string to correct
1101      * @return string the corrected string
1102      */
1103     public function cleaninput($str) {
1105         $html_code_list = array(
1106             "&#039;" => "'",
1107             "&#8217;" => "'",
1108             "&#8220;" => "\"",
1109             "&#8221;" => "\"",
1110             "&#8211;" => "-",
1111             "&#8212;" => "-",
1112         );
1113         $str = strtr($str, $html_code_list);
1114         // Use core_text entities_to_utf8 function to convert only numerical entities.
1115         $str = core_text::entities_to_utf8($str, false);
1116         return $str;
1117     }
1119     /**
1120      * Return the array moodle is expecting
1121      * for an HTML text. No processing is done on $text.
1122      * qformat classes that want to process $text
1123      * for instance to import external images files
1124      * and recode urls in $text must overwrite this method.
1125      * @param array $text some HTML text string
1126      * @return array with keys text, format and files.
1127      */
1128     public function text_field($text) {
1129         return array(
1130             'text' => trim($text),
1131             'format' => FORMAT_HTML,
1132             'files' => array(),
1133         );
1134     }
1136     /**
1137      * Return the value of a node, given a path to the node
1138      * if it doesn't exist return the default value.
1139      * @param array xml data to read
1140      * @param array path path to node expressed as array
1141      * @param mixed default
1142      * @param bool istext process as text
1143      * @param string error if set value must exist, return false and issue message if not
1144      * @return mixed value
1145      */
1146     public function getpath($xml, $path, $default, $istext=false, $error='') {
1147         foreach ($path as $index) {
1148             if (!isset($xml[$index])) {
1149                 if (!empty($error)) {
1150                     $this->error($error);
1151                     return false;
1152                 } else {
1153                     return $default;
1154                 }
1155             }
1157             $xml = $xml[$index];
1158         }
1160         if ($istext) {
1161             if (!is_string($xml)) {
1162                 $this->error(get_string('invalidxml', 'qformat_xml'));
1163             }
1164             $xml = trim($xml);
1165         }
1167         return $xml;
1168     }