2252758839b1f271302f0f2e05dc0c8b8ed049a0
[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);
384     // Log the deletion of this question.
385     $eventparams = array(
386         'contextid' => $question->contextid,
387         'objectid' => $question->id,
388         'other' => array('categoryid' => $question->category)
389     );
391     $event = \core\event\question_deleted::create($eventparams);
392     $event->trigger();
395 /**
396  * All question categories and their questions are deleted for this context id.
397  *
398  * @param object $contextid The contextid to delete question categories from
399  * @return array Feedback from deletes (if any)
400  */
401 function question_delete_context($contextid) {
402     global $DB;
404     //To store feedback to be showed at the end of the process
405     $feedbackdata   = array();
407     //Cache some strings
408     $strcatdeleted = get_string('unusedcategorydeleted', 'question');
409     $fields = 'id, parent, name, contextid';
410     if ($categories = $DB->get_records('question_categories', array('contextid' => $contextid), 'parent', $fields)) {
411         //Sort categories following their tree (parent-child) relationships
412         //this will make the feedback more readable
413         $categories = sort_categories_by_tree($categories);
415         foreach ($categories as $category) {
416             question_category_delete_safe($category);
418             //Fill feedback
419             $feedbackdata[] = array($category->name, $strcatdeleted);
420         }
421     }
422     return $feedbackdata;
425 /**
426  * All question categories and their questions are deleted for this course.
427  *
428  * @param stdClass $course an object representing the activity
429  * @param boolean $feedback to specify if the process must output a summary of its work
430  * @return boolean
431  */
432 function question_delete_course($course, $feedback=true) {
433     $coursecontext = context_course::instance($course->id);
434     $feedbackdata = question_delete_context($coursecontext->id, $feedback);
436     // Inform about changes performed if feedback is enabled.
437     if ($feedback && $feedbackdata) {
438         $table = new html_table();
439         $table->head = array(get_string('category', 'question'), get_string('action'));
440         $table->data = $feedbackdata;
441         echo html_writer::table($table);
442     }
443     return true;
446 /**
447  * Category is about to be deleted,
448  * 1/ All question categories and their questions are deleted for this course category.
449  * 2/ All questions are moved to new category
450  *
451  * @param object|core_course_category $category course category object
452  * @param object|core_course_category $newcategory empty means everything deleted, otherwise id of
453  *      category where content moved
454  * @param boolean $feedback to specify if the process must output a summary of its work
455  * @return boolean
456  */
457 function question_delete_course_category($category, $newcategory, $feedback=true) {
458     global $DB, $OUTPUT;
460     $context = context_coursecat::instance($category->id);
461     if (empty($newcategory)) {
462         $feedbackdata = question_delete_context($context->id, $feedback);
464         // Output feedback if requested.
465         if ($feedback && $feedbackdata) {
466             $table = new html_table();
467             $table->head = array(get_string('questioncategory', 'question'), get_string('action'));
468             $table->data = $feedbackdata;
469             echo html_writer::table($table);
470         }
472     } else {
473         // Move question categories to the new context.
474         if (!$newcontext = context_coursecat::instance($newcategory->id)) {
475             return false;
476         }
478         // Only move question categories if there is any question category at all!
479         if ($topcategory = question_get_top_category($context->id)) {
480             $newtopcategory = question_get_top_category($newcontext->id, true);
482             question_move_category_to_context($topcategory->id, $context->id, $newcontext->id);
483             $DB->set_field('question_categories', 'parent', $newtopcategory->id, array('parent' => $topcategory->id));
484             // Now delete the top category.
485             $DB->delete_records('question_categories', array('id' => $topcategory->id));
486         }
488         if ($feedback) {
489             $a = new stdClass();
490             $a->oldplace = $context->get_context_name();
491             $a->newplace = $newcontext->get_context_name();
492             echo $OUTPUT->notification(
493                     get_string('movedquestionsandcategories', 'question', $a), 'notifysuccess');
494         }
495     }
497     return true;
500 /**
501  * Enter description here...
502  *
503  * @param array $questionids of question ids
504  * @param object $newcontextid the context to create the saved category in.
505  * @param string $oldplace a textual description of the think being deleted,
506  *      e.g. from get_context_name
507  * @param object $newcategory
508  * @return mixed false on
509  */
510 function question_save_from_deletion($questionids, $newcontextid, $oldplace,
511         $newcategory = null) {
512     global $DB;
514     // Make a category in the parent context to move the questions to.
515     if (is_null($newcategory)) {
516         $newcategory = new stdClass();
517         $newcategory->parent = question_get_top_category($newcontextid, true)->id;
518         $newcategory->contextid = $newcontextid;
519         $newcategory->name = get_string('questionsrescuedfrom', 'question', $oldplace);
520         $newcategory->info = get_string('questionsrescuedfrominfo', 'question', $oldplace);
521         $newcategory->sortorder = 999;
522         $newcategory->stamp = make_unique_id_code();
523         $newcategory->id = $DB->insert_record('question_categories', $newcategory);
524     }
526     // Move any remaining questions to the 'saved' category.
527     if (!question_move_questions_to_category($questionids, $newcategory->id)) {
528         return false;
529     }
530     return $newcategory;
533 /**
534  * All question categories and their questions are deleted for this activity.
535  *
536  * @param object $cm the course module object representing the activity
537  * @param boolean $feedback to specify if the process must output a summary of its work
538  * @return boolean
539  */
540 function question_delete_activity($cm, $feedback=true) {
541     global $DB;
543     $modcontext = context_module::instance($cm->id);
544     $feedbackdata = question_delete_context($modcontext->id, $feedback);
545     // Inform about changes performed if feedback is enabled.
546     if ($feedback && $feedbackdata) {
547         $table = new html_table();
548         $table->head = array(get_string('category', 'question'), get_string('action'));
549         $table->data = $feedbackdata;
550         echo html_writer::table($table);
551     }
552     return true;
555 /**
556  * This function will handle moving all tag instances to a new context for a
557  * given list of questions.
558  *
559  * Questions can be tagged in up to two contexts:
560  * 1.) The context the question exists in.
561  * 2.) The course context (if the question context is a higher context.
562  *     E.g. course category context or system context.
563  *
564  * This means a question that exists in a higher context (e.g. course cat or
565  * system context) may have multiple groups of tags in any number of child
566  * course contexts.
567  *
568  * Questions in the course category context can be move "down" a context level
569  * into one of their child course contexts or activity contexts which affects the
570  * availability of that question in other courses / activities.
571  *
572  * In this case it makes the questions no longer available in the other course or
573  * activity contexts so we need to make sure that the tag instances in those other
574  * contexts are removed.
575  *
576  * @param stdClass[] $questions The list of question being moved (must include
577  *                              the id and contextid)
578  * @param context $newcontext The Moodle context the questions are being moved to
579  */
580 function question_move_question_tags_to_new_context(array $questions, context $newcontext) {
581     // If the questions are moving to a new course/activity context then we need to
582     // find any existing tag instances from any unavailable course contexts and
583     // delete them because they will no longer be applicable (we don't support
584     // tagging questions across courses).
585     $instancestodelete = [];
586     $instancesfornewcontext = [];
587     $newcontextparentids = $newcontext->get_parent_context_ids();
588     $questionids = array_map(function($question) {
589         return $question->id;
590     }, $questions);
591     $questionstagobjects = core_tag_tag::get_items_tags('core_question', 'question', $questionids);
593     foreach ($questions as $question) {
594         $tagobjects = $questionstagobjects[$question->id];
596         foreach ($tagobjects as $tagobject) {
597             $tagid = $tagobject->taginstanceid;
598             $tagcontextid = $tagobject->taginstancecontextid;
599             $istaginnewcontext = $tagcontextid == $newcontext->id;
600             $istaginquestioncontext = $tagcontextid == $question->contextid;
602             if ($istaginnewcontext) {
603                 // This tag instance is already in the correct context so we can
604                 // ignore it.
605                 continue;
606             }
608             if ($istaginquestioncontext) {
609                 // This tag instance is in the question context so it needs to be
610                 // updated.
611                 $instancesfornewcontext[] = $tagid;
612                 continue;
613             }
615             // These tag instances are in neither the new context nor the
616             // question context so we need to determine what to do based on
617             // the context they are in and the new question context.
618             $tagcontext = context::instance_by_id($tagcontextid);
619             $tagcoursecontext = $tagcontext->get_course_context(false);
620             // The tag is in a course context if get_course_context() returns
621             // itself.
622             $istaginstancecontextcourse = !empty($tagcoursecontext)
623                 && $tagcontext->id == $tagcoursecontext->id;
625             if ($istaginstancecontextcourse) {
626                 // If the tag instance is in a course context we need to add some
627                 // special handling.
628                 $tagcontextparentids = $tagcontext->get_parent_context_ids();
629                 $isnewcontextaparent = in_array($newcontext->id, $tagcontextparentids);
630                 $isnewcontextachild = in_array($tagcontext->id, $newcontextparentids);
632                 if ($isnewcontextaparent) {
633                     // If the tag instance is a course context tag and the new
634                     // context is still a parent context to the tag context then
635                     // we can leave this tag where it is.
636                     continue;
637                 } else if ($isnewcontextachild) {
638                     // If the new context is a child context (e.g. activity) of this
639                     // tag instance then we should move all of this tag instance
640                     // down into the activity context along with the question.
641                     $instancesfornewcontext[] = $tagid;
642                 } else {
643                     // If the tag is in a course context that is no longer a parent
644                     // or child of the new context then this tag instance should be
645                     // removed.
646                     $instancestodelete[] = $tagid;
647                 }
648             } else {
649                 // This is a catch all for any tag instances not in the question
650                 // context or a course context. These tag instances should be
651                 // updated to the new context id. This will clean up old invalid
652                 // data.
653                 $instancesfornewcontext[] = $tagid;
654             }
655         }
656     }
658     if (!empty($instancestodelete)) {
659         // Delete any course context tags that may no longer be valid.
660         core_tag_tag::delete_instances_by_id($instancestodelete);
661     }
663     if (!empty($instancesfornewcontext)) {
664         // Update the tag instances to the new context id.
665         core_tag_tag::change_instances_context($instancesfornewcontext, $newcontext);
666     }
669 /**
670  * This function should be considered private to the question bank, it is called from
671  * question/editlib.php question/contextmoveq.php and a few similar places to to the
672  * work of actually moving questions and associated data. However, callers of this
673  * function also have to do other work, which is why you should not call this method
674  * directly from outside the questionbank.
675  *
676  * @param array $questionids of question ids.
677  * @param integer $newcategoryid the id of the category to move to.
678  */
679 function question_move_questions_to_category($questionids, $newcategoryid) {
680     global $DB;
682     $newcontextid = $DB->get_field('question_categories', 'contextid',
683             array('id' => $newcategoryid));
684     list($questionidcondition, $params) = $DB->get_in_or_equal($questionids);
685     $questions = $DB->get_records_sql("
686             SELECT q.id, q.qtype, qc.contextid, q.idnumber, q.category
687               FROM {question} q
688               JOIN {question_categories} qc ON q.category = qc.id
689              WHERE  q.id $questionidcondition", $params);
690     foreach ($questions as $question) {
691         if ($newcontextid != $question->contextid) {
692             question_bank::get_qtype($question->qtype)->move_files(
693                     $question->id, $question->contextid, $newcontextid);
694         }
695         // Check whether there could be a clash of idnumbers in the new category.
696         if (((string) $question->idnumber !== '') &&
697                 $DB->record_exists('question', ['idnumber' => $question->idnumber, 'category' => $newcategoryid])) {
698             $rec = $DB->get_records_select('question', "category = ? AND idnumber LIKE ?",
699                     [$newcategoryid, $question->idnumber . '_%'], 'idnumber DESC', 'id, idnumber', 0, 1);
700             $unique = 1;
701             if (count($rec)) {
702                 $rec = reset($rec);
703                 $idnumber = $rec->idnumber;
704                 if (strpos($idnumber, '_') !== false) {
705                     $unique = substr($idnumber, strpos($idnumber, '_') + 1) + 1;
706                 }
707             }
708             // For the move process, add a numerical increment to the idnumber. This means that if a question is
709             // mistakenly moved then the idnumber will not be completely lost.
710             $q = new stdClass();
711             $q->id = $question->id;
712             $q->category = $newcategoryid;
713             $q->idnumber = $question->idnumber . '_' . $unique;
714             $DB->update_record('question', $q);
715         }
717         // Log this question move.
718         $eventparams = array(
719             'contextid' => $question->contextid,
720             'objectid' => $question->id,
721             'other' => array('oldcategoryid' => $question->category, 'newcategoryid' => $newcategoryid)
722         );
723         $event = \core\event\question_moved::create($eventparams);
724         $event->trigger();
725     }
727     // Move the questions themselves.
728     $DB->set_field_select('question', 'category', $newcategoryid,
729             "id $questionidcondition", $params);
731     // Move any subquestions belonging to them.
732     $DB->set_field_select('question', 'category', $newcategoryid,
733             "parent $questionidcondition", $params);
735     $newcontext = context::instance_by_id($newcontextid);
736     question_move_question_tags_to_new_context($questions, $newcontext);
738     // TODO Deal with datasets.
740     // Purge these questions from the cache.
741     foreach ($questions as $question) {
742         question_bank::notify_question_edited($question->id);
743     }
745     return true;
748 /**
749  * This function helps move a question cateogry to a new context by moving all
750  * the files belonging to all the questions to the new context.
751  * Also moves subcategories.
752  * @param integer $categoryid the id of the category being moved.
753  * @param integer $oldcontextid the old context id.
754  * @param integer $newcontextid the new context id.
755  */
756 function question_move_category_to_context($categoryid, $oldcontextid, $newcontextid) {
757     global $DB;
759     $questions = [];
760     $questionids = $DB->get_records_menu('question',
761             array('category' => $categoryid), '', 'id,qtype');
762     foreach ($questionids as $questionid => $qtype) {
763         question_bank::get_qtype($qtype)->move_files(
764                 $questionid, $oldcontextid, $newcontextid);
765         // Purge this question from the cache.
766         question_bank::notify_question_edited($questionid);
768         $questions[] = (object) [
769             'id' => $questionid,
770             'contextid' => $oldcontextid
771         ];
772     }
774     $newcontext = context::instance_by_id($newcontextid);
775     question_move_question_tags_to_new_context($questions, $newcontext);
777     $subcatids = $DB->get_records_menu('question_categories',
778             array('parent' => $categoryid), '', 'id,1');
779     foreach ($subcatids as $subcatid => $notused) {
780         $DB->set_field('question_categories', 'contextid', $newcontextid,
781                 array('id' => $subcatid));
782         question_move_category_to_context($subcatid, $oldcontextid, $newcontextid);
783     }
786 /**
787  * Generate the URL for starting a new preview of a given question with the given options.
788  * @param integer $questionid the question to preview.
789  * @param string $preferredbehaviour the behaviour to use for the preview.
790  * @param float $maxmark the maximum to mark the question out of.
791  * @param question_display_options $displayoptions the display options to use.
792  * @param int $variant the variant of the question to preview. If null, one will
793  *      be picked randomly.
794  * @param object $context context to run the preview in (affects things like
795  *      filter settings, theme, lang, etc.) Defaults to $PAGE->context.
796  * @return moodle_url the URL.
797  */
798 function question_preview_url($questionid, $preferredbehaviour = null,
799         $maxmark = null, $displayoptions = null, $variant = null, $context = null) {
801     $params = array('id' => $questionid);
803     if (is_null($context)) {
804         global $PAGE;
805         $context = $PAGE->context;
806     }
807     if ($context->contextlevel == CONTEXT_MODULE) {
808         $params['cmid'] = $context->instanceid;
809     } else if ($context->contextlevel == CONTEXT_COURSE) {
810         $params['courseid'] = $context->instanceid;
811     }
813     if (!is_null($preferredbehaviour)) {
814         $params['behaviour'] = $preferredbehaviour;
815     }
817     if (!is_null($maxmark)) {
818         $params['maxmark'] = $maxmark;
819     }
821     if (!is_null($displayoptions)) {
822         $params['correctness']     = $displayoptions->correctness;
823         $params['marks']           = $displayoptions->marks;
824         $params['markdp']          = $displayoptions->markdp;
825         $params['feedback']        = (bool) $displayoptions->feedback;
826         $params['generalfeedback'] = (bool) $displayoptions->generalfeedback;
827         $params['rightanswer']     = (bool) $displayoptions->rightanswer;
828         $params['history']         = (bool) $displayoptions->history;
829     }
831     if ($variant) {
832         $params['variant'] = $variant;
833     }
835     return new moodle_url('/question/preview.php', $params);
838 /**
839  * @return array that can be passed as $params to the {@link popup_action} constructor.
840  */
841 function question_preview_popup_params() {
842     return array(
843         'height' => 600,
844         'width' => 800,
845     );
848 /**
849  * Given a list of ids, load the basic information about a set of questions from
850  * the questions table. The $join and $extrafields arguments can be used together
851  * to pull in extra data. See, for example, the usage in mod/quiz/attemptlib.php, and
852  * read the code below to see how the SQL is assembled. Throws exceptions on error.
853  *
854  * @param array $questionids array of question ids to load. If null, then all
855  * questions matched by $join will be loaded.
856  * @param string $extrafields extra SQL code to be added to the query.
857  * @param string $join extra SQL code to be added to the query.
858  * @param array $extraparams values for any placeholders in $join.
859  * You must use named placeholders.
860  * @param string $orderby what to order the results by. Optional, default is unspecified order.
861  *
862  * @return array partially complete question objects. You need to call get_question_options
863  * on them before they can be properly used.
864  */
865 function question_preload_questions($questionids = null, $extrafields = '', $join = '',
866         $extraparams = array(), $orderby = '') {
867     global $DB;
869     if ($questionids === null) {
870         $where = '';
871         $params = array();
872     } else {
873         if (empty($questionids)) {
874             return array();
875         }
877         list($questionidcondition, $params) = $DB->get_in_or_equal(
878                 $questionids, SQL_PARAMS_NAMED, 'qid0000');
879         $where = 'WHERE q.id ' . $questionidcondition;
880     }
882     if ($join) {
883         $join = 'JOIN ' . $join;
884     }
886     if ($extrafields) {
887         $extrafields = ', ' . $extrafields;
888     }
890     if ($orderby) {
891         $orderby = 'ORDER BY ' . $orderby;
892     }
894     $sql = "SELECT q.*, qc.contextid{$extrafields}
895               FROM {question} q
896               JOIN {question_categories} qc ON q.category = qc.id
897               {$join}
898              {$where}
899           {$orderby}";
901     // Load the questions.
902     $questions = $DB->get_records_sql($sql, $extraparams + $params);
903     foreach ($questions as $question) {
904         $question->_partiallyloaded = true;
905     }
907     return $questions;
910 /**
911  * Load a set of questions, given a list of ids. The $join and $extrafields arguments can be used
912  * together to pull in extra data. See, for example, the usage in mod/quiz/attempt.php, and
913  * read the code below to see how the SQL is assembled. Throws exceptions on error.
914  *
915  * @param array $questionids array of question ids.
916  * @param string $extrafields extra SQL code to be added to the query.
917  * @param string $join extra SQL code to be added to the query.
918  * @param array $extraparams values for any placeholders in $join.
919  * You are strongly recommended to use named placeholder.
920  *
921  * @return array question objects.
922  */
923 function question_load_questions($questionids, $extrafields = '', $join = '') {
924     $questions = question_preload_questions($questionids, $extrafields, $join);
926     // Load the question type specific information
927     if (!get_question_options($questions)) {
928         return 'Could not load the question options';
929     }
931     return $questions;
934 /**
935  * Private function to factor common code out of get_question_options().
936  *
937  * @param object $question the question to tidy.
938  * @param stdClass $category The question_categories record for the given $question.
939  * @param stdClass[]|null $tagobjects The tags for the given $question.
940  * @param stdClass[]|null $filtercourses The courses to filter the course tags by.
941  */
942 function _tidy_question($question, $category, array $tagobjects = null, array $filtercourses = null) {
943     // Load question-type specific fields.
944     if (!question_bank::is_qtype_installed($question->qtype)) {
945         $question->questiontext = html_writer::tag('p', get_string('warningmissingtype',
946                 'qtype_missingtype')) . $question->questiontext;
947     }
948     question_bank::get_qtype($question->qtype)->get_question_options($question);
950     // Convert numeric fields to float. (Prevents these being displayed as 1.0000000.)
951     $question->defaultmark += 0;
952     $question->penalty += 0;
954     if (isset($question->_partiallyloaded)) {
955         unset($question->_partiallyloaded);
956     }
958     $question->categoryobject = $category;
960     if (!is_null($tagobjects)) {
961         $categorycontext = context::instance_by_id($category->contextid);
962         $sortedtagobjects = question_sort_tags($tagobjects, $categorycontext, $filtercourses);
963         $question->coursetagobjects = $sortedtagobjects->coursetagobjects;
964         $question->coursetags = $sortedtagobjects->coursetags;
965         $question->tagobjects = $sortedtagobjects->tagobjects;
966         $question->tags = $sortedtagobjects->tags;
967     }
970 /**
971  * Updates the question objects with question type specific
972  * information by calling {@link get_question_options()}
973  *
974  * Can be called either with an array of question objects or with a single
975  * question object.
976  *
977  * @param mixed $questions Either an array of question objects to be updated
978  *         or just a single question object
979  * @param bool $loadtags load the question tags from the tags table. Optional, default false.
980  * @param stdClass[] $filtercourses The courses to filter the course tags by.
981  * @return bool Indicates success or failure.
982  */
983 function get_question_options(&$questions, $loadtags = false, $filtercourses = null) {
984     global $DB;
986     $questionlist = is_array($questions) ? $questions : [$questions];
987     $categoryids = [];
988     $questionids = [];
990     if (empty($questionlist)) {
991         return true;
992     }
994     foreach ($questionlist as $question) {
995         $questionids[] = $question->id;
997         if (!in_array($question->category, $categoryids)) {
998             $categoryids[] = $question->category;
999         }
1000     }
1002     $categories = $DB->get_records_list('question_categories', 'id', $categoryids);
1004     if ($loadtags && core_tag_tag::is_enabled('core_question', 'question')) {
1005         $tagobjectsbyquestion = core_tag_tag::get_items_tags('core_question', 'question', $questionids);
1006     } else {
1007         $tagobjectsbyquestion = null;
1008     }
1010     foreach ($questionlist as $question) {
1011         if (is_null($tagobjectsbyquestion)) {
1012             $tagobjects = null;
1013         } else {
1014             $tagobjects = $tagobjectsbyquestion[$question->id];
1015         }
1017         _tidy_question($question, $categories[$question->category], $tagobjects, $filtercourses);
1018     }
1020     return true;
1023 /**
1024  * Sort question tags by course or normal tags.
1025  *
1026  * This function also search tag instances that may have a context id that don't match either a course or
1027  * question context and fix the data setting the correct context id.
1028  *
1029  * @param stdClass[] $tagobjects The tags for the given $question.
1030  * @param stdClass $categorycontext The question categories context.
1031  * @param stdClass[]|null $filtercourses The courses to filter the course tags by.
1032  * @return stdClass $sortedtagobjects Sorted tag objects.
1033  */
1034 function question_sort_tags($tagobjects, $categorycontext, $filtercourses = null) {
1036     // Questions can have two sets of tag instances. One set at the
1037     // course context level and another at the context the question
1038     // belongs to (e.g. course category, system etc).
1039     $sortedtagobjects = new stdClass();
1040     $sortedtagobjects->coursetagobjects = [];
1041     $sortedtagobjects->coursetags = [];
1042     $sortedtagobjects->tagobjects = [];
1043     $sortedtagobjects->tags = [];
1044     $taginstanceidstonormalise = [];
1045     $filtercoursecontextids = [];
1046     $hasfiltercourses = !empty($filtercourses);
1048     if ($hasfiltercourses) {
1049         // If we're being asked to filter the course tags by a set of courses
1050         // then get the context ids to filter below.
1051         $filtercoursecontextids = array_map(function($course) {
1052             $coursecontext = context_course::instance($course->id);
1053             return $coursecontext->id;
1054         }, $filtercourses);
1055     }
1057     foreach ($tagobjects as $tagobject) {
1058         $tagcontextid = $tagobject->taginstancecontextid;
1059         $tagcontext = context::instance_by_id($tagcontextid);
1060         $tagcoursecontext = $tagcontext->get_course_context(false);
1061         // This is a course tag if the tag context is a course context which
1062         // doesn't match the question's context. Any tag in the question context
1063         // is not considered a course tag, it belongs to the question.
1064         $iscoursetag = $tagcoursecontext
1065             && $tagcontext->id == $tagcoursecontext->id
1066             && $tagcontext->id != $categorycontext->id;
1068         if ($iscoursetag) {
1069             // Any tag instance in a course context level is considered a course tag.
1070             if (!$hasfiltercourses || in_array($tagcontextid, $filtercoursecontextids)) {
1071                 // Add the tag to the list of course tags if we aren't being
1072                 // asked to filter or if this tag is in the list of courses
1073                 // we're being asked to filter by.
1074                 $sortedtagobjects->coursetagobjects[] = $tagobject;
1075                 $sortedtagobjects->coursetags[$tagobject->id] = $tagobject->get_display_name();
1076             }
1077         } else {
1078             // All non course context level tag instances or tags in the question
1079             // context belong to the context that the question was created in.
1080             $sortedtagobjects->tagobjects[] = $tagobject;
1081             $sortedtagobjects->tags[$tagobject->id] = $tagobject->get_display_name();
1083             // Due to legacy tag implementations that don't force the recording
1084             // of a context id, some tag instances may have context ids that don't
1085             // match either a course context or the question context. In this case
1086             // we should take the opportunity to fix up the data and set the correct
1087             // context id.
1088             if ($tagcontext->id != $categorycontext->id) {
1089                 $taginstanceidstonormalise[] = $tagobject->taginstanceid;
1090                 // Update the object properties to reflect the DB update that will
1091                 // happen below.
1092                 $tagobject->taginstancecontextid = $categorycontext->id;
1093             }
1094         }
1095     }
1097     if (!empty($taginstanceidstonormalise)) {
1098         // If we found any tag instances with incorrect context id data then we can
1099         // correct those values now by setting them to the question context id.
1100         core_tag_tag::change_instances_context($taginstanceidstonormalise, $categorycontext);
1101     }
1103     return $sortedtagobjects;
1106 /**
1107  * Print the icon for the question type
1108  *
1109  * @param object $question The question object for which the icon is required.
1110  *       Only $question->qtype is used.
1111  * @return string the HTML for the img tag.
1112  */
1113 function print_question_icon($question) {
1114     global $PAGE;
1115     return $PAGE->get_renderer('question', 'bank')->qtype_icon($question->qtype);
1118 /**
1119  * Creates a stamp that uniquely identifies this version of the question
1120  *
1121  * In future we want this to use a hash of the question data to guarantee that
1122  * identical versions have the same version stamp.
1123  *
1124  * @param object $question
1125  * @return string A unique version stamp
1126  */
1127 function question_hash($question) {
1128     return make_unique_id_code();
1131 /// CATEGORY FUNCTIONS /////////////////////////////////////////////////////////////////
1133 /**
1134  * returns the categories with their names ordered following parent-child relationships
1135  * finally it tries to return pending categories (those being orphaned, whose parent is
1136  * incorrect) to avoid missing any category from original array.
1137  */
1138 function sort_categories_by_tree(&$categories, $id = 0, $level = 1) {
1139     global $DB;
1141     $children = array();
1142     $keys = array_keys($categories);
1144     foreach ($keys as $key) {
1145         if (!isset($categories[$key]->processed) && $categories[$key]->parent == $id) {
1146             $children[$key] = $categories[$key];
1147             $categories[$key]->processed = true;
1148             $children = $children + sort_categories_by_tree(
1149                     $categories, $children[$key]->id, $level+1);
1150         }
1151     }
1152     //If level = 1, we have finished, try to look for non processed categories
1153     // (bad parent) and sort them too
1154     if ($level == 1) {
1155         foreach ($keys as $key) {
1156             // If not processed and it's a good candidate to start (because its
1157             // parent doesn't exist in the course)
1158             if (!isset($categories[$key]->processed) && !$DB->record_exists('question_categories',
1159                     array('contextid' => $categories[$key]->contextid,
1160                             'id' => $categories[$key]->parent))) {
1161                 $children[$key] = $categories[$key];
1162                 $categories[$key]->processed = true;
1163                 $children = $children + sort_categories_by_tree(
1164                         $categories, $children[$key]->id, $level + 1);
1165             }
1166         }
1167     }
1168     return $children;
1171 /**
1172  * Private method, only for the use of add_indented_names().
1173  *
1174  * Recursively adds an indentedname field to each category, starting with the category
1175  * with id $id, and dealing with that category and all its children, and
1176  * return a new array, with those categories in the right order.
1177  *
1178  * @param array $categories an array of categories which has had childids
1179  *          fields added by flatten_category_tree(). Passed by reference for
1180  *          performance only. It is not modfied.
1181  * @param int $id the category to start the indenting process from.
1182  * @param int $depth the indent depth. Used in recursive calls.
1183  * @return array a new array of categories, in the right order for the tree.
1184  */
1185 function flatten_category_tree(&$categories, $id, $depth = 0, $nochildrenof = -1) {
1187     // Indent the name of this category.
1188     $newcategories = array();
1189     $newcategories[$id] = $categories[$id];
1190     $newcategories[$id]->indentedname = str_repeat('&nbsp;&nbsp;&nbsp;', $depth) .
1191             $categories[$id]->name;
1193     // Recursively indent the children.
1194     foreach ($categories[$id]->childids as $childid) {
1195         if ($childid != $nochildrenof) {
1196             $newcategories = $newcategories + flatten_category_tree(
1197                     $categories, $childid, $depth + 1, $nochildrenof);
1198         }
1199     }
1201     // Remove the childids array that were temporarily added.
1202     unset($newcategories[$id]->childids);
1204     return $newcategories;
1207 /**
1208  * Format categories into an indented list reflecting the tree structure.
1209  *
1210  * @param array $categories An array of category objects, for example from the.
1211  * @return array The formatted list of categories.
1212  */
1213 function add_indented_names($categories, $nochildrenof = -1) {
1215     // Add an array to each category to hold the child category ids. This array
1216     // will be removed again by flatten_category_tree(). It should not be used
1217     // outside these two functions.
1218     foreach (array_keys($categories) as $id) {
1219         $categories[$id]->childids = array();
1220     }
1222     // Build the tree structure, and record which categories are top-level.
1223     // We have to be careful, because the categories array may include published
1224     // categories from other courses, but not their parents.
1225     $toplevelcategoryids = array();
1226     foreach (array_keys($categories) as $id) {
1227         if (!empty($categories[$id]->parent) &&
1228                 array_key_exists($categories[$id]->parent, $categories)) {
1229             $categories[$categories[$id]->parent]->childids[] = $id;
1230         } else {
1231             $toplevelcategoryids[] = $id;
1232         }
1233     }
1235     // Flatten the tree to and add the indents.
1236     $newcategories = array();
1237     foreach ($toplevelcategoryids as $id) {
1238         $newcategories = $newcategories + flatten_category_tree(
1239                 $categories, $id, 0, $nochildrenof);
1240     }
1242     return $newcategories;
1245 /**
1246  * Output a select menu of question categories.
1247  *
1248  * Categories from this course and (optionally) published categories from other courses
1249  * are included. Optionally, only categories the current user may edit can be included.
1250  *
1251  * @param integer $courseid the id of the course to get the categories for.
1252  * @param integer $published if true, include publised categories from other courses.
1253  * @param integer $only_editable if true, exclude categories this user is not allowed to edit.
1254  * @param integer $selected optionally, the id of a category to be selected by
1255  *      default in the dropdown.
1256  */
1257 function question_category_select_menu($contexts, $top = false, $currentcat = 0,
1258         $selected = "", $nochildrenof = -1) {
1259     $categoriesarray = question_category_options($contexts, $top, $currentcat,
1260             false, $nochildrenof);
1261     if ($selected) {
1262         $choose = '';
1263     } else {
1264         $choose = 'choosedots';
1265     }
1266     $options = array();
1267     foreach ($categoriesarray as $group => $opts) {
1268         $options[] = array($group => $opts);
1269     }
1270     echo html_writer::label(get_string('questioncategory', 'core_question'), 'id_movetocategory', false, array('class' => 'accesshide'));
1271     $attrs = array('id' => 'id_movetocategory', 'class' => 'custom-select');
1272     echo html_writer::select($options, 'category', $selected, $choose, $attrs);
1275 /**
1276  * @param integer $contextid a context id.
1277  * @return object the default question category for that context, or false if none.
1278  */
1279 function question_get_default_category($contextid) {
1280     global $DB;
1281     $category = $DB->get_records_select('question_categories', 'contextid = ? AND parent <> 0',
1282             array($contextid), 'id', '*', 0, 1);
1283     if (!empty($category)) {
1284         return reset($category);
1285     } else {
1286         return false;
1287     }
1290 /**
1291  * Gets the top category in the given context.
1292  * This function can optionally create the top category if it doesn't exist.
1293  *
1294  * @param int $contextid A context id.
1295  * @param bool $create Whether create a top category if it doesn't exist.
1296  * @return bool|stdClass The top question category for that context, or false if none.
1297  */
1298 function question_get_top_category($contextid, $create = false) {
1299     global $DB;
1300     $category = $DB->get_record('question_categories',
1301             array('contextid' => $contextid, 'parent' => 0));
1303     if (!$category && $create) {
1304         // We need to make one.
1305         $category = new stdClass();
1306         $category->name = 'top'; // A non-real name for the top category. It will be localised at the display time.
1307         $category->info = '';
1308         $category->contextid = $contextid;
1309         $category->parent = 0;
1310         $category->sortorder = 0;
1311         $category->stamp = make_unique_id_code();
1312         $category->id = $DB->insert_record('question_categories', $category);
1313     }
1315     return $category;
1318 /**
1319  * Gets the list of top categories in the given contexts in the array("categoryid,categorycontextid") format.
1320  *
1321  * @param array $contextids List of context ids
1322  * @return array
1323  */
1324 function question_get_top_categories_for_contexts($contextids) {
1325     global $DB;
1327     $concatsql = $DB->sql_concat_join("','", ['id', 'contextid']);
1328     list($insql, $params) = $DB->get_in_or_equal($contextids);
1329     $sql = "SELECT $concatsql FROM {question_categories} WHERE contextid $insql AND parent = 0";
1330     $topcategories = $DB->get_fieldset_sql($sql, $params);
1332     return $topcategories;
1335 /**
1336  * Gets the default category in the most specific context.
1337  * If no categories exist yet then default ones are created in all contexts.
1338  *
1339  * @param array $contexts  The context objects for this context and all parent contexts.
1340  * @return object The default category - the category in the course context
1341  */
1342 function question_make_default_categories($contexts) {
1343     global $DB;
1344     static $preferredlevels = array(
1345         CONTEXT_COURSE => 4,
1346         CONTEXT_MODULE => 3,
1347         CONTEXT_COURSECAT => 2,
1348         CONTEXT_SYSTEM => 1,
1349     );
1351     $toreturn = null;
1352     $preferredness = 0;
1353     // If it already exists, just return it.
1354     foreach ($contexts as $key => $context) {
1355         $topcategory = question_get_top_category($context->id, true);
1356         if (!$exists = $DB->record_exists("question_categories",
1357                 array('contextid' => $context->id, 'parent' => $topcategory->id))) {
1358             // Otherwise, we need to make one
1359             $category = new stdClass();
1360             $contextname = $context->get_context_name(false, true);
1361             $category->name = get_string('defaultfor', 'question', $contextname);
1362             $category->info = get_string('defaultinfofor', 'question', $contextname);
1363             $category->contextid = $context->id;
1364             $category->parent = $topcategory->id;
1365             // By default, all categories get this number, and are sorted alphabetically.
1366             $category->sortorder = 999;
1367             $category->stamp = make_unique_id_code();
1368             $category->id = $DB->insert_record('question_categories', $category);
1369         } else {
1370             $category = question_get_default_category($context->id);
1371         }
1372         $thispreferredness = $preferredlevels[$context->contextlevel];
1373         if (has_any_capability(array('moodle/question:usemine', 'moodle/question:useall'), $context)) {
1374             $thispreferredness += 10;
1375         }
1376         if ($thispreferredness > $preferredness) {
1377             $toreturn = $category;
1378             $preferredness = $thispreferredness;
1379         }
1380     }
1382     if (!is_null($toreturn)) {
1383         $toreturn = clone($toreturn);
1384     }
1385     return $toreturn;
1388 /**
1389  * Get all the category objects, including a count of the number of questions in that category,
1390  * for all the categories in the lists $contexts.
1391  *
1392  * @param mixed $contexts either a single contextid, or a comma-separated list of context ids.
1393  * @param string $sortorder used as the ORDER BY clause in the select statement.
1394  * @param bool $top Whether to return the top categories or not.
1395  * @return array of category objects.
1396  */
1397 function get_categories_for_contexts($contexts, $sortorder = 'parent, sortorder, name ASC', $top = false) {
1398     global $DB;
1399     $topwhere = $top ? '' : 'AND c.parent <> 0';
1400     return $DB->get_records_sql("
1401             SELECT c.*, (SELECT count(1) FROM {question} q
1402                         WHERE c.id = q.category AND q.hidden='0' AND q.parent='0') AS questioncount
1403               FROM {question_categories} c
1404              WHERE c.contextid IN ($contexts) $topwhere
1405           ORDER BY $sortorder");
1408 /**
1409  * Output an array of question categories.
1410  *
1411  * @param array $contexts The list of contexts.
1412  * @param bool $top Whether to return the top categories or not.
1413  * @param int $currentcat
1414  * @param bool $popupform
1415  * @param int $nochildrenof
1416  * @return array
1417  */
1418 function question_category_options($contexts, $top = false, $currentcat = 0,
1419         $popupform = false, $nochildrenof = -1) {
1420     global $CFG;
1421     $pcontexts = array();
1422     foreach ($contexts as $context) {
1423         $pcontexts[] = $context->id;
1424     }
1425     $contextslist = join($pcontexts, ', ');
1427     $categories = get_categories_for_contexts($contextslist, 'parent, sortorder, name ASC', $top);
1429     if ($top) {
1430         $categories = question_fix_top_names($categories);
1431     }
1433     $categories = question_add_context_in_key($categories);
1434     $categories = add_indented_names($categories, $nochildrenof);
1436     // sort cats out into different contexts
1437     $categoriesarray = array();
1438     foreach ($pcontexts as $contextid) {
1439         $context = context::instance_by_id($contextid);
1440         $contextstring = $context->get_context_name(true, true);
1441         foreach ($categories as $category) {
1442             if ($category->contextid == $contextid) {
1443                 $cid = $category->id;
1444                 if ($currentcat != $cid || $currentcat == 0) {
1445                     $countstring = !empty($category->questioncount) ?
1446                             " ($category->questioncount)" : '';
1447                     $categoriesarray[$contextstring][$cid] =
1448                             format_string($category->indentedname, true,
1449                                 array('context' => $context)) . $countstring;
1450                 }
1451             }
1452         }
1453     }
1454     if ($popupform) {
1455         $popupcats = array();
1456         foreach ($categoriesarray as $contextstring => $optgroup) {
1457             $group = array();
1458             foreach ($optgroup as $key => $value) {
1459                 $key = str_replace($CFG->wwwroot, '', $key);
1460                 $group[$key] = $value;
1461             }
1462             $popupcats[] = array($contextstring => $group);
1463         }
1464         return $popupcats;
1465     } else {
1466         return $categoriesarray;
1467     }
1470 function question_add_context_in_key($categories) {
1471     $newcatarray = array();
1472     foreach ($categories as $id => $category) {
1473         $category->parent = "$category->parent,$category->contextid";
1474         $category->id = "$category->id,$category->contextid";
1475         $newcatarray["$id,$category->contextid"] = $category;
1476     }
1477     return $newcatarray;
1480 /**
1481  * Finds top categories in the given categories hierarchy and replace their name with a proper localised string.
1482  *
1483  * @param array $categories An array of question categories.
1484  * @return array The same question category list given to the function, with the top category names being translated.
1485  */
1486 function question_fix_top_names($categories) {
1488     foreach ($categories as $id => $category) {
1489         if ($category->parent == 0) {
1490             $context = context::instance_by_id($category->contextid);
1491             $categories[$id]->name = get_string('topfor', 'question', $context->get_context_name(false));
1492         }
1493     }
1495     return $categories;
1498 /**
1499  * @return array of question category ids of the category and all subcategories.
1500  */
1501 function question_categorylist($categoryid) {
1502     global $DB;
1504     // final list of category IDs
1505     $categorylist = array();
1507     // a list of category IDs to check for any sub-categories
1508     $subcategories = array($categoryid);
1510     while ($subcategories) {
1511         foreach ($subcategories as $subcategory) {
1512             // if anything from the temporary list was added already, then we have a loop
1513             if (isset($categorylist[$subcategory])) {
1514                 throw new coding_exception("Category id=$subcategory is already on the list - loop of categories detected.");
1515             }
1516             $categorylist[$subcategory] = $subcategory;
1517         }
1519         list ($in, $params) = $DB->get_in_or_equal($subcategories);
1521         $subcategories = $DB->get_records_select_menu('question_categories',
1522                 "parent $in", $params, NULL, 'id,id AS id2');
1523     }
1525     return $categorylist;
1528 /**
1529  * Get all parent categories of a given question category in decending order.
1530  * @param int $categoryid for which you want to find the parents.
1531  * @return array of question category ids of all parents categories.
1532  */
1533 function question_categorylist_parents(int $categoryid) {
1534     global $DB;
1535     $parent = $DB->get_field('question_categories', 'parent', array('id' => $categoryid));
1536     if (!$parent) {
1537         return [];
1538     }
1539     $categorylist = [$parent];
1540     $currentid = $parent;
1541     while ($currentid) {
1542         $currentid = $DB->get_field('question_categories', 'parent', array('id' => $currentid));
1543         if ($currentid) {
1544             $categorylist[] = $currentid;
1545         }
1546     }
1547     // Present the list in decending order (the top category at the top).
1548     $categorylist = array_reverse($categorylist);
1549     return $categorylist;
1552 //===========================
1553 // Import/Export Functions
1554 //===========================
1556 /**
1557  * Get list of available import or export formats
1558  * @param string $type 'import' if import list, otherwise export list assumed
1559  * @return array sorted list of import/export formats available
1560  */
1561 function get_import_export_formats($type) {
1562     global $CFG;
1563     require_once($CFG->dirroot . '/question/format.php');
1565     $formatclasses = core_component::get_plugin_list_with_class('qformat', '', 'format.php');
1567     $fileformatname = array();
1568     foreach ($formatclasses as $component => $formatclass) {
1570         $format = new $formatclass();
1571         if ($type == 'import') {
1572             $provided = $format->provide_import();
1573         } else {
1574             $provided = $format->provide_export();
1575         }
1577         if ($provided) {
1578             list($notused, $fileformat) = explode('_', $component, 2);
1579             $fileformatnames[$fileformat] = get_string('pluginname', $component);
1580         }
1581     }
1583     core_collator::asort($fileformatnames);
1584     return $fileformatnames;
1588 /**
1589  * Create a reasonable default file name for exporting questions from a particular
1590  * category.
1591  * @param object $course the course the questions are in.
1592  * @param object $category the question category.
1593  * @return string the filename.
1594  */
1595 function question_default_export_filename($course, $category) {
1596     // We build a string that is an appropriate name (questions) from the lang pack,
1597     // then the corse shortname, then the question category name, then a timestamp.
1599     $base = clean_filename(get_string('exportfilename', 'question'));
1601     $dateformat = str_replace(' ', '_', get_string('exportnameformat', 'question'));
1602     $timestamp = clean_filename(userdate(time(), $dateformat, 99, false));
1604     $shortname = clean_filename($course->shortname);
1605     if ($shortname == '' || $shortname == '_' ) {
1606         $shortname = $course->id;
1607     }
1609     $categoryname = clean_filename(format_string($category->name));
1611     return "{$base}-{$shortname}-{$categoryname}-{$timestamp}";
1613     return $export_name;
1616 /**
1617  * Converts contextlevels to strings and back to help with reading/writing contexts
1618  * to/from import/export files.
1619  *
1620  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
1621  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1622  */
1623 class context_to_string_translator{
1624     /**
1625      * @var array used to translate between contextids and strings for this context.
1626      */
1627     protected $contexttostringarray = array();
1629     public function __construct($contexts) {
1630         $this->generate_context_to_string_array($contexts);
1631     }
1633     public function context_to_string($contextid) {
1634         return $this->contexttostringarray[$contextid];
1635     }
1637     public function string_to_context($contextname) {
1638         $contextid = array_search($contextname, $this->contexttostringarray);
1639         return $contextid;
1640     }
1642     protected function generate_context_to_string_array($contexts) {
1643         if (!$this->contexttostringarray) {
1644             $catno = 1;
1645             foreach ($contexts as $context) {
1646                 switch ($context->contextlevel) {
1647                     case CONTEXT_MODULE :
1648                         $contextstring = 'module';
1649                         break;
1650                     case CONTEXT_COURSE :
1651                         $contextstring = 'course';
1652                         break;
1653                     case CONTEXT_COURSECAT :
1654                         $contextstring = "cat$catno";
1655                         $catno++;
1656                         break;
1657                     case CONTEXT_SYSTEM :
1658                         $contextstring = 'system';
1659                         break;
1660                 }
1661                 $this->contexttostringarray[$context->id] = $contextstring;
1662             }
1663         }
1664     }
1668 /**
1669  * Check capability on category
1670  *
1671  * @param int|stdClass $questionorid object or id. If an object is passed, it should include ->contextid and ->createdby.
1672  * @param string $cap 'add', 'edit', 'view', 'use', 'move' or 'tag'.
1673  * @param int $notused no longer used.
1674  * @return bool this user has the capability $cap for this question $question?
1675  * @throws coding_exception
1676  */
1677 function question_has_capability_on($questionorid, $cap, $notused = -1) {
1678     global $USER, $DB;
1680     if (is_numeric($questionorid)) {
1681         $questionid = (int)$questionorid;
1682     } else if (is_object($questionorid)) {
1683         // All we really need in this function is the contextid and author of the question.
1684         // We won't bother fetching other details of the question if these 2 fields are provided.
1685         if (isset($questionorid->contextid) && isset($questionorid->createdby)) {
1686             $question = $questionorid;
1687         } else if (!empty($questionorid->id)) {
1688             $questionid = $questionorid->id;
1689         }
1690     }
1692     // At this point, either $question or $questionid is expected to be set.
1693     if (isset($questionid)) {
1694         try {
1695             $question = question_bank::load_question_data($questionid);
1696         } catch (Exception $e) {
1697             // Let's log the exception for future debugging.
1698             debugging($e->getMessage(), DEBUG_NORMAL, $e->getTrace());
1700             // Well, at least we tried. Seems that we really have to read from DB.
1701             $question = $DB->get_record_sql('SELECT q.id, q.createdby, qc.contextid
1702                                                FROM {question} q
1703                                                JOIN {question_categories} qc ON q.category = qc.id
1704                                               WHERE q.id = :id', ['id' => $questionid]);
1705         }
1706     }
1708     if (!isset($question)) {
1709         throw new coding_exception('$questionorid parameter needs to be an integer or an object.');
1710     }
1712     $context = context::instance_by_id($question->contextid);
1714     // These are existing questions capabilities that are set per category.
1715     // Each of these has a 'mine' and 'all' version that is appended to the capability name.
1716     $capabilitieswithallandmine = ['edit' => 1, 'view' => 1, 'use' => 1, 'move' => 1, 'tag' => 1];
1718     if (!isset($capabilitieswithallandmine[$cap])) {
1719         return has_capability('moodle/question:' . $cap, $context);
1720     } else {
1721         return has_capability('moodle/question:' . $cap . 'all', $context) ||
1722             ($question->createdby == $USER->id && has_capability('moodle/question:' . $cap . 'mine', $context));
1723     }
1726 /**
1727  * Require capability on question.
1728  */
1729 function question_require_capability_on($question, $cap) {
1730     if (!question_has_capability_on($question, $cap)) {
1731         print_error('nopermissions', '', '', $cap);
1732     }
1733     return true;
1736 /**
1737  * @param object $context a context
1738  * @return string A URL for editing questions in this context.
1739  */
1740 function question_edit_url($context) {
1741     global $CFG, $SITE;
1742     if (!has_any_capability(question_get_question_capabilities(), $context)) {
1743         return false;
1744     }
1745     $baseurl = $CFG->wwwroot . '/question/edit.php?';
1746     $defaultcategory = question_get_default_category($context->id);
1747     if ($defaultcategory) {
1748         $baseurl .= 'cat=' . $defaultcategory->id . ',' . $context->id . '&amp;';
1749     }
1750     switch ($context->contextlevel) {
1751         case CONTEXT_SYSTEM:
1752             return $baseurl . 'courseid=' . $SITE->id;
1753         case CONTEXT_COURSECAT:
1754             // This is nasty, becuase we can only edit questions in a course
1755             // context at the moment, so for now we just return false.
1756             return false;
1757         case CONTEXT_COURSE:
1758             return $baseurl . 'courseid=' . $context->instanceid;
1759         case CONTEXT_MODULE:
1760             return $baseurl . 'cmid=' . $context->instanceid;
1761     }
1765 /**
1766  * Adds question bank setting links to the given navigation node if caps are met.
1767  *
1768  * @param navigation_node $navigationnode The navigation node to add the question branch to
1769  * @param object $context
1770  * @return navigation_node Returns the question branch that was added
1771  */
1772 function question_extend_settings_navigation(navigation_node $navigationnode, $context) {
1773     global $PAGE;
1775     if ($context->contextlevel == CONTEXT_COURSE) {
1776         $params = array('courseid'=>$context->instanceid);
1777     } else if ($context->contextlevel == CONTEXT_MODULE) {
1778         $params = array('cmid'=>$context->instanceid);
1779     } else {
1780         return;
1781     }
1783     if (($cat = $PAGE->url->param('cat')) && preg_match('~\d+,\d+~', $cat)) {
1784         $params['cat'] = $cat;
1785     }
1787     $questionnode = $navigationnode->add(get_string('questionbank', 'question'),
1788             new moodle_url('/question/edit.php', $params), navigation_node::TYPE_CONTAINER, null, 'questionbank');
1790     $contexts = new question_edit_contexts($context);
1791     if ($contexts->have_one_edit_tab_cap('questions')) {
1792         $questionnode->add(get_string('questions', 'question'), new moodle_url(
1793                 '/question/edit.php', $params), navigation_node::TYPE_SETTING, null, 'questions');
1794     }
1795     if ($contexts->have_one_edit_tab_cap('categories')) {
1796         $questionnode->add(get_string('categories', 'question'), new moodle_url(
1797                 '/question/category.php', $params), navigation_node::TYPE_SETTING, null, 'categories');
1798     }
1799     if ($contexts->have_one_edit_tab_cap('import')) {
1800         $questionnode->add(get_string('import', 'question'), new moodle_url(
1801                 '/question/import.php', $params), navigation_node::TYPE_SETTING, null, 'import');
1802     }
1803     if ($contexts->have_one_edit_tab_cap('export')) {
1804         $questionnode->add(get_string('export', 'question'), new moodle_url(
1805                 '/question/export.php', $params), navigation_node::TYPE_SETTING, null, 'export');
1806     }
1808     return $questionnode;
1811 /**
1812  * @return array all the capabilities that relate to accessing particular questions.
1813  */
1814 function question_get_question_capabilities() {
1815     return array(
1816         'moodle/question:add',
1817         'moodle/question:editmine',
1818         'moodle/question:editall',
1819         'moodle/question:viewmine',
1820         'moodle/question:viewall',
1821         'moodle/question:usemine',
1822         'moodle/question:useall',
1823         'moodle/question:movemine',
1824         'moodle/question:moveall',
1825     );
1828 /**
1829  * @return array all the question bank capabilities.
1830  */
1831 function question_get_all_capabilities() {
1832     $caps = question_get_question_capabilities();
1833     $caps[] = 'moodle/question:managecategory';
1834     $caps[] = 'moodle/question:flag';
1835     return $caps;
1839 /**
1840  * Tracks all the contexts related to the one where we are currently editing
1841  * questions, and provides helper methods to check permissions.
1842  *
1843  * @copyright 2007 Jamie Pratt me@jamiep.org
1844  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1845  */
1846 class question_edit_contexts {
1848     public static $caps = array(
1849         'editq' => array('moodle/question:add',
1850             'moodle/question:editmine',
1851             'moodle/question:editall',
1852             'moodle/question:viewmine',
1853             'moodle/question:viewall',
1854             'moodle/question:usemine',
1855             'moodle/question:useall',
1856             'moodle/question:movemine',
1857             'moodle/question:moveall'),
1858         'questions'=>array('moodle/question:add',
1859             'moodle/question:editmine',
1860             'moodle/question:editall',
1861             'moodle/question:viewmine',
1862             'moodle/question:viewall',
1863             'moodle/question:movemine',
1864             'moodle/question:moveall'),
1865         'categories'=>array('moodle/question:managecategory'),
1866         'import'=>array('moodle/question:add'),
1867         'export'=>array('moodle/question:viewall', 'moodle/question:viewmine'));
1869     protected $allcontexts;
1871     /**
1872      * Constructor
1873      * @param context the current context.
1874      */
1875     public function __construct(context $thiscontext) {
1876         $this->allcontexts = array_values($thiscontext->get_parent_contexts(true));
1877     }
1879     /**
1880      * @return array all parent contexts
1881      */
1882     public function all() {
1883         return $this->allcontexts;
1884     }
1886     /**
1887      * @return object lowest context which must be either the module or course context
1888      */
1889     public function lowest() {
1890         return $this->allcontexts[0];
1891     }
1893     /**
1894      * @param string $cap capability
1895      * @return array parent contexts having capability, zero based index
1896      */
1897     public function having_cap($cap) {
1898         $contextswithcap = array();
1899         foreach ($this->allcontexts as $context) {
1900             if (has_capability($cap, $context)) {
1901                 $contextswithcap[] = $context;
1902             }
1903         }
1904         return $contextswithcap;
1905     }
1907     /**
1908      * @param array $caps capabilities
1909      * @return array parent contexts having at least one of $caps, zero based index
1910      */
1911     public function having_one_cap($caps) {
1912         $contextswithacap = array();
1913         foreach ($this->allcontexts as $context) {
1914             foreach ($caps as $cap) {
1915                 if (has_capability($cap, $context)) {
1916                     $contextswithacap[] = $context;
1917                     break; //done with caps loop
1918                 }
1919             }
1920         }
1921         return $contextswithacap;
1922     }
1924     /**
1925      * @param string $tabname edit tab name
1926      * @return array parent contexts having at least one of $caps, zero based index
1927      */
1928     public function having_one_edit_tab_cap($tabname) {
1929         return $this->having_one_cap(self::$caps[$tabname]);
1930     }
1932     /**
1933      * @return those contexts where a user can add a question and then use it.
1934      */
1935     public function having_add_and_use() {
1936         $contextswithcap = array();
1937         foreach ($this->allcontexts as $context) {
1938             if (!has_capability('moodle/question:add', $context)) {
1939                 continue;
1940             }
1941             if (!has_any_capability(array('moodle/question:useall', 'moodle/question:usemine'), $context)) {
1942                             continue;
1943             }
1944             $contextswithcap[] = $context;
1945         }
1946         return $contextswithcap;
1947     }
1949     /**
1950      * Has at least one parent context got the cap $cap?
1951      *
1952      * @param string $cap capability
1953      * @return boolean
1954      */
1955     public function have_cap($cap) {
1956         return (count($this->having_cap($cap)));
1957     }
1959     /**
1960      * Has at least one parent context got one of the caps $caps?
1961      *
1962      * @param array $caps capability
1963      * @return boolean
1964      */
1965     public function have_one_cap($caps) {
1966         foreach ($caps as $cap) {
1967             if ($this->have_cap($cap)) {
1968                 return true;
1969             }
1970         }
1971         return false;
1972     }
1974     /**
1975      * Has at least one parent context got one of the caps for actions on $tabname
1976      *
1977      * @param string $tabname edit tab name
1978      * @return boolean
1979      */
1980     public function have_one_edit_tab_cap($tabname) {
1981         return $this->have_one_cap(self::$caps[$tabname]);
1982     }
1984     /**
1985      * Throw error if at least one parent context hasn't got the cap $cap
1986      *
1987      * @param string $cap capability
1988      */
1989     public function require_cap($cap) {
1990         if (!$this->have_cap($cap)) {
1991             print_error('nopermissions', '', '', $cap);
1992         }
1993     }
1995     /**
1996      * Throw error if at least one parent context hasn't got one of the caps $caps
1997      *
1998      * @param array $cap capabilities
1999      */
2000     public function require_one_cap($caps) {
2001         if (!$this->have_one_cap($caps)) {
2002             $capsstring = join($caps, ', ');
2003             print_error('nopermissions', '', '', $capsstring);
2004         }
2005     }
2007     /**
2008      * Throw error if at least one parent context hasn't got one of the caps $caps
2009      *
2010      * @param string $tabname edit tab name
2011      */
2012     public function require_one_edit_tab_cap($tabname) {
2013         if (!$this->have_one_edit_tab_cap($tabname)) {
2014             print_error('nopermissions', '', '', 'access question edit tab '.$tabname);
2015         }
2016     }
2020 /**
2021  * Helps call file_rewrite_pluginfile_urls with the right parameters.
2022  *
2023  * @package  core_question
2024  * @category files
2025  * @param string $text text being processed
2026  * @param string $file the php script used to serve files
2027  * @param int $contextid context ID
2028  * @param string $component component
2029  * @param string $filearea filearea
2030  * @param array $ids other IDs will be used to check file permission
2031  * @param int $itemid item ID
2032  * @param array $options options
2033  * @return string
2034  */
2035 function question_rewrite_question_urls($text, $file, $contextid, $component,
2036         $filearea, array $ids, $itemid, array $options=null) {
2038     $idsstr = '';
2039     if (!empty($ids)) {
2040         $idsstr .= implode('/', $ids);
2041     }
2042     if ($itemid !== null) {
2043         $idsstr .= '/' . $itemid;
2044     }
2045     return file_rewrite_pluginfile_urls($text, $file, $contextid, $component,
2046             $filearea, $idsstr, $options);
2049 /**
2050  * Rewrite the PLUGINFILE urls in part of the content of a question, for use when
2051  * viewing the question outside an attempt (for example, in the question bank
2052  * listing or in the quiz statistics report).
2053  *
2054  * @param string $text the question text.
2055  * @param int $questionid the question id.
2056  * @param int $filecontextid the context id of the question being displayed.
2057  * @param string $filecomponent the component that owns the file area.
2058  * @param string $filearea the file area name.
2059  * @param int|null $itemid the file's itemid
2060  * @param int $previewcontextid the context id where the preview is being displayed.
2061  * @param string $previewcomponent component responsible for displaying the preview.
2062  * @param array $options text and file options ('forcehttps'=>false)
2063  * @return string $questiontext with URLs rewritten.
2064  */
2065 function question_rewrite_question_preview_urls($text, $questionid,
2066         $filecontextid, $filecomponent, $filearea, $itemid,
2067         $previewcontextid, $previewcomponent, $options = null) {
2069     $path = "preview/$previewcontextid/$previewcomponent/$questionid";
2070     if ($itemid) {
2071         $path .= '/' . $itemid;
2072     }
2074     return file_rewrite_pluginfile_urls($text, 'pluginfile.php', $filecontextid,
2075             $filecomponent, $filearea, $path, $options);
2078 /**
2079  * Called by pluginfile.php to serve files related to the 'question' core
2080  * component and for files belonging to qtypes.
2081  *
2082  * For files that relate to questions in a question_attempt, then we delegate to
2083  * a function in the component that owns the attempt (for example in the quiz,
2084  * or in core question preview) to get necessary inforation.
2085  *
2086  * (Note that, at the moment, all question file areas relate to questions in
2087  * attempts, so the If at the start of the last paragraph is always true.)
2088  *
2089  * Does not return, either calls send_file_not_found(); or serves the file.
2090  *
2091  * @package  core_question
2092  * @category files
2093  * @param stdClass $course course settings object
2094  * @param stdClass $context context object
2095  * @param string $component the name of the component we are serving files for.
2096  * @param string $filearea the name of the file area.
2097  * @param array $args the remaining bits of the file path.
2098  * @param bool $forcedownload whether the user must be forced to download the file.
2099  * @param array $options additional options affecting the file serving
2100  */
2101 function question_pluginfile($course, $context, $component, $filearea, $args, $forcedownload, array $options=array()) {
2102     global $DB, $CFG;
2104     // Special case, sending a question bank export.
2105     if ($filearea === 'export') {
2106         list($context, $course, $cm) = get_context_info_array($context->id);
2107         require_login($course, false, $cm);
2109         require_once($CFG->dirroot . '/question/editlib.php');
2110         $contexts = new question_edit_contexts($context);
2111         // check export capability
2112         $contexts->require_one_edit_tab_cap('export');
2113         $category_id = (int)array_shift($args);
2114         $format      = array_shift($args);
2115         $cattofile   = array_shift($args);
2116         $contexttofile = array_shift($args);
2117         $filename    = array_shift($args);
2119         // load parent class for import/export
2120         require_once($CFG->dirroot . '/question/format.php');
2121         require_once($CFG->dirroot . '/question/editlib.php');
2122         require_once($CFG->dirroot . '/question/format/' . $format . '/format.php');
2124         $classname = 'qformat_' . $format;
2125         if (!class_exists($classname)) {
2126             send_file_not_found();
2127         }
2129         $qformat = new $classname();
2131         if (!$category = $DB->get_record('question_categories', array('id' => $category_id))) {
2132             send_file_not_found();
2133         }
2135         $qformat->setCategory($category);
2136         $qformat->setContexts($contexts->having_one_edit_tab_cap('export'));
2137         $qformat->setCourse($course);
2139         if ($cattofile == 'withcategories') {
2140             $qformat->setCattofile(true);
2141         } else {
2142             $qformat->setCattofile(false);
2143         }
2145         if ($contexttofile == 'withcontexts') {
2146             $qformat->setContexttofile(true);
2147         } else {
2148             $qformat->setContexttofile(false);
2149         }
2151         if (!$qformat->exportpreprocess()) {
2152             send_file_not_found();
2153             print_error('exporterror', 'question', $thispageurl->out());
2154         }
2156         // export data to moodle file pool
2157         if (!$content = $qformat->exportprocess()) {
2158             send_file_not_found();
2159         }
2161         send_file($content, $filename, 0, 0, true, true, $qformat->mime_type());
2162     }
2164     // Normal case, a file belonging to a question.
2165     $qubaidorpreview = array_shift($args);
2167     // Two sub-cases: 1. A question being previewed outside an attempt/usage.
2168     if ($qubaidorpreview === 'preview') {
2169         $previewcontextid = (int)array_shift($args);
2170         $previewcomponent = array_shift($args);
2171         $questionid = (int) array_shift($args);
2172         $previewcontext = context_helper::instance_by_id($previewcontextid);
2174         $result = component_callback($previewcomponent, 'question_preview_pluginfile', array(
2175                 $previewcontext, $questionid,
2176                 $context, $component, $filearea, $args,
2177                 $forcedownload, $options), 'callbackmissing');
2179         if ($result === 'callbackmissing') {
2180             throw new coding_exception("Component {$previewcomponent} does not define the callback " .
2181                     "{$previewcomponent}_question_preview_pluginfile callback. " .
2182                     "Which is required if you are using question_rewrite_question_preview_urls.", DEBUG_DEVELOPER);
2183         }
2185         send_file_not_found();
2186     }
2188     // 2. A question being attempted in the normal way.
2189     $qubaid = (int)$qubaidorpreview;
2190     $slot = (int)array_shift($args);
2192     $module = $DB->get_field('question_usages', 'component',
2193             array('id' => $qubaid));
2194     if (!$module) {
2195         send_file_not_found();
2196     }
2198     if ($module === 'core_question_preview') {
2199         require_once($CFG->dirroot . '/question/previewlib.php');
2200         return question_preview_question_pluginfile($course, $context,
2201                 $component, $filearea, $qubaid, $slot, $args, $forcedownload, $options);
2203     } else {
2204         $dir = core_component::get_component_directory($module);
2205         if (!file_exists("$dir/lib.php")) {
2206             send_file_not_found();
2207         }
2208         include_once("$dir/lib.php");
2210         $filefunction = $module . '_question_pluginfile';
2211         if (function_exists($filefunction)) {
2212             $filefunction($course, $context, $component, $filearea, $qubaid, $slot,
2213                 $args, $forcedownload, $options);
2214         }
2216         // Okay, we're here so lets check for function without 'mod_'.
2217         if (strpos($module, 'mod_') === 0) {
2218             $filefunctionold  = substr($module, 4) . '_question_pluginfile';
2219             if (function_exists($filefunctionold)) {
2220                 $filefunctionold($course, $context, $component, $filearea, $qubaid, $slot,
2221                     $args, $forcedownload, $options);
2222             }
2223         }
2225         send_file_not_found();
2226     }
2229 /**
2230  * Serve questiontext files in the question text when they are displayed in this report.
2231  *
2232  * @package  core_files
2233  * @category files
2234  * @param context $previewcontext the context in which the preview is happening.
2235  * @param int $questionid the question id.
2236  * @param context $filecontext the file (question) context.
2237  * @param string $filecomponent the component the file belongs to.
2238  * @param string $filearea the file area.
2239  * @param array $args remaining file args.
2240  * @param bool $forcedownload.
2241  * @param array $options additional options affecting the file serving.
2242  */
2243 function core_question_question_preview_pluginfile($previewcontext, $questionid,
2244         $filecontext, $filecomponent, $filearea, $args, $forcedownload, $options = array()) {
2245     global $DB;
2247     // Verify that contextid matches the question.
2248     $question = $DB->get_record_sql('
2249             SELECT q.*, qc.contextid
2250               FROM {question} q
2251               JOIN {question_categories} qc ON qc.id = q.category
2252              WHERE q.id = :id AND qc.contextid = :contextid',
2253             array('id' => $questionid, 'contextid' => $filecontext->id), MUST_EXIST);
2255     // Check the capability.
2256     list($context, $course, $cm) = get_context_info_array($previewcontext->id);
2257     require_login($course, false, $cm);
2259     question_require_capability_on($question, 'use');
2261     $fs = get_file_storage();
2262     $relativepath = implode('/', $args);
2263     $fullpath = "/{$filecontext->id}/{$filecomponent}/{$filearea}/{$relativepath}";
2264     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2265         send_file_not_found();
2266     }
2268     send_stored_file($file, 0, 0, $forcedownload, $options);
2271 /**
2272  * Create url for question export
2273  *
2274  * @param int $contextid, current context
2275  * @param int $categoryid, categoryid
2276  * @param string $format
2277  * @param string $withcategories
2278  * @param string $ithcontexts
2279  * @param moodle_url export file url
2280  */
2281 function question_make_export_url($contextid, $categoryid, $format, $withcategories,
2282         $withcontexts, $filename) {
2283     global $CFG;
2284     $urlbase = "$CFG->wwwroot/pluginfile.php";
2285     return moodle_url::make_file_url($urlbase,
2286             "/$contextid/question/export/{$categoryid}/{$format}/{$withcategories}" .
2287             "/{$withcontexts}/{$filename}", true);
2290 /**
2291  * Get the URL to export a single question (exportone.php).
2292  *
2293  * @param stdClass|question_definition $question the question definition as obtained from
2294  *      question_bank::load_question_data() or question_bank::make_question().
2295  *      (Only ->id and ->contextid are used.)
2296  * @return moodle_url the requested URL.
2297  */
2298 function question_get_export_single_question_url($question) {
2299     $params = ['id' => $question->id, 'sesskey' => sesskey()];
2300     $context = context::instance_by_id($question->contextid);
2301     switch ($context->contextlevel) {
2302         case CONTEXT_MODULE:
2303             $params['cmid'] = $context->instanceid;
2304             break;
2306         case CONTEXT_COURSE:
2307             $params['courseid'] = $context->instanceid;
2308             break;
2310         default:
2311             $params['courseid'] = SITEID;
2312     }
2314     return new moodle_url('/question/exportone.php', $params);
2317 /**
2318  * Return a list of page types
2319  * @param string $pagetype current page type
2320  * @param stdClass $parentcontext Block's parent context
2321  * @param stdClass $currentcontext Current context of block
2322  */
2323 function question_page_type_list($pagetype, $parentcontext, $currentcontext) {
2324     global $CFG;
2325     $types = array(
2326         'question-*'=>get_string('page-question-x', 'question'),
2327         'question-edit'=>get_string('page-question-edit', 'question'),
2328         'question-category'=>get_string('page-question-category', 'question'),
2329         'question-export'=>get_string('page-question-export', 'question'),
2330         'question-import'=>get_string('page-question-import', 'question')
2331     );
2332     if ($currentcontext->contextlevel == CONTEXT_COURSE) {
2333         require_once($CFG->dirroot . '/course/lib.php');
2334         return array_merge(course_page_type_list($pagetype, $parentcontext, $currentcontext), $types);
2335     } else {
2336         return $types;
2337     }
2340 /**
2341  * Does an activity module use the question bank?
2342  *
2343  * @param string $modname The name of the module (without mod_ prefix).
2344  * @return bool true if the module uses questions.
2345  */
2346 function question_module_uses_questions($modname) {
2347     if (plugin_supports('mod', $modname, FEATURE_USES_QUESTIONS)) {
2348         return true;
2349     }
2351     $component = 'mod_'.$modname;
2352     if (component_callback_exists($component, 'question_pluginfile')) {
2353         debugging("{$component} uses questions but doesn't declare FEATURE_USES_QUESTIONS", DEBUG_DEVELOPER);
2354         return true;
2355     }
2357     return false;