Merge branch 'wip-MDL-41025-m26' of git://github.com/samhemelryk/moodle
[moodle.git] / question / format.php
CommitLineData
aeb15530 1<?php
d3603157
TH
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * Defines the 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 */
25
26
a17b297d
TH
27defined('MOODLE_INTERNAL') || die();
28
29
4323d029 30/**
31 * Base class for question import and export formats.
32 *
d3603157
TH
33 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
34 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4323d029 35 */
f5565b69 36class qformat_default {
aca318e1 37
13bb604e 38 public $displayerrors = true;
e0736817 39 public $category = null;
13bb604e 40 public $questions = array();
e0736817 41 public $course = null;
13bb604e
TH
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;
271e6dec 54
cde2709a 55 protected $importcontext = null;
aca318e1 56
e198992b
TH
57 // functions to indicate import/export functionality
58 // override to return true if implemented
aca318e1 59
f7970e3c 60 /** @return bool whether this plugin provides import functionality. */
c7df5006 61 public function provide_import() {
46732124 62 return false;
aca318e1 63 }
64
f7970e3c 65 /** @return bool whether this plugin provides export functionality. */
c7df5006 66 public function provide_export() {
46732124
TH
67 return false;
68 }
69
70 /** The string mime-type of the files that this plugin reads or writes. */
c7df5006 71 public function mime_type() {
46732124
TH
72 return mimeinfo('type', $this->export_file_extension());
73 }
74
75 /**
76 * @return string the file extension (including .) that is normally used for
77 * files handled by this plugin.
78 */
c7df5006 79 public function export_file_extension() {
46732124 80 return '.txt';
aca318e1 81 }
a1ef8c6d 82
7da7bfa1
JF
83 /**
84 * Check if the given file is capable of being imported by this plugin.
85 *
86 * Note that expensive or detailed integrity checks on the file should
87 * not be performed by this method. Simple file type or magic-number tests
88 * would be suitable.
89 *
a1ef8c6d 90 * @param stored_file $file the file to check
7da7bfa1
JF
91 * @return bool whether this plugin can import the file
92 */
93 public function can_import_file($file) {
94 return ($file->get_mimetype() == $this->mime_type());
95 }
aca318e1 96
e198992b 97 // Accessor methods
aca318e1 98
08892d5b 99 /**
100 * set the category
101 * @param object category the category object
102 */
c7df5006 103 public function setCategory($category) {
13bb604e 104 if (count($this->questions)) {
88bc20c3 105 debugging('You shouldn\'t call setCategory after setQuestions');
106 }
08892d5b 107 $this->category = $category;
d197ea43 108 $this->importcontext = context::instance_by_id($this->category->contextid);
08892d5b 109 }
aca318e1 110
2c44a3d3 111 /**
112 * Set the specific questions to export. Should not include questions with
113 * parents (sub questions of cloze question type).
114 * Only used for question export.
115 * @param array of question objects
116 */
c7df5006 117 public function setQuestions($questions) {
13bb604e 118 if ($this->category !== null) {
88bc20c3 119 debugging('You shouldn\'t call setQuestions after setCategory');
120 }
2c44a3d3 121 $this->questions = $questions;
122 }
123
08892d5b 124 /**
125 * set the course class variable
126 * @param course object Moodle course variable
127 */
c7df5006 128 public function setCourse($course) {
aca318e1 129 $this->course = $course;
08892d5b 130 }
13bb604e 131
271e6dec 132 /**
133 * set an array of contexts.
134 * @param array $contexts Moodle course variable
135 */
c7df5006 136 public function setContexts($contexts) {
271e6dec 137 $this->contexts = $contexts;
138 $this->translator = new context_to_string_translator($this->contexts);
139 }
aca318e1 140
08892d5b 141 /**
142 * set the filename
143 * @param string filename name of file to import/export
144 */
c7df5006 145 public function setFilename($filename) {
08892d5b 146 $this->filename = $filename;
147 }
88bc20c3 148
149 /**
73b7b195 150 * set the "real" filename
151 * (this is what the user typed, regardless of wha happened next)
152 * @param string realfilename name of file as typed by user
153 */
c7df5006 154 public function setRealfilename($realfilename) {
88bc20c3 155 $this->realfilename = $realfilename;
156 }
08892d5b 157
158 /**
159 * set matchgrades
160 * @param string matchgrades error or nearest for grades
161 */
c7df5006 162 public function setMatchgrades($matchgrades) {
08892d5b 163 $this->matchgrades = $matchgrades;
aca318e1 164 }
165
76f0a334 166 /**
08892d5b 167 * set catfromfile
168 * @param bool catfromfile allow categories embedded in import file
76f0a334 169 */
c7df5006 170 public function setCatfromfile($catfromfile) {
08892d5b 171 $this->catfromfile = $catfromfile;
172 }
271e6dec 173
174 /**
175 * set contextfromfile
176 * @param bool $contextfromfile allow contexts embedded in import file
177 */
c7df5006 178 public function setContextfromfile($contextfromfile) {
271e6dec 179 $this->contextfromfile = $contextfromfile;
180 }
181
f1abd39f 182 /**
183 * set cattofile
184 * @param bool cattofile exports categories within export file
185 */
c7df5006 186 public function setCattofile($cattofile) {
f1abd39f 187 $this->cattofile = $cattofile;
271e6dec 188 }
13bb604e 189
271e6dec 190 /**
191 * set contexttofile
192 * @param bool cattofile exports categories within export file
193 */
c7df5006 194 public function setContexttofile($contexttofile) {
271e6dec 195 $this->contexttofile = $contexttofile;
196 }
aca318e1 197
f3701561 198 /**
199 * set stoponerror
200 * @param bool stoponerror stops database write if any errors reported
201 */
c7df5006 202 public function setStoponerror($stoponerror) {
f3701561 203 $this->stoponerror = $stoponerror;
204 }
205
1b8b535d 206 /**
f7970e3c 207 * @param bool $canaccess Whether the current use can access the backup data folder. Determines
1b8b535d 208 * where export files are saved.
209 */
c7df5006 210 public function set_can_access_backupdata($canaccess) {
1b8b535d 211 $this->canaccessbackupdata = $canaccess;
212 }
213
e198992b
TH
214 /***********************
215 * IMPORTING FUNCTIONS
216 ***********************/
f3701561 217
218 /**
219 * Handle parsing error
220 */
c7df5006 221 protected function error($message, $text='', $questionname='') {
5e8a85aa 222 $importerrorquestion = get_string('importerrorquestion', 'question');
cdeabc06 223
f3701561 224 echo "<div class=\"importerror\">\n";
cdeabc06 225 echo "<strong>$importerrorquestion $questionname</strong>";
f3701561 226 if (!empty($text)) {
227 $text = s($text);
228 echo "<blockquote>$text</blockquote>\n";
229 }
230 echo "<strong>$message</strong>\n";
231 echo "</div>";
232
233 $this->importerrors++;
234 }
08892d5b 235
271e6dec 236 /**
a41e3287 237 * Import for questiontype plugins
238 * Do not override.
239 * @param data mixed The segment of data containing the question
240 * @param question object processed (so far) by standard import code if appropriate
241 * @param extra mixed any additional format specific data that may be passed by the format
88bc20c3 242 * @param qtypehint hint about a question type from format
a41e3287 243 * @return object question object suitable for save_options() or false if cannot handle
244 */
c7df5006 245 public function try_importing_using_qtypes($data, $question = null, $extra = null,
49e2bba7 246 $qtypehint = '') {
a41e3287 247
248 // work out what format we are using
88bc20c3 249 $formatname = substr(get_class($this), strlen('qformat_'));
a41e3287 250 $methodname = "import_from_$formatname";
251
88bc20c3 252 //first try importing using a hint from format
253 if (!empty($qtypehint)) {
49e2bba7 254 $qtype = question_bank::get_qtype($qtypehint, false);
88bc20c3 255 if (is_object($qtype) && method_exists($qtype, $methodname)) {
256 $question = $qtype->$methodname($data, $question, $this, $extra);
257 if ($question) {
258 return $question;
259 }
260 }
261 }
262
a41e3287 263 // loop through installed questiontypes checking for
264 // function to handle this question
49e2bba7 265 foreach (question_bank::get_all_qtypes() as $qtype) {
13bb604e
TH
266 if (method_exists($qtype, $methodname)) {
267 if ($question = $qtype->$methodname($data, $question, $this, $extra)) {
a41e3287 268 return $question;
269 }
270 }
271e6dec 271 }
272 return false;
a41e3287 273 }
274
08892d5b 275 /**
276 * Perform any required pre-processing
f7970e3c 277 * @return bool success
08892d5b 278 */
7348402f 279 public function importpreprocess() {
08892d5b 280 return true;
281 }
282
283 /**
284 * Process the file
285 * This method should not normally be overidden
49e2bba7 286 * @param object $category
f7970e3c 287 * @return bool success
08892d5b 288 */
7348402f 289 public function importprocess($category) {
d649fb02 290 global $USER, $CFG, $DB, $OUTPUT;
cde2709a 291
9dd46039
TH
292 // reset the timer in case file upload was slow
293 set_time_limit(0);
67c12527 294
9dd46039 295 // STAGE 1: Parse the file
5e8a85aa 296 echo $OUTPUT->notification(get_string('parsingquestions', 'question'), 'notifysuccess');
271e6dec 297
08892d5b 298 if (! $lines = $this->readdata($this->filename)) {
5e8a85aa 299 echo $OUTPUT->notification(get_string('cannotread', 'question'));
aca318e1 300 return false;
301 }
302
4d188926 303 if (!$questions = $this->readquestions($lines)) { // Extract all the questions
5e8a85aa 304 echo $OUTPUT->notification(get_string('noquestionsinfile', 'question'));
aca318e1 305 return false;
306 }
307
f3701561 308 // STAGE 2: Write data to database
5e8a85aa 309 echo $OUTPUT->notification(get_string('importingquestions', 'question',
f7c1dfaf 310 $this->count_questions($questions)), 'notifysuccess');
aca318e1 311
f3701561 312 // check for errors before we continue
313 if ($this->stoponerror and ($this->importerrors>0)) {
5e8a85aa 314 echo $OUTPUT->notification(get_string('importparseerror', 'question'));
10b4a508 315 return true;
f3701561 316 }
317
76f0a334 318 // get list of valid answer grades
92111e8d 319 $gradeoptionsfull = question_bank::fraction_options_full();
76f0a334 320
c1828e0b 321 // check answer grades are valid
322 // (now need to do this here because of 'stop on error': MDL-10689)
323 $gradeerrors = 0;
324 $goodquestions = array();
325 foreach ($questions as $question) {
326 if (!empty($question->fraction) and (is_array($question->fraction))) {
327 $fractions = $question->fraction;
b5d09003 328 $invalidfractions = array();
c1828e0b 329 foreach ($fractions as $key => $fraction) {
e198992b
TH
330 $newfraction = match_grade_options($gradeoptionsfull, $fraction,
331 $this->matchgrades);
332 if ($newfraction === false) {
b5d09003 333 $invalidfractions[] = $fraction;
e198992b 334 } else {
c1828e0b 335 $fractions[$key] = $newfraction;
336 }
337 }
b5d09003
TH
338 if ($invalidfractions) {
339 echo $OUTPUT->notification(get_string('invalidgrade', 'question',
340 implode(', ', $invalidfractions)));
c1828e0b 341 ++$gradeerrors;
342 continue;
e198992b 343 } else {
c1828e0b 344 $question->fraction = $fractions;
345 }
346 }
347 $goodquestions[] = $question;
348 }
349 $questions = $goodquestions;
350
351 // check for errors before we continue
e198992b 352 if ($this->stoponerror && $gradeerrors > 0) {
c1828e0b 353 return false;
354 }
355
356 // count number of questions processed
aca318e1 357 $count = 0;
358
359 foreach ($questions as $question) { // Process and store each question
08892d5b 360
271e6dec 361 // reset the php timeout
49e2bba7 362 set_time_limit(0);
67c12527 363
08892d5b 364 // check for category modifiers
9dd46039 365 if ($question->qtype == 'category') {
08892d5b 366 if ($this->catfromfile) {
367 // find/create category object
40e71443 368 $catpath = $question->category;
728d60a1 369 $newcategory = $this->create_category_path($catpath);
08892d5b 370 if (!empty($newcategory)) {
371 $this->category = $newcategory;
372 }
373 }
271e6dec 374 continue;
08892d5b 375 }
4d188926 376 $question->context = $this->importcontext;
08892d5b 377
aca318e1 378 $count++;
379
5b0dc681 380 echo "<hr /><p><b>$count</b>. ".$this->format_question_text($question)."</p>";
aca318e1 381
9dd46039 382 $question->category = $this->category->id;
aca318e1 383 $question->stamp = make_unique_id_code(); // Set the unique code (not to be changed)
aca318e1 384
271e6dec 385 $question->createdby = $USER->id;
386 $question->timecreated = time();
08f53286
TH
387 $question->modifiedby = $USER->id;
388 $question->timemodified = time();
7ace84e0
JMV
389 $fileoptions = array(
390 'subdirs' => false,
391 'maxfiles' => -1,
392 'maxbytes' => 0,
393 );
271e6dec 394
cde2709a 395 $question->id = $DB->insert_record('question', $question);
7ace84e0 396
7980a381
JMV
397 if (isset($question->questiontextitemid)) {
398 $question->questiontext = file_save_draft_area_files($question->questiontextitemid,
7ace84e0
JMV
399 $this->importcontext->id, 'question', 'questiontext', $question->id,
400 $fileoptions, $question->questiontext);
401 } else if (isset($question->questiontextfiles)) {
cde2709a 402 foreach ($question->questiontextfiles as $file) {
d649fb02 403 question_bank::get_qtype($question->qtype)->import_file(
4d188926 404 $this->importcontext, 'question', 'questiontext', $question->id, $file);
cde2709a
DC
405 }
406 }
7980a381
JMV
407 if (isset($question->generalfeedbackitemid)) {
408 $question->generalfeedback = file_save_draft_area_files($question->generalfeedbackitemid,
7ace84e0
JMV
409 $this->importcontext->id, 'question', 'generalfeedback', $question->id,
410 $fileoptions, $question->generalfeedback);
411 } else if (isset($question->generalfeedbackfiles)) {
cde2709a 412 foreach ($question->generalfeedbackfiles as $file) {
d649fb02 413 question_bank::get_qtype($question->qtype)->import_file(
4d188926 414 $this->importcontext, 'question', 'generalfeedback', $question->id, $file);
cde2709a
DC
415 }
416 }
7ace84e0 417 $DB->update_record('question', $question);
aca318e1 418
419 $this->questionids[] = $question->id;
420
421 // Now to save all the answers and type-specific options
422
d649fb02 423 $result = question_bank::get_qtype($question->qtype)->save_question_options($question);
aca318e1 424
4f290077
TH
425 if (!empty($CFG->usetags) && isset($question->tags)) {
426 require_once($CFG->dirroot . '/tag/lib.php');
427 tag_set('question', $question->id, $question->tags);
428 }
429
aca318e1 430 if (!empty($result->error)) {
fef8f84e 431 echo $OUTPUT->notification($result->error);
aca318e1 432 return false;
433 }
434
435 if (!empty($result->notice)) {
fef8f84e 436 echo $OUTPUT->notification($result->notice);
aca318e1 437 return true;
438 }
cbe20043 439
440 // Give the question a unique version stamp determined by question_hash()
e198992b
TH
441 $DB->set_field('question', 'version', question_hash($question),
442 array('id' => $question->id));
aca318e1 443 }
444 return true;
445 }
13bb604e 446
ce2df288 447 /**
448 * Count all non-category questions in the questions array.
f34488b2 449 *
ce2df288 450 * @param array questions An array of question objects.
451 * @return int The count.
f34488b2 452 *
ce2df288 453 */
c7df5006 454 protected function count_questions($questions) {
ce2df288 455 $count = 0;
456 if (!is_array($questions)) {
457 return $count;
458 }
459 foreach ($questions as $question) {
e198992b
TH
460 if (!is_object($question) || !isset($question->qtype) ||
461 ($question->qtype == 'category')) {
ce2df288 462 continue;
463 }
464 $count++;
465 }
466 return $count;
467 }
468
271e6dec 469 /**
470 * find and/or create the category described by a delimited list
471 * e.g. $course$/tom/dick/harry or tom/dick/harry
472 *
473 * removes any context string no matter whether $getcontext is set
474 * but if $getcontext is set then ignore the context and use selected category context.
475 *
476 * @param string catpath delimited category path
271e6dec 477 * @param int courseid course to search for categories
478 * @return mixed category object or null if fails
479 */
c7df5006 480 protected function create_category_path($catpath) {
f34488b2 481 global $DB;
728d60a1 482 $catnames = $this->split_category_path($catpath);
271e6dec 483 $parent = 0;
484 $category = null;
88bc20c3 485
5ca9e32d 486 // check for context id in path, it might not be there in pre 1.9 exports
487 $matchcount = preg_match('/^\$([a-z]+)\$$/', $catnames[0], $matches);
49e2bba7 488 if ($matchcount == 1) {
271e6dec 489 $contextid = $this->translator->string_to_context($matches[1]);
490 array_shift($catnames);
491 } else {
728d60a1 492 $contextid = false;
271e6dec 493 }
728d60a1
TH
494
495 if ($this->contextfromfile && $contextid !== false) {
d197ea43 496 $context = context::instance_by_id($contextid);
271e6dec 497 require_capability('moodle/question:add', $context);
498 } else {
d197ea43 499 $context = context::instance_by_id($this->category->contextid);
271e6dec 500 }
4d188926 501 $this->importcontext = $context;
728d60a1
TH
502
503 // Now create any categories that need to be created.
271e6dec 504 foreach ($catnames as $catname) {
e198992b
TH
505 if ($category = $DB->get_record('question_categories',
506 array('name' => $catname, 'contextid' => $context->id, 'parent' => $parent))) {
271e6dec 507 $parent = $category->id;
508 } else {
509 require_capability('moodle/question:managecategory', $context);
510 // create the new category
7f389342 511 $category = new stdClass();
271e6dec 512 $category->contextid = $context->id;
513 $category->name = $catname;
514 $category->info = '';
515 $category->parent = $parent;
516 $category->sortorder = 999;
517 $category->stamp = make_unique_id_code();
bf8e93d7 518 $id = $DB->insert_record('question_categories', $category);
271e6dec 519 $category->id = $id;
520 $parent = $id;
521 }
522 }
523 return $category;
524 }
3f5633df 525
f3701561 526 /**
527 * Return complete file within an array, one item per line
528 * @param string filename name of file
529 * @return mixed contents array or false on failure
530 */
c7df5006 531 protected function readdata($filename) {
aca318e1 532 if (is_readable($filename)) {
533 $filearray = file($filename);
534
77c1f160
TH
535 // If the first line of the file starts with a UTF-8 BOM, remove it.
536 $filearray[0] = textlib::trim_utf8_bom($filearray[0]);
537
538 // Check for Macintosh OS line returns (ie file on one line), and fix.
6dbcacee 539 if (preg_match("~\r~", $filearray[0]) AND !preg_match("~\n~", $filearray[0])) {
aca318e1 540 return explode("\r", $filearray[0]);
541 } else {
542 return $filearray;
543 }
544 }
545 return false;
546 }
547
f3701561 548 /**
271e6dec 549 * Parses an array of lines into an array of questions,
550 * where each item is a question object as defined by
551 * readquestion(). Questions are defined as anything
f3701561 552 * between blank lines.
553 *
4d188926
TH
554 * NOTE this method used to take $context as a second argument. However, at
555 * the point where this method was called, it was impossible to know what
556 * context the quetsions were going to be saved into, so the value could be
557 * wrong. Also, none of the standard question formats were using this argument,
558 * so it was removed. See MDL-32220.
559 *
f3701561 560 * If your format does not use blank lines as a delimiter
561 * then you will need to override this method. Even then
562 * try to use readquestion for each question
563 * @param array lines array of lines from readdata
564 * @return array array of question objects
565 */
4d188926 566 protected function readquestions($lines) {
271e6dec 567
aca318e1 568 $questions = array();
569 $currentquestion = array();
570
571 foreach ($lines as $line) {
572 $line = trim($line);
573 if (empty($line)) {
574 if (!empty($currentquestion)) {
575 if ($question = $this->readquestion($currentquestion)) {
576 $questions[] = $question;
577 }
578 $currentquestion = array();
579 }
580 } else {
581 $currentquestion[] = $line;
582 }
583 }
584
585 if (!empty($currentquestion)) { // There may be a final question
4d188926 586 if ($question = $this->readquestion($currentquestion)) {
aca318e1 587 $questions[] = $question;
588 }
589 }
590
591 return $questions;
592 }
593
f3701561 594 /**
595 * return an "empty" question
596 * Somewhere to specify question parameters that are not handled
597 * by import but are required db fields.
598 * This should not be overridden.
599 * @return object default question
271e6dec 600 */
c7df5006 601 protected function defaultquestion() {
b0679efa 602 global $CFG;
0cd46577 603 static $defaultshuffleanswers = null;
604 if (is_null($defaultshuffleanswers)) {
605 $defaultshuffleanswers = get_config('quiz', 'shuffleanswers');
606 }
271e6dec 607
aca318e1 608 $question = new stdClass();
0cd46577 609 $question->shuffleanswers = $defaultshuffleanswers;
49e2bba7 610 $question->defaultmark = 1;
aca318e1 611 $question->image = "";
612 $question->usecase = 0;
613 $question->multiplier = array();
45bdcf11 614 $question->questiontextformat = FORMAT_MOODLE;
172f6d95 615 $question->generalfeedback = '';
45bdcf11 616 $question->generalfeedbackformat = FORMAT_MOODLE;
08892d5b 617 $question->correctfeedback = '';
618 $question->partiallycorrectfeedback = '';
619 $question->incorrectfeedback = '';
5931ea94 620 $question->answernumbering = 'abc';
49e2bba7 621 $question->penalty = 0.3333333;
3f5633df 622 $question->length = 1;
aca318e1 623
5fd8f999 624 // this option in case the questiontypes class wants
625 // to know where the data came from
626 $question->export_process = true;
093414d2 627 $question->import_process = true;
5fd8f999 628
aca318e1 629 return $question;
630 }
631
cacb8fa0
TH
632 /**
633 * Construct a reasonable default question name, based on the start of the question text.
634 * @param string $questiontext the question text.
635 * @param string $default default question name to use if the constructed one comes out blank.
636 * @return string a reasonable question name.
637 */
638 public function create_default_question_name($questiontext, $default) {
639 $name = $this->clean_question_name(shorten_text($questiontext, 80));
640 if ($name) {
641 return $name;
642 } else {
643 return $default;
644 }
645 }
646
647 /**
648 * Ensure that a question name does not contain anything nasty, and will fit in the DB field.
649 * @param string $name the raw question name.
650 * @return string a safe question name.
651 */
652 public function clean_question_name($name) {
653 $name = clean_param($name, PARAM_TEXT); // Matches what the question editing form does.
654 $name = trim($name);
655 $trimlength = 251;
656 while (textlib::strlen($name) > 255 && $trimlength > 0) {
657 $name = shorten_text($name, $trimlength);
658 $trimlength -= 10;
659 }
660 return $name;
661 }
662
7ace84e0
JMV
663 /**
664 * Add a blank combined feedback to a question object.
665 * @param object question
666 * @return object question
667 */
668 protected function add_blank_combined_feedback($question) {
669 $question->correctfeedback['text'] = '';
670 $question->correctfeedback['format'] = $question->questiontextformat;
671 $question->correctfeedback['files'] = array();
672 $question->partiallycorrectfeedback['text'] = '';
673 $question->partiallycorrectfeedback['format'] = $question->questiontextformat;
674 $question->partiallycorrectfeedback['files'] = array();
675 $question->incorrectfeedback['text'] = '';
676 $question->incorrectfeedback['format'] = $question->questiontextformat;
677 $question->incorrectfeedback['files'] = array();
678 return $question;
679 }
680
f3701561 681 /**
271e6dec 682 * Given the data known to define a question in
683 * this format, this function converts it into a question
f3701561 684 * object suitable for processing and insertion into Moodle.
685 *
686 * If your format does not use blank lines to delimit questions
687 * (e.g. an XML format) you must override 'readquestions' too
688 * @param $lines mixed data that represents question
689 * @return object question object
690 */
c7df5006 691 protected function readquestion($lines) {
aca318e1 692
5e8a85aa 693 $formatnotimplemented = get_string('formatnotimplemented', 'question');
1e3d6fd8 694 echo "<p>$formatnotimplemented</p>";
aca318e1 695
e0736817 696 return null;
aca318e1 697 }
698
f3701561 699 /**
700 * Override if any post-processing is required
f7970e3c 701 * @return bool success
f3701561 702 */
7348402f 703 public function importpostprocess() {
aca318e1 704 return true;
705 }
706
e198992b
TH
707 /*******************
708 * EXPORT FUNCTIONS
709 *******************/
aca318e1 710
271e6dec 711 /**
a41e3287 712 * Provide export functionality for plugin questiontypes
713 * Do not override
714 * @param name questiontype name
271e6dec 715 * @param question object data to export
a41e3287 716 * @param extra mixed any addition format specific data needed
717 * @return string the data to append to export or false if error (or unhandled)
718 */
c7df5006 719 protected function try_exporting_using_qtypes($name, $question, $extra=null) {
a41e3287 720 // work out the name of format in use
13bb604e 721 $formatname = substr(get_class($this), strlen('qformat_'));
a41e3287 722 $methodname = "export_to_$formatname";
723
d649fb02
TH
724 $qtype = question_bank::get_qtype($name, false);
725 if (method_exists($qtype, $methodname)) {
726 return $qtype->$methodname($question, $this, $extra);
a41e3287 727 }
728 return false;
729 }
730
f3701561 731 /**
732 * Do any pre-processing that may be required
f7970e3c 733 * @param bool success
f3701561 734 */
c7df5006 735 public function exportpreprocess() {
aca318e1 736 return true;
737 }
738
f3701561 739 /**
740 * Enable any processing to be done on the content
741 * just prior to the file being saved
742 * default is to do nothing
743 * @param string output text
744 * @param string processed output text
745 */
c7df5006 746 protected function presave_process($content) {
aca318e1 747 return $content;
748 }
749
f3701561 750 /**
751 * Do the export
752 * For most types this should not need to be overrided
cde2709a 753 * @return stored_file
f3701561 754 */
c7df5006 755 public function exportprocess() {
cde2709a 756 global $CFG, $OUTPUT, $DB, $USER;
aca318e1 757
758 // get the questions (from database) in this category
759 // only get q's with no parents (no cloze subquestions specifically)
cde2709a 760 if ($this->category) {
13bb604e 761 $questions = get_questions_category($this->category, true);
2c44a3d3 762 } else {
763 $questions = $this->questions;
764 }
aca318e1 765
aca318e1 766 $count = 0;
767
768 // results are first written into string (and then to a file)
769 // so create/initialize the string here
770 $expout = "";
271e6dec 771
f1abd39f 772 // track which category questions are in
773 // if it changes we will record the category change in the output
774 // file if selected. 0 means that it will get printed before the 1st question
775 $trackcategory = 0;
aca318e1 776
777 // iterate through questions
e198992b 778 foreach ($questions as $question) {
cde2709a 779 // used by file api
e198992b
TH
780 $contextid = $DB->get_field('question_categories', 'contextid',
781 array('id' => $question->category));
cde2709a 782 $question->contextid = $contextid;
271e6dec 783
a9b16aff 784 // do not export hidden questions
785 if (!empty($question->hidden)) {
786 continue;
787 }
788
789 // do not export random questions
55190d7e 790 if ($question->qtype == 'random') {
a9b16aff 791 continue;
792 }
271e6dec 793
f1abd39f 794 // check if we need to record category change
795 if ($this->cattofile) {
796 if ($question->category != $trackcategory) {
271e6dec 797 $trackcategory = $question->category;
728d60a1 798 $categoryname = $this->get_category_path($trackcategory, $this->contexttofile);
271e6dec 799
f1abd39f 800 // create 'dummy' question for category export
7f389342 801 $dummyquestion = new stdClass();
f1abd39f 802 $dummyquestion->qtype = 'category';
803 $dummyquestion->category = $categoryname;
728d60a1 804 $dummyquestion->name = 'Switch category to ' . $categoryname;
f1abd39f 805 $dummyquestion->id = 0;
806 $dummyquestion->questiontextformat = '';
cde2709a 807 $dummyquestion->contextid = 0;
728d60a1 808 $expout .= $this->writequestion($dummyquestion) . "\n";
271e6dec 809 }
810 }
f1abd39f 811
812 // export the question displaying message
813 $count++;
cde2709a 814
cde2709a 815 if (question_has_capability_on($question, 'view', $question->category)) {
cde2709a 816 $expout .= $this->writequestion($question, $contextid) . "\n";
0647e82b 817 }
a9b16aff 818 }
aca318e1 819
2c6d2c88 820 // continue path for following error checks
821 $course = $this->course;
2c44a3d3 822 $continuepath = "$CFG->wwwroot/question/export.php?courseid=$course->id";
2c6d2c88 823
824 // did we actually process anything
825 if ($count==0) {
5e8a85aa 826 print_error('noquestions', 'question', $continuepath);
2c6d2c88 827 }
828
aca318e1 829 // final pre-process on exported data
cde2709a
DC
830 $expout = $this->presave_process($expout);
831 return $expout;
aca318e1 832 }
3f5633df 833
271e6dec 834 /**
835 * get the category as a path (e.g., tom/dick/harry)
836 * @param int id the id of the most nested catgory
271e6dec 837 * @return string the path
838 */
c7df5006 839 protected function get_category_path($id, $includecontext = true) {
f34488b2 840 global $DB;
728d60a1 841
e198992b 842 if (!$category = $DB->get_record('question_categories', array('id' => $id))) {
1e7386c9 843 print_error('cannotfindcategory', 'error', '', $id);
271e6dec 844 }
271e6dec 845 $contextstring = $this->translator->context_to_string($category->contextid);
728d60a1
TH
846
847 $pathsections = array();
271e6dec 848 do {
728d60a1 849 $pathsections[] = $category->name;
271e6dec 850 $id = $category->parent;
13bb604e 851 } while ($category = $DB->get_record('question_categories', array('id' => $id)));
271e6dec 852
13bb604e 853 if ($includecontext) {
728d60a1 854 $pathsections[] = '$' . $contextstring . '$';
271e6dec 855 }
728d60a1
TH
856
857 $path = $this->assemble_category_path(array_reverse($pathsections));
858
271e6dec 859 return $path;
860 }
aca318e1 861
728d60a1
TH
862 /**
863 * Convert a list of category names, possibly preceeded by one of the
864 * context tokens like $course$, into a string representation of the
865 * category path.
866 *
867 * Names are separated by / delimiters. And /s in the name are replaced by //.
868 *
869 * To reverse the process and split the paths into names, use
870 * {@link split_category_path()}.
871 *
872 * @param array $names
873 * @return string
874 */
875 protected function assemble_category_path($names) {
876 $escapednames = array();
877 foreach ($names as $name) {
878 $escapedname = str_replace('/', '//', $name);
879 if (substr($escapedname, 0, 1) == '/') {
880 $escapedname = ' ' . $escapedname;
881 }
882 if (substr($escapedname, -1) == '/') {
883 $escapedname = $escapedname . ' ';
884 }
885 $escapednames[] = $escapedname;
886 }
887 return implode('/', $escapednames);
888 }
889
890 /**
891 * Convert a string, as returned by {@link assemble_category_path()},
892 * back into an array of category names.
893 *
071e68f9 894 * Each category name is cleaned by a call to clean_param(, PARAM_TEXT),
aab03169 895 * which matches the cleaning in question/category_form.php.
728d60a1
TH
896 *
897 * @param string $path
898 * @return array of category names.
899 */
900 protected function split_category_path($path) {
901 $rawnames = preg_split('~(?<!/)/(?!/)~', $path);
902 $names = array();
903 foreach ($rawnames as $rawname) {
071e68f9 904 $names[] = clean_param(trim(str_replace('//', '/', $rawname)), PARAM_TEXT);
728d60a1
TH
905 }
906 return $names;
907 }
908
f3701561 909 /**
910 * Do an post-processing that may be required
f7970e3c 911 * @return bool success
f3701561 912 */
c7df5006 913 protected function exportpostprocess() {
aca318e1 914 return true;
915 }
916
f3701561 917 /**
918 * convert a single question object into text output in the given
919 * format.
920 * This must be overriden
921 * @param object question question object
922 * @return mixed question export text or null if not implemented
923 */
c7df5006 924 protected function writequestion($question) {
1e3d6fd8 925 // if not overidden, then this is an error.
5e8a85aa 926 $formatnotimplemented = get_string('formatnotimplemented', 'question');
1e3d6fd8 927 echo "<p>$formatnotimplemented</p>";
e0736817 928 return null;
aca318e1 929 }
930
f3701561 931 /**
13bb604e
TH
932 * Convert the question text to plain text, so it can safely be displayed
933 * during import to let the user see roughly what is going on.
f3701561 934 */
c7df5006 935 protected function format_question_text($question) {
fe6ce234 936 global $DB;
0ff4bd08 937 $formatoptions = new stdClass();
5b0dc681 938 $formatoptions->noclean = true;
22cebed5 939 return html_to_text(format_text($question->questiontext,
c73c9836 940 $question->questiontextformat, $formatoptions), 0, false);
5b0dc681 941 }
aca318e1 942}
17ab0e74
JMV
943
944class qformat_based_on_xml extends qformat_default {
945
7ace84e0
JMV
946 /**
947 * A lot of imported files contain unwanted entities.
948 * This method tries to clean up all known problems.
949 * @param string str string to correct
950 * @return string the corrected string
951 */
952 public function cleaninput($str) {
953
954 $html_code_list = array(
955 "&#039;" => "'",
956 "&#8217;" => "'",
957 "&#8220;" => "\"",
958 "&#8221;" => "\"",
959 "&#8211;" => "-",
960 "&#8212;" => "-",
961 );
962 $str = strtr($str, $html_code_list);
963 // Use textlib entities_to_utf8 function to convert only numerical entities.
964 $str = textlib::entities_to_utf8($str, false);
965 return $str;
966 }
967
17ab0e74
JMV
968 /**
969 * Return the array moodle is expecting
970 * for an HTML text. No processing is done on $text.
971 * qformat classes that want to process $text
972 * for instance to import external images files
973 * and recode urls in $text must overwrite this method.
974 * @param array $text some HTML text string
975 * @return array with keys text, format and files.
976 */
977 public function text_field($text) {
978 return array(
979 'text' => trim($text),
980 'format' => FORMAT_HTML,
981 'files' => array(),
982 );
983 }
984
985 /**
986 * Return the value of a node, given a path to the node
987 * if it doesn't exist return the default value.
988 * @param array xml data to read
989 * @param array path path to node expressed as array
990 * @param mixed default
991 * @param bool istext process as text
992 * @param string error if set value must exist, return false and issue message if not
993 * @return mixed value
994 */
995 public function getpath($xml, $path, $default, $istext=false, $error='') {
996 foreach ($path as $index) {
997 if (!isset($xml[$index])) {
998 if (!empty($error)) {
999 $this->error($error);
1000 return false;
1001 } else {
1002 return $default;
1003 }
1004 }
1005
1006 $xml = $xml[$index];
1007 }
1008
1009 if ($istext) {
1010 if (!is_string($xml)) {
1011 $this->error(get_string('invalidxml', 'qformat_xml'));
1012 }
1013 $xml = trim($xml);
1014 }
1015
1016 return $xml;
1017 }
1018}