MDL-36088 questions: Add new events
[moodle.git] / lib / questionlib.php
CommitLineData
50fcb1d8 1<?php
50fcb1d8 2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
516cf3eb 17/**
6b11a0e8 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 *
f29aeb5a
TH
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
6b11a0e8 32 */
720be6f2 33
8b92c1e3 34
9c197f44
TH
35defined('MOODLE_INTERNAL') || die();
36
f29aeb5a 37require_once($CFG->dirroot . '/question/engine/lib.php');
afe24f85 38require_once($CFG->dirroot . '/question/type/questiontypebase.php');
8b92c1e3 39
8b92c1e3 40
b55797b8 41
f29aeb5a 42/// CONSTANTS ///////////////////////////////////
e56a08dc 43
6b11a0e8 44/**
45 * Constant determines the number of answer boxes supplied in the editing
46 * form for multiple choice and similar question types.
47 */
f29aeb5a 48define("QUESTION_NUMANS", 10);
e56a08dc 49
271ffe3f 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 */
55define("QUESTION_NUMANS_START", 3);
56
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 */
62define("QUESTION_NUMANS_ADD", 3);
63
af52ecee 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.
117bd748 67 *
af52ecee 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 */
75function 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}
93
94/**
95 * Save a new question type order to the config_plugins table.
50fcb1d8 96 * @global object
af52ecee 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 */
100function question_save_qtype_order($neworder, $config = null) {
101 global $DB;
102
103 if (is_null($config)) {
104 $config = get_config('question');
105 }
106
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 }
113}
114
516cf3eb 115/// FUNCTIONS //////////////////////////////////////////////////////
116
f29aeb5a
TH
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 */
121function questions_in_use($questionids) {
122 global $CFG;
123
124 if (question_engine::questions_in_use($questionids)) {
125 return true;
126 }
127
bd3b3bba 128 foreach (core_component::get_plugin_list('mod') as $module => $path) {
f29aeb5a
TH
129 $lib = $path . '/lib.php';
130 if (is_readable($lib)) {
131 include_once($lib);
132
133 $fn = $module . '_questions_in_use';
7453df70 134 if (function_exists($fn)) {
f29aeb5a
TH
135 if ($fn($questionids)) {
136 return true;
137 }
138 } else {
139
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 }
7453df70 150 }
90c3f310 151 }
152 }
f29aeb5a
TH
153
154 return false;
90c3f310 155}
516cf3eb 156
e2b347e9 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 */
166function question_context_has_any_questions($context) {
eb84a826 167 global $DB;
e2b347e9 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 }
eb84a826 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));
e2b347e9 179}
180
8511669c 181/**
aa5f0511
TH
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.
8511669c 185 * @param array $gradeoptionsfull list of valid options
186 * @param int $grade grade to be tested
187 * @param string $matchgrades 'error' or 'nearest'
aa5f0511 188 * @return mixed either 'fixed' value or false if error.
8511669c 189 */
aa5f0511
TH
190function match_grade_options($gradeoptionsfull, $grade, $matchgrades = 'error') {
191
aac80ff3 192 if ($matchgrades == 'error') {
aa5f0511 193 // (Almost) exact match, or an error.
aac80ff3 194 foreach ($gradeoptionsfull as $value => $option) {
aa5f0511 195 // Slightly fuzzy test, never check floats for equality.
aac80ff3 196 if (abs($grade - $value) < 0.00001) {
aa5f0511 197 return $value; // Be sure the return the proper value.
8511669c 198 }
199 }
aa5f0511 200 // Didn't find a match so that's an error.
8511669c 201 return false;
aa5f0511 202
aac80ff3 203 } else if ($matchgrades == 'nearest') {
aa5f0511
TH
204 // Work out nearest value
205 $best = false;
206 $bestmismatch = 2;
aac80ff3 207 foreach ($gradeoptionsfull as $value => $option) {
aa5f0511
TH
208 $newmismatch = abs($grade - $value);
209 if ($newmismatch < $bestmismatch) {
210 $best = $value;
211 $bestmismatch = $newmismatch;
8511669c 212 }
8511669c 213 }
aa5f0511
TH
214 return $best;
215
aac80ff3 216 } else {
aa5f0511
TH
217 // Unknow option passed.
218 throw new coding_exception('Unknown $matchgrades ' . $matchgrades .
219 ' passed to match_grade_options');
271ffe3f 220 }
8511669c 221}
222
31031e98
FM
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 */
241function question_remove_stale_questions_from_category($categoryid) {
242 global $DB;
243
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();
252}
253
7f7144fd
TB
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 *
442f12f8 260 * @param object|core_course_category $category course category object
7f7144fd
TB
261 */
262function 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.
267
268 // Deal with any questions in the category.
269 if ($questions = $DB->get_records('question', $criteria, '', 'id,qtype')) {
270
271 // Try to delete each question.
272 foreach ($questions as $question) {
273 question_delete_question($question->id);
274 }
275
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 }
295
296 // Now delete the category.
297 $DB->delete_records('question_categories', array('id' => $category->id));
298}
299
f29aeb5a
TH
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 */
307function question_category_in_use($categoryid, $recursive = false) {
eb84a826 308 global $DB;
f67172b6 309
310 //Look at each question in the category
aac80ff3
TH
311 if ($questions = $DB->get_records_menu('question',
312 array('category' => $categoryid), '', 'id, 1')) {
f29aeb5a
TH
313 if (questions_in_use(array_keys($questions))) {
314 return true;
f67172b6 315 }
316 }
f29aeb5a
TH
317 if (!$recursive) {
318 return false;
319 }
f67172b6 320
321 //Look under child categories recursively
aac80ff3
TH
322 if ($children = $DB->get_records('question_categories',
323 array('parent' => $categoryid), '', 'id, 1')) {
f29aeb5a
TH
324 foreach ($children as $child) {
325 if (question_category_in_use($child->id, $recursive)) {
326 return true;
f67172b6 327 }
328 }
329 }
330
331 return false;
332}
333
516cf3eb 334/**
6b11a0e8 335 * Deletes question and all associated data from the database
336 *
90c3f310 337 * It will not delete a question if it is used by an activity module
6b11a0e8 338 * @param object $question The question being deleted
339 */
f29aeb5a 340function question_delete_question($questionid) {
f9b0500f 341 global $DB;
271ffe3f 342
9203b705
TH
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) {
3c573960 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 }
354
90c3f310 355 // Do not delete a question if it is used by an activity module
f29aeb5a 356 if (questions_in_use(array($questionid))) {
90c3f310 357 return;
358 }
359
f29aeb5a
TH
360 $dm = new question_engine_data_mapper();
361 $dm->delete_previews($questionid);
0429cd86 362
f29aeb5a
TH
363 // delete questiontype-specific data
364 question_bank::get_qtype($question->qtype, false)->delete_question(
365 $questionid, $question->contextid);
90c3f310 366
cc033d48 367 // Delete all tag instances.
b355a1c9 368 core_tag_tag::remove_all_item_tags('core_question', 'question', $question->id);
cc033d48 369
90c3f310 370 // Now recursively delete all child questions
aac80ff3
TH
371 if ($children = $DB->get_records('question',
372 array('parent' => $questionid), '', 'id, qtype')) {
516cf3eb 373 foreach ($children as $child) {
1d723a16 374 if ($child->id != $questionid) {
7ee214ff 375 question_delete_question($child->id);
1d723a16 376 }
516cf3eb 377 }
378 }
271ffe3f 379
90c3f310 380 // Finally delete the question record itself
f29aeb5a 381 $DB->delete_records('question', array('id' => $questionid));
a560d636 382 question_bank::notify_question_edited($questionid);
93e435b9
SB
383
384 // Log the deletion of this question.
4ca60a56
V
385 $event = \core\event\question_deleted::create_from_question_instance($question);
386 $event->add_record_snapshot('question', $question);
93e435b9 387 $event->trigger();
516cf3eb 388}
389
f67172b6 390/**
7f7144fd 391 * All question categories and their questions are deleted for this context id.
f67172b6 392 *
7f7144fd
TB
393 * @param object $contextid The contextid to delete question categories from
394 * @return array Feedback from deletes (if any)
f67172b6 395 */
7f7144fd
TB
396function question_delete_context($contextid) {
397 global $DB;
eb84a826 398
f67172b6 399 //To store feedback to be showed at the end of the process
400 $feedbackdata = array();
401
402 //Cache some strings
e0c22222 403 $strcatdeleted = get_string('unusedcategorydeleted', 'question');
7f7144fd
TB
404 $fields = 'id, parent, name, contextid';
405 if ($categories = $DB->get_records('question_categories', array('contextid' => $contextid), 'parent', $fields)) {
f67172b6 406 //Sort categories following their tree (parent-child) relationships
3bee1ead 407 //this will make the feedback more readable
7f7144fd 408 $categories = sort_categories_by_tree($categories);
3bee1ead 409
7f7144fd
TB
410 foreach ($categories as $category) {
411 question_category_delete_safe($category);
f67172b6 412
3bee1ead 413 //Fill feedback
414 $feedbackdata[] = array($category->name, $strcatdeleted);
415 }
7f7144fd
TB
416 }
417 return $feedbackdata;
418}
419
420/**
421 * All question categories and their questions are deleted for this course.
422 *
423 * @param stdClass $course an object representing the activity
424 * @param boolean $feedback to specify if the process must output a summary of its work
425 * @return boolean
426 */
427function question_delete_course($course, $feedback=true) {
428 $coursecontext = context_course::instance($course->id);
429 $feedbackdata = question_delete_context($coursecontext->id, $feedback);
430
431 // Inform about changes performed if feedback is enabled.
432 if ($feedback && $feedbackdata) {
433 $table = new html_table();
434 $table->head = array(get_string('category', 'question'), get_string('action'));
435 $table->data = $feedbackdata;
436 echo html_writer::table($table);
3bee1ead 437 }
438 return true;
439}
f67172b6 440
e2b347e9 441/**
442 * Category is about to be deleted,
443 * 1/ All question categories and their questions are deleted for this course category.
444 * 2/ All questions are moved to new category
445 *
442f12f8
MG
446 * @param object|core_course_category $category course category object
447 * @param object|core_course_category $newcategory empty means everything deleted, otherwise id of
aac80ff3 448 * category where content moved
e2b347e9 449 * @param boolean $feedback to specify if the process must output a summary of its work
450 * @return boolean
451 */
452function question_delete_course_category($category, $newcategory, $feedback=true) {
aa9a6867 453 global $DB, $OUTPUT;
534792cd 454
b0c6dc1c 455 $context = context_coursecat::instance($category->id);
e2b347e9 456 if (empty($newcategory)) {
7f7144fd 457 $feedbackdata = question_delete_context($context->id, $feedback);
e2b347e9 458
459 // Output feedback if requested.
7f7144fd 460 if ($feedback && $feedbackdata) {
642816a6 461 $table = new html_table();
aac80ff3 462 $table->head = array(get_string('questioncategory', 'question'), get_string('action'));
e2b347e9 463 $table->data = $feedbackdata;
16be8974 464 echo html_writer::table($table);
e2b347e9 465 }
466
467 } else {
cc033d48 468 // Move question categories to the new context.
b0c6dc1c 469 if (!$newcontext = context_coursecat::instance($newcategory->id)) {
e2b347e9 470 return false;
471 }
cc033d48 472
ae9f5a04
SR
473 // Only move question categories if there is any question category at all!
474 if ($topcategory = question_get_top_category($context->id)) {
475 $newtopcategory = question_get_top_category($newcontext->id, true);
476
477 question_move_category_to_context($topcategory->id, $context->id, $newcontext->id);
478 $DB->set_field('question_categories', 'parent', $newtopcategory->id, array('parent' => $topcategory->id));
479 // Now delete the top category.
480 $DB->delete_records('question_categories', array('id' => $topcategory->id));
481 }
cc033d48 482
e2b347e9 483 if ($feedback) {
0ff4bd08 484 $a = new stdClass();
329846f1
AG
485 $a->oldplace = $context->get_context_name();
486 $a->newplace = $newcontext->get_context_name();
aac80ff3
TH
487 echo $OUTPUT->notification(
488 get_string('movedquestionsandcategories', 'question', $a), 'notifysuccess');
e2b347e9 489 }
490 }
491
492 return true;
493}
494
495/**
496 * Enter description here...
497 *
9d0ac0ff 498 * @param array $questionids of question ids
7f7144fd 499 * @param object $newcontextid the context to create the saved category in.
aac80ff3
TH
500 * @param string $oldplace a textual description of the think being deleted,
501 * e.g. from get_context_name
e2b347e9 502 * @param object $newcategory
b9bd6da4 503 * @return mixed false on
e2b347e9 504 */
aac80ff3
TH
505function question_save_from_deletion($questionids, $newcontextid, $oldplace,
506 $newcategory = null) {
eb84a826 507 global $DB;
508
e2b347e9 509 // Make a category in the parent context to move the questions to.
510 if (is_null($newcategory)) {
365a5941 511 $newcategory = new stdClass();
94fe904e 512 $newcategory->parent = question_get_top_category($newcontextid, true)->id;
e2b347e9 513 $newcategory->contextid = $newcontextid;
eb84a826 514 $newcategory->name = get_string('questionsrescuedfrom', 'question', $oldplace);
515 $newcategory->info = get_string('questionsrescuedfrominfo', 'question', $oldplace);
e2b347e9 516 $newcategory->sortorder = 999;
517 $newcategory->stamp = make_unique_id_code();
a8f3a651 518 $newcategory->id = $DB->insert_record('question_categories', $newcategory);
e2b347e9 519 }
520
521 // Move any remaining questions to the 'saved' category.
522 if (!question_move_questions_to_category($questionids, $newcategory->id)) {
523 return false;
524 }
525 return $newcategory;
526}
527
3bee1ead 528/**
529 * All question categories and their questions are deleted for this activity.
530 *
531 * @param object $cm the course module object representing the activity
532 * @param boolean $feedback to specify if the process must output a summary of its work
533 * @return boolean
534 */
535function question_delete_activity($cm, $feedback=true) {
7f7144fd 536 global $DB;
f67172b6 537
b0c6dc1c 538 $modcontext = context_module::instance($cm->id);
7f7144fd
TB
539 $feedbackdata = question_delete_context($modcontext->id, $feedback);
540 // Inform about changes performed if feedback is enabled.
541 if ($feedback && $feedbackdata) {
542 $table = new html_table();
543 $table->head = array(get_string('category', 'question'), get_string('action'));
544 $table->data = $feedbackdata;
545 echo html_writer::table($table);
f67172b6 546 }
547 return true;
548}
7fb1b88d 549
68beb758
RW
550/**
551 * This function will handle moving all tag instances to a new context for a
552 * given list of questions.
553 *
554 * Questions can be tagged in up to two contexts:
555 * 1.) The context the question exists in.
556 * 2.) The course context (if the question context is a higher context.
557 * E.g. course category context or system context.
558 *
559 * This means a question that exists in a higher context (e.g. course cat or
560 * system context) may have multiple groups of tags in any number of child
561 * course contexts.
562 *
563 * Questions in the course category context can be move "down" a context level
564 * into one of their child course contexts or activity contexts which affects the
565 * availability of that question in other courses / activities.
566 *
567 * In this case it makes the questions no longer available in the other course or
568 * activity contexts so we need to make sure that the tag instances in those other
569 * contexts are removed.
570 *
571 * @param stdClass[] $questions The list of question being moved (must include
572 * the id and contextid)
573 * @param context $newcontext The Moodle context the questions are being moved to
574 */
575function question_move_question_tags_to_new_context(array $questions, context $newcontext) {
576 // If the questions are moving to a new course/activity context then we need to
577 // find any existing tag instances from any unavailable course contexts and
578 // delete them because they will no longer be applicable (we don't support
579 // tagging questions across courses).
580 $instancestodelete = [];
581 $instancesfornewcontext = [];
582 $newcontextparentids = $newcontext->get_parent_context_ids();
583 $questionids = array_map(function($question) {
584 return $question->id;
585 }, $questions);
586 $questionstagobjects = core_tag_tag::get_items_tags('core_question', 'question', $questionids);
587
588 foreach ($questions as $question) {
589 $tagobjects = $questionstagobjects[$question->id];
590
591 foreach ($tagobjects as $tagobject) {
592 $tagid = $tagobject->taginstanceid;
593 $tagcontextid = $tagobject->taginstancecontextid;
594 $istaginnewcontext = $tagcontextid == $newcontext->id;
595 $istaginquestioncontext = $tagcontextid == $question->contextid;
596
597 if ($istaginnewcontext) {
598 // This tag instance is already in the correct context so we can
599 // ignore it.
600 continue;
601 }
602
603 if ($istaginquestioncontext) {
604 // This tag instance is in the question context so it needs to be
605 // updated.
606 $instancesfornewcontext[] = $tagid;
607 continue;
608 }
609
610 // These tag instances are in neither the new context nor the
611 // question context so we need to determine what to do based on
612 // the context they are in and the new question context.
613 $tagcontext = context::instance_by_id($tagcontextid);
614 $tagcoursecontext = $tagcontext->get_course_context(false);
615 // The tag is in a course context if get_course_context() returns
616 // itself.
617 $istaginstancecontextcourse = !empty($tagcoursecontext)
618 && $tagcontext->id == $tagcoursecontext->id;
619
620 if ($istaginstancecontextcourse) {
621 // If the tag instance is in a course context we need to add some
622 // special handling.
623 $tagcontextparentids = $tagcontext->get_parent_context_ids();
624 $isnewcontextaparent = in_array($newcontext->id, $tagcontextparentids);
625 $isnewcontextachild = in_array($tagcontext->id, $newcontextparentids);
626
627 if ($isnewcontextaparent) {
628 // If the tag instance is a course context tag and the new
629 // context is still a parent context to the tag context then
630 // we can leave this tag where it is.
631 continue;
632 } else if ($isnewcontextachild) {
633 // If the new context is a child context (e.g. activity) of this
634 // tag instance then we should move all of this tag instance
635 // down into the activity context along with the question.
636 $instancesfornewcontext[] = $tagid;
637 } else {
638 // If the tag is in a course context that is no longer a parent
639 // or child of the new context then this tag instance should be
640 // removed.
641 $instancestodelete[] = $tagid;
642 }
643 } else {
644 // This is a catch all for any tag instances not in the question
645 // context or a course context. These tag instances should be
646 // updated to the new context id. This will clean up old invalid
647 // data.
648 $instancesfornewcontext[] = $tagid;
649 }
650 }
651 }
652
653 if (!empty($instancestodelete)) {
654 // Delete any course context tags that may no longer be valid.
655 core_tag_tag::delete_instances_by_id($instancestodelete);
656 }
657
658 if (!empty($instancesfornewcontext)) {
659 // Update the tag instances to the new context id.
660 core_tag_tag::change_instances_context($instancesfornewcontext, $newcontext);
661 }
662}
663
7fb1b88d 664/**
665 * This function should be considered private to the question bank, it is called from
aac80ff3 666 * question/editlib.php question/contextmoveq.php and a few similar places to to the
9bec0e7e 667 * work of actually moving questions and associated data. However, callers of this
aac80ff3
TH
668 * function also have to do other work, which is why you should not call this method
669 * directly from outside the questionbank.
7fb1b88d 670 *
9d0ac0ff 671 * @param array $questionids of question ids.
fe6ce234 672 * @param integer $newcategoryid the id of the category to move to.
7fb1b88d 673 */
fe6ce234 674function question_move_questions_to_category($questionids, $newcategoryid) {
d649fb02 675 global $DB;
f685e830 676
5d548d3e
TH
677 $newcontextid = $DB->get_field('question_categories', 'contextid',
678 array('id' => $newcategoryid));
679 list($questionidcondition, $params) = $DB->get_in_or_equal($questionids);
680 $questions = $DB->get_records_sql("
93e435b9 681 SELECT q.id, q.qtype, qc.contextid, q.idnumber, q.category
5d548d3e
TH
682 FROM {question} q
683 JOIN {question_categories} qc ON q.category = qc.id
a3f92b2e 684 WHERE q.id $questionidcondition", $params);
5d548d3e
TH
685 foreach ($questions as $question) {
686 if ($newcontextid != $question->contextid) {
d649fb02
TH
687 question_bank::get_qtype($question->qtype)->move_files(
688 $question->id, $question->contextid, $newcontextid);
5d548d3e 689 }
6189fda4
JB
690 // Check whether there could be a clash of idnumbers in the new category.
691 if (((string) $question->idnumber !== '') &&
692 $DB->record_exists('question', ['idnumber' => $question->idnumber, 'category' => $newcategoryid])) {
693 $rec = $DB->get_records_select('question', "category = ? AND idnumber LIKE ?",
694 [$newcategoryid, $question->idnumber . '_%'], 'idnumber DESC', 'id, idnumber', 0, 1);
695 $unique = 1;
696 if (count($rec)) {
697 $rec = reset($rec);
698 $idnumber = $rec->idnumber;
699 if (strpos($idnumber, '_') !== false) {
700 $unique = substr($idnumber, strpos($idnumber, '_') + 1) + 1;
701 }
702 }
703 // For the move process, add a numerical increment to the idnumber. This means that if a question is
704 // mistakenly moved then the idnumber will not be completely lost.
705 $q = new stdClass();
706 $q->id = $question->id;
707 $q->category = $newcategoryid;
708 $q->idnumber = $question->idnumber . '_' . $unique;
709 $DB->update_record('question', $q);
710 }
93e435b9
SB
711
712 // Log this question move.
4ca60a56
V
713 $event = \core\event\question_moved::create_from_question_instance($question, context::instance_by_id($question->contextid),
714 ['oldcategoryid' => $question->category, 'newcategoryid' => $newcategoryid]);
93e435b9 715 $event->trigger();
fe6ce234
DC
716 }
717
7fb1b88d 718 // Move the questions themselves.
aac80ff3
TH
719 $DB->set_field_select('question', 'category', $newcategoryid,
720 "id $questionidcondition", $params);
7fb1b88d 721
722 // Move any subquestions belonging to them.
aac80ff3
TH
723 $DB->set_field_select('question', 'category', $newcategoryid,
724 "parent $questionidcondition", $params);
7fb1b88d 725
68beb758
RW
726 $newcontext = context::instance_by_id($newcontextid);
727 question_move_question_tags_to_new_context($questions, $newcontext);
cc033d48 728
7fb1b88d 729 // TODO Deal with datasets.
730
a560d636
TH
731 // Purge these questions from the cache.
732 foreach ($questions as $question) {
733 question_bank::notify_question_edited($question->id);
734 }
735
f685e830 736 return true;
7fb1b88d 737}
738
5d548d3e
TH
739/**
740 * This function helps move a question cateogry to a new context by moving all
741 * the files belonging to all the questions to the new context.
742 * Also moves subcategories.
743 * @param integer $categoryid the id of the category being moved.
744 * @param integer $oldcontextid the old context id.
745 * @param integer $newcontextid the new context id.
746 */
747function question_move_category_to_context($categoryid, $oldcontextid, $newcontextid) {
d649fb02 748 global $DB;
5d548d3e 749
68beb758 750 $questions = [];
5d548d3e
TH
751 $questionids = $DB->get_records_menu('question',
752 array('category' => $categoryid), '', 'id,qtype');
753 foreach ($questionids as $questionid => $qtype) {
aac80ff3
TH
754 question_bank::get_qtype($qtype)->move_files(
755 $questionid, $oldcontextid, $newcontextid);
a560d636
TH
756 // Purge this question from the cache.
757 question_bank::notify_question_edited($questionid);
68beb758
RW
758
759 $questions[] = (object) [
760 'id' => $questionid,
761 'contextid' => $oldcontextid
762 ];
5d548d3e
TH
763 }
764
68beb758
RW
765 $newcontext = context::instance_by_id($newcontextid);
766 question_move_question_tags_to_new_context($questions, $newcontext);
cc033d48 767
5d548d3e
TH
768 $subcatids = $DB->get_records_menu('question_categories',
769 array('parent' => $categoryid), '', 'id,1');
770 foreach ($subcatids as $subcatid => $notused) {
aac80ff3
TH
771 $DB->set_field('question_categories', 'contextid', $newcontextid,
772 array('id' => $subcatid));
5d548d3e
TH
773 question_move_category_to_context($subcatid, $oldcontextid, $newcontextid);
774 }
775}
776
f29aeb5a
TH
777/**
778 * Generate the URL for starting a new preview of a given question with the given options.
779 * @param integer $questionid the question to preview.
780 * @param string $preferredbehaviour the behaviour to use for the preview.
781 * @param float $maxmark the maximum to mark the question out of.
782 * @param question_display_options $displayoptions the display options to use.
c014b989
TH
783 * @param int $variant the variant of the question to preview. If null, one will
784 * be picked randomly.
56a4ae46
TH
785 * @param object $context context to run the preview in (affects things like
786 * filter settings, theme, lang, etc.) Defaults to $PAGE->context.
8011be18 787 * @return moodle_url the URL.
f29aeb5a 788 */
612106b3 789function question_preview_url($questionid, $preferredbehaviour = null,
56a4ae46 790 $maxmark = null, $displayoptions = null, $variant = null, $context = null) {
612106b3
TH
791
792 $params = array('id' => $questionid);
793
56a4ae46
TH
794 if (is_null($context)) {
795 global $PAGE;
796 $context = $PAGE->context;
797 }
798 if ($context->contextlevel == CONTEXT_MODULE) {
799 $params['cmid'] = $context->instanceid;
800 } else if ($context->contextlevel == CONTEXT_COURSE) {
801 $params['courseid'] = $context->instanceid;
802 }
803
612106b3
TH
804 if (!is_null($preferredbehaviour)) {
805 $params['behaviour'] = $preferredbehaviour;
806 }
807
808 if (!is_null($maxmark)) {
809 $params['maxmark'] = $maxmark;
810 }
811
812 if (!is_null($displayoptions)) {
813 $params['correctness'] = $displayoptions->correctness;
814 $params['marks'] = $displayoptions->marks;
815 $params['markdp'] = $displayoptions->markdp;
816 $params['feedback'] = (bool) $displayoptions->feedback;
817 $params['generalfeedback'] = (bool) $displayoptions->generalfeedback;
818 $params['rightanswer'] = (bool) $displayoptions->rightanswer;
819 $params['history'] = (bool) $displayoptions->history;
820 }
821
c014b989
TH
822 if ($variant) {
823 $params['variant'] = $variant;
824 }
612106b3 825
c014b989 826 return new moodle_url('/question/preview.php', $params);
f29aeb5a
TH
827}
828
612106b3
TH
829/**
830 * @return array that can be passed as $params to the {@link popup_action} constructor.
831 */
832function question_preview_popup_params() {
833 return array(
834 'height' => 600,
835 'width' => 800,
836 );
837}
838
5a2a5331 839/**
aac80ff3
TH
840 * Given a list of ids, load the basic information about a set of questions from
841 * the questions table. The $join and $extrafields arguments can be used together
842 * to pull in extra data. See, for example, the usage in mod/quiz/attemptlib.php, and
78e7a3dd 843 * read the code below to see how the SQL is assembled. Throws exceptions on error.
5a2a5331 844 *
ccba5b88
TH
845 * @param array $questionids array of question ids to load. If null, then all
846 * questions matched by $join will be loaded.
78e7a3dd 847 * @param string $extrafields extra SQL code to be added to the query.
848 * @param string $join extra SQL code to be added to the query.
849 * @param array $extraparams values for any placeholders in $join.
ccba5b88
TH
850 * You must use named placeholders.
851 * @param string $orderby what to order the results by. Optional, default is unspecified order.
5a2a5331 852 *
78e7a3dd 853 * @return array partially complete question objects. You need to call get_question_options
854 * on them before they can be properly used.
5a2a5331 855 */
ccba5b88
TH
856function question_preload_questions($questionids = null, $extrafields = '', $join = '',
857 $extraparams = array(), $orderby = '') {
f29aeb5a 858 global $DB;
ccba5b88
TH
859
860 if ($questionids === null) {
861 $where = '';
862 $params = array();
863 } else {
864 if (empty($questionids)) {
865 return array();
866 }
867
868 list($questionidcondition, $params) = $DB->get_in_or_equal(
869 $questionids, SQL_PARAMS_NAMED, 'qid0000');
870 $where = 'WHERE q.id ' . $questionidcondition;
4089d9ec 871 }
ccba5b88 872
5a2a5331 873 if ($join) {
ccba5b88 874 $join = 'JOIN ' . $join;
5a2a5331 875 }
ccba5b88 876
5a2a5331 877 if ($extrafields) {
878 $extrafields = ', ' . $extrafields;
879 }
5a2a5331 880
ccba5b88
TH
881 if ($orderby) {
882 $orderby = 'ORDER BY ' . $orderby;
5a2a5331 883 }
884
ccba5b88
TH
885 $sql = "SELECT q.*, qc.contextid{$extrafields}
886 FROM {question} q
887 JOIN {question_categories} qc ON q.category = qc.id
888 {$join}
889 {$where}
890 {$orderby}";
891
892 // Load the questions.
893 $questions = $DB->get_records_sql($sql, $extraparams + $params);
78e7a3dd 894 foreach ($questions as $question) {
895 $question->_partiallyloaded = true;
896 }
897
898 return $questions;
899}
900
901/**
902 * Load a set of questions, given a list of ids. The $join and $extrafields arguments can be used
903 * together to pull in extra data. See, for example, the usage in mod/quiz/attempt.php, and
904 * read the code below to see how the SQL is assembled. Throws exceptions on error.
905 *
906 * @param array $questionids array of question ids.
907 * @param string $extrafields extra SQL code to be added to the query.
908 * @param string $join extra SQL code to be added to the query.
909 * @param array $extraparams values for any placeholders in $join.
910 * You are strongly recommended to use named placeholder.
911 *
912 * @return array question objects.
913 */
914function question_load_questions($questionids, $extrafields = '', $join = '') {
915 $questions = question_preload_questions($questionids, $extrafields, $join);
916
5a2a5331 917 // Load the question type specific information
918 if (!get_question_options($questions)) {
919 return 'Could not load the question options';
920 }
921
922 return $questions;
923}
924
516cf3eb 925/**
d7444d44 926 * Private function to factor common code out of get_question_options().
271ffe3f 927 *
d7444d44 928 * @param object $question the question to tidy.
081eb156
RW
929 * @param stdClass $category The question_categories record for the given $question.
930 * @param stdClass[]|null $tagobjects The tags for the given $question.
931 * @param stdClass[]|null $filtercourses The courses to filter the course tags by.
d7444d44 932 */
081eb156 933function _tidy_question($question, $category, array $tagobjects = null, array $filtercourses = null) {
d2acbd1a 934 // Load question-type specific fields.
2daffca5 935 if (!question_bank::is_qtype_installed($question->qtype)) {
d649fb02
TH
936 $question->questiontext = html_writer::tag('p', get_string('warningmissingtype',
937 'qtype_missingtype')) . $question->questiontext;
d7444d44 938 }
d649fb02 939 question_bank::get_qtype($question->qtype)->get_question_options($question);
d2acbd1a
TH
940
941 // Convert numeric fields to float. (Prevents these being displayed as 1.0000000.)
942 $question->defaultmark += 0;
943 $question->penalty += 0;
944
a8a8ec51
TH
945 if (isset($question->_partiallyloaded)) {
946 unset($question->_partiallyloaded);
78e7a3dd 947 }
d2acbd1a 948
081eb156
RW
949 $question->categoryobject = $category;
950
951 if (!is_null($tagobjects)) {
952 $categorycontext = context::instance_by_id($category->contextid);
6307622b
SL
953 $sortedtagobjects = question_sort_tags($tagobjects, $categorycontext, $filtercourses);
954 $question->coursetagobjects = $sortedtagobjects->coursetagobjects;
955 $question->coursetags = $sortedtagobjects->coursetags;
956 $question->tagobjects = $sortedtagobjects->tagobjects;
957 $question->tags = $sortedtagobjects->tags;
c599a682 958 }
d7444d44 959}
516cf3eb 960
d7444d44 961/**
962 * Updates the question objects with question type specific
963 * information by calling {@link get_question_options()}
964 *
965 * Can be called either with an array of question objects or with a single
966 * question object.
271ffe3f 967 *
d7444d44 968 * @param mixed $questions Either an array of question objects to be updated
969 * or just a single question object
081eb156
RW
970 * @param bool $loadtags load the question tags from the tags table. Optional, default false.
971 * @param stdClass[] $filtercourses The courses to filter the course tags by.
d7444d44 972 * @return bool Indicates success or failure.
973 */
081eb156
RW
974function get_question_options(&$questions, $loadtags = false, $filtercourses = null) {
975 global $DB;
976
977 $questionlist = is_array($questions) ? $questions : [$questions];
978 $categoryids = [];
979 $questionids = [];
980
981 if (empty($questionlist)) {
982 return true;
983 }
984
985 foreach ($questionlist as $question) {
986 $questionids[] = $question->id;
987
988 if (!in_array($question->category, $categoryids)) {
989 $categoryids[] = $question->category;
516cf3eb 990 }
516cf3eb 991 }
081eb156
RW
992
993 $categories = $DB->get_records_list('question_categories', 'id', $categoryids);
994
995 if ($loadtags && core_tag_tag::is_enabled('core_question', 'question')) {
996 $tagobjectsbyquestion = core_tag_tag::get_items_tags('core_question', 'question', $questionids);
997 } else {
998 $tagobjectsbyquestion = null;
999 }
1000
1001 foreach ($questionlist as $question) {
1002 if (is_null($tagobjectsbyquestion)) {
1003 $tagobjects = null;
1004 } else {
1005 $tagobjects = $tagobjectsbyquestion[$question->id];
1006 }
1007
1008 _tidy_question($question, $categories[$question->category], $tagobjects, $filtercourses);
1009 }
1010
a8a8ec51 1011 return true;
516cf3eb 1012}
1013
6307622b
SL
1014/**
1015 * Sort question tags by course or normal tags.
1016 *
1017 * This function also search tag instances that may have a context id that don't match either a course or
1018 * question context and fix the data setting the correct context id.
1019 *
1020 * @param stdClass[] $tagobjects The tags for the given $question.
1021 * @param stdClass $categorycontext The question categories context.
1022 * @param stdClass[]|null $filtercourses The courses to filter the course tags by.
1023 * @return stdClass $sortedtagobjects Sorted tag objects.
1024 */
1025function question_sort_tags($tagobjects, $categorycontext, $filtercourses = null) {
1026
1027 // Questions can have two sets of tag instances. One set at the
1028 // course context level and another at the context the question
1029 // belongs to (e.g. course category, system etc).
1030 $sortedtagobjects = new stdClass();
1031 $sortedtagobjects->coursetagobjects = [];
1032 $sortedtagobjects->coursetags = [];
1033 $sortedtagobjects->tagobjects = [];
1034 $sortedtagobjects->tags = [];
1035 $taginstanceidstonormalise = [];
1036 $filtercoursecontextids = [];
1037 $hasfiltercourses = !empty($filtercourses);
1038
1039 if ($hasfiltercourses) {
1040 // If we're being asked to filter the course tags by a set of courses
1041 // then get the context ids to filter below.
1042 $filtercoursecontextids = array_map(function($course) {
1043 $coursecontext = context_course::instance($course->id);
1044 return $coursecontext->id;
1045 }, $filtercourses);
1046 }
1047
1048 foreach ($tagobjects as $tagobject) {
1049 $tagcontextid = $tagobject->taginstancecontextid;
1050 $tagcontext = context::instance_by_id($tagcontextid);
1051 $tagcoursecontext = $tagcontext->get_course_context(false);
1052 // This is a course tag if the tag context is a course context which
1053 // doesn't match the question's context. Any tag in the question context
1054 // is not considered a course tag, it belongs to the question.
1055 $iscoursetag = $tagcoursecontext
1056 && $tagcontext->id == $tagcoursecontext->id
1057 && $tagcontext->id != $categorycontext->id;
1058
1059 if ($iscoursetag) {
1060 // Any tag instance in a course context level is considered a course tag.
1061 if (!$hasfiltercourses || in_array($tagcontextid, $filtercoursecontextids)) {
1062 // Add the tag to the list of course tags if we aren't being
1063 // asked to filter or if this tag is in the list of courses
1064 // we're being asked to filter by.
1065 $sortedtagobjects->coursetagobjects[] = $tagobject;
1066 $sortedtagobjects->coursetags[$tagobject->id] = $tagobject->get_display_name();
1067 }
1068 } else {
1069 // All non course context level tag instances or tags in the question
1070 // context belong to the context that the question was created in.
1071 $sortedtagobjects->tagobjects[] = $tagobject;
1072 $sortedtagobjects->tags[$tagobject->id] = $tagobject->get_display_name();
1073
1074 // Due to legacy tag implementations that don't force the recording
1075 // of a context id, some tag instances may have context ids that don't
1076 // match either a course context or the question context. In this case
1077 // we should take the opportunity to fix up the data and set the correct
1078 // context id.
1079 if ($tagcontext->id != $categorycontext->id) {
1080 $taginstanceidstonormalise[] = $tagobject->taginstanceid;
1081 // Update the object properties to reflect the DB update that will
1082 // happen below.
1083 $tagobject->taginstancecontextid = $categorycontext->id;
1084 }
1085 }
1086 }
1087
1088 if (!empty($taginstanceidstonormalise)) {
1089 // If we found any tag instances with incorrect context id data then we can
1090 // correct those values now by setting them to the question context id.
1091 core_tag_tag::change_instances_context($taginstanceidstonormalise, $categorycontext);
1092 }
1093
1094 return $sortedtagobjects;
1095}
1096
516cf3eb 1097/**
aac80ff3
TH
1098 * Print the icon for the question type
1099 *
1100 * @param object $question The question object for which the icon is required.
1101 * Only $question->qtype is used.
1102 * @return string the HTML for the img tag.
1103 */
f29aeb5a 1104function print_question_icon($question) {
5cc021a0
TH
1105 global $PAGE;
1106 return $PAGE->get_renderer('question', 'bank')->qtype_icon($question->qtype);
81d833ad 1107}
1108
1109/**
f29aeb5a 1110 * Creates a stamp that uniquely identifies this version of the question
81d833ad 1111 *
f29aeb5a
TH
1112 * In future we want this to use a hash of the question data to guarantee that
1113 * identical versions have the same version stamp.
1114 *
1115 * @param object $question
1116 * @return string A unique version stamp
81d833ad 1117 */
f29aeb5a
TH
1118function question_hash($question) {
1119 return make_unique_id_code();
81d833ad 1120}
1121
f29aeb5a
TH
1122/// CATEGORY FUNCTIONS /////////////////////////////////////////////////////////////////
1123
516cf3eb 1124/**
f29aeb5a
TH
1125 * returns the categories with their names ordered following parent-child relationships
1126 * finally it tries to return pending categories (those being orphaned, whose parent is
1127 * incorrect) to avoid missing any category from original array.
1128 */
1129function sort_categories_by_tree(&$categories, $id = 0, $level = 1) {
1130 global $DB;
5e9170b4 1131
f29aeb5a
TH
1132 $children = array();
1133 $keys = array_keys($categories);
516cf3eb 1134
f29aeb5a
TH
1135 foreach ($keys as $key) {
1136 if (!isset($categories[$key]->processed) && $categories[$key]->parent == $id) {
1137 $children[$key] = $categories[$key];
1138 $categories[$key]->processed = true;
aac80ff3
TH
1139 $children = $children + sort_categories_by_tree(
1140 $categories, $children[$key]->id, $level+1);
516cf3eb 1141 }
1142 }
aac80ff3
TH
1143 //If level = 1, we have finished, try to look for non processed categories
1144 // (bad parent) and sort them too
f29aeb5a
TH
1145 if ($level == 1) {
1146 foreach ($keys as $key) {
aac80ff3
TH
1147 // If not processed and it's a good candidate to start (because its
1148 // parent doesn't exist in the course)
1149 if (!isset($categories[$key]->processed) && !$DB->record_exists('question_categories',
1150 array('contextid' => $categories[$key]->contextid,
1151 'id' => $categories[$key]->parent))) {
f29aeb5a
TH
1152 $children[$key] = $categories[$key];
1153 $categories[$key]->processed = true;
aac80ff3
TH
1154 $children = $children + sort_categories_by_tree(
1155 $categories, $children[$key]->id, $level + 1);
f29aeb5a
TH
1156 }
1157 }
516cf3eb 1158 }
f29aeb5a 1159 return $children;
6cb4910c 1160}
1161
1162/**
062a7522 1163 * Private method, only for the use of add_indented_names().
271ffe3f 1164 *
062a7522 1165 * Recursively adds an indentedname field to each category, starting with the category
271ffe3f 1166 * with id $id, and dealing with that category and all its children, and
062a7522 1167 * return a new array, with those categories in the right order.
1168 *
271ffe3f 1169 * @param array $categories an array of categories which has had childids
062a7522 1170 * fields added by flatten_category_tree(). Passed by reference for
1171 * performance only. It is not modfied.
1172 * @param int $id the category to start the indenting process from.
1173 * @param int $depth the indent depth. Used in recursive calls.
1174 * @return array a new array of categories, in the right order for the tree.
6cb4910c 1175 */
3bee1ead 1176function flatten_category_tree(&$categories, $id, $depth = 0, $nochildrenof = -1) {
271ffe3f 1177
062a7522 1178 // Indent the name of this category.
1179 $newcategories = array();
1180 $newcategories[$id] = $categories[$id];
aac80ff3
TH
1181 $newcategories[$id]->indentedname = str_repeat('&nbsp;&nbsp;&nbsp;', $depth) .
1182 $categories[$id]->name;
271ffe3f 1183
062a7522 1184 // Recursively indent the children.
1185 foreach ($categories[$id]->childids as $childid) {
aac80ff3
TH
1186 if ($childid != $nochildrenof) {
1187 $newcategories = $newcategories + flatten_category_tree(
1188 $categories, $childid, $depth + 1, $nochildrenof);
3bee1ead 1189 }
6cb4910c 1190 }
271ffe3f 1191
062a7522 1192 // Remove the childids array that were temporarily added.
1193 unset($newcategories[$id]->childids);
271ffe3f 1194
062a7522 1195 return $newcategories;
6cb4910c 1196}
1197
1198/**
062a7522 1199 * Format categories into an indented list reflecting the tree structure.
271ffe3f 1200 *
062a7522 1201 * @param array $categories An array of category objects, for example from the.
1202 * @return array The formatted list of categories.
6cb4910c 1203 */
3bee1ead 1204function add_indented_names($categories, $nochildrenof = -1) {
6cb4910c 1205
aac80ff3
TH
1206 // Add an array to each category to hold the child category ids. This array
1207 // will be removed again by flatten_category_tree(). It should not be used
1208 // outside these two functions.
062a7522 1209 foreach (array_keys($categories) as $id) {
1210 $categories[$id]->childids = array();
6cb4910c 1211 }
1212
062a7522 1213 // Build the tree structure, and record which categories are top-level.
271ffe3f 1214 // We have to be careful, because the categories array may include published
062a7522 1215 // categories from other courses, but not their parents.
1216 $toplevelcategoryids = array();
1217 foreach (array_keys($categories) as $id) {
aac80ff3
TH
1218 if (!empty($categories[$id]->parent) &&
1219 array_key_exists($categories[$id]->parent, $categories)) {
062a7522 1220 $categories[$categories[$id]->parent]->childids[] = $id;
1221 } else {
1222 $toplevelcategoryids[] = $id;
6cb4910c 1223 }
1224 }
1225
062a7522 1226 // Flatten the tree to and add the indents.
1227 $newcategories = array();
1228 foreach ($toplevelcategoryids as $id) {
aac80ff3
TH
1229 $newcategories = $newcategories + flatten_category_tree(
1230 $categories, $id, 0, $nochildrenof);
6cb4910c 1231 }
1232
062a7522 1233 return $newcategories;
6cb4910c 1234}
2dd6d66b 1235
516cf3eb 1236/**
062a7522 1237 * Output a select menu of question categories.
271ffe3f 1238 *
062a7522 1239 * Categories from this course and (optionally) published categories from other courses
271ffe3f 1240 * are included. Optionally, only categories the current user may edit can be included.
062a7522 1241 *
1242 * @param integer $courseid the id of the course to get the categories for.
1243 * @param integer $published if true, include publised categories from other courses.
1244 * @param integer $only_editable if true, exclude categories this user is not allowed to edit.
aac80ff3
TH
1245 * @param integer $selected optionally, the id of a category to be selected by
1246 * default in the dropdown.
062a7522 1247 */
aac80ff3
TH
1248function question_category_select_menu($contexts, $top = false, $currentcat = 0,
1249 $selected = "", $nochildrenof = -1) {
aac80ff3
TH
1250 $categoriesarray = question_category_options($contexts, $top, $currentcat,
1251 false, $nochildrenof);
3ed998f3 1252 if ($selected) {
6770330d 1253 $choose = '';
3ed998f3 1254 } else {
6770330d 1255 $choose = 'choosedots';
516cf3eb 1256 }
6770330d 1257 $options = array();
aac80ff3
TH
1258 foreach ($categoriesarray as $group => $opts) {
1259 $options[] = array($group => $opts);
6770330d 1260 }
9422f6ee 1261 echo html_writer::label(get_string('questioncategory', 'core_question'), 'id_movetocategory', false, array('class' => 'accesshide'));
12d6dfc1
DW
1262 $attrs = array('id' => 'id_movetocategory', 'class' => 'custom-select');
1263 echo html_writer::select($options, 'category', $selected, $choose, $attrs);
516cf3eb 1264}
1265
cca6e300 1266/**
1267 * @param integer $contextid a context id.
1268 * @return object the default question category for that context, or false if none.
1269 */
1270function question_get_default_category($contextid) {
1271 global $DB;
bb063971
SR
1272 $category = $DB->get_records_select('question_categories', 'contextid = ? AND parent <> 0',
1273 array($contextid), 'id', '*', 0, 1);
cca6e300 1274 if (!empty($category)) {
1275 return reset($category);
1276 } else {
1277 return false;
1278 }
1279}
1280
bb063971
SR
1281/**
1282 * Gets the top category in the given context.
1283 * This function can optionally create the top category if it doesn't exist.
1284 *
1285 * @param int $contextid A context id.
1286 * @param bool $create Whether create a top category if it doesn't exist.
1287 * @return bool|stdClass The top question category for that context, or false if none.
1288 */
1289function question_get_top_category($contextid, $create = false) {
1290 global $DB;
1291 $category = $DB->get_record('question_categories',
1292 array('contextid' => $contextid, 'parent' => 0));
1293
1294 if (!$category && $create) {
1295 // We need to make one.
1296 $category = new stdClass();
1297 $category->name = 'top'; // A non-real name for the top category. It will be localised at the display time.
1298 $category->info = '';
1299 $category->contextid = $contextid;
1300 $category->parent = 0;
1301 $category->sortorder = 0;
1302 $category->stamp = make_unique_id_code();
1303 $category->id = $DB->insert_record('question_categories', $category);
1304 }
1305
1306 return $category;
1307}
1308
3b8f3198
SR
1309/**
1310 * Gets the list of top categories in the given contexts in the array("categoryid,categorycontextid") format.
1311 *
1312 * @param array $contextids List of context ids
1313 * @return array
1314 */
1315function question_get_top_categories_for_contexts($contextids) {
1316 global $DB;
1317
1318 $concatsql = $DB->sql_concat_join("','", ['id', 'contextid']);
1319 list($insql, $params) = $DB->get_in_or_equal($contextids);
1320 $sql = "SELECT $concatsql FROM {question_categories} WHERE contextid $insql AND parent = 0";
1321 $topcategories = $DB->get_fieldset_sql($sql, $params);
1322
1323 return $topcategories;
1324}
1325
8f0f605d 1326/**
aac80ff3
TH
1327 * Gets the default category in the most specific context.
1328 * If no categories exist yet then default ones are created in all contexts.
1329 *
1330 * @param array $contexts The context objects for this context and all parent contexts.
1331 * @return object The default category - the category in the course context
1332 */
8f0f605d 1333function question_make_default_categories($contexts) {
eb84a826 1334 global $DB;
353b2d70 1335 static $preferredlevels = array(
1336 CONTEXT_COURSE => 4,
1337 CONTEXT_MODULE => 3,
1338 CONTEXT_COURSECAT => 2,
1339 CONTEXT_SYSTEM => 1,
1340 );
eb84a826 1341
8f0f605d 1342 $toreturn = null;
353b2d70 1343 $preferredness = 0;
8f0f605d 1344 // If it already exists, just return it.
1345 foreach ($contexts as $key => $context) {
bb063971 1346 $topcategory = question_get_top_category($context->id, true);
aac80ff3 1347 if (!$exists = $DB->record_exists("question_categories",
bb063971 1348 array('contextid' => $context->id, 'parent' => $topcategory->id))) {
eb84a826 1349 // Otherwise, we need to make one
0ff4bd08 1350 $category = new stdClass();
329846f1 1351 $contextname = $context->get_context_name(false, true);
eb84a826 1352 $category->name = get_string('defaultfor', 'question', $contextname);
1353 $category->info = get_string('defaultinfofor', 'question', $contextname);
1354 $category->contextid = $context->id;
bb063971 1355 $category->parent = $topcategory->id;
aac80ff3
TH
1356 // By default, all categories get this number, and are sorted alphabetically.
1357 $category->sortorder = 999;
eb84a826 1358 $category->stamp = make_unique_id_code();
bf8e93d7 1359 $category->id = $DB->insert_record('question_categories', $category);
b9bd6da4 1360 } else {
cca6e300 1361 $category = question_get_default_category($context->id);
8f0f605d 1362 }
76cf77e4
TH
1363 $thispreferredness = $preferredlevels[$context->contextlevel];
1364 if (has_any_capability(array('moodle/question:usemine', 'moodle/question:useall'), $context)) {
1365 $thispreferredness += 10;
1366 }
1367 if ($thispreferredness > $preferredness) {
353b2d70 1368 $toreturn = $category;
76cf77e4 1369 $preferredness = $thispreferredness;
8f0f605d 1370 }
1371 }
1372
353b2d70 1373 if (!is_null($toreturn)) {
1374 $toreturn = clone($toreturn);
1375 }
8f0f605d 1376 return $toreturn;
1377}
1378
375ed78a 1379/**
3bee1ead 1380 * Get all the category objects, including a count of the number of questions in that category,
1381 * for all the categories in the lists $contexts.
375ed78a 1382 *
3bee1ead 1383 * @param mixed $contexts either a single contextid, or a comma-separated list of context ids.
1384 * @param string $sortorder used as the ORDER BY clause in the select statement.
bb063971 1385 * @param bool $top Whether to return the top categories or not.
3bee1ead 1386 * @return array of category objects.
375ed78a 1387 */
bb063971 1388function get_categories_for_contexts($contexts, $sortorder = 'parent, sortorder, name ASC', $top = false) {
eb84a826 1389 global $DB;
bb063971 1390 $topwhere = $top ? '' : 'AND c.parent <> 0';
eb84a826 1391 return $DB->get_records_sql("
630a3dc3 1392 SELECT c.*, (SELECT count(1) FROM {question} q
eb84a826 1393 WHERE c.id = q.category AND q.hidden='0' AND q.parent='0') AS questioncount
1394 FROM {question_categories} c
bb063971 1395 WHERE c.contextid IN ($contexts) $topwhere
eb84a826 1396 ORDER BY $sortorder");
3bee1ead 1397}
3a3c454e 1398
3bee1ead 1399/**
1400 * Output an array of question categories.
bb063971
SR
1401 *
1402 * @param array $contexts The list of contexts.
1403 * @param bool $top Whether to return the top categories or not.
1404 * @param int $currentcat
1405 * @param bool $popupform
1406 * @param int $nochildrenof
1407 * @return array
3bee1ead 1408 */
aac80ff3
TH
1409function question_category_options($contexts, $top = false, $currentcat = 0,
1410 $popupform = false, $nochildrenof = -1) {
3bee1ead 1411 global $CFG;
1412 $pcontexts = array();
aac80ff3 1413 foreach ($contexts as $context) {
3bee1ead 1414 $pcontexts[] = $context->id;
61d9b9fc 1415 }
3bee1ead 1416 $contextslist = join($pcontexts, ', ');
1417
bb063971 1418 $categories = get_categories_for_contexts($contextslist, 'parent, sortorder, name ASC', $top);
3bee1ead 1419
aac80ff3 1420 if ($top) {
bb063971 1421 $categories = question_fix_top_names($categories);
3bee1ead 1422 }
bb063971
SR
1423
1424 $categories = question_add_context_in_key($categories);
3bee1ead 1425 $categories = add_indented_names($categories, $nochildrenof);
3ed998f3 1426
aac80ff3 1427 // sort cats out into different contexts
375ed78a 1428 $categoriesarray = array();
fc51c2bc
TH
1429 foreach ($pcontexts as $contextid) {
1430 $context = context::instance_by_id($contextid);
1431 $contextstring = $context->get_context_name(true, true);
3bee1ead 1432 foreach ($categories as $category) {
fc51c2bc 1433 if ($category->contextid == $contextid) {
3bee1ead 1434 $cid = $category->id;
aac80ff3
TH
1435 if ($currentcat != $cid || $currentcat == 0) {
1436 $countstring = !empty($category->questioncount) ?
1437 " ($category->questioncount)" : '';
fc51c2bc
TH
1438 $categoriesarray[$contextstring][$cid] =
1439 format_string($category->indentedname, true,
1440 array('context' => $context)) . $countstring;
3bee1ead 1441 }
1442 }
375ed78a 1443 }
1444 }
aac80ff3 1445 if ($popupform) {
3bee1ead 1446 $popupcats = array();
aac80ff3 1447 foreach ($categoriesarray as $contextstring => $optgroup) {
94fa6be4 1448 $group = array();
aac80ff3 1449 foreach ($optgroup as $key => $value) {
78bfb562
PS
1450 $key = str_replace($CFG->wwwroot, '', $key);
1451 $group[$key] = $value;
94fa6be4 1452 }
aac80ff3 1453 $popupcats[] = array($contextstring => $group);
3bee1ead 1454 }
1455 return $popupcats;
1456 } else {
1457 return $categoriesarray;
1458 }
375ed78a 1459}
1460
aac80ff3 1461function question_add_context_in_key($categories) {
3bee1ead 1462 $newcatarray = array();
1463 foreach ($categories as $id => $category) {
1464 $category->parent = "$category->parent,$category->contextid";
1465 $category->id = "$category->id,$category->contextid";
1466 $newcatarray["$id,$category->contextid"] = $category;
516cf3eb 1467 }
3bee1ead 1468 return $newcatarray;
1469}
f29aeb5a 1470
bb063971
SR
1471/**
1472 * Finds top categories in the given categories hierarchy and replace their name with a proper localised string.
1473 *
1474 * @param array $categories An array of question categories.
1475 * @return array The same question category list given to the function, with the top category names being translated.
1476 */
1477function question_fix_top_names($categories) {
1478
1479 foreach ($categories as $id => $category) {
1480 if ($category->parent == 0) {
c185e4fe
SR
1481 $context = context::instance_by_id($category->contextid);
1482 $categories[$id]->name = get_string('topfor', 'question', $context->get_context_name(false));
bb063971 1483 }
3bee1ead 1484 }
bb063971
SR
1485
1486 return $categories;
516cf3eb 1487}
1488
516cf3eb 1489/**
2daffca5 1490 * @return array of question category ids of the category and all subcategories.
b20ea669 1491 */
dc1f00de 1492function question_categorylist($categoryid) {
eb84a826 1493 global $DB;
1494
e80c64ab 1495 // final list of category IDs
0f76ac4f
TM
1496 $categorylist = array();
1497
e80c64ab
TM
1498 // a list of category IDs to check for any sub-categories
1499 $subcategories = array($categoryid);
0f76ac4f 1500
e80c64ab 1501 while ($subcategories) {
0f76ac4f 1502 foreach ($subcategories as $subcategory) {
e80c64ab
TM
1503 // if anything from the temporary list was added already, then we have a loop
1504 if (isset($categorylist[$subcategory])) {
1505 throw new coding_exception("Category id=$subcategory is already on the list - loop of categories detected.");
1506 }
1507 $categorylist[$subcategory] = $subcategory;
0f76ac4f
TM
1508 }
1509
e80c64ab
TM
1510 list ($in, $params) = $DB->get_in_or_equal($subcategories);
1511
1512 $subcategories = $DB->get_records_select_menu('question_categories',
1513 "parent $in", $params, NULL, 'id,id AS id2');
516cf3eb 1514 }
2daffca5 1515
516cf3eb 1516 return $categorylist;
1517}
1518
d0a60444
JB
1519/**
1520 * Get all parent categories of a given question category in decending order.
1521 * @param int $categoryid for which you want to find the parents.
1522 * @return array of question category ids of all parents categories.
1523 */
1524function question_categorylist_parents(int $categoryid) {
1525 global $DB;
1526 $parent = $DB->get_field('question_categories', 'parent', array('id' => $categoryid));
1527 if (!$parent) {
1528 return [];
1529 }
1530 $categorylist = [$parent];
1531 $currentid = $parent;
1532 while ($currentid) {
1533 $currentid = $DB->get_field('question_categories', 'parent', array('id' => $currentid));
1534 if ($currentid) {
1535 $categorylist[] = $currentid;
1536 }
1537 }
1538 // Present the list in decending order (the top category at the top).
1539 $categorylist = array_reverse($categorylist);
1540 return $categorylist;
1541}
1542
947217d7 1543//===========================
1544// Import/Export Functions
1545//===========================
1546
ff4b6492 1547/**
1548 * Get list of available import or export formats
1549 * @param string $type 'import' if import list, otherwise export list assumed
271ffe3f 1550 * @return array sorted list of import/export formats available
50fcb1d8 1551 */
f29aeb5a 1552function get_import_export_formats($type) {
ff4b6492 1553 global $CFG;
44a7f384 1554 require_once($CFG->dirroot . '/question/format.php');
f7c1dfaf 1555
059e08ed 1556 $formatclasses = core_component::get_plugin_list_with_class('qformat', '', 'format.php');
ff4b6492 1557
f7c1dfaf 1558 $fileformatname = array();
44a7f384 1559 foreach ($formatclasses as $component => $formatclass) {
f29aeb5a 1560
44a7f384 1561 $format = new $formatclass();
f29aeb5a 1562 if ($type == 'import') {
44a7f384 1563 $provided = $format->provide_import();
f29aeb5a 1564 } else {
44a7f384 1565 $provided = $format->provide_export();
ff4b6492 1566 }
f29aeb5a 1567
ff4b6492 1568 if ($provided) {
44a7f384 1569 list($notused, $fileformat) = explode('_', $component, 2);
64679179 1570 $fileformatnames[$fileformat] = get_string('pluginname', $component);
ff4b6492 1571 }
1572 }
ff4b6492 1573
2f1e464a 1574 core_collator::asort($fileformatnames);
ff4b6492 1575 return $fileformatnames;
1576}
feb60a07 1577
1578
1579/**
aac80ff3
TH
1580 * Create a reasonable default file name for exporting questions from a particular
1581 * category.
1582 * @param object $course the course the questions are in.
1583 * @param object $category the question category.
1584 * @return string the filename.
1585 */
b80d424c
TH
1586function question_default_export_filename($course, $category) {
1587 // We build a string that is an appropriate name (questions) from the lang pack,
0ff4bd08 1588 // then the corse shortname, then the question category name, then a timestamp.
b80d424c
TH
1589
1590 $base = clean_filename(get_string('exportfilename', 'question'));
1591
1592 $dateformat = str_replace(' ', '_', get_string('exportnameformat', 'question'));
1593 $timestamp = clean_filename(userdate(time(), $dateformat, 99, false));
1594
1595 $shortname = clean_filename($course->shortname);
1596 if ($shortname == '' || $shortname == '_' ) {
1597 $shortname = $course->id;
1598 }
1599
1600 $categoryname = clean_filename(format_string($category->name));
1601
1602 return "{$base}-{$shortname}-{$categoryname}-{$timestamp}";
feb60a07 1603
1604 return $export_name;
1605}
50fcb1d8 1606
1607/**
f29aeb5a
TH
1608 * Converts contextlevels to strings and back to help with reading/writing contexts
1609 * to/from import/export files.
1610 *
50fcb1d8 1611 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
1612 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1613 */
3bee1ead 1614class context_to_string_translator{
1615 /**
1616 * @var array used to translate between contextids and strings for this context.
1617 */
f29aeb5a 1618 protected $contexttostringarray = array();
3bee1ead 1619
f29aeb5a 1620 public function __construct($contexts) {
3bee1ead 1621 $this->generate_context_to_string_array($contexts);
1622 }
1623
f29aeb5a 1624 public function context_to_string($contextid) {
3bee1ead 1625 return $this->contexttostringarray[$contextid];
1626 }
1627
f29aeb5a 1628 public function string_to_context($contextname) {
3bee1ead 1629 $contextid = array_search($contextname, $this->contexttostringarray);
1630 return $contextid;
1631 }
1632
f29aeb5a 1633 protected function generate_context_to_string_array($contexts) {
aac80ff3 1634 if (!$this->contexttostringarray) {
3bee1ead 1635 $catno = 1;
aac80ff3
TH
1636 foreach ($contexts as $context) {
1637 switch ($context->contextlevel) {
3bee1ead 1638 case CONTEXT_MODULE :
1639 $contextstring = 'module';
1640 break;
1641 case CONTEXT_COURSE :
1642 $contextstring = 'course';
1643 break;
1644 case CONTEXT_COURSECAT :
1645 $contextstring = "cat$catno";
1646 $catno++;
1647 break;
1648 case CONTEXT_SYSTEM :
1649 $contextstring = 'system';
1650 break;
1651 }
1652 $this->contexttostringarray[$context->id] = $contextstring;
1653 }
1654 }
1655 }
1656
1657}
feb60a07 1658
3bee1ead 1659/**
1660 * Check capability on category
50fcb1d8 1661 *
8e93e515 1662 * @param int|stdClass $questionorid object or id. If an object is passed, it should include ->contextid and ->createdby.
e7329cd0 1663 * @param string $cap 'add', 'edit', 'view', 'use', 'move' or 'tag'.
8e93e515
SR
1664 * @param int $notused no longer used.
1665 * @return bool this user has the capability $cap for this question $question?
1666 * @throws coding_exception
3bee1ead 1667 */
e7329cd0 1668function question_has_capability_on($questionorid, $cap, $notused = -1) {
8e93e515 1669 global $USER, $DB;
e7329cd0
SL
1670
1671 if (is_numeric($questionorid)) {
8e93e515 1672 $questionid = (int)$questionorid;
e7329cd0 1673 } else if (is_object($questionorid)) {
8e93e515
SR
1674 // All we really need in this function is the contextid and author of the question.
1675 // We won't bother fetching other details of the question if these 2 fields are provided.
e7329cd0
SL
1676 if (isset($questionorid->contextid) && isset($questionorid->createdby)) {
1677 $question = $questionorid;
8e93e515
SR
1678 } else if (!empty($questionorid->id)) {
1679 $questionid = $questionorid->id;
3bee1ead 1680 }
8e93e515
SR
1681 }
1682
1683 // At this point, either $question or $questionid is expected to be set.
1684 if (isset($questionid)) {
1685 try {
1686 $question = question_bank::load_question_data($questionid);
1687 } catch (Exception $e) {
1688 // Let's log the exception for future debugging.
1689 debugging($e->getMessage(), DEBUG_NORMAL, $e->getTrace());
3bee1ead 1690
8e93e515
SR
1691 // Well, at least we tried. Seems that we really have to read from DB.
1692 $question = $DB->get_record_sql('SELECT q.id, q.createdby, qc.contextid
1693 FROM {question} q
1694 JOIN {question_categories} qc ON q.category = qc.id
1695 WHERE q.id = :id', ['id' => $questionid]);
3bee1ead 1696 }
8e93e515
SR
1697 }
1698
1699 if (!isset($question)) {
e7329cd0 1700 throw new coding_exception('$questionorid parameter needs to be an integer or an object.');
3bee1ead 1701 }
1702
e7329cd0
SL
1703 $context = context::instance_by_id($question->contextid);
1704
02b1868c
SL
1705 // These are existing questions capabilities that are set per category.
1706 // Each of these has a 'mine' and 'all' version that is appended to the capability name.
e7329cd0
SL
1707 $capabilitieswithallandmine = ['edit' => 1, 'view' => 1, 'use' => 1, 'move' => 1, 'tag' => 1];
1708
1709 if (!isset($capabilitieswithallandmine[$cap])) {
1710 return has_capability('moodle/question:' . $cap, $context);
1711 } else {
1712 return has_capability('moodle/question:' . $cap . 'all', $context) ||
1713 ($question->createdby == $USER->id && has_capability('moodle/question:' . $cap . 'mine', $context));
1714 }
3bee1ead 1715}
1716
1717/**
1718 * Require capability on question.
1719 */
aac80ff3
TH
1720function question_require_capability_on($question, $cap) {
1721 if (!question_has_capability_on($question, $cap)) {
3bee1ead 1722 print_error('nopermissions', '', '', $cap);
1723 }
1724 return true;
1725}
1726
62e76c67 1727/**
f29aeb5a
TH
1728 * @param object $context a context
1729 * @return string A URL for editing questions in this context.
f62040ed 1730 */
f29aeb5a
TH
1731function question_edit_url($context) {
1732 global $CFG, $SITE;
1733 if (!has_any_capability(question_get_question_capabilities(), $context)) {
1734 return false;
f62040ed 1735 }
f29aeb5a
TH
1736 $baseurl = $CFG->wwwroot . '/question/edit.php?';
1737 $defaultcategory = question_get_default_category($context->id);
1738 if ($defaultcategory) {
1739 $baseurl .= 'cat=' . $defaultcategory->id . ',' . $context->id . '&amp;';
f62040ed 1740 }
f29aeb5a
TH
1741 switch ($context->contextlevel) {
1742 case CONTEXT_SYSTEM:
1743 return $baseurl . 'courseid=' . $SITE->id;
1744 case CONTEXT_COURSECAT:
1745 // This is nasty, becuase we can only edit questions in a course
1746 // context at the moment, so for now we just return false.
1747 return false;
1748 case CONTEXT_COURSE:
1749 return $baseurl . 'courseid=' . $context->instanceid;
1750 case CONTEXT_MODULE:
1751 return $baseurl . 'cmid=' . $context->instanceid;
62e76c67 1752 }
f29aeb5a 1753
62e76c67 1754}
56ed242b
SH
1755
1756/**
792881f0 1757 * Adds question bank setting links to the given navigation node if caps are met.
56ed242b
SH
1758 *
1759 * @param navigation_node $navigationnode The navigation node to add the question branch to
0ff4bd08 1760 * @param object $context
56ed242b
SH
1761 * @return navigation_node Returns the question branch that was added
1762 */
1763function question_extend_settings_navigation(navigation_node $navigationnode, $context) {
1764 global $PAGE;
1765
1766 if ($context->contextlevel == CONTEXT_COURSE) {
1767 $params = array('courseid'=>$context->instanceid);
1768 } else if ($context->contextlevel == CONTEXT_MODULE) {
1769 $params = array('cmid'=>$context->instanceid);
1770 } else {
1771 return;
1772 }
1773
8356e6cf
TH
1774 if (($cat = $PAGE->url->param('cat')) && preg_match('~\d+,\d+~', $cat)) {
1775 $params['cat'] = $cat;
1776 }
1777
aac80ff3 1778 $questionnode = $navigationnode->add(get_string('questionbank', 'question'),
e6b2598b 1779 new moodle_url('/question/edit.php', $params), navigation_node::TYPE_CONTAINER, null, 'questionbank');
56ed242b
SH
1780
1781 $contexts = new question_edit_contexts($context);
1782 if ($contexts->have_one_edit_tab_cap('questions')) {
e0c22222 1783 $questionnode->add(get_string('questions', 'question'), new moodle_url(
e6b2598b 1784 '/question/edit.php', $params), navigation_node::TYPE_SETTING, null, 'questions');
56ed242b
SH
1785 }
1786 if ($contexts->have_one_edit_tab_cap('categories')) {
e0c22222 1787 $questionnode->add(get_string('categories', 'question'), new moodle_url(
e6b2598b 1788 '/question/category.php', $params), navigation_node::TYPE_SETTING, null, 'categories');
56ed242b
SH
1789 }
1790 if ($contexts->have_one_edit_tab_cap('import')) {
e0c22222 1791 $questionnode->add(get_string('import', 'question'), new moodle_url(
e6b2598b 1792 '/question/import.php', $params), navigation_node::TYPE_SETTING, null, 'import');
56ed242b
SH
1793 }
1794 if ($contexts->have_one_edit_tab_cap('export')) {
e0c22222 1795 $questionnode->add(get_string('export', 'question'), new moodle_url(
e6b2598b 1796 '/question/export.php', $params), navigation_node::TYPE_SETTING, null, 'export');
56ed242b
SH
1797 }
1798
1799 return $questionnode;
1800}
1801
f29aeb5a
TH
1802/**
1803 * @return array all the capabilities that relate to accessing particular questions.
1804 */
1805function question_get_question_capabilities() {
1806 return array(
1807 'moodle/question:add',
1808 'moodle/question:editmine',
1809 'moodle/question:editall',
1810 'moodle/question:viewmine',
1811 'moodle/question:viewall',
1812 'moodle/question:usemine',
1813 'moodle/question:useall',
1814 'moodle/question:movemine',
1815 'moodle/question:moveall',
1816 );
1817}
1818
1819/**
1820 * @return array all the question bank capabilities.
1821 */
1822function question_get_all_capabilities() {
1823 $caps = question_get_question_capabilities();
1824 $caps[] = 'moodle/question:managecategory';
1825 $caps[] = 'moodle/question:flag';
1826 return $caps;
1827}
1828
6f4c71f5
TH
1829
1830/**
1831 * Tracks all the contexts related to the one where we are currently editing
1832 * questions, and provides helper methods to check permissions.
1833 *
1834 * @copyright 2007 Jamie Pratt me@jamiep.org
1835 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1836 */
56ed242b
SH
1837class question_edit_contexts {
1838
aac80ff3 1839 public static $caps = array(
56ed242b
SH
1840 'editq' => array('moodle/question:add',
1841 'moodle/question:editmine',
1842 'moodle/question:editall',
1843 'moodle/question:viewmine',
1844 'moodle/question:viewall',
1845 'moodle/question:usemine',
1846 'moodle/question:useall',
1847 'moodle/question:movemine',
1848 'moodle/question:moveall'),
1849 'questions'=>array('moodle/question:add',
1850 'moodle/question:editmine',
1851 'moodle/question:editall',
1852 'moodle/question:viewmine',
1853 'moodle/question:viewall',
1854 'moodle/question:movemine',
1855 'moodle/question:moveall'),
1856 'categories'=>array('moodle/question:managecategory'),
1857 'import'=>array('moodle/question:add'),
1858 'export'=>array('moodle/question:viewall', 'moodle/question:viewmine'));
1859
1860 protected $allcontexts;
1861
1862 /**
6f4c71f5
TH
1863 * Constructor
1864 * @param context the current context.
56ed242b 1865 */
6f4c71f5
TH
1866 public function __construct(context $thiscontext) {
1867 $this->allcontexts = array_values($thiscontext->get_parent_contexts(true));
56ed242b 1868 }
6f4c71f5 1869
56ed242b
SH
1870 /**
1871 * @return array all parent contexts
1872 */
f29aeb5a 1873 public function all() {
56ed242b
SH
1874 return $this->allcontexts;
1875 }
6f4c71f5 1876
56ed242b
SH
1877 /**
1878 * @return object lowest context which must be either the module or course context
1879 */
f29aeb5a 1880 public function lowest() {
56ed242b
SH
1881 return $this->allcontexts[0];
1882 }
6f4c71f5 1883
56ed242b
SH
1884 /**
1885 * @param string $cap capability
1886 * @return array parent contexts having capability, zero based index
1887 */
f29aeb5a 1888 public function having_cap($cap) {
56ed242b 1889 $contextswithcap = array();
aac80ff3
TH
1890 foreach ($this->allcontexts as $context) {
1891 if (has_capability($cap, $context)) {
56ed242b
SH
1892 $contextswithcap[] = $context;
1893 }
1894 }
1895 return $contextswithcap;
1896 }
6f4c71f5 1897
56ed242b
SH
1898 /**
1899 * @param array $caps capabilities
1900 * @return array parent contexts having at least one of $caps, zero based index
1901 */
f29aeb5a 1902 public function having_one_cap($caps) {
56ed242b 1903 $contextswithacap = array();
aac80ff3
TH
1904 foreach ($this->allcontexts as $context) {
1905 foreach ($caps as $cap) {
1906 if (has_capability($cap, $context)) {
56ed242b
SH
1907 $contextswithacap[] = $context;
1908 break; //done with caps loop
1909 }
1910 }
1911 }
1912 return $contextswithacap;
1913 }
6f4c71f5 1914
56ed242b
SH
1915 /**
1916 * @param string $tabname edit tab name
1917 * @return array parent contexts having at least one of $caps, zero based index
1918 */
f29aeb5a 1919 public function having_one_edit_tab_cap($tabname) {
aac80ff3 1920 return $this->having_one_cap(self::$caps[$tabname]);
56ed242b 1921 }
6f4c71f5 1922
76cf77e4
TH
1923 /**
1924 * @return those contexts where a user can add a question and then use it.
1925 */
1926 public function having_add_and_use() {
1927 $contextswithcap = array();
1928 foreach ($this->allcontexts as $context) {
1929 if (!has_capability('moodle/question:add', $context)) {
1930 continue;
1931 }
1932 if (!has_any_capability(array('moodle/question:useall', 'moodle/question:usemine'), $context)) {
1933 continue;
1934 }
1935 $contextswithcap[] = $context;
1936 }
1937 return $contextswithcap;
1938 }
1939
56ed242b
SH
1940 /**
1941 * Has at least one parent context got the cap $cap?
1942 *
1943 * @param string $cap capability
1944 * @return boolean
1945 */
f29aeb5a 1946 public function have_cap($cap) {
56ed242b
SH
1947 return (count($this->having_cap($cap)));
1948 }
1949
1950 /**
1951 * Has at least one parent context got one of the caps $caps?
1952 *
1953 * @param array $caps capability
1954 * @return boolean
1955 */
f29aeb5a 1956 public function have_one_cap($caps) {
56ed242b
SH
1957 foreach ($caps as $cap) {
1958 if ($this->have_cap($cap)) {
1959 return true;
1960 }
1961 }
1962 return false;
1963 }
f29aeb5a 1964
56ed242b
SH
1965 /**
1966 * Has at least one parent context got one of the caps for actions on $tabname
1967 *
1968 * @param string $tabname edit tab name
1969 * @return boolean
1970 */
aac80ff3
TH
1971 public function have_one_edit_tab_cap($tabname) {
1972 return $this->have_one_cap(self::$caps[$tabname]);
56ed242b 1973 }
f29aeb5a 1974
56ed242b
SH
1975 /**
1976 * Throw error if at least one parent context hasn't got the cap $cap
1977 *
1978 * @param string $cap capability
1979 */
aac80ff3
TH
1980 public function require_cap($cap) {
1981 if (!$this->have_cap($cap)) {
56ed242b
SH
1982 print_error('nopermissions', '', '', $cap);
1983 }
1984 }
f29aeb5a 1985
56ed242b
SH
1986 /**
1987 * Throw error if at least one parent context hasn't got one of the caps $caps
1988 *
1989 * @param array $cap capabilities
1990 */
aac80ff3 1991 public function require_one_cap($caps) {
56ed242b
SH
1992 if (!$this->have_one_cap($caps)) {
1993 $capsstring = join($caps, ', ');
1994 print_error('nopermissions', '', '', $capsstring);
1995 }
1996 }
1997
1998 /**
1999 * Throw error if at least one parent context hasn't got one of the caps $caps
2000 *
2001 * @param string $tabname edit tab name
2002 */
aac80ff3 2003 public function require_one_edit_tab_cap($tabname) {
56ed242b
SH
2004 if (!$this->have_one_edit_tab_cap($tabname)) {
2005 print_error('nopermissions', '', '', 'access question edit tab '.$tabname);
2006 }
2007 }
fe6ce234
DC
2008}
2009
6f4c71f5 2010
fe6ce234 2011/**
fdb5bc03 2012 * Helps call file_rewrite_pluginfile_urls with the right parameters.
fe6ce234 2013 *
d2b7803e
DC
2014 * @package core_question
2015 * @category files
fe6ce234
DC
2016 * @param string $text text being processed
2017 * @param string $file the php script used to serve files
d2b7803e 2018 * @param int $contextid context ID
fe6ce234
DC
2019 * @param string $component component
2020 * @param string $filearea filearea
2021 * @param array $ids other IDs will be used to check file permission
d2b7803e
DC
2022 * @param int $itemid item ID
2023 * @param array $options options
fe6ce234
DC
2024 * @return string
2025 */
aac80ff3
TH
2026function question_rewrite_question_urls($text, $file, $contextid, $component,
2027 $filearea, array $ids, $itemid, array $options=null) {
fe6ce234 2028
fdb5bc03
TH
2029 $idsstr = '';
2030 if (!empty($ids)) {
2031 $idsstr .= implode('/', $ids);
fe6ce234 2032 }
fdb5bc03
TH
2033 if ($itemid !== null) {
2034 $idsstr .= '/' . $itemid;
fe6ce234 2035 }
fdb5bc03
TH
2036 return file_rewrite_pluginfile_urls($text, $file, $contextid, $component,
2037 $filearea, $idsstr, $options);
2038}
fe6ce234 2039
181393aa
TH
2040/**
2041 * Rewrite the PLUGINFILE urls in part of the content of a question, for use when
2042 * viewing the question outside an attempt (for example, in the question bank
2043 * listing or in the quiz statistics report).
2044 *
2045 * @param string $text the question text.
2046 * @param int $questionid the question id.
2047 * @param int $filecontextid the context id of the question being displayed.
2048 * @param string $filecomponent the component that owns the file area.
2049 * @param string $filearea the file area name.
2050 * @param int|null $itemid the file's itemid
2051 * @param int $previewcontextid the context id where the preview is being displayed.
2052 * @param string $previewcomponent component responsible for displaying the preview.
2053 * @param array $options text and file options ('forcehttps'=>false)
2054 * @return string $questiontext with URLs rewritten.
2055 */
2056function question_rewrite_question_preview_urls($text, $questionid,
2057 $filecontextid, $filecomponent, $filearea, $itemid,
2058 $previewcontextid, $previewcomponent, $options = null) {
fe6ce234 2059
181393aa
TH
2060 $path = "preview/$previewcontextid/$previewcomponent/$questionid";
2061 if ($itemid) {
2062 $path .= '/' . $itemid;
2063 }
2064
2065 return file_rewrite_pluginfile_urls($text, 'pluginfile.php', $filecontextid,
2066 $filecomponent, $filearea, $path, $options);
fdb5bc03 2067}
fe6ce234 2068
fe6ce234
DC
2069/**
2070 * Called by pluginfile.php to serve files related to the 'question' core
2071 * component and for files belonging to qtypes.
2072 *
2073 * For files that relate to questions in a question_attempt, then we delegate to
2074 * a function in the component that owns the attempt (for example in the quiz,
2075 * or in core question preview) to get necessary inforation.
2076 *
2077 * (Note that, at the moment, all question file areas relate to questions in
2078 * attempts, so the If at the start of the last paragraph is always true.)
2079 *
2080 * Does not return, either calls send_file_not_found(); or serves the file.
2081 *
d2b7803e
DC
2082 * @package core_question
2083 * @category files
2084 * @param stdClass $course course settings object
2085 * @param stdClass $context context object
fe6ce234
DC
2086 * @param string $component the name of the component we are serving files for.
2087 * @param string $filearea the name of the file area.
2088 * @param array $args the remaining bits of the file path.
2089 * @param bool $forcedownload whether the user must be forced to download the file.
7a00d438 2090 * @param array $options additional options affecting the file serving
fe6ce234 2091 */
7a00d438 2092function question_pluginfile($course, $context, $component, $filearea, $args, $forcedownload, array $options=array()) {
fe6ce234
DC
2093 global $DB, $CFG;
2094
181393aa 2095 // Special case, sending a question bank export.
cde2709a 2096 if ($filearea === 'export') {
97f1137a
TH
2097 list($context, $course, $cm) = get_context_info_array($context->id);
2098 require_login($course, false, $cm);
2099
cde2709a
DC
2100 require_once($CFG->dirroot . '/question/editlib.php');
2101 $contexts = new question_edit_contexts($context);
2102 // check export capability
2103 $contexts->require_one_edit_tab_cap('export');
2104 $category_id = (int)array_shift($args);
2105 $format = array_shift($args);
2106 $cattofile = array_shift($args);
2107 $contexttofile = array_shift($args);
2108 $filename = array_shift($args);
2109
2110 // load parent class for import/export
2111 require_once($CFG->dirroot . '/question/format.php');
2112 require_once($CFG->dirroot . '/question/editlib.php');
2113 require_once($CFG->dirroot . '/question/format/' . $format . '/format.php');
2114
2115 $classname = 'qformat_' . $format;
2116 if (!class_exists($classname)) {
2117 send_file_not_found();
2118 }
2119
2120 $qformat = new $classname();
2121
2122 if (!$category = $DB->get_record('question_categories', array('id' => $category_id))) {
2123 send_file_not_found();
2124 }
2125
2126 $qformat->setCategory($category);
2127 $qformat->setContexts($contexts->having_one_edit_tab_cap('export'));
2128 $qformat->setCourse($course);
2129
2130 if ($cattofile == 'withcategories') {
2131 $qformat->setCattofile(true);
2132 } else {
2133 $qformat->setCattofile(false);
2134 }
2135
2136 if ($contexttofile == 'withcontexts') {
2137 $qformat->setContexttofile(true);
2138 } else {
2139 $qformat->setContexttofile(false);
2140 }
2141
2142 if (!$qformat->exportpreprocess()) {
2143 send_file_not_found();
2144 print_error('exporterror', 'question', $thispageurl->out());
2145 }
2146
2147 // export data to moodle file pool
cc98914e 2148 if (!$content = $qformat->exportprocess()) {
cde2709a
DC
2149 send_file_not_found();
2150 }
2151
46732124 2152 send_file($content, $filename, 0, 0, true, true, $qformat->mime_type());
cde2709a
DC
2153 }
2154
181393aa
TH
2155 // Normal case, a file belonging to a question.
2156 $qubaidorpreview = array_shift($args);
2157
2158 // Two sub-cases: 1. A question being previewed outside an attempt/usage.
2159 if ($qubaidorpreview === 'preview') {
2160 $previewcontextid = (int)array_shift($args);
2161 $previewcomponent = array_shift($args);
2162 $questionid = (int) array_shift($args);
2163 $previewcontext = context_helper::instance_by_id($previewcontextid);
2164
2165 $result = component_callback($previewcomponent, 'question_preview_pluginfile', array(
2166 $previewcontext, $questionid,
2167 $context, $component, $filearea, $args,
1b49f31d
TH
2168 $forcedownload, $options), 'callbackmissing');
2169
2170 if ($result === 'callbackmissing') {
2171 throw new coding_exception("Component {$previewcomponent} does not define the callback " .
2172 "{$previewcomponent}_question_preview_pluginfile callback. " .
2173 "Which is required if you are using question_rewrite_question_preview_urls.", DEBUG_DEVELOPER);
181393aa
TH
2174 }
2175
2176 send_file_not_found();
2177 }
2178
2179 // 2. A question being attempted in the normal way.
2180 $qubaid = (int)$qubaidorpreview;
7a719748 2181 $slot = (int)array_shift($args);
fe6ce234 2182
7a719748
TH
2183 $module = $DB->get_field('question_usages', 'component',
2184 array('id' => $qubaid));
9c75f8dc
TH
2185 if (!$module) {
2186 send_file_not_found();
2187 }
fe6ce234 2188
7a719748 2189 if ($module === 'core_question_preview') {
fe6ce234
DC
2190 require_once($CFG->dirroot . '/question/previewlib.php');
2191 return question_preview_question_pluginfile($course, $context,
7a00d438 2192 $component, $filearea, $qubaid, $slot, $args, $forcedownload, $options);
fe6ce234
DC
2193
2194 } else {
b0d1d941 2195 $dir = core_component::get_component_directory($module);
fe6ce234
DC
2196 if (!file_exists("$dir/lib.php")) {
2197 send_file_not_found();
2198 }
2199 include_once("$dir/lib.php");
2200
2201 $filefunction = $module . '_question_pluginfile';
0dd0f963
AB
2202 if (function_exists($filefunction)) {
2203 $filefunction($course, $context, $component, $filearea, $qubaid, $slot,
2204 $args, $forcedownload, $options);
fe6ce234
DC
2205 }
2206
813f6964
DP
2207 // Okay, we're here so lets check for function without 'mod_'.
2208 if (strpos($module, 'mod_') === 0) {
38d488ce 2209 $filefunctionold = substr($module, 4) . '_question_pluginfile';
0dd0f963
AB
2210 if (function_exists($filefunctionold)) {
2211 $filefunctionold($course, $context, $component, $filearea, $qubaid, $slot,
2212 $args, $forcedownload, $options);
2213 }
2214 }
fe6ce234
DC
2215
2216 send_file_not_found();
2217 }
2218}
2219
0019a9b7
TH
2220/**
2221 * Serve questiontext files in the question text when they are displayed in this report.
d2b7803e
DC
2222 *
2223 * @package core_files
2224 * @category files
68d2f6a0
TH
2225 * @param context $previewcontext the context in which the preview is happening.
2226 * @param int $questionid the question id.
2227 * @param context $filecontext the file (question) context.
2228 * @param string $filecomponent the component the file belongs to.
2229 * @param string $filearea the file area.
2230 * @param array $args remaining file args.
2231 * @param bool $forcedownload.
2232 * @param array $options additional options affecting the file serving.
0019a9b7 2233 */
68d2f6a0
TH
2234function core_question_question_preview_pluginfile($previewcontext, $questionid,
2235 $filecontext, $filecomponent, $filearea, $args, $forcedownload, $options = array()) {
0019a9b7
TH
2236 global $DB;
2237
2238 // Verify that contextid matches the question.
2239 $question = $DB->get_record_sql('
2240 SELECT q.*, qc.contextid
2241 FROM {question} q
2242 JOIN {question_categories} qc ON qc.id = q.category
2243 WHERE q.id = :id AND qc.contextid = :contextid',
68d2f6a0 2244 array('id' => $questionid, 'contextid' => $filecontext->id), MUST_EXIST);
0019a9b7
TH
2245
2246 // Check the capability.
68d2f6a0 2247 list($context, $course, $cm) = get_context_info_array($previewcontext->id);
0019a9b7
TH
2248 require_login($course, false, $cm);
2249
2250 question_require_capability_on($question, 'use');
2251
68d2f6a0
TH
2252 $fs = get_file_storage();
2253 $relativepath = implode('/', $args);
2254 $fullpath = "/{$filecontext->id}/{$filecomponent}/{$filearea}/{$relativepath}";
2255 if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
2256 send_file_not_found();
2257 }
2258
2259 send_stored_file($file, 0, 0, $forcedownload, $options);
0019a9b7
TH
2260}
2261
cde2709a
DC
2262/**
2263 * Create url for question export
2264 *
2265 * @param int $contextid, current context
2266 * @param int $categoryid, categoryid
2267 * @param string $format
2268 * @param string $withcategories
2269 * @param string $ithcontexts
2270 * @param moodle_url export file url
2271 */
aac80ff3
TH
2272function question_make_export_url($contextid, $categoryid, $format, $withcategories,
2273 $withcontexts, $filename) {
cde2709a 2274 global $CFG;
672f4836 2275 $urlbase = "$CFG->wwwroot/pluginfile.php";
aac80ff3
TH
2276 return moodle_url::make_file_url($urlbase,
2277 "/$contextid/question/export/{$categoryid}/{$format}/{$withcategories}" .
2278 "/{$withcontexts}/{$filename}", true);
cde2709a 2279}
b1627a92 2280
616442a2
TH
2281/**
2282 * Get the URL to export a single question (exportone.php).
2283 *
2284 * @param stdClass|question_definition $question the question definition as obtained from
2285 * question_bank::load_question_data() or question_bank::make_question().
2286 * (Only ->id and ->contextid are used.)
2287 * @return moodle_url the requested URL.
2288 */
2289function question_get_export_single_question_url($question) {
2290 $params = ['id' => $question->id, 'sesskey' => sesskey()];
2291 $context = context::instance_by_id($question->contextid);
2292 switch ($context->contextlevel) {
2293 case CONTEXT_MODULE:
2294 $params['cmid'] = $context->instanceid;
2295 break;
2296
2297 case CONTEXT_COURSE:
2298 $params['courseid'] = $context->instanceid;
2299 break;
2300
2301 default:
2302 $params['courseid'] = SITEID;
2303 }
2304
2305 return new moodle_url('/question/exportone.php', $params);
2306}
2307
b1627a92
DC
2308/**
2309 * Return a list of page types
2310 * @param string $pagetype current page type
2311 * @param stdClass $parentcontext Block's parent context
2312 * @param stdClass $currentcontext Current context of block
2313 */
b38e2e28 2314function question_page_type_list($pagetype, $parentcontext, $currentcontext) {
b1627a92
DC
2315 global $CFG;
2316 $types = array(
2317 'question-*'=>get_string('page-question-x', 'question'),
2318 'question-edit'=>get_string('page-question-edit', 'question'),
2319 'question-category'=>get_string('page-question-category', 'question'),
2320 'question-export'=>get_string('page-question-export', 'question'),
2321 'question-import'=>get_string('page-question-import', 'question')
2322 );
2323 if ($currentcontext->contextlevel == CONTEXT_COURSE) {
2324 require_once($CFG->dirroot . '/course/lib.php');
b38e2e28 2325 return array_merge(course_page_type_list($pagetype, $parentcontext, $currentcontext), $types);
b1627a92
DC
2326 } else {
2327 return $types;
2328 }
2329}
b07ef13b
DP
2330
2331/**
2332 * Does an activity module use the question bank?
2333 *
2334 * @param string $modname The name of the module (without mod_ prefix).
2335 * @return bool true if the module uses questions.
2336 */
2337function question_module_uses_questions($modname) {
2338 if (plugin_supports('mod', $modname, FEATURE_USES_QUESTIONS)) {
2339 return true;
2340 }
2341
2342 $component = 'mod_'.$modname;
2343 if (component_callback_exists($component, 'question_pluginfile')) {
2344 debugging("{$component} uses questions but doesn't declare FEATURE_USES_QUESTIONS", DEBUG_DEVELOPER);
2345 return true;
2346 }
2347
2348 return false;
2349}