eb99d4f383a9d59353040cf6d00d3f19db8af1c4
[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|coursecat $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|coursecat $category course category object
442  * @param object|coursecat $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         // Update the contextid for any tag instances for questions in the old context.
469         core_tag_tag::move_context('core_question', 'question', $context, $newcontext);
471         $DB->set_field('question_categories', 'contextid', $newcontext->id, array('contextid' => $context->id));
473         if ($feedback) {
474             $a = new stdClass();
475             $a->oldplace = $context->get_context_name();
476             $a->newplace = $newcontext->get_context_name();
477             echo $OUTPUT->notification(
478                     get_string('movedquestionsandcategories', 'question', $a), 'notifysuccess');
479         }
480     }
482     return true;
485 /**
486  * Enter description here...
487  *
488  * @param array $questionids of question ids
489  * @param object $newcontextid the context to create the saved category in.
490  * @param string $oldplace a textual description of the think being deleted,
491  *      e.g. from get_context_name
492  * @param object $newcategory
493  * @return mixed false on
494  */
495 function question_save_from_deletion($questionids, $newcontextid, $oldplace,
496         $newcategory = null) {
497     global $DB;
499     // Make a category in the parent context to move the questions to.
500     if (is_null($newcategory)) {
501         $newcategory = new stdClass();
502         $newcategory->parent = 0;
503         $newcategory->contextid = $newcontextid;
504         $newcategory->name = get_string('questionsrescuedfrom', 'question', $oldplace);
505         $newcategory->info = get_string('questionsrescuedfrominfo', 'question', $oldplace);
506         $newcategory->sortorder = 999;
507         $newcategory->stamp = make_unique_id_code();
508         $newcategory->id = $DB->insert_record('question_categories', $newcategory);
509     }
511     // Move any remaining questions to the 'saved' category.
512     if (!question_move_questions_to_category($questionids, $newcategory->id)) {
513         return false;
514     }
515     return $newcategory;
518 /**
519  * All question categories and their questions are deleted for this activity.
520  *
521  * @param object $cm the course module object representing the activity
522  * @param boolean $feedback to specify if the process must output a summary of its work
523  * @return boolean
524  */
525 function question_delete_activity($cm, $feedback=true) {
526     global $DB;
528     $modcontext = context_module::instance($cm->id);
529     $feedbackdata = question_delete_context($modcontext->id, $feedback);
530     // Inform about changes performed if feedback is enabled.
531     if ($feedback && $feedbackdata) {
532         $table = new html_table();
533         $table->head = array(get_string('category', 'question'), get_string('action'));
534         $table->data = $feedbackdata;
535         echo html_writer::table($table);
536     }
537     return true;
540 /**
541  * This function will handle moving all tag instances to a new context for a
542  * given list of questions.
543  *
544  * Questions can be tagged in up to two contexts:
545  * 1.) The context the question exists in.
546  * 2.) The course context (if the question context is a higher context.
547  *     E.g. course category context or system context.
548  *
549  * This means a question that exists in a higher context (e.g. course cat or
550  * system context) may have multiple groups of tags in any number of child
551  * course contexts.
552  *
553  * Questions in the course category context can be move "down" a context level
554  * into one of their child course contexts or activity contexts which affects the
555  * availability of that question in other courses / activities.
556  *
557  * In this case it makes the questions no longer available in the other course or
558  * activity contexts so we need to make sure that the tag instances in those other
559  * contexts are removed.
560  *
561  * @param stdClass[] $questions The list of question being moved (must include
562  *                              the id and contextid)
563  * @param context $newcontext The Moodle context the questions are being moved to
564  */
565 function question_move_question_tags_to_new_context(array $questions, context $newcontext) {
566     // If the questions are moving to a new course/activity context then we need to
567     // find any existing tag instances from any unavailable course contexts and
568     // delete them because they will no longer be applicable (we don't support
569     // tagging questions across courses).
570     $instancestodelete = [];
571     $instancesfornewcontext = [];
572     $newcontextparentids = $newcontext->get_parent_context_ids();
573     $questionids = array_map(function($question) {
574         return $question->id;
575     }, $questions);
576     $questionstagobjects = core_tag_tag::get_items_tags('core_question', 'question', $questionids);
578     foreach ($questions as $question) {
579         $tagobjects = $questionstagobjects[$question->id];
581         foreach ($tagobjects as $tagobject) {
582             $tagid = $tagobject->taginstanceid;
583             $tagcontextid = $tagobject->taginstancecontextid;
584             $istaginnewcontext = $tagcontextid == $newcontext->id;
585             $istaginquestioncontext = $tagcontextid == $question->contextid;
587             if ($istaginnewcontext) {
588                 // This tag instance is already in the correct context so we can
589                 // ignore it.
590                 continue;
591             }
593             if ($istaginquestioncontext) {
594                 // This tag instance is in the question context so it needs to be
595                 // updated.
596                 $instancesfornewcontext[] = $tagid;
597                 continue;
598             }
600             // These tag instances are in neither the new context nor the
601             // question context so we need to determine what to do based on
602             // the context they are in and the new question context.
603             $tagcontext = context::instance_by_id($tagcontextid);
604             $tagcoursecontext = $tagcontext->get_course_context(false);
605             // The tag is in a course context if get_course_context() returns
606             // itself.
607             $istaginstancecontextcourse = !empty($tagcoursecontext)
608                 && $tagcontext->id == $tagcoursecontext->id;
610             if ($istaginstancecontextcourse) {
611                 // If the tag instance is in a course context we need to add some
612                 // special handling.
613                 $tagcontextparentids = $tagcontext->get_parent_context_ids();
614                 $isnewcontextaparent = in_array($newcontext->id, $tagcontextparentids);
615                 $isnewcontextachild = in_array($tagcontext->id, $newcontextparentids);
617                 if ($isnewcontextaparent) {
618                     // If the tag instance is a course context tag and the new
619                     // context is still a parent context to the tag context then
620                     // we can leave this tag where it is.
621                     continue;
622                 } else if ($isnewcontextachild) {
623                     // If the new context is a child context (e.g. activity) of this
624                     // tag instance then we should move all of this tag instance
625                     // down into the activity context along with the question.
626                     $instancesfornewcontext[] = $tagid;
627                 } else {
628                     // If the tag is in a course context that is no longer a parent
629                     // or child of the new context then this tag instance should be
630                     // removed.
631                     $instancestodelete[] = $tagid;
632                 }
633             } else {
634                 // This is a catch all for any tag instances not in the question
635                 // context or a course context. These tag instances should be
636                 // updated to the new context id. This will clean up old invalid
637                 // data.
638                 $instancesfornewcontext[] = $tagid;
639             }
640         }
641     }
643     if (!empty($instancestodelete)) {
644         // Delete any course context tags that may no longer be valid.
645         core_tag_tag::delete_instances_by_id($instancestodelete);
646     }
648     if (!empty($instancesfornewcontext)) {
649         // Update the tag instances to the new context id.
650         core_tag_tag::change_instances_context($instancesfornewcontext, $newcontext);
651     }
654 /**
655  * This function should be considered private to the question bank, it is called from
656  * question/editlib.php question/contextmoveq.php and a few similar places to to the
657  * work of acutally moving questions and associated data. However, callers of this
658  * function also have to do other work, which is why you should not call this method
659  * directly from outside the questionbank.
660  *
661  * @param array $questionids of question ids.
662  * @param integer $newcategoryid the id of the category to move to.
663  */
664 function question_move_questions_to_category($questionids, $newcategoryid) {
665     global $DB;
667     $newcontextid = $DB->get_field('question_categories', 'contextid',
668             array('id' => $newcategoryid));
669     list($questionidcondition, $params) = $DB->get_in_or_equal($questionids);
670     $questions = $DB->get_records_sql("
671             SELECT q.id, q.qtype, qc.contextid
672               FROM {question} q
673               JOIN {question_categories} qc ON q.category = qc.id
674              WHERE  q.id $questionidcondition", $params);
675     foreach ($questions as $question) {
676         if ($newcontextid != $question->contextid) {
677             question_bank::get_qtype($question->qtype)->move_files(
678                     $question->id, $question->contextid, $newcontextid);
679         }
680     }
682     // Move the questions themselves.
683     $DB->set_field_select('question', 'category', $newcategoryid,
684             "id $questionidcondition", $params);
686     // Move any subquestions belonging to them.
687     $DB->set_field_select('question', 'category', $newcategoryid,
688             "parent $questionidcondition", $params);
690     $newcontext = context::instance_by_id($newcontextid);
691     question_move_question_tags_to_new_context($questions, $newcontext);
693     // TODO Deal with datasets.
695     // Purge these questions from the cache.
696     foreach ($questions as $question) {
697         question_bank::notify_question_edited($question->id);
698     }
700     return true;
703 /**
704  * This function helps move a question cateogry to a new context by moving all
705  * the files belonging to all the questions to the new context.
706  * Also moves subcategories.
707  * @param integer $categoryid the id of the category being moved.
708  * @param integer $oldcontextid the old context id.
709  * @param integer $newcontextid the new context id.
710  */
711 function question_move_category_to_context($categoryid, $oldcontextid, $newcontextid) {
712     global $DB;
714     $questions = [];
715     $questionids = $DB->get_records_menu('question',
716             array('category' => $categoryid), '', 'id,qtype');
717     foreach ($questionids as $questionid => $qtype) {
718         question_bank::get_qtype($qtype)->move_files(
719                 $questionid, $oldcontextid, $newcontextid);
720         // Purge this question from the cache.
721         question_bank::notify_question_edited($questionid);
723         $questions[] = (object) [
724             'id' => $questionid,
725             'contextid' => $oldcontextid
726         ];
727     }
729     $newcontext = context::instance_by_id($newcontextid);
730     question_move_question_tags_to_new_context($questions, $newcontext);
732     $subcatids = $DB->get_records_menu('question_categories',
733             array('parent' => $categoryid), '', 'id,1');
734     foreach ($subcatids as $subcatid => $notused) {
735         $DB->set_field('question_categories', 'contextid', $newcontextid,
736                 array('id' => $subcatid));
737         question_move_category_to_context($subcatid, $oldcontextid, $newcontextid);
738     }
741 /**
742  * Generate the URL for starting a new preview of a given question with the given options.
743  * @param integer $questionid the question to preview.
744  * @param string $preferredbehaviour the behaviour to use for the preview.
745  * @param float $maxmark the maximum to mark the question out of.
746  * @param question_display_options $displayoptions the display options to use.
747  * @param int $variant the variant of the question to preview. If null, one will
748  *      be picked randomly.
749  * @param object $context context to run the preview in (affects things like
750  *      filter settings, theme, lang, etc.) Defaults to $PAGE->context.
751  * @return moodle_url the URL.
752  */
753 function question_preview_url($questionid, $preferredbehaviour = null,
754         $maxmark = null, $displayoptions = null, $variant = null, $context = null) {
756     $params = array('id' => $questionid);
758     if (is_null($context)) {
759         global $PAGE;
760         $context = $PAGE->context;
761     }
762     if ($context->contextlevel == CONTEXT_MODULE) {
763         $params['cmid'] = $context->instanceid;
764     } else if ($context->contextlevel == CONTEXT_COURSE) {
765         $params['courseid'] = $context->instanceid;
766     }
768     if (!is_null($preferredbehaviour)) {
769         $params['behaviour'] = $preferredbehaviour;
770     }
772     if (!is_null($maxmark)) {
773         $params['maxmark'] = $maxmark;
774     }
776     if (!is_null($displayoptions)) {
777         $params['correctness']     = $displayoptions->correctness;
778         $params['marks']           = $displayoptions->marks;
779         $params['markdp']          = $displayoptions->markdp;
780         $params['feedback']        = (bool) $displayoptions->feedback;
781         $params['generalfeedback'] = (bool) $displayoptions->generalfeedback;
782         $params['rightanswer']     = (bool) $displayoptions->rightanswer;
783         $params['history']         = (bool) $displayoptions->history;
784     }
786     if ($variant) {
787         $params['variant'] = $variant;
788     }
790     return new moodle_url('/question/preview.php', $params);
793 /**
794  * @return array that can be passed as $params to the {@link popup_action} constructor.
795  */
796 function question_preview_popup_params() {
797     return array(
798         'height' => 600,
799         'width' => 800,
800     );
803 /**
804  * Given a list of ids, load the basic information about a set of questions from
805  * the questions table. The $join and $extrafields arguments can be used together
806  * to pull in extra data. See, for example, the usage in mod/quiz/attemptlib.php, and
807  * read the code below to see how the SQL is assembled. Throws exceptions on error.
808  *
809  * @param array $questionids array of question ids to load. If null, then all
810  * questions matched by $join will be loaded.
811  * @param string $extrafields extra SQL code to be added to the query.
812  * @param string $join extra SQL code to be added to the query.
813  * @param array $extraparams values for any placeholders in $join.
814  * You must use named placeholders.
815  * @param string $orderby what to order the results by. Optional, default is unspecified order.
816  *
817  * @return array partially complete question objects. You need to call get_question_options
818  * on them before they can be properly used.
819  */
820 function question_preload_questions($questionids = null, $extrafields = '', $join = '',
821         $extraparams = array(), $orderby = '') {
822     global $DB;
824     if ($questionids === null) {
825         $where = '';
826         $params = array();
827     } else {
828         if (empty($questionids)) {
829             return array();
830         }
832         list($questionidcondition, $params) = $DB->get_in_or_equal(
833                 $questionids, SQL_PARAMS_NAMED, 'qid0000');
834         $where = 'WHERE q.id ' . $questionidcondition;
835     }
837     if ($join) {
838         $join = 'JOIN ' . $join;
839     }
841     if ($extrafields) {
842         $extrafields = ', ' . $extrafields;
843     }
845     if ($orderby) {
846         $orderby = 'ORDER BY ' . $orderby;
847     }
849     $sql = "SELECT q.*, qc.contextid{$extrafields}
850               FROM {question} q
851               JOIN {question_categories} qc ON q.category = qc.id
852               {$join}
853              {$where}
854           {$orderby}";
856     // Load the questions.
857     $questions = $DB->get_records_sql($sql, $extraparams + $params);
858     foreach ($questions as $question) {
859         $question->_partiallyloaded = true;
860     }
862     return $questions;
865 /**
866  * Load a set of questions, given a list of ids. The $join and $extrafields arguments can be used
867  * together to pull in extra data. See, for example, the usage in mod/quiz/attempt.php, and
868  * read the code below to see how the SQL is assembled. Throws exceptions on error.
869  *
870  * @param array $questionids array of question ids.
871  * @param string $extrafields extra SQL code to be added to the query.
872  * @param string $join extra SQL code to be added to the query.
873  * @param array $extraparams values for any placeholders in $join.
874  * You are strongly recommended to use named placeholder.
875  *
876  * @return array question objects.
877  */
878 function question_load_questions($questionids, $extrafields = '', $join = '') {
879     $questions = question_preload_questions($questionids, $extrafields, $join);
881     // Load the question type specific information
882     if (!get_question_options($questions)) {
883         return 'Could not load the question options';
884     }
886     return $questions;
889 /**
890  * Private function to factor common code out of get_question_options().
891  *
892  * @param object $question the question to tidy.
893  * @param stdClass $category The question_categories record for the given $question.
894  * @param stdClass[]|null $tagobjects The tags for the given $question.
895  * @param stdClass[]|null $filtercourses The courses to filter the course tags by.
896  */
897 function _tidy_question($question, $category, array $tagobjects = null, array $filtercourses = null) {
898     global $CFG;
900     // Load question-type specific fields.
901     if (!question_bank::is_qtype_installed($question->qtype)) {
902         $question->questiontext = html_writer::tag('p', get_string('warningmissingtype',
903                 'qtype_missingtype')) . $question->questiontext;
904     }
905     question_bank::get_qtype($question->qtype)->get_question_options($question);
907     // Convert numeric fields to float. (Prevents these being displayed as 1.0000000.)
908     $question->defaultmark += 0;
909     $question->penalty += 0;
911     if (isset($question->_partiallyloaded)) {
912         unset($question->_partiallyloaded);
913     }
915     $question->categoryobject = $category;
917     if (!is_null($tagobjects)) {
918         $categorycontext = context::instance_by_id($category->contextid);
920         // Questions can have two sets of tag instances. One set at the
921         // course context level and another at the context the question
922         // belongs to (e.g. course category, system etc).
923         $question->coursetagobjects = [];
924         $question->coursetags = [];
925         $question->tagobjects = [];
926         $question->tags = [];
927         $taginstanceidstonormalise = [];
928         $filtercoursecontextids = [];
929         $hasfiltercourses = !empty($filtercourses);
931         if ($hasfiltercourses) {
932             // If we're being asked to filter the course tags by a set of courses
933             // then get the context ids to filter below.
934             $filtercoursecontextids = array_map(function($course) {
935                 $coursecontext = context_course::instance($course->id);
936                 return $coursecontext->id;
937             }, $filtercourses);
938         }
940         foreach ($tagobjects as $tagobject) {
941             $tagcontextid = $tagobject->taginstancecontextid;
942             $tagcontext = context::instance_by_id($tagcontextid);
943             $tagcoursecontext = $tagcontext->get_course_context(false);
944             // This is a course tag if the tag context is a course context which
945             // doesn't match the question's context. Any tag in the question context
946             // is not considered a course tag, it belongs to the question.
947             $iscoursetag = $tagcoursecontext
948                 && $tagcontext->id == $tagcoursecontext->id
949                 && $tagcontext->id != $categorycontext->id;
951             if ($iscoursetag) {
952                 // Any tag instance in a course context level is considered a course tag.
953                 if (!$hasfiltercourses || in_array($tagcontextid, $filtercoursecontextids)) {
954                     // Add the tag to the list of course tags if we aren't being
955                     // asked to filter or if this tag is in the list of courses
956                     // we're being asked to filter by.
957                     $question->coursetagobjects[] = $tagobject;
958                     $question->coursetags[$tagobject->id] = $tagobject->get_display_name();
959                 }
960             } else {
961                 // All non course context level tag instances or tags in the question
962                 // context belong to the context that the question was created in.
963                 $question->tagobjects[] = $tagobject;
964                 $question->tags[$tagobject->id] = $tagobject->get_display_name();
966                 // Due to legacy tag implementations that don't force the recording
967                 // of a context id, some tag instances may have context ids that don't
968                 // match either a course context or the question context. In this case
969                 // we should take the opportunity to fix up the data and set the correct
970                 // context id.
971                 if ($tagcontext->id != $categorycontext->id) {
972                     $taginstanceidstonormalise[] = $tagobject->taginstanceid;
973                     // Update the object properties to reflect the DB update that will
974                     // happen below.
975                     $tagobject->taginstancecontextid = $categorycontext->id;
976                 }
977             }
978         }
980         if (!empty($taginstanceidstonormalise)) {
981             // If we found any tag instances with incorrect context id data then we can
982             // correct those values now by setting them to the question context id.
983             core_tag_tag::change_instances_context($taginstanceidstonormalise, $categorycontext);
984         }
985     }
988 /**
989  * Updates the question objects with question type specific
990  * information by calling {@link get_question_options()}
991  *
992  * Can be called either with an array of question objects or with a single
993  * question object.
994  *
995  * @param mixed $questions Either an array of question objects to be updated
996  *         or just a single question object
997  * @param bool $loadtags load the question tags from the tags table. Optional, default false.
998  * @param stdClass[] $filtercourses The courses to filter the course tags by.
999  * @return bool Indicates success or failure.
1000  */
1001 function get_question_options(&$questions, $loadtags = false, $filtercourses = null) {
1002     global $DB;
1004     $questionlist = is_array($questions) ? $questions : [$questions];
1005     $categoryids = [];
1006     $questionids = [];
1008     if (empty($questionlist)) {
1009         return true;
1010     }
1012     foreach ($questionlist as $question) {
1013         $questionids[] = $question->id;
1015         if (!in_array($question->category, $categoryids)) {
1016             $categoryids[] = $question->category;
1017         }
1018     }
1020     $categories = $DB->get_records_list('question_categories', 'id', $categoryids);
1022     if ($loadtags && core_tag_tag::is_enabled('core_question', 'question')) {
1023         $tagobjectsbyquestion = core_tag_tag::get_items_tags('core_question', 'question', $questionids);
1024     } else {
1025         $tagobjectsbyquestion = null;
1026     }
1028     foreach ($questionlist as $question) {
1029         if (is_null($tagobjectsbyquestion)) {
1030             $tagobjects = null;
1031         } else {
1032             $tagobjects = $tagobjectsbyquestion[$question->id];
1033         }
1035         _tidy_question($question, $categories[$question->category], $tagobjects, $filtercourses);
1036     }
1038     return true;
1041 /**
1042  * Print the icon for the question type
1043  *
1044  * @param object $question The question object for which the icon is required.
1045  *       Only $question->qtype is used.
1046  * @return string the HTML for the img tag.
1047  */
1048 function print_question_icon($question) {
1049     global $PAGE;
1050     return $PAGE->get_renderer('question', 'bank')->qtype_icon($question->qtype);
1053 /**
1054  * Creates a stamp that uniquely identifies this version of the question
1055  *
1056  * In future we want this to use a hash of the question data to guarantee that
1057  * identical versions have the same version stamp.
1058  *
1059  * @param object $question
1060  * @return string A unique version stamp
1061  */
1062 function question_hash($question) {
1063     return make_unique_id_code();
1066 /// CATEGORY FUNCTIONS /////////////////////////////////////////////////////////////////
1068 /**
1069  * returns the categories with their names ordered following parent-child relationships
1070  * finally it tries to return pending categories (those being orphaned, whose parent is
1071  * incorrect) to avoid missing any category from original array.
1072  */
1073 function sort_categories_by_tree(&$categories, $id = 0, $level = 1) {
1074     global $DB;
1076     $children = array();
1077     $keys = array_keys($categories);
1079     foreach ($keys as $key) {
1080         if (!isset($categories[$key]->processed) && $categories[$key]->parent == $id) {
1081             $children[$key] = $categories[$key];
1082             $categories[$key]->processed = true;
1083             $children = $children + sort_categories_by_tree(
1084                     $categories, $children[$key]->id, $level+1);
1085         }
1086     }
1087     //If level = 1, we have finished, try to look for non processed categories
1088     // (bad parent) and sort them too
1089     if ($level == 1) {
1090         foreach ($keys as $key) {
1091             // If not processed and it's a good candidate to start (because its
1092             // parent doesn't exist in the course)
1093             if (!isset($categories[$key]->processed) && !$DB->record_exists('question_categories',
1094                     array('contextid' => $categories[$key]->contextid,
1095                             'id' => $categories[$key]->parent))) {
1096                 $children[$key] = $categories[$key];
1097                 $categories[$key]->processed = true;
1098                 $children = $children + sort_categories_by_tree(
1099                         $categories, $children[$key]->id, $level + 1);
1100             }
1101         }
1102     }
1103     return $children;
1106 /**
1107  * Private method, only for the use of add_indented_names().
1108  *
1109  * Recursively adds an indentedname field to each category, starting with the category
1110  * with id $id, and dealing with that category and all its children, and
1111  * return a new array, with those categories in the right order.
1112  *
1113  * @param array $categories an array of categories which has had childids
1114  *          fields added by flatten_category_tree(). Passed by reference for
1115  *          performance only. It is not modfied.
1116  * @param int $id the category to start the indenting process from.
1117  * @param int $depth the indent depth. Used in recursive calls.
1118  * @return array a new array of categories, in the right order for the tree.
1119  */
1120 function flatten_category_tree(&$categories, $id, $depth = 0, $nochildrenof = -1) {
1122     // Indent the name of this category.
1123     $newcategories = array();
1124     $newcategories[$id] = $categories[$id];
1125     $newcategories[$id]->indentedname = str_repeat('&nbsp;&nbsp;&nbsp;', $depth) .
1126             $categories[$id]->name;
1128     // Recursively indent the children.
1129     foreach ($categories[$id]->childids as $childid) {
1130         if ($childid != $nochildrenof) {
1131             $newcategories = $newcategories + flatten_category_tree(
1132                     $categories, $childid, $depth + 1, $nochildrenof);
1133         }
1134     }
1136     // Remove the childids array that were temporarily added.
1137     unset($newcategories[$id]->childids);
1139     return $newcategories;
1142 /**
1143  * Format categories into an indented list reflecting the tree structure.
1144  *
1145  * @param array $categories An array of category objects, for example from the.
1146  * @return array The formatted list of categories.
1147  */
1148 function add_indented_names($categories, $nochildrenof = -1) {
1150     // Add an array to each category to hold the child category ids. This array
1151     // will be removed again by flatten_category_tree(). It should not be used
1152     // outside these two functions.
1153     foreach (array_keys($categories) as $id) {
1154         $categories[$id]->childids = array();
1155     }
1157     // Build the tree structure, and record which categories are top-level.
1158     // We have to be careful, because the categories array may include published
1159     // categories from other courses, but not their parents.
1160     $toplevelcategoryids = array();
1161     foreach (array_keys($categories) as $id) {
1162         if (!empty($categories[$id]->parent) &&
1163                 array_key_exists($categories[$id]->parent, $categories)) {
1164             $categories[$categories[$id]->parent]->childids[] = $id;
1165         } else {
1166             $toplevelcategoryids[] = $id;
1167         }
1168     }
1170     // Flatten the tree to and add the indents.
1171     $newcategories = array();
1172     foreach ($toplevelcategoryids as $id) {
1173         $newcategories = $newcategories + flatten_category_tree(
1174                 $categories, $id, 0, $nochildrenof);
1175     }
1177     return $newcategories;
1180 /**
1181  * Output a select menu of question categories.
1182  *
1183  * Categories from this course and (optionally) published categories from other courses
1184  * are included. Optionally, only categories the current user may edit can be included.
1185  *
1186  * @param integer $courseid the id of the course to get the categories for.
1187  * @param integer $published if true, include publised categories from other courses.
1188  * @param integer $only_editable if true, exclude categories this user is not allowed to edit.
1189  * @param integer $selected optionally, the id of a category to be selected by
1190  *      default in the dropdown.
1191  */
1192 function question_category_select_menu($contexts, $top = false, $currentcat = 0,
1193         $selected = "", $nochildrenof = -1) {
1194     $categoriesarray = question_category_options($contexts, $top, $currentcat,
1195             false, $nochildrenof);
1196     if ($selected) {
1197         $choose = '';
1198     } else {
1199         $choose = 'choosedots';
1200     }
1201     $options = array();
1202     foreach ($categoriesarray as $group => $opts) {
1203         $options[] = array($group => $opts);
1204     }
1205     echo html_writer::label(get_string('questioncategory', 'core_question'), 'id_movetocategory', false, array('class' => 'accesshide'));
1206     $attrs = array('id' => 'id_movetocategory', 'class' => 'custom-select');
1207     echo html_writer::select($options, 'category', $selected, $choose, $attrs);
1210 /**
1211  * @param integer $contextid a context id.
1212  * @return object the default question category for that context, or false if none.
1213  */
1214 function question_get_default_category($contextid) {
1215     global $DB;
1216     $category = $DB->get_records_select('question_categories', 'contextid = ? AND parent <> 0',
1217             array($contextid), 'id', '*', 0, 1);
1218     if (!empty($category)) {
1219         return reset($category);
1220     } else {
1221         return false;
1222     }
1225 /**
1226  * Gets the top category in the given context.
1227  * This function can optionally create the top category if it doesn't exist.
1228  *
1229  * @param int $contextid A context id.
1230  * @param bool $create Whether create a top category if it doesn't exist.
1231  * @return bool|stdClass The top question category for that context, or false if none.
1232  */
1233 function question_get_top_category($contextid, $create = false) {
1234     global $DB;
1235     $category = $DB->get_record('question_categories',
1236             array('contextid' => $contextid, 'parent' => 0));
1238     if (!$category && $create) {
1239         // We need to make one.
1240         $category = new stdClass();
1241         $category->name = 'top'; // A non-real name for the top category. It will be localised at the display time.
1242         $category->info = '';
1243         $category->contextid = $contextid;
1244         $category->parent = 0;
1245         $category->sortorder = 0;
1246         $category->stamp = make_unique_id_code();
1247         $category->id = $DB->insert_record('question_categories', $category);
1248     }
1250     return $category;
1253 /**
1254  * Gets the list of top categories in the given contexts in the array("categoryid,categorycontextid") format.
1255  *
1256  * @param array $contextids List of context ids
1257  * @return array
1258  */
1259 function question_get_top_categories_for_contexts($contextids) {
1260     global $DB;
1262     $concatsql = $DB->sql_concat_join("','", ['id', 'contextid']);
1263     list($insql, $params) = $DB->get_in_or_equal($contextids);
1264     $sql = "SELECT $concatsql FROM {question_categories} WHERE contextid $insql AND parent = 0";
1265     $topcategories = $DB->get_fieldset_sql($sql, $params);
1267     return $topcategories;
1270 /**
1271  * Gets the default category in the most specific context.
1272  * If no categories exist yet then default ones are created in all contexts.
1273  *
1274  * @param array $contexts  The context objects for this context and all parent contexts.
1275  * @return object The default category - the category in the course context
1276  */
1277 function question_make_default_categories($contexts) {
1278     global $DB;
1279     static $preferredlevels = array(
1280         CONTEXT_COURSE => 4,
1281         CONTEXT_MODULE => 3,
1282         CONTEXT_COURSECAT => 2,
1283         CONTEXT_SYSTEM => 1,
1284     );
1286     $toreturn = null;
1287     $preferredness = 0;
1288     // If it already exists, just return it.
1289     foreach ($contexts as $key => $context) {
1290         $topcategory = question_get_top_category($context->id, true);
1291         if (!$exists = $DB->record_exists("question_categories",
1292                 array('contextid' => $context->id, 'parent' => $topcategory->id))) {
1293             // Otherwise, we need to make one
1294             $category = new stdClass();
1295             $contextname = $context->get_context_name(false, true);
1296             $category->name = get_string('defaultfor', 'question', $contextname);
1297             $category->info = get_string('defaultinfofor', 'question', $contextname);
1298             $category->contextid = $context->id;
1299             $category->parent = $topcategory->id;
1300             // By default, all categories get this number, and are sorted alphabetically.
1301             $category->sortorder = 999;
1302             $category->stamp = make_unique_id_code();
1303             $category->id = $DB->insert_record('question_categories', $category);
1304         } else {
1305             $category = question_get_default_category($context->id);
1306         }
1307         $thispreferredness = $preferredlevels[$context->contextlevel];
1308         if (has_any_capability(array('moodle/question:usemine', 'moodle/question:useall'), $context)) {
1309             $thispreferredness += 10;
1310         }
1311         if ($thispreferredness > $preferredness) {
1312             $toreturn = $category;
1313             $preferredness = $thispreferredness;
1314         }
1315     }
1317     if (!is_null($toreturn)) {
1318         $toreturn = clone($toreturn);
1319     }
1320     return $toreturn;
1323 /**
1324  * Get all the category objects, including a count of the number of questions in that category,
1325  * for all the categories in the lists $contexts.
1326  *
1327  * @param mixed $contexts either a single contextid, or a comma-separated list of context ids.
1328  * @param string $sortorder used as the ORDER BY clause in the select statement.
1329  * @param bool $top Whether to return the top categories or not.
1330  * @return array of category objects.
1331  */
1332 function get_categories_for_contexts($contexts, $sortorder = 'parent, sortorder, name ASC', $top = false) {
1333     global $DB;
1334     $topwhere = $top ? '' : 'AND c.parent <> 0';
1335     return $DB->get_records_sql("
1336             SELECT c.*, (SELECT count(1) FROM {question} q
1337                         WHERE c.id = q.category AND q.hidden='0' AND q.parent='0') AS questioncount
1338               FROM {question_categories} c
1339              WHERE c.contextid IN ($contexts) $topwhere
1340           ORDER BY $sortorder");
1343 /**
1344  * Output an array of question categories.
1345  *
1346  * @param array $contexts The list of contexts.
1347  * @param bool $top Whether to return the top categories or not.
1348  * @param int $currentcat
1349  * @param bool $popupform
1350  * @param int $nochildrenof
1351  * @return array
1352  */
1353 function question_category_options($contexts, $top = false, $currentcat = 0,
1354         $popupform = false, $nochildrenof = -1) {
1355     global $CFG;
1356     $pcontexts = array();
1357     foreach ($contexts as $context) {
1358         $pcontexts[] = $context->id;
1359     }
1360     $contextslist = join($pcontexts, ', ');
1362     $categories = get_categories_for_contexts($contextslist, 'parent, sortorder, name ASC', $top);
1364     if ($top) {
1365         $categories = question_fix_top_names($categories);
1366     }
1368     $categories = question_add_context_in_key($categories);
1369     $categories = add_indented_names($categories, $nochildrenof);
1371     // sort cats out into different contexts
1372     $categoriesarray = array();
1373     foreach ($pcontexts as $contextid) {
1374         $context = context::instance_by_id($contextid);
1375         $contextstring = $context->get_context_name(true, true);
1376         foreach ($categories as $category) {
1377             if ($category->contextid == $contextid) {
1378                 $cid = $category->id;
1379                 if ($currentcat != $cid || $currentcat == 0) {
1380                     $countstring = !empty($category->questioncount) ?
1381                             " ($category->questioncount)" : '';
1382                     $categoriesarray[$contextstring][$cid] =
1383                             format_string($category->indentedname, true,
1384                                 array('context' => $context)) . $countstring;
1385                 }
1386             }
1387         }
1388     }
1389     if ($popupform) {
1390         $popupcats = array();
1391         foreach ($categoriesarray as $contextstring => $optgroup) {
1392             $group = array();
1393             foreach ($optgroup as $key => $value) {
1394                 $key = str_replace($CFG->wwwroot, '', $key);
1395                 $group[$key] = $value;
1396             }
1397             $popupcats[] = array($contextstring => $group);
1398         }
1399         return $popupcats;
1400     } else {
1401         return $categoriesarray;
1402     }
1405 function question_add_context_in_key($categories) {
1406     $newcatarray = array();
1407     foreach ($categories as $id => $category) {
1408         $category->parent = "$category->parent,$category->contextid";
1409         $category->id = "$category->id,$category->contextid";
1410         $newcatarray["$id,$category->contextid"] = $category;
1411     }
1412     return $newcatarray;
1415 /**
1416  * Finds top categories in the given categories hierarchy and replace their name with a proper localised string.
1417  *
1418  * @param array $categories An array of question categories.
1419  * @return array The same question category list given to the function, with the top category names being translated.
1420  */
1421 function question_fix_top_names($categories) {
1423     foreach ($categories as $id => $category) {
1424         if ($category->parent == 0) {
1425             $categories[$id]->name = get_string('top');
1426         }
1427     }
1429     return $categories;
1432 /**
1433  * @return array of question category ids of the category and all subcategories.
1434  */
1435 function question_categorylist($categoryid) {
1436     global $DB;
1438     // final list of category IDs
1439     $categorylist = array();
1441     // a list of category IDs to check for any sub-categories
1442     $subcategories = array($categoryid);
1444     while ($subcategories) {
1445         foreach ($subcategories as $subcategory) {
1446             // if anything from the temporary list was added already, then we have a loop
1447             if (isset($categorylist[$subcategory])) {
1448                 throw new coding_exception("Category id=$subcategory is already on the list - loop of categories detected.");
1449             }
1450             $categorylist[$subcategory] = $subcategory;
1451         }
1453         list ($in, $params) = $DB->get_in_or_equal($subcategories);
1455         $subcategories = $DB->get_records_select_menu('question_categories',
1456                 "parent $in", $params, NULL, 'id,id AS id2');
1457     }
1459     return $categorylist;
1462 //===========================
1463 // Import/Export Functions
1464 //===========================
1466 /**
1467  * Get list of available import or export formats
1468  * @param string $type 'import' if import list, otherwise export list assumed
1469  * @return array sorted list of import/export formats available
1470  */
1471 function get_import_export_formats($type) {
1472     global $CFG;
1473     require_once($CFG->dirroot . '/question/format.php');
1475     $formatclasses = core_component::get_plugin_list_with_class('qformat', '', 'format.php');
1477     $fileformatname = array();
1478     foreach ($formatclasses as $component => $formatclass) {
1480         $format = new $formatclass();
1481         if ($type == 'import') {
1482             $provided = $format->provide_import();
1483         } else {
1484             $provided = $format->provide_export();
1485         }
1487         if ($provided) {
1488             list($notused, $fileformat) = explode('_', $component, 2);
1489             $fileformatnames[$fileformat] = get_string('pluginname', $component);
1490         }
1491     }
1493     core_collator::asort($fileformatnames);
1494     return $fileformatnames;
1498 /**
1499  * Create a reasonable default file name for exporting questions from a particular
1500  * category.
1501  * @param object $course the course the questions are in.
1502  * @param object $category the question category.
1503  * @return string the filename.
1504  */
1505 function question_default_export_filename($course, $category) {
1506     // We build a string that is an appropriate name (questions) from the lang pack,
1507     // then the corse shortname, then the question category name, then a timestamp.
1509     $base = clean_filename(get_string('exportfilename', 'question'));
1511     $dateformat = str_replace(' ', '_', get_string('exportnameformat', 'question'));
1512     $timestamp = clean_filename(userdate(time(), $dateformat, 99, false));
1514     $shortname = clean_filename($course->shortname);
1515     if ($shortname == '' || $shortname == '_' ) {
1516         $shortname = $course->id;
1517     }
1519     $categoryname = clean_filename(format_string($category->name));
1521     return "{$base}-{$shortname}-{$categoryname}-{$timestamp}";
1523     return $export_name;
1526 /**
1527  * Converts contextlevels to strings and back to help with reading/writing contexts
1528  * to/from import/export files.
1529  *
1530  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1531  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1532  */
1533 class context_to_string_translator{
1534     /**
1535      * @var array used to translate between contextids and strings for this context.
1536      */
1537     protected $contexttostringarray = array();
1539     public function __construct($contexts) {
1540         $this->generate_context_to_string_array($contexts);
1541     }
1543     public function context_to_string($contextid) {
1544         return $this->contexttostringarray[$contextid];
1545     }
1547     public function string_to_context($contextname) {
1548         $contextid = array_search($contextname, $this->contexttostringarray);
1549         return $contextid;
1550     }
1552     protected function generate_context_to_string_array($contexts) {
1553         if (!$this->contexttostringarray) {
1554             $catno = 1;
1555             foreach ($contexts as $context) {
1556                 switch ($context->contextlevel) {
1557                     case CONTEXT_MODULE :
1558                         $contextstring = 'module';
1559                         break;
1560                     case CONTEXT_COURSE :
1561                         $contextstring = 'course';
1562                         break;
1563                     case CONTEXT_COURSECAT :
1564                         $contextstring = "cat$catno";
1565                         $catno++;
1566                         break;
1567                     case CONTEXT_SYSTEM :
1568                         $contextstring = 'system';
1569                         break;
1570                 }
1571                 $this->contexttostringarray[$context->id] = $contextstring;
1572             }
1573         }
1574     }
1578 /**
1579  * Check capability on category
1580  *
1581  * @param mixed $question object or id
1582  * @param string $cap 'add', 'edit', 'view', 'use', 'move'
1583  * @param integer $cachecat useful to cache all question records in a category
1584  * @return boolean this user has the capability $cap for this question $question?
1585  */
1586 function question_has_capability_on($question, $cap, $cachecat = -1) {
1587     global $USER, $DB;
1589     // these are capabilities on existing questions capabilties are
1590     //set per category. Each of these has a mine and all version. Append 'mine' and 'all'
1591     $question_questioncaps = array('edit', 'view', 'use', 'move', 'tag');
1592     static $questions = array();
1593     static $categories = array();
1594     static $cachedcat = array();
1595     if ($cachecat != -1 && array_search($cachecat, $cachedcat) === false) {
1596         $questions += $DB->get_records('question', array('category' => $cachecat), '', 'id,category,createdby');
1597         $cachedcat[] = $cachecat;
1598     }
1599     if (!is_object($question)) {
1600         if (!isset($questions[$question])) {
1601             if (!$questions[$question] = $DB->get_record('question',
1602                     array('id' => $question), 'id,category,createdby')) {
1603                 print_error('questiondoesnotexist', 'question');
1604             }
1605         }
1606         $question = $questions[$question];
1607     }
1608     if (empty($question->category)) {
1609         // This can happen when we have created a fake 'missingtype' question to
1610         // take the place of a deleted question.
1611         return false;
1612     }
1613     if (!isset($categories[$question->category])) {
1614         if (!$categories[$question->category] = $DB->get_record('question_categories',
1615                 array('id'=>$question->category))) {
1616             print_error('invalidcategory', 'question');
1617         }
1618     }
1619     $category = $categories[$question->category];
1620     $context = context::instance_by_id($category->contextid);
1622     if (array_search($cap, $question_questioncaps)!== false) {
1623         if (!has_capability('moodle/question:' . $cap . 'all', $context)) {
1624             if ($question->createdby == $USER->id) {
1625                 return has_capability('moodle/question:' . $cap . 'mine', $context);
1626             } else {
1627                 return false;
1628             }
1629         } else {
1630             return true;
1631         }
1632     } else {
1633         return has_capability('moodle/question:' . $cap, $context);
1634     }
1638 /**
1639  * Require capability on question.
1640  */
1641 function question_require_capability_on($question, $cap) {
1642     if (!question_has_capability_on($question, $cap)) {
1643         print_error('nopermissions', '', '', $cap);
1644     }
1645     return true;
1648 /**
1649  * @param object $context a context
1650  * @return string A URL for editing questions in this context.
1651  */
1652 function question_edit_url($context) {
1653     global $CFG, $SITE;
1654     if (!has_any_capability(question_get_question_capabilities(), $context)) {
1655         return false;
1656     }
1657     $baseurl = $CFG->wwwroot . '/question/edit.php?';
1658     $defaultcategory = question_get_default_category($context->id);
1659     if ($defaultcategory) {
1660         $baseurl .= 'cat=' . $defaultcategory->id . ',' . $context->id . '&amp;';
1661     }
1662     switch ($context->contextlevel) {
1663         case CONTEXT_SYSTEM:
1664             return $baseurl . 'courseid=' . $SITE->id;
1665         case CONTEXT_COURSECAT:
1666             // This is nasty, becuase we can only edit questions in a course
1667             // context at the moment, so for now we just return false.
1668             return false;
1669         case CONTEXT_COURSE:
1670             return $baseurl . 'courseid=' . $context->instanceid;
1671         case CONTEXT_MODULE:
1672             return $baseurl . 'cmid=' . $context->instanceid;
1673     }
1677 /**
1678  * Adds question bank setting links to the given navigation node if caps are met.
1679  *
1680  * @param navigation_node $navigationnode The navigation node to add the question branch to
1681  * @param object $context
1682  * @return navigation_node Returns the question branch that was added
1683  */
1684 function question_extend_settings_navigation(navigation_node $navigationnode, $context) {
1685     global $PAGE;
1687     if ($context->contextlevel == CONTEXT_COURSE) {
1688         $params = array('courseid'=>$context->instanceid);
1689     } else if ($context->contextlevel == CONTEXT_MODULE) {
1690         $params = array('cmid'=>$context->instanceid);
1691     } else {
1692         return;
1693     }
1695     if (($cat = $PAGE->url->param('cat')) && preg_match('~\d+,\d+~', $cat)) {
1696         $params['cat'] = $cat;
1697     }
1699     $questionnode = $navigationnode->add(get_string('questionbank', 'question'),
1700             new moodle_url('/question/edit.php', $params), navigation_node::TYPE_CONTAINER, null, 'questionbank');
1702     $contexts = new question_edit_contexts($context);
1703     if ($contexts->have_one_edit_tab_cap('questions')) {
1704         $questionnode->add(get_string('questions', 'question'), new moodle_url(
1705                 '/question/edit.php', $params), navigation_node::TYPE_SETTING, null, 'questions');
1706     }
1707     if ($contexts->have_one_edit_tab_cap('categories')) {
1708         $questionnode->add(get_string('categories', 'question'), new moodle_url(
1709                 '/question/category.php', $params), navigation_node::TYPE_SETTING, null, 'categories');
1710     }
1711     if ($contexts->have_one_edit_tab_cap('import')) {
1712         $questionnode->add(get_string('import', 'question'), new moodle_url(
1713                 '/question/import.php', $params), navigation_node::TYPE_SETTING, null, 'import');
1714     }
1715     if ($contexts->have_one_edit_tab_cap('export')) {
1716         $questionnode->add(get_string('export', 'question'), new moodle_url(
1717                 '/question/export.php', $params), navigation_node::TYPE_SETTING, null, 'export');
1718     }
1720     return $questionnode;
1723 /**
1724  * @return array all the capabilities that relate to accessing particular questions.
1725  */
1726 function question_get_question_capabilities() {
1727     return array(
1728         'moodle/question:add',
1729         'moodle/question:editmine',
1730         'moodle/question:editall',
1731         'moodle/question:viewmine',
1732         'moodle/question:viewall',
1733         'moodle/question:usemine',
1734         'moodle/question:useall',
1735         'moodle/question:movemine',
1736         'moodle/question:moveall',
1737     );
1740 /**
1741  * @return array all the question bank capabilities.
1742  */
1743 function question_get_all_capabilities() {
1744     $caps = question_get_question_capabilities();
1745     $caps[] = 'moodle/question:managecategory';
1746     $caps[] = 'moodle/question:flag';
1747     return $caps;
1751 /**
1752  * Tracks all the contexts related to the one where we are currently editing
1753  * questions, and provides helper methods to check permissions.
1754  *
1755  * @copyright 2007 Jamie Pratt me@jamiep.org
1756  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1757  */
1758 class question_edit_contexts {
1760     public static $caps = array(
1761         'editq' => array('moodle/question:add',
1762             'moodle/question:editmine',
1763             'moodle/question:editall',
1764             'moodle/question:viewmine',
1765             'moodle/question:viewall',
1766             'moodle/question:usemine',
1767             'moodle/question:useall',
1768             'moodle/question:movemine',
1769             'moodle/question:moveall'),
1770         'questions'=>array('moodle/question:add',
1771             'moodle/question:editmine',
1772             'moodle/question:editall',
1773             'moodle/question:viewmine',
1774             'moodle/question:viewall',
1775             'moodle/question:movemine',
1776             'moodle/question:moveall'),
1777         'categories'=>array('moodle/question:managecategory'),
1778         'import'=>array('moodle/question:add'),
1779         'export'=>array('moodle/question:viewall', 'moodle/question:viewmine'));
1781     protected $allcontexts;
1783     /**
1784      * Constructor
1785      * @param context the current context.
1786      */
1787     public function __construct(context $thiscontext) {
1788         $this->allcontexts = array_values($thiscontext->get_parent_contexts(true));
1789     }
1791     /**
1792      * @return array all parent contexts
1793      */
1794     public function all() {
1795         return $this->allcontexts;
1796     }
1798     /**
1799      * @return object lowest context which must be either the module or course context
1800      */
1801     public function lowest() {
1802         return $this->allcontexts[0];
1803     }
1805     /**
1806      * @param string $cap capability
1807      * @return array parent contexts having capability, zero based index
1808      */
1809     public function having_cap($cap) {
1810         $contextswithcap = array();
1811         foreach ($this->allcontexts as $context) {
1812             if (has_capability($cap, $context)) {
1813                 $contextswithcap[] = $context;
1814             }
1815         }
1816         return $contextswithcap;
1817     }
1819     /**
1820      * @param array $caps capabilities
1821      * @return array parent contexts having at least one of $caps, zero based index
1822      */
1823     public function having_one_cap($caps) {
1824         $contextswithacap = array();
1825         foreach ($this->allcontexts as $context) {
1826             foreach ($caps as $cap) {
1827                 if (has_capability($cap, $context)) {
1828                     $contextswithacap[] = $context;
1829                     break; //done with caps loop
1830                 }
1831             }
1832         }
1833         return $contextswithacap;
1834     }
1836     /**
1837      * @param string $tabname edit tab name
1838      * @return array parent contexts having at least one of $caps, zero based index
1839      */
1840     public function having_one_edit_tab_cap($tabname) {
1841         return $this->having_one_cap(self::$caps[$tabname]);
1842     }
1844     /**
1845      * @return those contexts where a user can add a question and then use it.
1846      */
1847     public function having_add_and_use() {
1848         $contextswithcap = array();
1849         foreach ($this->allcontexts as $context) {
1850             if (!has_capability('moodle/question:add', $context)) {
1851                 continue;
1852             }
1853             if (!has_any_capability(array('moodle/question:useall', 'moodle/question:usemine'), $context)) {
1854                             continue;
1855             }
1856             $contextswithcap[] = $context;
1857         }
1858         return $contextswithcap;
1859     }
1861     /**
1862      * Has at least one parent context got the cap $cap?
1863      *
1864      * @param string $cap capability
1865      * @return boolean
1866      */
1867     public function have_cap($cap) {
1868         return (count($this->having_cap($cap)));
1869     }
1871     /**
1872      * Has at least one parent context got one of the caps $caps?
1873      *
1874      * @param array $caps capability
1875      * @return boolean
1876      */
1877     public function have_one_cap($caps) {
1878         foreach ($caps as $cap) {
1879             if ($this->have_cap($cap)) {
1880                 return true;
1881             }
1882         }
1883         return false;
1884     }
1886     /**
1887      * Has at least one parent context got one of the caps for actions on $tabname
1888      *
1889      * @param string $tabname edit tab name
1890      * @return boolean
1891      */
1892     public function have_one_edit_tab_cap($tabname) {
1893         return $this->have_one_cap(self::$caps[$tabname]);
1894     }
1896     /**
1897      * Throw error if at least one parent context hasn't got the cap $cap
1898      *
1899      * @param string $cap capability
1900      */
1901     public function require_cap($cap) {
1902         if (!$this->have_cap($cap)) {
1903             print_error('nopermissions', '', '', $cap);
1904         }
1905     }
1907     /**
1908      * Throw error if at least one parent context hasn't got one of the caps $caps
1909      *
1910      * @param array $cap capabilities
1911      */
1912     public function require_one_cap($caps) {
1913         if (!$this->have_one_cap($caps)) {
1914             $capsstring = join($caps, ', ');
1915             print_error('nopermissions', '', '', $capsstring);
1916         }
1917     }
1919     /**
1920      * Throw error if at least one parent context hasn't got one of the caps $caps
1921      *
1922      * @param string $tabname edit tab name
1923      */
1924     public function require_one_edit_tab_cap($tabname) {
1925         if (!$this->have_one_edit_tab_cap($tabname)) {
1926             print_error('nopermissions', '', '', 'access question edit tab '.$tabname);
1927         }
1928     }
1932 /**
1933  * Helps call file_rewrite_pluginfile_urls with the right parameters.
1934  *
1935  * @package  core_question
1936  * @category files
1937  * @param string $text text being processed
1938  * @param string $file the php script used to serve files
1939  * @param int $contextid context ID
1940  * @param string $component component
1941  * @param string $filearea filearea
1942  * @param array $ids other IDs will be used to check file permission
1943  * @param int $itemid item ID
1944  * @param array $options options
1945  * @return string
1946  */
1947 function question_rewrite_question_urls($text, $file, $contextid, $component,
1948         $filearea, array $ids, $itemid, array $options=null) {
1950     $idsstr = '';
1951     if (!empty($ids)) {
1952         $idsstr .= implode('/', $ids);
1953     }
1954     if ($itemid !== null) {
1955         $idsstr .= '/' . $itemid;
1956     }
1957     return file_rewrite_pluginfile_urls($text, $file, $contextid, $component,
1958             $filearea, $idsstr, $options);
1961 /**
1962  * Rewrite the PLUGINFILE urls in part of the content of a question, for use when
1963  * viewing the question outside an attempt (for example, in the question bank
1964  * listing or in the quiz statistics report).
1965  *
1966  * @param string $text the question text.
1967  * @param int $questionid the question id.
1968  * @param int $filecontextid the context id of the question being displayed.
1969  * @param string $filecomponent the component that owns the file area.
1970  * @param string $filearea the file area name.
1971  * @param int|null $itemid the file's itemid
1972  * @param int $previewcontextid the context id where the preview is being displayed.
1973  * @param string $previewcomponent component responsible for displaying the preview.
1974  * @param array $options text and file options ('forcehttps'=>false)
1975  * @return string $questiontext with URLs rewritten.
1976  */
1977 function question_rewrite_question_preview_urls($text, $questionid,
1978         $filecontextid, $filecomponent, $filearea, $itemid,
1979         $previewcontextid, $previewcomponent, $options = null) {
1981     $path = "preview/$previewcontextid/$previewcomponent/$questionid";
1982     if ($itemid) {
1983         $path .= '/' . $itemid;
1984     }
1986     return file_rewrite_pluginfile_urls($text, 'pluginfile.php', $filecontextid,
1987             $filecomponent, $filearea, $path, $options);
1990 /**
1991  * Called by pluginfile.php to serve files related to the 'question' core
1992  * component and for files belonging to qtypes.
1993  *
1994  * For files that relate to questions in a question_attempt, then we delegate to
1995  * a function in the component that owns the attempt (for example in the quiz,
1996  * or in core question preview) to get necessary inforation.
1997  *
1998  * (Note that, at the moment, all question file areas relate to questions in
1999  * attempts, so the If at the start of the last paragraph is always true.)
2000  *
2001  * Does not return, either calls send_file_not_found(); or serves the file.
2002  *
2003  * @package  core_question
2004  * @category files
2005  * @param stdClass $course course settings object
2006  * @param stdClass $context context object
2007  * @param string $component the name of the component we are serving files for.
2008  * @param string $filearea the name of the file area.
2009  * @param array $args the remaining bits of the file path.
2010  * @param bool $forcedownload whether the user must be forced to download the file.
2011  * @param array $options additional options affecting the file serving
2012  */
2013 function question_pluginfile($course, $context, $component, $filearea, $args, $forcedownload, array $options=array()) {
2014     global $DB, $CFG;
2016     // Special case, sending a question bank export.
2017     if ($filearea === 'export') {
2018         list($context, $course, $cm) = get_context_info_array($context->id);
2019         require_login($course, false, $cm);
2021         require_once($CFG->dirroot . '/question/editlib.php');
2022         $contexts = new question_edit_contexts($context);
2023         // check export capability
2024         $contexts->require_one_edit_tab_cap('export');
2025         $category_id = (int)array_shift($args);
2026         $format      = array_shift($args);
2027         $cattofile   = array_shift($args);
2028         $contexttofile = array_shift($args);
2029         $filename    = array_shift($args);
2031         // load parent class for import/export
2032         require_once($CFG->dirroot . '/question/format.php');
2033         require_once($CFG->dirroot . '/question/editlib.php');
2034         require_once($CFG->dirroot . '/question/format/' . $format . '/format.php');
2036         $classname = 'qformat_' . $format;
2037         if (!class_exists($classname)) {
2038             send_file_not_found();
2039         }
2041         $qformat = new $classname();
2043         if (!$category = $DB->get_record('question_categories', array('id' => $category_id))) {
2044             send_file_not_found();
2045         }
2047         $qformat->setCategory($category);
2048         $qformat->setContexts($contexts->having_one_edit_tab_cap('export'));
2049         $qformat->setCourse($course);
2051         if ($cattofile == 'withcategories') {
2052             $qformat->setCattofile(true);
2053         } else {
2054             $qformat->setCattofile(false);
2055         }
2057         if ($contexttofile == 'withcontexts') {
2058             $qformat->setContexttofile(true);
2059         } else {
2060             $qformat->setContexttofile(false);
2061         }
2063         if (!$qformat->exportpreprocess()) {
2064             send_file_not_found();
2065             print_error('exporterror', 'question', $thispageurl->out());
2066         }
2068         // export data to moodle file pool
2069         if (!$content = $qformat->exportprocess(true)) {
2070             send_file_not_found();
2071         }
2073         send_file($content, $filename, 0, 0, true, true, $qformat->mime_type());
2074     }
2076     // Normal case, a file belonging to a question.
2077     $qubaidorpreview = array_shift($args);
2079     // Two sub-cases: 1. A question being previewed outside an attempt/usage.
2080     if ($qubaidorpreview === 'preview') {
2081         $previewcontextid = (int)array_shift($args);
2082         $previewcomponent = array_shift($args);
2083         $questionid = (int) array_shift($args);
2084         $previewcontext = context_helper::instance_by_id($previewcontextid);
2086         $result = component_callback($previewcomponent, 'question_preview_pluginfile', array(
2087                 $previewcontext, $questionid,
2088                 $context, $component, $filearea, $args,
2089                 $forcedownload, $options), 'callbackmissing');
2091         if ($result === 'callbackmissing') {
2092             throw new coding_exception("Component {$previewcomponent} does not define the callback " .
2093                     "{$previewcomponent}_question_preview_pluginfile callback. " .
2094                     "Which is required if you are using question_rewrite_question_preview_urls.", DEBUG_DEVELOPER);
2095         }
2097         send_file_not_found();
2098     }
2100     // 2. A question being attempted in the normal way.
2101     $qubaid = (int)$qubaidorpreview;
2102     $slot = (int)array_shift($args);
2104     $module = $DB->get_field('question_usages', 'component',
2105             array('id' => $qubaid));
2106     if (!$module) {
2107         send_file_not_found();
2108     }
2110     if ($module === 'core_question_preview') {
2111         require_once($CFG->dirroot . '/question/previewlib.php');
2112         return question_preview_question_pluginfile($course, $context,
2113                 $component, $filearea, $qubaid, $slot, $args, $forcedownload, $options);
2115     } else {
2116         $dir = core_component::get_component_directory($module);
2117         if (!file_exists("$dir/lib.php")) {
2118             send_file_not_found();
2119         }
2120         include_once("$dir/lib.php");
2122         $filefunction = $module . '_question_pluginfile';
2123         if (function_exists($filefunction)) {
2124             $filefunction($course, $context, $component, $filearea, $qubaid, $slot,
2125                 $args, $forcedownload, $options);
2126         }
2128         // Okay, we're here so lets check for function without 'mod_'.
2129         if (strpos($module, 'mod_') === 0) {
2130             $filefunctionold  = substr($module, 4) . '_question_pluginfile';
2131             if (function_exists($filefunctionold)) {
2132                 $filefunctionold($course, $context, $component, $filearea, $qubaid, $slot,
2133                     $args, $forcedownload, $options);
2134             }
2135         }
2137         send_file_not_found();
2138     }
2141 /**
2142  * Serve questiontext files in the question text when they are displayed in this report.
2143  *
2144  * @package  core_files
2145  * @category files
2146  * @param context $previewcontext the context in which the preview is happening.
2147  * @param int $questionid the question id.
2148  * @param context $filecontext the file (question) context.
2149  * @param string $filecomponent the component the file belongs to.
2150  * @param string $filearea the file area.
2151  * @param array $args remaining file args.
2152  * @param bool $forcedownload.
2153  * @param array $options additional options affecting the file serving.
2154  */
2155 function core_question_question_preview_pluginfile($previewcontext, $questionid,
2156         $filecontext, $filecomponent, $filearea, $args, $forcedownload, $options = array()) {
2157     global $DB;
2159     // Verify that contextid matches the question.
2160     $question = $DB->get_record_sql('
2161             SELECT q.*, qc.contextid
2162               FROM {question} q
2163               JOIN {question_categories} qc ON qc.id = q.category
2164              WHERE q.id = :id AND qc.contextid = :contextid',
2165             array('id' => $questionid, 'contextid' => $filecontext->id), MUST_EXIST);
2167     // Check the capability.
2168     list($context, $course, $cm) = get_context_info_array($previewcontext->id);
2169     require_login($course, false, $cm);
2171     question_require_capability_on($question, 'use');
2173     $fs = get_file_storage();
2174     $relativepath = implode('/', $args);
2175     $fullpath = "/{$filecontext->id}/{$filecomponent}/{$filearea}/{$relativepath}";
2176     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2177         send_file_not_found();
2178     }
2180     send_stored_file($file, 0, 0, $forcedownload, $options);
2183 /**
2184  * Create url for question export
2185  *
2186  * @param int $contextid, current context
2187  * @param int $categoryid, categoryid
2188  * @param string $format
2189  * @param string $withcategories
2190  * @param string $ithcontexts
2191  * @param moodle_url export file url
2192  */
2193 function question_make_export_url($contextid, $categoryid, $format, $withcategories,
2194         $withcontexts, $filename) {
2195     global $CFG;
2196     $urlbase = "$CFG->wwwroot/pluginfile.php";
2197     return moodle_url::make_file_url($urlbase,
2198             "/$contextid/question/export/{$categoryid}/{$format}/{$withcategories}" .
2199             "/{$withcontexts}/{$filename}", true);
2202 /**
2203  * Return a list of page types
2204  * @param string $pagetype current page type
2205  * @param stdClass $parentcontext Block's parent context
2206  * @param stdClass $currentcontext Current context of block
2207  */
2208 function question_page_type_list($pagetype, $parentcontext, $currentcontext) {
2209     global $CFG;
2210     $types = array(
2211         'question-*'=>get_string('page-question-x', 'question'),
2212         'question-edit'=>get_string('page-question-edit', 'question'),
2213         'question-category'=>get_string('page-question-category', 'question'),
2214         'question-export'=>get_string('page-question-export', 'question'),
2215         'question-import'=>get_string('page-question-import', 'question')
2216     );
2217     if ($currentcontext->contextlevel == CONTEXT_COURSE) {
2218         require_once($CFG->dirroot . '/course/lib.php');
2219         return array_merge(course_page_type_list($pagetype, $parentcontext, $currentcontext), $types);
2220     } else {
2221         return $types;
2222     }
2225 /**
2226  * Does an activity module use the question bank?
2227  *
2228  * @param string $modname The name of the module (without mod_ prefix).
2229  * @return bool true if the module uses questions.
2230  */
2231 function question_module_uses_questions($modname) {
2232     if (plugin_supports('mod', $modname, FEATURE_USES_QUESTIONS)) {
2233         return true;
2234     }
2236     $component = 'mod_'.$modname;
2237     if (component_callback_exists($component, 'question_pluginfile')) {
2238         debugging("{$component} uses questions but doesn't declare FEATURE_USES_QUESTIONS", DEBUG_DEVELOPER);
2239         return true;
2240     }
2242     return false;