Merge branch 'MDL-63333_master' of git://github.com/markn86/moodle
[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             $fileoptions = array(
410                     'subdirs' => true,
411                     'maxfiles' => -1,
412                     'maxbytes' => 0,
413                 );
415             $question->id = $DB->insert_record('question', $question);
417             if (isset($question->questiontextitemid)) {
418                 $question->questiontext = file_save_draft_area_files($question->questiontextitemid,
419                         $this->importcontext->id, 'question', 'questiontext', $question->id,
420                         $fileoptions, $question->questiontext);
421             } else if (isset($question->questiontextfiles)) {
422                 foreach ($question->questiontextfiles as $file) {
423                     question_bank::get_qtype($question->qtype)->import_file(
424                             $this->importcontext, 'question', 'questiontext', $question->id, $file);
425                 }
426             }
427             if (isset($question->generalfeedbackitemid)) {
428                 $question->generalfeedback = file_save_draft_area_files($question->generalfeedbackitemid,
429                         $this->importcontext->id, 'question', 'generalfeedback', $question->id,
430                         $fileoptions, $question->generalfeedback);
431             } else if (isset($question->generalfeedbackfiles)) {
432                 foreach ($question->generalfeedbackfiles as $file) {
433                     question_bank::get_qtype($question->qtype)->import_file(
434                             $this->importcontext, 'question', 'generalfeedback', $question->id, $file);
435                 }
436             }
437             $DB->update_record('question', $question);
439             $this->questionids[] = $question->id;
441             // Now to save all the answers and type-specific options
443             $result = question_bank::get_qtype($question->qtype)->save_question_options($question);
445             if (core_tag_tag::is_enabled('core_question', 'question')) {
446                 // Is the current context we're importing in a course context?
447                 $importingcontext = $this->importcontext;
448                 $importingcoursecontext = $importingcontext->get_course_context(false);
449                 $isimportingcontextcourseoractivity = !empty($importingcoursecontext);
451                 if (!empty($question->coursetags)) {
452                     if ($isimportingcontextcourseoractivity) {
453                         $mergedtags = array_merge($question->coursetags, $question->tags);
455                         core_tag_tag::set_item_tags('core_question', 'question', $question->id,
456                             $question->context, $mergedtags);
457                     } else {
458                         core_tag_tag::set_item_tags('core_question', 'question', $question->id,
459                             context_course::instance($this->course->id), $question->coursetags);
461                         if (!empty($question->tags)) {
462                             core_tag_tag::set_item_tags('core_question', 'question', $question->id,
463                                 $importingcontext, $question->tags);
464                         }
465                     }
466                 } else if (!empty($question->tags)) {
467                     core_tag_tag::set_item_tags('core_question', 'question', $question->id,
468                         $question->context, $question->tags);
469                 }
470             }
472             if (!empty($result->error)) {
473                 echo $OUTPUT->notification($result->error);
474                 // Can't use $transaction->rollback(); since it requires an exception,
475                 // and I don't want to rewrite this code to change the error handling now.
476                 $DB->force_transaction_rollback();
477                 return false;
478             }
480             $transaction->allow_commit();
482             if (!empty($result->notice)) {
483                 echo $OUTPUT->notification($result->notice);
484                 return true;
485             }
487             // Give the question a unique version stamp determined by question_hash()
488             $DB->set_field('question', 'version', question_hash($question),
489                     array('id' => $question->id));
490         }
491         return true;
492     }
494     /**
495      * Count all non-category questions in the questions array.
496      *
497      * @param array questions An array of question objects.
498      * @return int The count.
499      *
500      */
501     protected function count_questions($questions) {
502         $count = 0;
503         if (!is_array($questions)) {
504             return $count;
505         }
506         foreach ($questions as $question) {
507             if (!is_object($question) || !isset($question->qtype) ||
508                     ($question->qtype == 'category')) {
509                 continue;
510             }
511             $count++;
512         }
513         return $count;
514     }
516     /**
517      * find and/or create the category described by a delimited list
518      * e.g. $course$/tom/dick/harry or tom/dick/harry
519      *
520      * removes any context string no matter whether $getcontext is set
521      * but if $getcontext is set then ignore the context and use selected category context.
522      *
523      * @param string catpath delimited category path
524      * @param object $lastcategoryinfo Contains category information
525      * @return mixed category object or null if fails
526      */
527     protected function create_category_path($catpath, $lastcategoryinfo = null) {
528         global $DB;
529         $catnames = $this->split_category_path($catpath);
530         $parent = 0;
531         $category = null;
533         // check for context id in path, it might not be there in pre 1.9 exports
534         $matchcount = preg_match('/^\$([a-z]+)\$$/', $catnames[0], $matches);
535         if ($matchcount == 1) {
536             $contextid = $this->translator->string_to_context($matches[1]);
537             array_shift($catnames);
538         } else {
539             $contextid = false;
540         }
542         // Before 3.5, question categories could be created at top level.
543         // From 3.5 onwards, all question categories should be a child of a special category called the "top" category.
544         if (isset($catnames[0]) && (($catnames[0] != 'top') || (count($catnames) < 3))) {
545             array_unshift($catnames, 'top');
546         }
548         if ($this->contextfromfile && $contextid !== false) {
549             $context = context::instance_by_id($contextid);
550             require_capability('moodle/question:add', $context);
551         } else {
552             $context = context::instance_by_id($this->category->contextid);
553         }
554         $this->importcontext = $context;
556         // Now create any categories that need to be created.
557         foreach ($catnames as $key => $catname) {
558             if ($parent == 0) {
559                 $category = question_get_top_category($context->id, true);
560                 $parent = $category->id;
561             } else if ($category = $DB->get_record('question_categories',
562                     array('name' => $catname, 'contextid' => $context->id, 'parent' => $parent))) {
563                 // Do nothing unless the child category appears before the parent category
564                 // in the imported xml file. Because the parent was created without info being available
565                 // at that time, this allows the info to be added from the xml data.
566                 if ($key == (count($catnames) - 1) && $lastcategoryinfo && $lastcategoryinfo->info !== null &&
567                         $lastcategoryinfo->info !== "" && $category->info == "") {
568                     $category->info = $lastcategoryinfo->info;
569                     if ($lastcategoryinfo->infoformat !== null && $lastcategoryinfo->infoformat !== "") {
570                         $category->infoformat = $lastcategoryinfo->infoformat;
571                     }
572                     $DB->update_record('question_categories', $category);
573                 }
574                 $parent = $category->id;
575             } else {
576                 if ($catname == 'top') {
577                     // Should not happen, but if it does just move on.
578                     // Occurs when there has been some import/export that has created
579                     // multiple nested 'top' categories (due to old bug solved by MDL-63165).
580                     // This basically silently cleans up old errors. Not throwing an exception here.
581                     continue;
582                 }
583                 require_capability('moodle/question:managecategory', $context);
584                 // Create the new category. This will create all the categories in the catpath,
585                 // though only the final category will have any info added if available.
586                 $category = new stdClass();
587                 $category->contextid = $context->id;
588                 $category->name = $catname;
589                 $category->info = '';
590                 // Only add info (category description) for the final category in the catpath.
591                 if ($key == (count($catnames) - 1) && $lastcategoryinfo && $lastcategoryinfo->info !== null &&
592                         $lastcategoryinfo->info !== "") {
593                     $category->info = $lastcategoryinfo->info;
594                     if ($lastcategoryinfo->infoformat !== null && $lastcategoryinfo->infoformat !== "") {
595                         $category->infoformat = $lastcategoryinfo->infoformat;
596                     }
597                 }
598                 $category->parent = $parent;
599                 $category->sortorder = 999;
600                 $category->stamp = make_unique_id_code();
601                 $category->id = $DB->insert_record('question_categories', $category);
602                 $parent = $category->id;
603             }
604         }
605         return $category;
606     }
608     /**
609      * Return complete file within an array, one item per line
610      * @param string filename name of file
611      * @return mixed contents array or false on failure
612      */
613     protected function readdata($filename) {
614         if (is_readable($filename)) {
615             $filearray = file($filename);
617             // If the first line of the file starts with a UTF-8 BOM, remove it.
618             $filearray[0] = core_text::trim_utf8_bom($filearray[0]);
620             // Check for Macintosh OS line returns (ie file on one line), and fix.
621             if (preg_match("~\r~", $filearray[0]) AND !preg_match("~\n~", $filearray[0])) {
622                 return explode("\r", $filearray[0]);
623             } else {
624                 return $filearray;
625             }
626         }
627         return false;
628     }
630     /**
631      * Parses an array of lines into an array of questions,
632      * where each item is a question object as defined by
633      * readquestion().   Questions are defined as anything
634      * between blank lines.
635      *
636      * NOTE this method used to take $context as a second argument. However, at
637      * the point where this method was called, it was impossible to know what
638      * context the quetsions were going to be saved into, so the value could be
639      * wrong. Also, none of the standard question formats were using this argument,
640      * so it was removed. See MDL-32220.
641      *
642      * If your format does not use blank lines as a delimiter
643      * then you will need to override this method. Even then
644      * try to use readquestion for each question
645      * @param array lines array of lines from readdata
646      * @return array array of question objects
647      */
648     protected function readquestions($lines) {
650         $questions = array();
651         $currentquestion = array();
653         foreach ($lines as $line) {
654             $line = trim($line);
655             if (empty($line)) {
656                 if (!empty($currentquestion)) {
657                     if ($question = $this->readquestion($currentquestion)) {
658                         $questions[] = $question;
659                     }
660                     $currentquestion = array();
661                 }
662             } else {
663                 $currentquestion[] = $line;
664             }
665         }
667         if (!empty($currentquestion)) {  // There may be a final question
668             if ($question = $this->readquestion($currentquestion)) {
669                 $questions[] = $question;
670             }
671         }
673         return $questions;
674     }
676     /**
677      * return an "empty" question
678      * Somewhere to specify question parameters that are not handled
679      * by import but are required db fields.
680      * This should not be overridden.
681      * @return object default question
682      */
683     protected function defaultquestion() {
684         global $CFG;
685         static $defaultshuffleanswers = null;
686         if (is_null($defaultshuffleanswers)) {
687             $defaultshuffleanswers = get_config('quiz', 'shuffleanswers');
688         }
690         $question = new stdClass();
691         $question->shuffleanswers = $defaultshuffleanswers;
692         $question->defaultmark = 1;
693         $question->image = "";
694         $question->usecase = 0;
695         $question->multiplier = array();
696         $question->questiontextformat = FORMAT_MOODLE;
697         $question->generalfeedback = '';
698         $question->generalfeedbackformat = FORMAT_MOODLE;
699         $question->answernumbering = 'abc';
700         $question->penalty = 0.3333333;
701         $question->length = 1;
703         // this option in case the questiontypes class wants
704         // to know where the data came from
705         $question->export_process = true;
706         $question->import_process = true;
708         $this->add_blank_combined_feedback($question);
710         return $question;
711     }
713     /**
714      * Construct a reasonable default question name, based on the start of the question text.
715      * @param string $questiontext the question text.
716      * @param string $default default question name to use if the constructed one comes out blank.
717      * @return string a reasonable question name.
718      */
719     public function create_default_question_name($questiontext, $default) {
720         $name = $this->clean_question_name(shorten_text($questiontext, 80));
721         if ($name) {
722             return $name;
723         } else {
724             return $default;
725         }
726     }
728     /**
729      * Ensure that a question name does not contain anything nasty, and will fit in the DB field.
730      * @param string $name the raw question name.
731      * @return string a safe question name.
732      */
733     public function clean_question_name($name) {
734         $name = clean_param($name, PARAM_TEXT); // Matches what the question editing form does.
735         $name = trim($name);
736         $trimlength = 251;
737         while (core_text::strlen($name) > 255 && $trimlength > 0) {
738             $name = shorten_text($name, $trimlength);
739             $trimlength -= 10;
740         }
741         return $name;
742     }
744     /**
745      * Add a blank combined feedback to a question object.
746      * @param object question
747      * @return object question
748      */
749     protected function add_blank_combined_feedback($question) {
750         $question->correctfeedback = [
751             'text' => '',
752             'format' => $question->questiontextformat,
753             'files' => []
754         ];
755         $question->partiallycorrectfeedback = [
756             'text' => '',
757             'format' => $question->questiontextformat,
758             'files' => []
759         ];
760         $question->incorrectfeedback = [
761             'text' => '',
762             'format' => $question->questiontextformat,
763             'files' => []
764         ];
765         return $question;
766     }
768     /**
769      * Given the data known to define a question in
770      * this format, this function converts it into a question
771      * object suitable for processing and insertion into Moodle.
772      *
773      * If your format does not use blank lines to delimit questions
774      * (e.g. an XML format) you must override 'readquestions' too
775      * @param $lines mixed data that represents question
776      * @return object question object
777      */
778     protected function readquestion($lines) {
779         // We should never get there unless the qformat plugin is broken.
780         throw new coding_exception('Question format plugin is missing important code: readquestion.');
782         return null;
783     }
785     /**
786      * Override if any post-processing is required
787      * @return bool success
788      */
789     public function importpostprocess() {
790         return true;
791     }
793     /*******************
794      * EXPORT FUNCTIONS
795      *******************/
797     /**
798      * Provide export functionality for plugin questiontypes
799      * Do not override
800      * @param name questiontype name
801      * @param question object data to export
802      * @param extra mixed any addition format specific data needed
803      * @return string the data to append to export or false if error (or unhandled)
804      */
805     protected function try_exporting_using_qtypes($name, $question, $extra=null) {
806         // work out the name of format in use
807         $formatname = substr(get_class($this), strlen('qformat_'));
808         $methodname = "export_to_{$formatname}";
810         $qtype = question_bank::get_qtype($name, false);
811         if (method_exists($qtype, $methodname)) {
812             return $qtype->$methodname($question, $this, $extra);
813         }
814         return false;
815     }
817     /**
818      * Do any pre-processing that may be required
819      * @param bool success
820      */
821     public function exportpreprocess() {
822         return true;
823     }
825     /**
826      * Enable any processing to be done on the content
827      * just prior to the file being saved
828      * default is to do nothing
829      * @param string output text
830      * @param string processed output text
831      */
832     protected function presave_process($content) {
833         return $content;
834     }
836     /**
837      * Perform the export.
838      * For most types this should not need to be overrided.
839      *
840      * @param   bool    $checkcapabilities Whether to check capabilities when exporting the questions.
841      * @return  string  The content of the export.
842      */
843     public function exportprocess($checkcapabilities = true) {
844         global $CFG, $DB;
846         // Get the parents (from database) for this category.
847         $parents = [];
848         if ($this->category) {
849             $parents = question_categorylist_parents($this->category->id);
850         }
852         // get the questions (from database) in this category
853         // only get q's with no parents (no cloze subquestions specifically)
854         if ($this->category) {
855             $questions = get_questions_category($this->category, true);
856         } else {
857             $questions = $this->questions;
858         }
860         $count = 0;
862         // results are first written into string (and then to a file)
863         // so create/initialize the string here
864         $expout = "";
866         // track which category questions are in
867         // if it changes we will record the category change in the output
868         // file if selected. 0 means that it will get printed before the 1st question
869         $trackcategory = 0;
871         // Array of categories written to file.
872         $writtencategories = [];
874         foreach ($questions as $question) {
875             // used by file api
876             $contextid = $DB->get_field('question_categories', 'contextid',
877                     array('id' => $question->category));
878             $question->contextid = $contextid;
880             // do not export hidden questions
881             if (!empty($question->hidden)) {
882                 continue;
883             }
885             // do not export random questions
886             if ($question->qtype == 'random') {
887                 continue;
888             }
890             // check if we need to record category change
891             if ($this->cattofile) {
892                 $addnewcat = false;
893                 if ($question->category != $trackcategory) {
894                     $addnewcat = true;
895                     $trackcategory = $question->category;
896                 }
897                 $trackcategoryparents = question_categorylist_parents($trackcategory);
898                 // Check if we need to record empty parents categories.
899                 foreach ($trackcategoryparents as $trackcategoryparent) {
900                     // If parent wasn't written.
901                     if (!in_array($trackcategoryparent, $writtencategories)) {
902                         // If parent is empty.
903                         if (!count($DB->get_records('question', array('category' => $trackcategoryparent)))) {
904                             $categoryname = $this->get_category_path($trackcategoryparent, $this->contexttofile);
905                             $categoryinfo = $DB->get_record('question_categories', array('id' => $trackcategoryparent),
906                                 'name, info, infoformat', MUST_EXIST);
907                             if ($categoryinfo->name != 'top') {
908                                 // Create 'dummy' question for parent category.
909                                 $dummyquestion = $this->create_dummy_question_representing_category($categoryname, $categoryinfo);
910                                 $expout .= $this->writequestion($dummyquestion) . "\n";
911                                 $writtencategories[] = $trackcategoryparent;
912                             }
913                         }
914                     }
915                 }
916                 if ($addnewcat && !in_array($trackcategory, $writtencategories)) {
917                     $categoryname = $this->get_category_path($trackcategory, $this->contexttofile);
918                     $categoryinfo = $DB->get_record('question_categories', array('id' => $trackcategory),
919                             'info, infoformat', MUST_EXIST);
920                     // Create 'dummy' question for category.
921                     $dummyquestion = $this->create_dummy_question_representing_category($categoryname, $categoryinfo);
922                     $expout .= $this->writequestion($dummyquestion) . "\n";
923                     $writtencategories[] = $trackcategory;
924                 }
925             }
927             // export the question displaying message
928             $count++;
930             if (!$checkcapabilities || question_has_capability_on($question, 'view')) {
931                 $expout .= $this->writequestion($question, $contextid) . "\n";
932             }
933         }
935         // continue path for following error checks
936         $course = $this->course;
937         $continuepath = "{$CFG->wwwroot}/question/export.php?courseid={$course->id}";
939         // did we actually process anything
940         if ($count==0) {
941             print_error('noquestions', 'question', $continuepath);
942         }
944         // final pre-process on exported data
945         $expout = $this->presave_process($expout);
946         return $expout;
947     }
949     /**
950      * Create 'dummy' question for category export.
951      * @param string $categoryname the name of the category
952      * @param object $categoryinfo description of the category
953      * @return stdClass 'dummy' question for category
954      */
955     protected function create_dummy_question_representing_category(string $categoryname, $categoryinfo) {
956         $dummyquestion = new stdClass();
957         $dummyquestion->qtype = 'category';
958         $dummyquestion->category = $categoryname;
959         $dummyquestion->id = 0;
960         $dummyquestion->questiontextformat = '';
961         $dummyquestion->contextid = 0;
962         $dummyquestion->info = $categoryinfo->info;
963         $dummyquestion->infoformat = $categoryinfo->infoformat;
964         $dummyquestion->name = 'Switch category to ' . $categoryname;
965         return $dummyquestion;
966     }
968     /**
969      * get the category as a path (e.g., tom/dick/harry)
970      * @param int id the id of the most nested catgory
971      * @return string the path
972      */
973     protected function get_category_path($id, $includecontext = true) {
974         global $DB;
976         if (!$category = $DB->get_record('question_categories', array('id' => $id))) {
977             print_error('cannotfindcategory', 'error', '', $id);
978         }
979         $contextstring = $this->translator->context_to_string($category->contextid);
981         $pathsections = array();
982         do {
983             $pathsections[] = $category->name;
984             $id = $category->parent;
985         } while ($category = $DB->get_record('question_categories', array('id' => $id)));
987         if ($includecontext) {
988             $pathsections[] = '$' . $contextstring . '$';
989         }
991         $path = $this->assemble_category_path(array_reverse($pathsections));
993         return $path;
994     }
996     /**
997      * Convert a list of category names, possibly preceeded by one of the
998      * context tokens like $course$, into a string representation of the
999      * category path.
1000      *
1001      * Names are separated by / delimiters. And /s in the name are replaced by //.
1002      *
1003      * To reverse the process and split the paths into names, use
1004      * {@link split_category_path()}.
1005      *
1006      * @param array $names
1007      * @return string
1008      */
1009     protected function assemble_category_path($names) {
1010         $escapednames = array();
1011         foreach ($names as $name) {
1012             $escapedname = str_replace('/', '//', $name);
1013             if (substr($escapedname, 0, 1) == '/') {
1014                 $escapedname = ' ' . $escapedname;
1015             }
1016             if (substr($escapedname, -1) == '/') {
1017                 $escapedname = $escapedname . ' ';
1018             }
1019             $escapednames[] = $escapedname;
1020         }
1021         return implode('/', $escapednames);
1022     }
1024     /**
1025      * Convert a string, as returned by {@link assemble_category_path()},
1026      * back into an array of category names.
1027      *
1028      * Each category name is cleaned by a call to clean_param(, PARAM_TEXT),
1029      * which matches the cleaning in question/category_form.php.
1030      *
1031      * @param string $path
1032      * @return array of category names.
1033      */
1034     protected function split_category_path($path) {
1035         $rawnames = preg_split('~(?<!/)/(?!/)~', $path);
1036         $names = array();
1037         foreach ($rawnames as $rawname) {
1038             $names[] = clean_param(trim(str_replace('//', '/', $rawname)), PARAM_TEXT);
1039         }
1040         return $names;
1041     }
1043     /**
1044      * Do an post-processing that may be required
1045      * @return bool success
1046      */
1047     protected function exportpostprocess() {
1048         return true;
1049     }
1051     /**
1052      * convert a single question object into text output in the given
1053      * format.
1054      * This must be overriden
1055      * @param object question question object
1056      * @return mixed question export text or null if not implemented
1057      */
1058     protected function writequestion($question) {
1059         // if not overidden, then this is an error.
1060         throw new coding_exception('Question format plugin is missing important code: writequestion.');
1061         return null;
1062     }
1064     /**
1065      * Convert the question text to plain text, so it can safely be displayed
1066      * during import to let the user see roughly what is going on.
1067      */
1068     protected function format_question_text($question) {
1069         return s(question_utils::to_plain_text($question->questiontext,
1070                 $question->questiontextformat));
1071     }
1074 class qformat_based_on_xml extends qformat_default {
1076     /**
1077      * A lot of imported files contain unwanted entities.
1078      * This method tries to clean up all known problems.
1079      * @param string str string to correct
1080      * @return string the corrected string
1081      */
1082     public function cleaninput($str) {
1084         $html_code_list = array(
1085             "&#039;" => "'",
1086             "&#8217;" => "'",
1087             "&#8220;" => "\"",
1088             "&#8221;" => "\"",
1089             "&#8211;" => "-",
1090             "&#8212;" => "-",
1091         );
1092         $str = strtr($str, $html_code_list);
1093         // Use core_text entities_to_utf8 function to convert only numerical entities.
1094         $str = core_text::entities_to_utf8($str, false);
1095         return $str;
1096     }
1098     /**
1099      * Return the array moodle is expecting
1100      * for an HTML text. No processing is done on $text.
1101      * qformat classes that want to process $text
1102      * for instance to import external images files
1103      * and recode urls in $text must overwrite this method.
1104      * @param array $text some HTML text string
1105      * @return array with keys text, format and files.
1106      */
1107     public function text_field($text) {
1108         return array(
1109             'text' => trim($text),
1110             'format' => FORMAT_HTML,
1111             'files' => array(),
1112         );
1113     }
1115     /**
1116      * Return the value of a node, given a path to the node
1117      * if it doesn't exist return the default value.
1118      * @param array xml data to read
1119      * @param array path path to node expressed as array
1120      * @param mixed default
1121      * @param bool istext process as text
1122      * @param string error if set value must exist, return false and issue message if not
1123      * @return mixed value
1124      */
1125     public function getpath($xml, $path, $default, $istext=false, $error='') {
1126         foreach ($path as $index) {
1127             if (!isset($xml[$index])) {
1128                 if (!empty($error)) {
1129                     $this->error($error);
1130                     return false;
1131                 } else {
1132                     return $default;
1133                 }
1134             }
1136             $xml = $xml[$index];
1137         }
1139         if ($istext) {
1140             if (!is_string($xml)) {
1141                 $this->error(get_string('invalidxml', 'qformat_xml'));
1142             }
1143             $xml = trim($xml);
1144         }
1146         return $xml;
1147     }