MDL-53140 qtype_calculatedsimple: Support locale-aware decimal points
[moodle.git] / lib / questionlib.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  * Code for handling and processing questions
19  *
20  * This is code that is module independent, i.e., can be used by any module that
21  * uses questions, like quiz, lesson, ..
22  * This script also loads the questiontype classes
23  * Code for handling the editing of questions is in {@link question/editlib.php}
24  *
25  * TODO: separate those functions which form part of the API
26  *       from the helper functions.
27  *
28  * @package moodlecore
29  * @subpackage questionbank
30  * @copyright 1999 onwards Martin Dougiamas and others {@link http://moodle.com}
31  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32  */
35 defined('MOODLE_INTERNAL') || die();
37 require_once($CFG->dirroot . '/question/engine/lib.php');
38 require_once($CFG->dirroot . '/question/type/questiontypebase.php');
42 /// CONSTANTS ///////////////////////////////////
44 /**
45  * Constant determines the number of answer boxes supplied in the editing
46  * form for multiple choice and similar question types.
47  */
48 define("QUESTION_NUMANS", 10);
50 /**
51  * Constant determines the number of answer boxes supplied in the editing
52  * form for multiple choice and similar question types to start with, with
53  * the option of adding QUESTION_NUMANS_ADD more answers.
54  */
55 define("QUESTION_NUMANS_START", 3);
57 /**
58  * Constant determines the number of answer boxes to add in the editing
59  * form for multiple choice and similar question types when the user presses
60  * 'add form fields button'.
61  */
62 define("QUESTION_NUMANS_ADD", 3);
64 /**
65  * Move one question type in a list of question types. If you try to move one element
66  * off of the end, nothing will change.
67  *
68  * @param array $sortedqtypes An array $qtype => anything.
69  * @param string $tomove one of the keys from $sortedqtypes
70  * @param integer $direction +1 or -1
71  * @return array an array $index => $qtype, with $index from 0 to n in order, and
72  *      the $qtypes in the same order as $sortedqtypes, except that $tomove will
73  *      have been moved one place.
74  */
75 function question_reorder_qtypes($sortedqtypes, $tomove, $direction) {
76     $neworder = array_keys($sortedqtypes);
77     // Find the element to move.
78     $key = array_search($tomove, $neworder);
79     if ($key === false) {
80         return $neworder;
81     }
82     // Work out the other index.
83     $otherkey = $key + $direction;
84     if (!isset($neworder[$otherkey])) {
85         return $neworder;
86     }
87     // Do the swap.
88     $swap = $neworder[$otherkey];
89     $neworder[$otherkey] = $neworder[$key];
90     $neworder[$key] = $swap;
91     return $neworder;
92 }
94 /**
95  * Save a new question type order to the config_plugins table.
96  * @global object
97  * @param $neworder An arra $index => $qtype. Indices should start at 0 and be in order.
98  * @param $config get_config('question'), if you happen to have it around, to save one DB query.
99  */
100 function question_save_qtype_order($neworder, $config = null) {
101     global $DB;
103     if (is_null($config)) {
104         $config = get_config('question');
105     }
107     foreach ($neworder as $index => $qtype) {
108         $sortvar = $qtype . '_sortorder';
109         if (!isset($config->$sortvar) || $config->$sortvar != $index + 1) {
110             set_config($sortvar, $index + 1, 'question');
111         }
112     }
115 /// FUNCTIONS //////////////////////////////////////////////////////
117 /**
118  * @param array $questionids of question ids.
119  * @return boolean whether any of these questions are being used by any part of Moodle.
120  */
121 function questions_in_use($questionids) {
122     global $CFG;
124     if (question_engine::questions_in_use($questionids)) {
125         return true;
126     }
128     foreach (core_component::get_plugin_list('mod') as $module => $path) {
129         $lib = $path . '/lib.php';
130         if (is_readable($lib)) {
131             include_once($lib);
133             $fn = $module . '_questions_in_use';
134             if (function_exists($fn)) {
135                 if ($fn($questionids)) {
136                     return true;
137                 }
138             } else {
140                 // Fallback for legacy modules.
141                 $fn = $module . '_question_list_instances';
142                 if (function_exists($fn)) {
143                     foreach ($questionids as $questionid) {
144                         $instances = $fn($questionid);
145                         if (!empty($instances)) {
146                             return true;
147                         }
148                     }
149                 }
150             }
151         }
152     }
154     return false;
157 /**
158  * Determine whether there arey any questions belonging to this context, that is whether any of its
159  * question categories contain any questions. This will return true even if all the questions are
160  * hidden.
161  *
162  * @param mixed $context either a context object, or a context id.
163  * @return boolean whether any of the question categories beloning to this context have
164  *         any questions in them.
165  */
166 function question_context_has_any_questions($context) {
167     global $DB;
168     if (is_object($context)) {
169         $contextid = $context->id;
170     } else if (is_numeric($context)) {
171         $contextid = $context;
172     } else {
173         print_error('invalidcontextinhasanyquestions', 'question');
174     }
175     return $DB->record_exists_sql("SELECT *
176                                      FROM {question} q
177                                      JOIN {question_categories} qc ON qc.id = q.category
178                                     WHERE qc.contextid = ? AND q.parent = 0", array($contextid));
181 /**
182  * Check whether a given grade is one of a list of allowed options. If not,
183  * depending on $matchgrades, either return the nearest match, or return false
184  * to signal an error.
185  * @param array $gradeoptionsfull list of valid options
186  * @param int $grade grade to be tested
187  * @param string $matchgrades 'error' or 'nearest'
188  * @return mixed either 'fixed' value or false if error.
189  */
190 function match_grade_options($gradeoptionsfull, $grade, $matchgrades = 'error') {
192     if ($matchgrades == 'error') {
193         // (Almost) exact match, or an error.
194         foreach ($gradeoptionsfull as $value => $option) {
195             // Slightly fuzzy test, never check floats for equality.
196             if (abs($grade - $value) < 0.00001) {
197                 return $value; // Be sure the return the proper value.
198             }
199         }
200         // Didn't find a match so that's an error.
201         return false;
203     } else if ($matchgrades == 'nearest') {
204         // Work out nearest value
205         $best = false;
206         $bestmismatch = 2;
207         foreach ($gradeoptionsfull as $value => $option) {
208             $newmismatch = abs($grade - $value);
209             if ($newmismatch < $bestmismatch) {
210                 $best = $value;
211                 $bestmismatch = $newmismatch;
212             }
213         }
214         return $best;
216     } else {
217         // Unknow option passed.
218         throw new coding_exception('Unknown $matchgrades ' . $matchgrades .
219                 ' passed to match_grade_options');
220     }
223 /**
224  * Remove stale questions from a category.
225  *
226  * While questions should not be left behind when they are not used any more,
227  * it does happen, maybe via restore, or old logic, or uncovered scenarios. When
228  * this happens, the users are unable to delete the question category unless
229  * they move those stale questions to another one category, but to them the
230  * category is empty as it does not contain anything. The purpose of this function
231  * is to detect the questions that may have gone stale and remove them.
232  *
233  * You will typically use this prior to checking if the category contains questions.
234  *
235  * The stale questions (unused and hidden to the user) handled are:
236  * - hidden questions
237  * - random questions
238  *
239  * @param int $categoryid The category ID.
240  */
241 function question_remove_stale_questions_from_category($categoryid) {
242     global $DB;
244     $select = 'category = :categoryid AND (qtype = :qtype OR hidden = :hidden)';
245     $params = ['categoryid' => $categoryid, 'qtype' => 'random', 'hidden' => 1];
246     $questions = $DB->get_recordset_select("question", $select, $params, '', 'id');
247     foreach ($questions as $question) {
248         // The function question_delete_question does not delete questions in use.
249         question_delete_question($question->id);
250     }
251     $questions->close();
254 /**
255  * Category is about to be deleted,
256  * 1/ All questions are deleted for this question category.
257  * 2/ Any questions that can't be deleted are moved to a new category
258  * NOTE: this function is called from lib/db/upgrade.php
259  *
260  * @param object|core_course_category $category course category object
261  */
262 function question_category_delete_safe($category) {
263     global $DB;
264     $criteria = array('category' => $category->id);
265     $context = context::instance_by_id($category->contextid, IGNORE_MISSING);
266     $rescue = null; // See the code around the call to question_save_from_deletion.
268     // Deal with any questions in the category.
269     if ($questions = $DB->get_records('question', $criteria, '', 'id,qtype')) {
271         // Try to delete each question.
272         foreach ($questions as $question) {
273             question_delete_question($question->id);
274         }
276         // Check to see if there were any questions that were kept because
277         // they are still in use somehow, even though quizzes in courses
278         // in this category will already have been deleted. This could
279         // happen, for example, if questions are added to a course,
280         // and then that course is moved to another category (MDL-14802).
281         $questionids = $DB->get_records_menu('question', $criteria, '', 'id, 1');
282         if (!empty($questionids)) {
283             $parentcontextid = SYSCONTEXTID;
284             $name = get_string('unknown', 'question');
285             if ($context !== false) {
286                 $name = $context->get_context_name();
287                 $parentcontext = $context->get_parent_context();
288                 if ($parentcontext) {
289                     $parentcontextid = $parentcontext->id;
290                 }
291             }
292             question_save_from_deletion(array_keys($questionids), $parentcontextid, $name, $rescue);
293         }
294     }
296     // Now delete the category.
297     $DB->delete_records('question_categories', array('id' => $category->id));
300 /**
301  * Tests whether any question in a category is used by any part of Moodle.
302  *
303  * @param integer $categoryid a question category id.
304  * @param boolean $recursive whether to check child categories too.
305  * @return boolean whether any question in this category is in use.
306  */
307 function question_category_in_use($categoryid, $recursive = false) {
308     global $DB;
310     //Look at each question in the category
311     if ($questions = $DB->get_records_menu('question',
312             array('category' => $categoryid), '', 'id, 1')) {
313         if (questions_in_use(array_keys($questions))) {
314             return true;
315         }
316     }
317     if (!$recursive) {
318         return false;
319     }
321     //Look under child categories recursively
322     if ($children = $DB->get_records('question_categories',
323             array('parent' => $categoryid), '', 'id, 1')) {
324         foreach ($children as $child) {
325             if (question_category_in_use($child->id, $recursive)) {
326                 return true;
327             }
328         }
329     }
331     return false;
334 /**
335  * Deletes question and all associated data from the database
336  *
337  * It will not delete a question if it is used by an activity module
338  * @param object $question  The question being deleted
339  */
340 function question_delete_question($questionid) {
341     global $DB;
343     $question = $DB->get_record_sql('
344             SELECT q.*, qc.contextid
345             FROM {question} q
346             JOIN {question_categories} qc ON qc.id = q.category
347             WHERE q.id = ?', array($questionid));
348     if (!$question) {
349         // In some situations, for example if this was a child of a
350         // Cloze question that was previously deleted, the question may already
351         // have gone. In this case, just do nothing.
352         return;
353     }
355     // Do not delete a question if it is used by an activity module
356     if (questions_in_use(array($questionid))) {
357         return;
358     }
360     $dm = new question_engine_data_mapper();
361     $dm->delete_previews($questionid);
363     // delete questiontype-specific data
364     question_bank::get_qtype($question->qtype, false)->delete_question(
365             $questionid, $question->contextid);
367     // Delete all tag instances.
368     core_tag_tag::remove_all_item_tags('core_question', 'question', $question->id);
370     // Now recursively delete all child questions
371     if ($children = $DB->get_records('question',
372             array('parent' => $questionid), '', 'id, qtype')) {
373         foreach ($children as $child) {
374             if ($child->id != $questionid) {
375                 question_delete_question($child->id);
376             }
377         }
378     }
380     // Finally delete the question record itself
381     $DB->delete_records('question', array('id' => $questionid));
382     question_bank::notify_question_edited($questionid);
385 /**
386  * All question categories and their questions are deleted for this context id.
387  *
388  * @param object $contextid The contextid to delete question categories from
389  * @return array Feedback from deletes (if any)
390  */
391 function question_delete_context($contextid) {
392     global $DB;
394     //To store feedback to be showed at the end of the process
395     $feedbackdata   = array();
397     //Cache some strings
398     $strcatdeleted = get_string('unusedcategorydeleted', 'question');
399     $fields = 'id, parent, name, contextid';
400     if ($categories = $DB->get_records('question_categories', array('contextid' => $contextid), 'parent', $fields)) {
401         //Sort categories following their tree (parent-child) relationships
402         //this will make the feedback more readable
403         $categories = sort_categories_by_tree($categories);
405         foreach ($categories as $category) {
406             question_category_delete_safe($category);
408             //Fill feedback
409             $feedbackdata[] = array($category->name, $strcatdeleted);
410         }
411     }
412     return $feedbackdata;
415 /**
416  * All question categories and their questions are deleted for this course.
417  *
418  * @param stdClass $course an object representing the activity
419  * @param boolean $feedback to specify if the process must output a summary of its work
420  * @return boolean
421  */
422 function question_delete_course($course, $feedback=true) {
423     $coursecontext = context_course::instance($course->id);
424     $feedbackdata = question_delete_context($coursecontext->id, $feedback);
426     // Inform about changes performed if feedback is enabled.
427     if ($feedback && $feedbackdata) {
428         $table = new html_table();
429         $table->head = array(get_string('category', 'question'), get_string('action'));
430         $table->data = $feedbackdata;
431         echo html_writer::table($table);
432     }
433     return true;
436 /**
437  * Category is about to be deleted,
438  * 1/ All question categories and their questions are deleted for this course category.
439  * 2/ All questions are moved to new category
440  *
441  * @param object|core_course_category $category course category object
442  * @param object|core_course_category $newcategory empty means everything deleted, otherwise id of
443  *      category where content moved
444  * @param boolean $feedback to specify if the process must output a summary of its work
445  * @return boolean
446  */
447 function question_delete_course_category($category, $newcategory, $feedback=true) {
448     global $DB, $OUTPUT;
450     $context = context_coursecat::instance($category->id);
451     if (empty($newcategory)) {
452         $feedbackdata = question_delete_context($context->id, $feedback);
454         // Output feedback if requested.
455         if ($feedback && $feedbackdata) {
456             $table = new html_table();
457             $table->head = array(get_string('questioncategory', 'question'), get_string('action'));
458             $table->data = $feedbackdata;
459             echo html_writer::table($table);
460         }
462     } else {
463         // Move question categories to the new context.
464         if (!$newcontext = context_coursecat::instance($newcategory->id)) {
465             return false;
466         }
468         // Only move question categories if there is any question category at all!
469         if ($topcategory = question_get_top_category($context->id)) {
470             $newtopcategory = question_get_top_category($newcontext->id, true);
472             question_move_category_to_context($topcategory->id, $context->id, $newcontext->id);
473             $DB->set_field('question_categories', 'parent', $newtopcategory->id, array('parent' => $topcategory->id));
474             // Now delete the top category.
475             $DB->delete_records('question_categories', array('id' => $topcategory->id));
476         }
478         if ($feedback) {
479             $a = new stdClass();
480             $a->oldplace = $context->get_context_name();
481             $a->newplace = $newcontext->get_context_name();
482             echo $OUTPUT->notification(
483                     get_string('movedquestionsandcategories', 'question', $a), 'notifysuccess');
484         }
485     }
487     return true;
490 /**
491  * Enter description here...
492  *
493  * @param array $questionids of question ids
494  * @param object $newcontextid the context to create the saved category in.
495  * @param string $oldplace a textual description of the think being deleted,
496  *      e.g. from get_context_name
497  * @param object $newcategory
498  * @return mixed false on
499  */
500 function question_save_from_deletion($questionids, $newcontextid, $oldplace,
501         $newcategory = null) {
502     global $DB;
504     // Make a category in the parent context to move the questions to.
505     if (is_null($newcategory)) {
506         $newcategory = new stdClass();
507         $newcategory->parent = question_get_top_category($newcontextid, true)->id;
508         $newcategory->contextid = $newcontextid;
509         $newcategory->name = get_string('questionsrescuedfrom', 'question', $oldplace);
510         $newcategory->info = get_string('questionsrescuedfrominfo', 'question', $oldplace);
511         $newcategory->sortorder = 999;
512         $newcategory->stamp = make_unique_id_code();
513         $newcategory->id = $DB->insert_record('question_categories', $newcategory);
514     }
516     // Move any remaining questions to the 'saved' category.
517     if (!question_move_questions_to_category($questionids, $newcategory->id)) {
518         return false;
519     }
520     return $newcategory;
523 /**
524  * All question categories and their questions are deleted for this activity.
525  *
526  * @param object $cm the course module object representing the activity
527  * @param boolean $feedback to specify if the process must output a summary of its work
528  * @return boolean
529  */
530 function question_delete_activity($cm, $feedback=true) {
531     global $DB;
533     $modcontext = context_module::instance($cm->id);
534     $feedbackdata = question_delete_context($modcontext->id, $feedback);
535     // Inform about changes performed if feedback is enabled.
536     if ($feedback && $feedbackdata) {
537         $table = new html_table();
538         $table->head = array(get_string('category', 'question'), get_string('action'));
539         $table->data = $feedbackdata;
540         echo html_writer::table($table);
541     }
542     return true;
545 /**
546  * This function will handle moving all tag instances to a new context for a
547  * given list of questions.
548  *
549  * Questions can be tagged in up to two contexts:
550  * 1.) The context the question exists in.
551  * 2.) The course context (if the question context is a higher context.
552  *     E.g. course category context or system context.
553  *
554  * This means a question that exists in a higher context (e.g. course cat or
555  * system context) may have multiple groups of tags in any number of child
556  * course contexts.
557  *
558  * Questions in the course category context can be move "down" a context level
559  * into one of their child course contexts or activity contexts which affects the
560  * availability of that question in other courses / activities.
561  *
562  * In this case it makes the questions no longer available in the other course or
563  * activity contexts so we need to make sure that the tag instances in those other
564  * contexts are removed.
565  *
566  * @param stdClass[] $questions The list of question being moved (must include
567  *                              the id and contextid)
568  * @param context $newcontext The Moodle context the questions are being moved to
569  */
570 function question_move_question_tags_to_new_context(array $questions, context $newcontext) {
571     // If the questions are moving to a new course/activity context then we need to
572     // find any existing tag instances from any unavailable course contexts and
573     // delete them because they will no longer be applicable (we don't support
574     // tagging questions across courses).
575     $instancestodelete = [];
576     $instancesfornewcontext = [];
577     $newcontextparentids = $newcontext->get_parent_context_ids();
578     $questionids = array_map(function($question) {
579         return $question->id;
580     }, $questions);
581     $questionstagobjects = core_tag_tag::get_items_tags('core_question', 'question', $questionids);
583     foreach ($questions as $question) {
584         $tagobjects = $questionstagobjects[$question->id];
586         foreach ($tagobjects as $tagobject) {
587             $tagid = $tagobject->taginstanceid;
588             $tagcontextid = $tagobject->taginstancecontextid;
589             $istaginnewcontext = $tagcontextid == $newcontext->id;
590             $istaginquestioncontext = $tagcontextid == $question->contextid;
592             if ($istaginnewcontext) {
593                 // This tag instance is already in the correct context so we can
594                 // ignore it.
595                 continue;
596             }
598             if ($istaginquestioncontext) {
599                 // This tag instance is in the question context so it needs to be
600                 // updated.
601                 $instancesfornewcontext[] = $tagid;
602                 continue;
603             }
605             // These tag instances are in neither the new context nor the
606             // question context so we need to determine what to do based on
607             // the context they are in and the new question context.
608             $tagcontext = context::instance_by_id($tagcontextid);
609             $tagcoursecontext = $tagcontext->get_course_context(false);
610             // The tag is in a course context if get_course_context() returns
611             // itself.
612             $istaginstancecontextcourse = !empty($tagcoursecontext)
613                 && $tagcontext->id == $tagcoursecontext->id;
615             if ($istaginstancecontextcourse) {
616                 // If the tag instance is in a course context we need to add some
617                 // special handling.
618                 $tagcontextparentids = $tagcontext->get_parent_context_ids();
619                 $isnewcontextaparent = in_array($newcontext->id, $tagcontextparentids);
620                 $isnewcontextachild = in_array($tagcontext->id, $newcontextparentids);
622                 if ($isnewcontextaparent) {
623                     // If the tag instance is a course context tag and the new
624                     // context is still a parent context to the tag context then
625                     // we can leave this tag where it is.
626                     continue;
627                 } else if ($isnewcontextachild) {
628                     // If the new context is a child context (e.g. activity) of this
629                     // tag instance then we should move all of this tag instance
630                     // down into the activity context along with the question.
631                     $instancesfornewcontext[] = $tagid;
632                 } else {
633                     // If the tag is in a course context that is no longer a parent
634                     // or child of the new context then this tag instance should be
635                     // removed.
636                     $instancestodelete[] = $tagid;
637                 }
638             } else {
639                 // This is a catch all for any tag instances not in the question
640                 // context or a course context. These tag instances should be
641                 // updated to the new context id. This will clean up old invalid
642                 // data.
643                 $instancesfornewcontext[] = $tagid;
644             }
645         }
646     }
648     if (!empty($instancestodelete)) {
649         // Delete any course context tags that may no longer be valid.
650         core_tag_tag::delete_instances_by_id($instancestodelete);
651     }
653     if (!empty($instancesfornewcontext)) {
654         // Update the tag instances to the new context id.
655         core_tag_tag::change_instances_context($instancesfornewcontext, $newcontext);
656     }
659 /**
660  * This function should be considered private to the question bank, it is called from
661  * question/editlib.php question/contextmoveq.php and a few similar places to to the
662  * work of actually moving questions and associated data. However, callers of this
663  * function also have to do other work, which is why you should not call this method
664  * directly from outside the questionbank.
665  *
666  * @param array $questionids of question ids.
667  * @param integer $newcategoryid the id of the category to move to.
668  */
669 function question_move_questions_to_category($questionids, $newcategoryid) {
670     global $DB;
672     $newcontextid = $DB->get_field('question_categories', 'contextid',
673             array('id' => $newcategoryid));
674     list($questionidcondition, $params) = $DB->get_in_or_equal($questionids);
675     $questions = $DB->get_records_sql("
676             SELECT q.id, q.qtype, qc.contextid, q.idnumber
677               FROM {question} q
678               JOIN {question_categories} qc ON q.category = qc.id
679              WHERE  q.id $questionidcondition", $params);
680     foreach ($questions as $question) {
681         if ($newcontextid != $question->contextid) {
682             question_bank::get_qtype($question->qtype)->move_files(
683                     $question->id, $question->contextid, $newcontextid);
684         }
685         // Check whether there could be a clash of idnumbers in the new category.
686         if (((string) $question->idnumber !== '') &&
687                 $DB->record_exists('question', ['idnumber' => $question->idnumber, 'category' => $newcategoryid])) {
688             $rec = $DB->get_records_select('question', "category = ? AND idnumber LIKE ?",
689                     [$newcategoryid, $question->idnumber . '_%'], 'idnumber DESC', 'id, idnumber', 0, 1);
690             $unique = 1;
691             if (count($rec)) {
692                 $rec = reset($rec);
693                 $idnumber = $rec->idnumber;
694                 if (strpos($idnumber, '_') !== false) {
695                     $unique = substr($idnumber, strpos($idnumber, '_') + 1) + 1;
696                 }
697             }
698             // For the move process, add a numerical increment to the idnumber. This means that if a question is
699             // mistakenly moved then the idnumber will not be completely lost.
700             $q = new stdClass();
701             $q->id = $question->id;
702             $q->category = $newcategoryid;
703             $q->idnumber = $question->idnumber . '_' . $unique;
704             $DB->update_record('question', $q);
705         }
706     }
708     // Move the questions themselves.
709     $DB->set_field_select('question', 'category', $newcategoryid,
710             "id $questionidcondition", $params);
712     // Move any subquestions belonging to them.
713     $DB->set_field_select('question', 'category', $newcategoryid,
714             "parent $questionidcondition", $params);
716     $newcontext = context::instance_by_id($newcontextid);
717     question_move_question_tags_to_new_context($questions, $newcontext);
719     // TODO Deal with datasets.
721     // Purge these questions from the cache.
722     foreach ($questions as $question) {
723         question_bank::notify_question_edited($question->id);
724     }
726     return true;
729 /**
730  * This function helps move a question cateogry to a new context by moving all
731  * the files belonging to all the questions to the new context.
732  * Also moves subcategories.
733  * @param integer $categoryid the id of the category being moved.
734  * @param integer $oldcontextid the old context id.
735  * @param integer $newcontextid the new context id.
736  */
737 function question_move_category_to_context($categoryid, $oldcontextid, $newcontextid) {
738     global $DB;
740     $questions = [];
741     $questionids = $DB->get_records_menu('question',
742             array('category' => $categoryid), '', 'id,qtype');
743     foreach ($questionids as $questionid => $qtype) {
744         question_bank::get_qtype($qtype)->move_files(
745                 $questionid, $oldcontextid, $newcontextid);
746         // Purge this question from the cache.
747         question_bank::notify_question_edited($questionid);
749         $questions[] = (object) [
750             'id' => $questionid,
751             'contextid' => $oldcontextid
752         ];
753     }
755     $newcontext = context::instance_by_id($newcontextid);
756     question_move_question_tags_to_new_context($questions, $newcontext);
758     $subcatids = $DB->get_records_menu('question_categories',
759             array('parent' => $categoryid), '', 'id,1');
760     foreach ($subcatids as $subcatid => $notused) {
761         $DB->set_field('question_categories', 'contextid', $newcontextid,
762                 array('id' => $subcatid));
763         question_move_category_to_context($subcatid, $oldcontextid, $newcontextid);
764     }
767 /**
768  * Generate the URL for starting a new preview of a given question with the given options.
769  * @param integer $questionid the question to preview.
770  * @param string $preferredbehaviour the behaviour to use for the preview.
771  * @param float $maxmark the maximum to mark the question out of.
772  * @param question_display_options $displayoptions the display options to use.
773  * @param int $variant the variant of the question to preview. If null, one will
774  *      be picked randomly.
775  * @param object $context context to run the preview in (affects things like
776  *      filter settings, theme, lang, etc.) Defaults to $PAGE->context.
777  * @return moodle_url the URL.
778  */
779 function question_preview_url($questionid, $preferredbehaviour = null,
780         $maxmark = null, $displayoptions = null, $variant = null, $context = null) {
782     $params = array('id' => $questionid);
784     if (is_null($context)) {
785         global $PAGE;
786         $context = $PAGE->context;
787     }
788     if ($context->contextlevel == CONTEXT_MODULE) {
789         $params['cmid'] = $context->instanceid;
790     } else if ($context->contextlevel == CONTEXT_COURSE) {
791         $params['courseid'] = $context->instanceid;
792     }
794     if (!is_null($preferredbehaviour)) {
795         $params['behaviour'] = $preferredbehaviour;
796     }
798     if (!is_null($maxmark)) {
799         $params['maxmark'] = format_float($maxmark, strlen($maxmark), true, true);
800     }
802     if (!is_null($displayoptions)) {
803         $params['correctness']     = $displayoptions->correctness;
804         $params['marks']           = $displayoptions->marks;
805         $params['markdp']          = $displayoptions->markdp;
806         $params['feedback']        = (bool) $displayoptions->feedback;
807         $params['generalfeedback'] = (bool) $displayoptions->generalfeedback;
808         $params['rightanswer']     = (bool) $displayoptions->rightanswer;
809         $params['history']         = (bool) $displayoptions->history;
810     }
812     if ($variant) {
813         $params['variant'] = $variant;
814     }
816     return new moodle_url('/question/preview.php', $params);
819 /**
820  * @return array that can be passed as $params to the {@link popup_action} constructor.
821  */
822 function question_preview_popup_params() {
823     return array(
824         'height' => 600,
825         'width' => 800,
826     );
829 /**
830  * Given a list of ids, load the basic information about a set of questions from
831  * the questions table. The $join and $extrafields arguments can be used together
832  * to pull in extra data. See, for example, the usage in mod/quiz/attemptlib.php, and
833  * read the code below to see how the SQL is assembled. Throws exceptions on error.
834  *
835  * @param array $questionids array of question ids to load. If null, then all
836  * questions matched by $join will be loaded.
837  * @param string $extrafields extra SQL code to be added to the query.
838  * @param string $join extra SQL code to be added to the query.
839  * @param array $extraparams values for any placeholders in $join.
840  * You must use named placeholders.
841  * @param string $orderby what to order the results by. Optional, default is unspecified order.
842  *
843  * @return array partially complete question objects. You need to call get_question_options
844  * on them before they can be properly used.
845  */
846 function question_preload_questions($questionids = null, $extrafields = '', $join = '',
847         $extraparams = array(), $orderby = '') {
848     global $DB;
850     if ($questionids === null) {
851         $where = '';
852         $params = array();
853     } else {
854         if (empty($questionids)) {
855             return array();
856         }
858         list($questionidcondition, $params) = $DB->get_in_or_equal(
859                 $questionids, SQL_PARAMS_NAMED, 'qid0000');
860         $where = 'WHERE q.id ' . $questionidcondition;
861     }
863     if ($join) {
864         $join = 'JOIN ' . $join;
865     }
867     if ($extrafields) {
868         $extrafields = ', ' . $extrafields;
869     }
871     if ($orderby) {
872         $orderby = 'ORDER BY ' . $orderby;
873     }
875     $sql = "SELECT q.*, qc.contextid{$extrafields}
876               FROM {question} q
877               JOIN {question_categories} qc ON q.category = qc.id
878               {$join}
879              {$where}
880           {$orderby}";
882     // Load the questions.
883     $questions = $DB->get_records_sql($sql, $extraparams + $params);
884     foreach ($questions as $question) {
885         $question->_partiallyloaded = true;
886     }
888     return $questions;
891 /**
892  * Load a set of questions, given a list of ids. The $join and $extrafields arguments can be used
893  * together to pull in extra data. See, for example, the usage in mod/quiz/attempt.php, and
894  * read the code below to see how the SQL is assembled. Throws exceptions on error.
895  *
896  * @param array $questionids array of question ids.
897  * @param string $extrafields extra SQL code to be added to the query.
898  * @param string $join extra SQL code to be added to the query.
899  * @param array $extraparams values for any placeholders in $join.
900  * You are strongly recommended to use named placeholder.
901  *
902  * @return array question objects.
903  */
904 function question_load_questions($questionids, $extrafields = '', $join = '') {
905     $questions = question_preload_questions($questionids, $extrafields, $join);
907     // Load the question type specific information
908     if (!get_question_options($questions)) {
909         return 'Could not load the question options';
910     }
912     return $questions;
915 /**
916  * Private function to factor common code out of get_question_options().
917  *
918  * @param object $question the question to tidy.
919  * @param stdClass $category The question_categories record for the given $question.
920  * @param stdClass[]|null $tagobjects The tags for the given $question.
921  * @param stdClass[]|null $filtercourses The courses to filter the course tags by.
922  */
923 function _tidy_question($question, $category, array $tagobjects = null, array $filtercourses = null) {
924     // Load question-type specific fields.
925     if (!question_bank::is_qtype_installed($question->qtype)) {
926         $question->questiontext = html_writer::tag('p', get_string('warningmissingtype',
927                 'qtype_missingtype')) . $question->questiontext;
928     }
929     question_bank::get_qtype($question->qtype)->get_question_options($question);
931     // Convert numeric fields to float. (Prevents these being displayed as 1.0000000.)
932     $question->defaultmark += 0;
933     $question->penalty += 0;
935     if (isset($question->_partiallyloaded)) {
936         unset($question->_partiallyloaded);
937     }
939     $question->categoryobject = $category;
941     if (!is_null($tagobjects)) {
942         $categorycontext = context::instance_by_id($category->contextid);
943         $sortedtagobjects = question_sort_tags($tagobjects, $categorycontext, $filtercourses);
944         $question->coursetagobjects = $sortedtagobjects->coursetagobjects;
945         $question->coursetags = $sortedtagobjects->coursetags;
946         $question->tagobjects = $sortedtagobjects->tagobjects;
947         $question->tags = $sortedtagobjects->tags;
948     }
951 /**
952  * Updates the question objects with question type specific
953  * information by calling {@link get_question_options()}
954  *
955  * Can be called either with an array of question objects or with a single
956  * question object.
957  *
958  * @param mixed $questions Either an array of question objects to be updated
959  *         or just a single question object
960  * @param bool $loadtags load the question tags from the tags table. Optional, default false.
961  * @param stdClass[] $filtercourses The courses to filter the course tags by.
962  * @return bool Indicates success or failure.
963  */
964 function get_question_options(&$questions, $loadtags = false, $filtercourses = null) {
965     global $DB;
967     $questionlist = is_array($questions) ? $questions : [$questions];
968     $categoryids = [];
969     $questionids = [];
971     if (empty($questionlist)) {
972         return true;
973     }
975     foreach ($questionlist as $question) {
976         $questionids[] = $question->id;
978         if (!in_array($question->category, $categoryids)) {
979             $categoryids[] = $question->category;
980         }
981     }
983     $categories = $DB->get_records_list('question_categories', 'id', $categoryids);
985     if ($loadtags && core_tag_tag::is_enabled('core_question', 'question')) {
986         $tagobjectsbyquestion = core_tag_tag::get_items_tags('core_question', 'question', $questionids);
987     } else {
988         $tagobjectsbyquestion = null;
989     }
991     foreach ($questionlist as $question) {
992         if (is_null($tagobjectsbyquestion)) {
993             $tagobjects = null;
994         } else {
995             $tagobjects = $tagobjectsbyquestion[$question->id];
996         }
998         _tidy_question($question, $categories[$question->category], $tagobjects, $filtercourses);
999     }
1001     return true;
1004 /**
1005  * Sort question tags by course or normal tags.
1006  *
1007  * This function also search tag instances that may have a context id that don't match either a course or
1008  * question context and fix the data setting the correct context id.
1009  *
1010  * @param stdClass[] $tagobjects The tags for the given $question.
1011  * @param stdClass $categorycontext The question categories context.
1012  * @param stdClass[]|null $filtercourses The courses to filter the course tags by.
1013  * @return stdClass $sortedtagobjects Sorted tag objects.
1014  */
1015 function question_sort_tags($tagobjects, $categorycontext, $filtercourses = null) {
1017     // Questions can have two sets of tag instances. One set at the
1018     // course context level and another at the context the question
1019     // belongs to (e.g. course category, system etc).
1020     $sortedtagobjects = new stdClass();
1021     $sortedtagobjects->coursetagobjects = [];
1022     $sortedtagobjects->coursetags = [];
1023     $sortedtagobjects->tagobjects = [];
1024     $sortedtagobjects->tags = [];
1025     $taginstanceidstonormalise = [];
1026     $filtercoursecontextids = [];
1027     $hasfiltercourses = !empty($filtercourses);
1029     if ($hasfiltercourses) {
1030         // If we're being asked to filter the course tags by a set of courses
1031         // then get the context ids to filter below.
1032         $filtercoursecontextids = array_map(function($course) {
1033             $coursecontext = context_course::instance($course->id);
1034             return $coursecontext->id;
1035         }, $filtercourses);
1036     }
1038     foreach ($tagobjects as $tagobject) {
1039         $tagcontextid = $tagobject->taginstancecontextid;
1040         $tagcontext = context::instance_by_id($tagcontextid);
1041         $tagcoursecontext = $tagcontext->get_course_context(false);
1042         // This is a course tag if the tag context is a course context which
1043         // doesn't match the question's context. Any tag in the question context
1044         // is not considered a course tag, it belongs to the question.
1045         $iscoursetag = $tagcoursecontext
1046             && $tagcontext->id == $tagcoursecontext->id
1047             && $tagcontext->id != $categorycontext->id;
1049         if ($iscoursetag) {
1050             // Any tag instance in a course context level is considered a course tag.
1051             if (!$hasfiltercourses || in_array($tagcontextid, $filtercoursecontextids)) {
1052                 // Add the tag to the list of course tags if we aren't being
1053                 // asked to filter or if this tag is in the list of courses
1054                 // we're being asked to filter by.
1055                 $sortedtagobjects->coursetagobjects[] = $tagobject;
1056                 $sortedtagobjects->coursetags[$tagobject->id] = $tagobject->get_display_name();
1057             }
1058         } else {
1059             // All non course context level tag instances or tags in the question
1060             // context belong to the context that the question was created in.
1061             $sortedtagobjects->tagobjects[] = $tagobject;
1062             $sortedtagobjects->tags[$tagobject->id] = $tagobject->get_display_name();
1064             // Due to legacy tag implementations that don't force the recording
1065             // of a context id, some tag instances may have context ids that don't
1066             // match either a course context or the question context. In this case
1067             // we should take the opportunity to fix up the data and set the correct
1068             // context id.
1069             if ($tagcontext->id != $categorycontext->id) {
1070                 $taginstanceidstonormalise[] = $tagobject->taginstanceid;
1071                 // Update the object properties to reflect the DB update that will
1072                 // happen below.
1073                 $tagobject->taginstancecontextid = $categorycontext->id;
1074             }
1075         }
1076     }
1078     if (!empty($taginstanceidstonormalise)) {
1079         // If we found any tag instances with incorrect context id data then we can
1080         // correct those values now by setting them to the question context id.
1081         core_tag_tag::change_instances_context($taginstanceidstonormalise, $categorycontext);
1082     }
1084     return $sortedtagobjects;
1087 /**
1088  * Print the icon for the question type
1089  *
1090  * @param object $question The question object for which the icon is required.
1091  *       Only $question->qtype is used.
1092  * @return string the HTML for the img tag.
1093  */
1094 function print_question_icon($question) {
1095     global $PAGE;
1096     return $PAGE->get_renderer('question', 'bank')->qtype_icon($question->qtype);
1099 /**
1100  * Creates a stamp that uniquely identifies this version of the question
1101  *
1102  * In future we want this to use a hash of the question data to guarantee that
1103  * identical versions have the same version stamp.
1104  *
1105  * @param object $question
1106  * @return string A unique version stamp
1107  */
1108 function question_hash($question) {
1109     return make_unique_id_code();
1112 /// CATEGORY FUNCTIONS /////////////////////////////////////////////////////////////////
1114 /**
1115  * returns the categories with their names ordered following parent-child relationships
1116  * finally it tries to return pending categories (those being orphaned, whose parent is
1117  * incorrect) to avoid missing any category from original array.
1118  */
1119 function sort_categories_by_tree(&$categories, $id = 0, $level = 1) {
1120     global $DB;
1122     $children = array();
1123     $keys = array_keys($categories);
1125     foreach ($keys as $key) {
1126         if (!isset($categories[$key]->processed) && $categories[$key]->parent == $id) {
1127             $children[$key] = $categories[$key];
1128             $categories[$key]->processed = true;
1129             $children = $children + sort_categories_by_tree(
1130                     $categories, $children[$key]->id, $level+1);
1131         }
1132     }
1133     //If level = 1, we have finished, try to look for non processed categories
1134     // (bad parent) and sort them too
1135     if ($level == 1) {
1136         foreach ($keys as $key) {
1137             // If not processed and it's a good candidate to start (because its
1138             // parent doesn't exist in the course)
1139             if (!isset($categories[$key]->processed) && !$DB->record_exists('question_categories',
1140                     array('contextid' => $categories[$key]->contextid,
1141                             'id' => $categories[$key]->parent))) {
1142                 $children[$key] = $categories[$key];
1143                 $categories[$key]->processed = true;
1144                 $children = $children + sort_categories_by_tree(
1145                         $categories, $children[$key]->id, $level + 1);
1146             }
1147         }
1148     }
1149     return $children;
1152 /**
1153  * Private method, only for the use of add_indented_names().
1154  *
1155  * Recursively adds an indentedname field to each category, starting with the category
1156  * with id $id, and dealing with that category and all its children, and
1157  * return a new array, with those categories in the right order.
1158  *
1159  * @param array $categories an array of categories which has had childids
1160  *          fields added by flatten_category_tree(). Passed by reference for
1161  *          performance only. It is not modfied.
1162  * @param int $id the category to start the indenting process from.
1163  * @param int $depth the indent depth. Used in recursive calls.
1164  * @return array a new array of categories, in the right order for the tree.
1165  */
1166 function flatten_category_tree(&$categories, $id, $depth = 0, $nochildrenof = -1) {
1168     // Indent the name of this category.
1169     $newcategories = array();
1170     $newcategories[$id] = $categories[$id];
1171     $newcategories[$id]->indentedname = str_repeat('&nbsp;&nbsp;&nbsp;', $depth) .
1172             $categories[$id]->name;
1174     // Recursively indent the children.
1175     foreach ($categories[$id]->childids as $childid) {
1176         if ($childid != $nochildrenof) {
1177             $newcategories = $newcategories + flatten_category_tree(
1178                     $categories, $childid, $depth + 1, $nochildrenof);
1179         }
1180     }
1182     // Remove the childids array that were temporarily added.
1183     unset($newcategories[$id]->childids);
1185     return $newcategories;
1188 /**
1189  * Format categories into an indented list reflecting the tree structure.
1190  *
1191  * @param array $categories An array of category objects, for example from the.
1192  * @return array The formatted list of categories.
1193  */
1194 function add_indented_names($categories, $nochildrenof = -1) {
1196     // Add an array to each category to hold the child category ids. This array
1197     // will be removed again by flatten_category_tree(). It should not be used
1198     // outside these two functions.
1199     foreach (array_keys($categories) as $id) {
1200         $categories[$id]->childids = array();
1201     }
1203     // Build the tree structure, and record which categories are top-level.
1204     // We have to be careful, because the categories array may include published
1205     // categories from other courses, but not their parents.
1206     $toplevelcategoryids = array();
1207     foreach (array_keys($categories) as $id) {
1208         if (!empty($categories[$id]->parent) &&
1209                 array_key_exists($categories[$id]->parent, $categories)) {
1210             $categories[$categories[$id]->parent]->childids[] = $id;
1211         } else {
1212             $toplevelcategoryids[] = $id;
1213         }
1214     }
1216     // Flatten the tree to and add the indents.
1217     $newcategories = array();
1218     foreach ($toplevelcategoryids as $id) {
1219         $newcategories = $newcategories + flatten_category_tree(
1220                 $categories, $id, 0, $nochildrenof);
1221     }
1223     return $newcategories;
1226 /**
1227  * Output a select menu of question categories.
1228  *
1229  * Categories from this course and (optionally) published categories from other courses
1230  * are included. Optionally, only categories the current user may edit can be included.
1231  *
1232  * @param integer $courseid the id of the course to get the categories for.
1233  * @param integer $published if true, include publised categories from other courses.
1234  * @param integer $only_editable if true, exclude categories this user is not allowed to edit.
1235  * @param integer $selected optionally, the id of a category to be selected by
1236  *      default in the dropdown.
1237  */
1238 function question_category_select_menu($contexts, $top = false, $currentcat = 0,
1239         $selected = "", $nochildrenof = -1) {
1240     $categoriesarray = question_category_options($contexts, $top, $currentcat,
1241             false, $nochildrenof);
1242     if ($selected) {
1243         $choose = '';
1244     } else {
1245         $choose = 'choosedots';
1246     }
1247     $options = array();
1248     foreach ($categoriesarray as $group => $opts) {
1249         $options[] = array($group => $opts);
1250     }
1251     echo html_writer::label(get_string('questioncategory', 'core_question'), 'id_movetocategory', false, array('class' => 'accesshide'));
1252     $attrs = array('id' => 'id_movetocategory', 'class' => 'custom-select');
1253     echo html_writer::select($options, 'category', $selected, $choose, $attrs);
1256 /**
1257  * @param integer $contextid a context id.
1258  * @return object the default question category for that context, or false if none.
1259  */
1260 function question_get_default_category($contextid) {
1261     global $DB;
1262     $category = $DB->get_records_select('question_categories', 'contextid = ? AND parent <> 0',
1263             array($contextid), 'id', '*', 0, 1);
1264     if (!empty($category)) {
1265         return reset($category);
1266     } else {
1267         return false;
1268     }
1271 /**
1272  * Gets the top category in the given context.
1273  * This function can optionally create the top category if it doesn't exist.
1274  *
1275  * @param int $contextid A context id.
1276  * @param bool $create Whether create a top category if it doesn't exist.
1277  * @return bool|stdClass The top question category for that context, or false if none.
1278  */
1279 function question_get_top_category($contextid, $create = false) {
1280     global $DB;
1281     $category = $DB->get_record('question_categories',
1282             array('contextid' => $contextid, 'parent' => 0));
1284     if (!$category && $create) {
1285         // We need to make one.
1286         $category = new stdClass();
1287         $category->name = 'top'; // A non-real name for the top category. It will be localised at the display time.
1288         $category->info = '';
1289         $category->contextid = $contextid;
1290         $category->parent = 0;
1291         $category->sortorder = 0;
1292         $category->stamp = make_unique_id_code();
1293         $category->id = $DB->insert_record('question_categories', $category);
1294     }
1296     return $category;
1299 /**
1300  * Gets the list of top categories in the given contexts in the array("categoryid,categorycontextid") format.
1301  *
1302  * @param array $contextids List of context ids
1303  * @return array
1304  */
1305 function question_get_top_categories_for_contexts($contextids) {
1306     global $DB;
1308     $concatsql = $DB->sql_concat_join("','", ['id', 'contextid']);
1309     list($insql, $params) = $DB->get_in_or_equal($contextids);
1310     $sql = "SELECT $concatsql FROM {question_categories} WHERE contextid $insql AND parent = 0";
1311     $topcategories = $DB->get_fieldset_sql($sql, $params);
1313     return $topcategories;
1316 /**
1317  * Gets the default category in the most specific context.
1318  * If no categories exist yet then default ones are created in all contexts.
1319  *
1320  * @param array $contexts  The context objects for this context and all parent contexts.
1321  * @return object The default category - the category in the course context
1322  */
1323 function question_make_default_categories($contexts) {
1324     global $DB;
1325     static $preferredlevels = array(
1326         CONTEXT_COURSE => 4,
1327         CONTEXT_MODULE => 3,
1328         CONTEXT_COURSECAT => 2,
1329         CONTEXT_SYSTEM => 1,
1330     );
1332     $toreturn = null;
1333     $preferredness = 0;
1334     // If it already exists, just return it.
1335     foreach ($contexts as $key => $context) {
1336         $topcategory = question_get_top_category($context->id, true);
1337         if (!$exists = $DB->record_exists("question_categories",
1338                 array('contextid' => $context->id, 'parent' => $topcategory->id))) {
1339             // Otherwise, we need to make one
1340             $category = new stdClass();
1341             $contextname = $context->get_context_name(false, true);
1342             $category->name = get_string('defaultfor', 'question', $contextname);
1343             $category->info = get_string('defaultinfofor', 'question', $contextname);
1344             $category->contextid = $context->id;
1345             $category->parent = $topcategory->id;
1346             // By default, all categories get this number, and are sorted alphabetically.
1347             $category->sortorder = 999;
1348             $category->stamp = make_unique_id_code();
1349             $category->id = $DB->insert_record('question_categories', $category);
1350         } else {
1351             $category = question_get_default_category($context->id);
1352         }
1353         $thispreferredness = $preferredlevels[$context->contextlevel];
1354         if (has_any_capability(array('moodle/question:usemine', 'moodle/question:useall'), $context)) {
1355             $thispreferredness += 10;
1356         }
1357         if ($thispreferredness > $preferredness) {
1358             $toreturn = $category;
1359             $preferredness = $thispreferredness;
1360         }
1361     }
1363     if (!is_null($toreturn)) {
1364         $toreturn = clone($toreturn);
1365     }
1366     return $toreturn;
1369 /**
1370  * Get all the category objects, including a count of the number of questions in that category,
1371  * for all the categories in the lists $contexts.
1372  *
1373  * @param mixed $contexts either a single contextid, or a comma-separated list of context ids.
1374  * @param string $sortorder used as the ORDER BY clause in the select statement.
1375  * @param bool $top Whether to return the top categories or not.
1376  * @return array of category objects.
1377  */
1378 function get_categories_for_contexts($contexts, $sortorder = 'parent, sortorder, name ASC', $top = false) {
1379     global $DB;
1380     $topwhere = $top ? '' : 'AND c.parent <> 0';
1381     return $DB->get_records_sql("
1382             SELECT c.*, (SELECT count(1) FROM {question} q
1383                         WHERE c.id = q.category AND q.hidden='0' AND q.parent='0') AS questioncount
1384               FROM {question_categories} c
1385              WHERE c.contextid IN ($contexts) $topwhere
1386           ORDER BY $sortorder");
1389 /**
1390  * Output an array of question categories.
1391  *
1392  * @param array $contexts The list of contexts.
1393  * @param bool $top Whether to return the top categories or not.
1394  * @param int $currentcat
1395  * @param bool $popupform
1396  * @param int $nochildrenof
1397  * @return array
1398  */
1399 function question_category_options($contexts, $top = false, $currentcat = 0,
1400         $popupform = false, $nochildrenof = -1) {
1401     global $CFG;
1402     $pcontexts = array();
1403     foreach ($contexts as $context) {
1404         $pcontexts[] = $context->id;
1405     }
1406     $contextslist = join($pcontexts, ', ');
1408     $categories = get_categories_for_contexts($contextslist, 'parent, sortorder, name ASC', $top);
1410     if ($top) {
1411         $categories = question_fix_top_names($categories);
1412     }
1414     $categories = question_add_context_in_key($categories);
1415     $categories = add_indented_names($categories, $nochildrenof);
1417     // sort cats out into different contexts
1418     $categoriesarray = array();
1419     foreach ($pcontexts as $contextid) {
1420         $context = context::instance_by_id($contextid);
1421         $contextstring = $context->get_context_name(true, true);
1422         foreach ($categories as $category) {
1423             if ($category->contextid == $contextid) {
1424                 $cid = $category->id;
1425                 if ($currentcat != $cid || $currentcat == 0) {
1426                     $countstring = !empty($category->questioncount) ?
1427                             " ($category->questioncount)" : '';
1428                     $categoriesarray[$contextstring][$cid] =
1429                             format_string($category->indentedname, true,
1430                                 array('context' => $context)) . $countstring;
1431                 }
1432             }
1433         }
1434     }
1435     if ($popupform) {
1436         $popupcats = array();
1437         foreach ($categoriesarray as $contextstring => $optgroup) {
1438             $group = array();
1439             foreach ($optgroup as $key => $value) {
1440                 $key = str_replace($CFG->wwwroot, '', $key);
1441                 $group[$key] = $value;
1442             }
1443             $popupcats[] = array($contextstring => $group);
1444         }
1445         return $popupcats;
1446     } else {
1447         return $categoriesarray;
1448     }
1451 function question_add_context_in_key($categories) {
1452     $newcatarray = array();
1453     foreach ($categories as $id => $category) {
1454         $category->parent = "$category->parent,$category->contextid";
1455         $category->id = "$category->id,$category->contextid";
1456         $newcatarray["$id,$category->contextid"] = $category;
1457     }
1458     return $newcatarray;
1461 /**
1462  * Finds top categories in the given categories hierarchy and replace their name with a proper localised string.
1463  *
1464  * @param array $categories An array of question categories.
1465  * @return array The same question category list given to the function, with the top category names being translated.
1466  */
1467 function question_fix_top_names($categories) {
1469     foreach ($categories as $id => $category) {
1470         if ($category->parent == 0) {
1471             $context = context::instance_by_id($category->contextid);
1472             $categories[$id]->name = get_string('topfor', 'question', $context->get_context_name(false));
1473         }
1474     }
1476     return $categories;
1479 /**
1480  * @return array of question category ids of the category and all subcategories.
1481  */
1482 function question_categorylist($categoryid) {
1483     global $DB;
1485     // final list of category IDs
1486     $categorylist = array();
1488     // a list of category IDs to check for any sub-categories
1489     $subcategories = array($categoryid);
1491     while ($subcategories) {
1492         foreach ($subcategories as $subcategory) {
1493             // if anything from the temporary list was added already, then we have a loop
1494             if (isset($categorylist[$subcategory])) {
1495                 throw new coding_exception("Category id=$subcategory is already on the list - loop of categories detected.");
1496             }
1497             $categorylist[$subcategory] = $subcategory;
1498         }
1500         list ($in, $params) = $DB->get_in_or_equal($subcategories);
1502         $subcategories = $DB->get_records_select_menu('question_categories',
1503                 "parent $in", $params, NULL, 'id,id AS id2');
1504     }
1506     return $categorylist;
1509 /**
1510  * Get all parent categories of a given question category in decending order.
1511  * @param int $categoryid for which you want to find the parents.
1512  * @return array of question category ids of all parents categories.
1513  */
1514 function question_categorylist_parents(int $categoryid) {
1515     global $DB;
1516     $parent = $DB->get_field('question_categories', 'parent', array('id' => $categoryid));
1517     if (!$parent) {
1518         return [];
1519     }
1520     $categorylist = [$parent];
1521     $currentid = $parent;
1522     while ($currentid) {
1523         $currentid = $DB->get_field('question_categories', 'parent', array('id' => $currentid));
1524         if ($currentid) {
1525             $categorylist[] = $currentid;
1526         }
1527     }
1528     // Present the list in decending order (the top category at the top).
1529     $categorylist = array_reverse($categorylist);
1530     return $categorylist;
1533 //===========================
1534 // Import/Export Functions
1535 //===========================
1537 /**
1538  * Get list of available import or export formats
1539  * @param string $type 'import' if import list, otherwise export list assumed
1540  * @return array sorted list of import/export formats available
1541  */
1542 function get_import_export_formats($type) {
1543     global $CFG;
1544     require_once($CFG->dirroot . '/question/format.php');
1546     $formatclasses = core_component::get_plugin_list_with_class('qformat', '', 'format.php');
1548     $fileformatname = array();
1549     foreach ($formatclasses as $component => $formatclass) {
1551         $format = new $formatclass();
1552         if ($type == 'import') {
1553             $provided = $format->provide_import();
1554         } else {
1555             $provided = $format->provide_export();
1556         }
1558         if ($provided) {
1559             list($notused, $fileformat) = explode('_', $component, 2);
1560             $fileformatnames[$fileformat] = get_string('pluginname', $component);
1561         }
1562     }
1564     core_collator::asort($fileformatnames);
1565     return $fileformatnames;
1569 /**
1570  * Create a reasonable default file name for exporting questions from a particular
1571  * category.
1572  * @param object $course the course the questions are in.
1573  * @param object $category the question category.
1574  * @return string the filename.
1575  */
1576 function question_default_export_filename($course, $category) {
1577     // We build a string that is an appropriate name (questions) from the lang pack,
1578     // then the corse shortname, then the question category name, then a timestamp.
1580     $base = clean_filename(get_string('exportfilename', 'question'));
1582     $dateformat = str_replace(' ', '_', get_string('exportnameformat', 'question'));
1583     $timestamp = clean_filename(userdate(time(), $dateformat, 99, false));
1585     $shortname = clean_filename($course->shortname);
1586     if ($shortname == '' || $shortname == '_' ) {
1587         $shortname = $course->id;
1588     }
1590     $categoryname = clean_filename(format_string($category->name));
1592     return "{$base}-{$shortname}-{$categoryname}-{$timestamp}";
1594     return $export_name;
1597 /**
1598  * Converts contextlevels to strings and back to help with reading/writing contexts
1599  * to/from import/export files.
1600  *
1601  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1602  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1603  */
1604 class context_to_string_translator{
1605     /**
1606      * @var array used to translate between contextids and strings for this context.
1607      */
1608     protected $contexttostringarray = array();
1610     public function __construct($contexts) {
1611         $this->generate_context_to_string_array($contexts);
1612     }
1614     public function context_to_string($contextid) {
1615         return $this->contexttostringarray[$contextid];
1616     }
1618     public function string_to_context($contextname) {
1619         $contextid = array_search($contextname, $this->contexttostringarray);
1620         return $contextid;
1621     }
1623     protected function generate_context_to_string_array($contexts) {
1624         if (!$this->contexttostringarray) {
1625             $catno = 1;
1626             foreach ($contexts as $context) {
1627                 switch ($context->contextlevel) {
1628                     case CONTEXT_MODULE :
1629                         $contextstring = 'module';
1630                         break;
1631                     case CONTEXT_COURSE :
1632                         $contextstring = 'course';
1633                         break;
1634                     case CONTEXT_COURSECAT :
1635                         $contextstring = "cat$catno";
1636                         $catno++;
1637                         break;
1638                     case CONTEXT_SYSTEM :
1639                         $contextstring = 'system';
1640                         break;
1641                 }
1642                 $this->contexttostringarray[$context->id] = $contextstring;
1643             }
1644         }
1645     }
1649 /**
1650  * Check capability on category
1651  *
1652  * @param int|stdClass $questionorid object or id. If an object is passed, it should include ->contextid and ->createdby.
1653  * @param string $cap 'add', 'edit', 'view', 'use', 'move' or 'tag'.
1654  * @param int $notused no longer used.
1655  * @return bool this user has the capability $cap for this question $question?
1656  * @throws coding_exception
1657  */
1658 function question_has_capability_on($questionorid, $cap, $notused = -1) {
1659     global $USER, $DB;
1661     if (is_numeric($questionorid)) {
1662         $questionid = (int)$questionorid;
1663     } else if (is_object($questionorid)) {
1664         // All we really need in this function is the contextid and author of the question.
1665         // We won't bother fetching other details of the question if these 2 fields are provided.
1666         if (isset($questionorid->contextid) && isset($questionorid->createdby)) {
1667             $question = $questionorid;
1668         } else if (!empty($questionorid->id)) {
1669             $questionid = $questionorid->id;
1670         }
1671     }
1673     // At this point, either $question or $questionid is expected to be set.
1674     if (isset($questionid)) {
1675         try {
1676             $question = question_bank::load_question_data($questionid);
1677         } catch (Exception $e) {
1678             // Let's log the exception for future debugging.
1679             debugging($e->getMessage(), DEBUG_NORMAL, $e->getTrace());
1681             // Well, at least we tried. Seems that we really have to read from DB.
1682             $question = $DB->get_record_sql('SELECT q.id, q.createdby, qc.contextid
1683                                                FROM {question} q
1684                                                JOIN {question_categories} qc ON q.category = qc.id
1685                                               WHERE q.id = :id', ['id' => $questionid]);
1686         }
1687     }
1689     if (!isset($question)) {
1690         throw new coding_exception('$questionorid parameter needs to be an integer or an object.');
1691     }
1693     $context = context::instance_by_id($question->contextid);
1695     // These are existing questions capabilities that are set per category.
1696     // Each of these has a 'mine' and 'all' version that is appended to the capability name.
1697     $capabilitieswithallandmine = ['edit' => 1, 'view' => 1, 'use' => 1, 'move' => 1, 'tag' => 1];
1699     if (!isset($capabilitieswithallandmine[$cap])) {
1700         return has_capability('moodle/question:' . $cap, $context);
1701     } else {
1702         return has_capability('moodle/question:' . $cap . 'all', $context) ||
1703             ($question->createdby == $USER->id && has_capability('moodle/question:' . $cap . 'mine', $context));
1704     }
1707 /**
1708  * Require capability on question.
1709  */
1710 function question_require_capability_on($question, $cap) {
1711     if (!question_has_capability_on($question, $cap)) {
1712         print_error('nopermissions', '', '', $cap);
1713     }
1714     return true;
1717 /**
1718  * @param object $context a context
1719  * @return string A URL for editing questions in this context.
1720  */
1721 function question_edit_url($context) {
1722     global $CFG, $SITE;
1723     if (!has_any_capability(question_get_question_capabilities(), $context)) {
1724         return false;
1725     }
1726     $baseurl = $CFG->wwwroot . '/question/edit.php?';
1727     $defaultcategory = question_get_default_category($context->id);
1728     if ($defaultcategory) {
1729         $baseurl .= 'cat=' . $defaultcategory->id . ',' . $context->id . '&amp;';
1730     }
1731     switch ($context->contextlevel) {
1732         case CONTEXT_SYSTEM:
1733             return $baseurl . 'courseid=' . $SITE->id;
1734         case CONTEXT_COURSECAT:
1735             // This is nasty, becuase we can only edit questions in a course
1736             // context at the moment, so for now we just return false.
1737             return false;
1738         case CONTEXT_COURSE:
1739             return $baseurl . 'courseid=' . $context->instanceid;
1740         case CONTEXT_MODULE:
1741             return $baseurl . 'cmid=' . $context->instanceid;
1742     }
1746 /**
1747  * Adds question bank setting links to the given navigation node if caps are met.
1748  *
1749  * @param navigation_node $navigationnode The navigation node to add the question branch to
1750  * @param object $context
1751  * @return navigation_node Returns the question branch that was added
1752  */
1753 function question_extend_settings_navigation(navigation_node $navigationnode, $context) {
1754     global $PAGE;
1756     if ($context->contextlevel == CONTEXT_COURSE) {
1757         $params = array('courseid'=>$context->instanceid);
1758     } else if ($context->contextlevel == CONTEXT_MODULE) {
1759         $params = array('cmid'=>$context->instanceid);
1760     } else {
1761         return;
1762     }
1764     if (($cat = $PAGE->url->param('cat')) && preg_match('~\d+,\d+~', $cat)) {
1765         $params['cat'] = $cat;
1766     }
1768     $questionnode = $navigationnode->add(get_string('questionbank', 'question'),
1769             new moodle_url('/question/edit.php', $params), navigation_node::TYPE_CONTAINER, null, 'questionbank');
1771     $contexts = new question_edit_contexts($context);
1772     if ($contexts->have_one_edit_tab_cap('questions')) {
1773         $questionnode->add(get_string('questions', 'question'), new moodle_url(
1774                 '/question/edit.php', $params), navigation_node::TYPE_SETTING, null, 'questions');
1775     }
1776     if ($contexts->have_one_edit_tab_cap('categories')) {
1777         $questionnode->add(get_string('categories', 'question'), new moodle_url(
1778                 '/question/category.php', $params), navigation_node::TYPE_SETTING, null, 'categories');
1779     }
1780     if ($contexts->have_one_edit_tab_cap('import')) {
1781         $questionnode->add(get_string('import', 'question'), new moodle_url(
1782                 '/question/import.php', $params), navigation_node::TYPE_SETTING, null, 'import');
1783     }
1784     if ($contexts->have_one_edit_tab_cap('export')) {
1785         $questionnode->add(get_string('export', 'question'), new moodle_url(
1786                 '/question/export.php', $params), navigation_node::TYPE_SETTING, null, 'export');
1787     }
1789     return $questionnode;
1792 /**
1793  * @return array all the capabilities that relate to accessing particular questions.
1794  */
1795 function question_get_question_capabilities() {
1796     return array(
1797         'moodle/question:add',
1798         'moodle/question:editmine',
1799         'moodle/question:editall',
1800         'moodle/question:viewmine',
1801         'moodle/question:viewall',
1802         'moodle/question:usemine',
1803         'moodle/question:useall',
1804         'moodle/question:movemine',
1805         'moodle/question:moveall',
1806     );
1809 /**
1810  * @return array all the question bank capabilities.
1811  */
1812 function question_get_all_capabilities() {
1813     $caps = question_get_question_capabilities();
1814     $caps[] = 'moodle/question:managecategory';
1815     $caps[] = 'moodle/question:flag';
1816     return $caps;
1820 /**
1821  * Tracks all the contexts related to the one where we are currently editing
1822  * questions, and provides helper methods to check permissions.
1823  *
1824  * @copyright 2007 Jamie Pratt me@jamiep.org
1825  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1826  */
1827 class question_edit_contexts {
1829     public static $caps = array(
1830         'editq' => array('moodle/question:add',
1831             'moodle/question:editmine',
1832             'moodle/question:editall',
1833             'moodle/question:viewmine',
1834             'moodle/question:viewall',
1835             'moodle/question:usemine',
1836             'moodle/question:useall',
1837             'moodle/question:movemine',
1838             'moodle/question:moveall'),
1839         'questions'=>array('moodle/question:add',
1840             'moodle/question:editmine',
1841             'moodle/question:editall',
1842             'moodle/question:viewmine',
1843             'moodle/question:viewall',
1844             'moodle/question:movemine',
1845             'moodle/question:moveall'),
1846         'categories'=>array('moodle/question:managecategory'),
1847         'import'=>array('moodle/question:add'),
1848         'export'=>array('moodle/question:viewall', 'moodle/question:viewmine'));
1850     protected $allcontexts;
1852     /**
1853      * Constructor
1854      * @param context the current context.
1855      */
1856     public function __construct(context $thiscontext) {
1857         $this->allcontexts = array_values($thiscontext->get_parent_contexts(true));
1858     }
1860     /**
1861      * @return array all parent contexts
1862      */
1863     public function all() {
1864         return $this->allcontexts;
1865     }
1867     /**
1868      * @return object lowest context which must be either the module or course context
1869      */
1870     public function lowest() {
1871         return $this->allcontexts[0];
1872     }
1874     /**
1875      * @param string $cap capability
1876      * @return array parent contexts having capability, zero based index
1877      */
1878     public function having_cap($cap) {
1879         $contextswithcap = array();
1880         foreach ($this->allcontexts as $context) {
1881             if (has_capability($cap, $context)) {
1882                 $contextswithcap[] = $context;
1883             }
1884         }
1885         return $contextswithcap;
1886     }
1888     /**
1889      * @param array $caps capabilities
1890      * @return array parent contexts having at least one of $caps, zero based index
1891      */
1892     public function having_one_cap($caps) {
1893         $contextswithacap = array();
1894         foreach ($this->allcontexts as $context) {
1895             foreach ($caps as $cap) {
1896                 if (has_capability($cap, $context)) {
1897                     $contextswithacap[] = $context;
1898                     break; //done with caps loop
1899                 }
1900             }
1901         }
1902         return $contextswithacap;
1903     }
1905     /**
1906      * @param string $tabname edit tab name
1907      * @return array parent contexts having at least one of $caps, zero based index
1908      */
1909     public function having_one_edit_tab_cap($tabname) {
1910         return $this->having_one_cap(self::$caps[$tabname]);
1911     }
1913     /**
1914      * @return those contexts where a user can add a question and then use it.
1915      */
1916     public function having_add_and_use() {
1917         $contextswithcap = array();
1918         foreach ($this->allcontexts as $context) {
1919             if (!has_capability('moodle/question:add', $context)) {
1920                 continue;
1921             }
1922             if (!has_any_capability(array('moodle/question:useall', 'moodle/question:usemine'), $context)) {
1923                             continue;
1924             }
1925             $contextswithcap[] = $context;
1926         }
1927         return $contextswithcap;
1928     }
1930     /**
1931      * Has at least one parent context got the cap $cap?
1932      *
1933      * @param string $cap capability
1934      * @return boolean
1935      */
1936     public function have_cap($cap) {
1937         return (count($this->having_cap($cap)));
1938     }
1940     /**
1941      * Has at least one parent context got one of the caps $caps?
1942      *
1943      * @param array $caps capability
1944      * @return boolean
1945      */
1946     public function have_one_cap($caps) {
1947         foreach ($caps as $cap) {
1948             if ($this->have_cap($cap)) {
1949                 return true;
1950             }
1951         }
1952         return false;
1953     }
1955     /**
1956      * Has at least one parent context got one of the caps for actions on $tabname
1957      *
1958      * @param string $tabname edit tab name
1959      * @return boolean
1960      */
1961     public function have_one_edit_tab_cap($tabname) {
1962         return $this->have_one_cap(self::$caps[$tabname]);
1963     }
1965     /**
1966      * Throw error if at least one parent context hasn't got the cap $cap
1967      *
1968      * @param string $cap capability
1969      */
1970     public function require_cap($cap) {
1971         if (!$this->have_cap($cap)) {
1972             print_error('nopermissions', '', '', $cap);
1973         }
1974     }
1976     /**
1977      * Throw error if at least one parent context hasn't got one of the caps $caps
1978      *
1979      * @param array $cap capabilities
1980      */
1981     public function require_one_cap($caps) {
1982         if (!$this->have_one_cap($caps)) {
1983             $capsstring = join($caps, ', ');
1984             print_error('nopermissions', '', '', $capsstring);
1985         }
1986     }
1988     /**
1989      * Throw error if at least one parent context hasn't got one of the caps $caps
1990      *
1991      * @param string $tabname edit tab name
1992      */
1993     public function require_one_edit_tab_cap($tabname) {
1994         if (!$this->have_one_edit_tab_cap($tabname)) {
1995             print_error('nopermissions', '', '', 'access question edit tab '.$tabname);
1996         }
1997     }
2001 /**
2002  * Helps call file_rewrite_pluginfile_urls with the right parameters.
2003  *
2004  * @package  core_question
2005  * @category files
2006  * @param string $text text being processed
2007  * @param string $file the php script used to serve files
2008  * @param int $contextid context ID
2009  * @param string $component component
2010  * @param string $filearea filearea
2011  * @param array $ids other IDs will be used to check file permission
2012  * @param int $itemid item ID
2013  * @param array $options options
2014  * @return string
2015  */
2016 function question_rewrite_question_urls($text, $file, $contextid, $component,
2017         $filearea, array $ids, $itemid, array $options=null) {
2019     $idsstr = '';
2020     if (!empty($ids)) {
2021         $idsstr .= implode('/', $ids);
2022     }
2023     if ($itemid !== null) {
2024         $idsstr .= '/' . $itemid;
2025     }
2026     return file_rewrite_pluginfile_urls($text, $file, $contextid, $component,
2027             $filearea, $idsstr, $options);
2030 /**
2031  * Rewrite the PLUGINFILE urls in part of the content of a question, for use when
2032  * viewing the question outside an attempt (for example, in the question bank
2033  * listing or in the quiz statistics report).
2034  *
2035  * @param string $text the question text.
2036  * @param int $questionid the question id.
2037  * @param int $filecontextid the context id of the question being displayed.
2038  * @param string $filecomponent the component that owns the file area.
2039  * @param string $filearea the file area name.
2040  * @param int|null $itemid the file's itemid
2041  * @param int $previewcontextid the context id where the preview is being displayed.
2042  * @param string $previewcomponent component responsible for displaying the preview.
2043  * @param array $options text and file options ('forcehttps'=>false)
2044  * @return string $questiontext with URLs rewritten.
2045  */
2046 function question_rewrite_question_preview_urls($text, $questionid,
2047         $filecontextid, $filecomponent, $filearea, $itemid,
2048         $previewcontextid, $previewcomponent, $options = null) {
2050     $path = "preview/$previewcontextid/$previewcomponent/$questionid";
2051     if ($itemid) {
2052         $path .= '/' . $itemid;
2053     }
2055     return file_rewrite_pluginfile_urls($text, 'pluginfile.php', $filecontextid,
2056             $filecomponent, $filearea, $path, $options);
2059 /**
2060  * Called by pluginfile.php to serve files related to the 'question' core
2061  * component and for files belonging to qtypes.
2062  *
2063  * For files that relate to questions in a question_attempt, then we delegate to
2064  * a function in the component that owns the attempt (for example in the quiz,
2065  * or in core question preview) to get necessary inforation.
2066  *
2067  * (Note that, at the moment, all question file areas relate to questions in
2068  * attempts, so the If at the start of the last paragraph is always true.)
2069  *
2070  * Does not return, either calls send_file_not_found(); or serves the file.
2071  *
2072  * @package  core_question
2073  * @category files
2074  * @param stdClass $course course settings object
2075  * @param stdClass $context context object
2076  * @param string $component the name of the component we are serving files for.
2077  * @param string $filearea the name of the file area.
2078  * @param array $args the remaining bits of the file path.
2079  * @param bool $forcedownload whether the user must be forced to download the file.
2080  * @param array $options additional options affecting the file serving
2081  */
2082 function question_pluginfile($course, $context, $component, $filearea, $args, $forcedownload, array $options=array()) {
2083     global $DB, $CFG;
2085     // Special case, sending a question bank export.
2086     if ($filearea === 'export') {
2087         list($context, $course, $cm) = get_context_info_array($context->id);
2088         require_login($course, false, $cm);
2090         require_once($CFG->dirroot . '/question/editlib.php');
2091         $contexts = new question_edit_contexts($context);
2092         // check export capability
2093         $contexts->require_one_edit_tab_cap('export');
2094         $category_id = (int)array_shift($args);
2095         $format      = array_shift($args);
2096         $cattofile   = array_shift($args);
2097         $contexttofile = array_shift($args);
2098         $filename    = array_shift($args);
2100         // load parent class for import/export
2101         require_once($CFG->dirroot . '/question/format.php');
2102         require_once($CFG->dirroot . '/question/editlib.php');
2103         require_once($CFG->dirroot . '/question/format/' . $format . '/format.php');
2105         $classname = 'qformat_' . $format;
2106         if (!class_exists($classname)) {
2107             send_file_not_found();
2108         }
2110         $qformat = new $classname();
2112         if (!$category = $DB->get_record('question_categories', array('id' => $category_id))) {
2113             send_file_not_found();
2114         }
2116         $qformat->setCategory($category);
2117         $qformat->setContexts($contexts->having_one_edit_tab_cap('export'));
2118         $qformat->setCourse($course);
2120         if ($cattofile == 'withcategories') {
2121             $qformat->setCattofile(true);
2122         } else {
2123             $qformat->setCattofile(false);
2124         }
2126         if ($contexttofile == 'withcontexts') {
2127             $qformat->setContexttofile(true);
2128         } else {
2129             $qformat->setContexttofile(false);
2130         }
2132         if (!$qformat->exportpreprocess()) {
2133             send_file_not_found();
2134             print_error('exporterror', 'question', $thispageurl->out());
2135         }
2137         // export data to moodle file pool
2138         if (!$content = $qformat->exportprocess()) {
2139             send_file_not_found();
2140         }
2142         send_file($content, $filename, 0, 0, true, true, $qformat->mime_type());
2143     }
2145     // Normal case, a file belonging to a question.
2146     $qubaidorpreview = array_shift($args);
2148     // Two sub-cases: 1. A question being previewed outside an attempt/usage.
2149     if ($qubaidorpreview === 'preview') {
2150         $previewcontextid = (int)array_shift($args);
2151         $previewcomponent = array_shift($args);
2152         $questionid = (int) array_shift($args);
2153         $previewcontext = context_helper::instance_by_id($previewcontextid);
2155         $result = component_callback($previewcomponent, 'question_preview_pluginfile', array(
2156                 $previewcontext, $questionid,
2157                 $context, $component, $filearea, $args,
2158                 $forcedownload, $options), 'callbackmissing');
2160         if ($result === 'callbackmissing') {
2161             throw new coding_exception("Component {$previewcomponent} does not define the callback " .
2162                     "{$previewcomponent}_question_preview_pluginfile callback. " .
2163                     "Which is required if you are using question_rewrite_question_preview_urls.", DEBUG_DEVELOPER);
2164         }
2166         send_file_not_found();
2167     }
2169     // 2. A question being attempted in the normal way.
2170     $qubaid = (int)$qubaidorpreview;
2171     $slot = (int)array_shift($args);
2173     $module = $DB->get_field('question_usages', 'component',
2174             array('id' => $qubaid));
2175     if (!$module) {
2176         send_file_not_found();
2177     }
2179     if ($module === 'core_question_preview') {
2180         require_once($CFG->dirroot . '/question/previewlib.php');
2181         return question_preview_question_pluginfile($course, $context,
2182                 $component, $filearea, $qubaid, $slot, $args, $forcedownload, $options);
2184     } else {
2185         $dir = core_component::get_component_directory($module);
2186         if (!file_exists("$dir/lib.php")) {
2187             send_file_not_found();
2188         }
2189         include_once("$dir/lib.php");
2191         $filefunction = $module . '_question_pluginfile';
2192         if (function_exists($filefunction)) {
2193             $filefunction($course, $context, $component, $filearea, $qubaid, $slot,
2194                 $args, $forcedownload, $options);
2195         }
2197         // Okay, we're here so lets check for function without 'mod_'.
2198         if (strpos($module, 'mod_') === 0) {
2199             $filefunctionold  = substr($module, 4) . '_question_pluginfile';
2200             if (function_exists($filefunctionold)) {
2201                 $filefunctionold($course, $context, $component, $filearea, $qubaid, $slot,
2202                     $args, $forcedownload, $options);
2203             }
2204         }
2206         send_file_not_found();
2207     }
2210 /**
2211  * Serve questiontext files in the question text when they are displayed in this report.
2212  *
2213  * @package  core_files
2214  * @category files
2215  * @param context $previewcontext the context in which the preview is happening.
2216  * @param int $questionid the question id.
2217  * @param context $filecontext the file (question) context.
2218  * @param string $filecomponent the component the file belongs to.
2219  * @param string $filearea the file area.
2220  * @param array $args remaining file args.
2221  * @param bool $forcedownload.
2222  * @param array $options additional options affecting the file serving.
2223  */
2224 function core_question_question_preview_pluginfile($previewcontext, $questionid,
2225         $filecontext, $filecomponent, $filearea, $args, $forcedownload, $options = array()) {
2226     global $DB;
2228     // Verify that contextid matches the question.
2229     $question = $DB->get_record_sql('
2230             SELECT q.*, qc.contextid
2231               FROM {question} q
2232               JOIN {question_categories} qc ON qc.id = q.category
2233              WHERE q.id = :id AND qc.contextid = :contextid',
2234             array('id' => $questionid, 'contextid' => $filecontext->id), MUST_EXIST);
2236     // Check the capability.
2237     list($context, $course, $cm) = get_context_info_array($previewcontext->id);
2238     require_login($course, false, $cm);
2240     question_require_capability_on($question, 'use');
2242     $fs = get_file_storage();
2243     $relativepath = implode('/', $args);
2244     $fullpath = "/{$filecontext->id}/{$filecomponent}/{$filearea}/{$relativepath}";
2245     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2246         send_file_not_found();
2247     }
2249     send_stored_file($file, 0, 0, $forcedownload, $options);
2252 /**
2253  * Create url for question export
2254  *
2255  * @param int $contextid, current context
2256  * @param int $categoryid, categoryid
2257  * @param string $format
2258  * @param string $withcategories
2259  * @param string $ithcontexts
2260  * @param moodle_url export file url
2261  */
2262 function question_make_export_url($contextid, $categoryid, $format, $withcategories,
2263         $withcontexts, $filename) {
2264     global $CFG;
2265     $urlbase = "$CFG->wwwroot/pluginfile.php";
2266     return moodle_url::make_file_url($urlbase,
2267             "/$contextid/question/export/{$categoryid}/{$format}/{$withcategories}" .
2268             "/{$withcontexts}/{$filename}", true);
2271 /**
2272  * Get the URL to export a single question (exportone.php).
2273  *
2274  * @param stdClass|question_definition $question the question definition as obtained from
2275  *      question_bank::load_question_data() or question_bank::make_question().
2276  *      (Only ->id and ->contextid are used.)
2277  * @return moodle_url the requested URL.
2278  */
2279 function question_get_export_single_question_url($question) {
2280     $params = ['id' => $question->id, 'sesskey' => sesskey()];
2281     $context = context::instance_by_id($question->contextid);
2282     switch ($context->contextlevel) {
2283         case CONTEXT_MODULE:
2284             $params['cmid'] = $context->instanceid;
2285             break;
2287         case CONTEXT_COURSE:
2288             $params['courseid'] = $context->instanceid;
2289             break;
2291         default:
2292             $params['courseid'] = SITEID;
2293     }
2295     return new moodle_url('/question/exportone.php', $params);
2298 /**
2299  * Return a list of page types
2300  * @param string $pagetype current page type
2301  * @param stdClass $parentcontext Block's parent context
2302  * @param stdClass $currentcontext Current context of block
2303  */
2304 function question_page_type_list($pagetype, $parentcontext, $currentcontext) {
2305     global $CFG;
2306     $types = array(
2307         'question-*'=>get_string('page-question-x', 'question'),
2308         'question-edit'=>get_string('page-question-edit', 'question'),
2309         'question-category'=>get_string('page-question-category', 'question'),
2310         'question-export'=>get_string('page-question-export', 'question'),
2311         'question-import'=>get_string('page-question-import', 'question')
2312     );
2313     if ($currentcontext->contextlevel == CONTEXT_COURSE) {
2314         require_once($CFG->dirroot . '/course/lib.php');
2315         return array_merge(course_page_type_list($pagetype, $parentcontext, $currentcontext), $types);
2316     } else {
2317         return $types;
2318     }
2321 /**
2322  * Does an activity module use the question bank?
2323  *
2324  * @param string $modname The name of the module (without mod_ prefix).
2325  * @return bool true if the module uses questions.
2326  */
2327 function question_module_uses_questions($modname) {
2328     if (plugin_supports('mod', $modname, FEATURE_USES_QUESTIONS)) {
2329         return true;
2330     }
2332     $component = 'mod_'.$modname;
2333     if (component_callback_exists($component, 'question_pluginfile')) {
2334         debugging("{$component} uses questions but doesn't declare FEATURE_USES_QUESTIONS", DEBUG_DEVELOPER);
2335         return true;
2336     }
2338     return false;