2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Code for handling and processing questions
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}
25 * TODO: separate those functions which form part of the API
26 * from the helper functions.
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
35 defined('MOODLE_INTERNAL') ||
die();
37 require_once($CFG->dirroot
. '/question/engine/lib.php');
38 require_once($CFG->dirroot
. '/question/type/questiontypebase.php');
42 /// CONSTANTS ///////////////////////////////////
45 * Constant determines the number of answer boxes supplied in the editing
46 * form for multiple choice and similar question types.
48 define("QUESTION_NUMANS", 10);
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.
55 define("QUESTION_NUMANS_START", 3);
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'.
62 define("QUESTION_NUMANS_ADD", 3);
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.
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.
75 function question_reorder_qtypes($sortedqtypes, $tomove, $direction) {
76 $neworder = array_keys($sortedqtypes);
77 // Find the element to move.
78 $key = array_search($tomove, $neworder);
82 // Work out the other index.
83 $otherkey = $key +
$direction;
84 if (!isset($neworder[$otherkey])) {
88 $swap = $neworder[$otherkey];
89 $neworder[$otherkey] = $neworder[$key];
90 $neworder[$key] = $swap;
95 * Save a new question type order to the config_plugins table.
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.
100 function question_save_qtype_order($neworder, $config = null) {
103 if (is_null($config)) {
104 $config = get_config('question');
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');
115 /// FUNCTIONS //////////////////////////////////////////////////////
118 * Returns an array of names of activity modules that use this question
120 * @deprecated since Moodle 2.1. Use {@link questions_in_use} instead.
122 * @param object $questionid
123 * @return array of strings
125 function question_list_instances($questionid) {
126 throw new coding_exception('question_list_instances has been deprectated. ' .
127 'Please use questions_in_use instead.');
131 * @param array $questionids of question ids.
132 * @return boolean whether any of these questions are being used by any part of Moodle.
134 function questions_in_use($questionids) {
137 if (question_engine
::questions_in_use($questionids)) {
141 foreach (get_plugin_list('mod') as $module => $path) {
142 $lib = $path . '/lib.php';
143 if (is_readable($lib)) {
146 $fn = $module . '_questions_in_use';
147 if (function_exists($fn)) {
148 if ($fn($questionids)) {
153 // Fallback for legacy modules.
154 $fn = $module . '_question_list_instances';
155 if (function_exists($fn)) {
156 foreach ($questionids as $questionid) {
157 $instances = $fn($questionid);
158 if (!empty($instances)) {
171 * Determine whether there arey any questions belonging to this context, that is whether any of its
172 * question categories contain any questions. This will return true even if all the questions are
175 * @param mixed $context either a context object, or a context id.
176 * @return boolean whether any of the question categories beloning to this context have
177 * any questions in them.
179 function question_context_has_any_questions($context) {
181 if (is_object($context)) {
182 $contextid = $context->id
;
183 } else if (is_numeric($context)) {
184 $contextid = $context;
186 print_error('invalidcontextinhasanyquestions', 'question');
188 return $DB->record_exists_sql("SELECT *
190 JOIN {question_categories} qc ON qc.id = q.category
191 WHERE qc.contextid = ? AND q.parent = 0", array($contextid));
195 * Returns list of 'allowed' grades for grade selection
196 * formatted suitably for dropdown box function
198 * @deprecated since 2.1. Use {@link question_bank::fraction_options()} or
199 * {@link question_bank::fraction_options_full()} instead.
201 * @return object ->gradeoptionsfull full array ->gradeoptions +ve only
203 function get_grade_options() {
204 $grades = new stdClass();
205 $grades->gradeoptions
= question_bank
::fraction_options();
206 $grades->gradeoptionsfull
= question_bank
::fraction_options_full();
212 * match grade options
213 * if no match return error or match nearest
214 * @param array $gradeoptionsfull list of valid options
215 * @param int $grade grade to be tested
216 * @param string $matchgrades 'error' or 'nearest'
217 * @return mixed either 'fixed' value or false if erro
219 function match_grade_options($gradeoptionsfull, $grade, $matchgrades='error') {
220 if ($matchgrades == 'error') {
221 // if we just need an error...
222 foreach ($gradeoptionsfull as $value => $option) {
223 // slightly fuzzy test, never check floats for equality :-)
224 if (abs($grade - $value) < 0.00001) {
228 // didn't find a match so that's an error
230 } else if ($matchgrades == 'nearest') {
231 // work out nearest value
233 foreach ($gradeoptionsfull as $value => $option) {
234 if ($grade==$value) {
237 $hownear[ $value ] = abs( $grade - $value );
239 // reverse sort list of deltas and grab the last (smallest)
240 asort( $hownear, SORT_NUMERIC
);
242 return key( $hownear );
249 * @deprecated Since Moodle 2.1. Use {@link question_category_in_use} instead.
250 * @param integer $categoryid a question category id.
251 * @param boolean $recursive whether to check child categories too.
252 * @return boolean whether any question in this category is in use.
254 function question_category_isused($categoryid, $recursive = false) {
255 throw new coding_exception('question_category_isused has been deprectated. ' .
256 'Please use question_category_in_use instead.');
260 * Tests whether any question in a category is used by any part of Moodle.
262 * @param integer $categoryid a question category id.
263 * @param boolean $recursive whether to check child categories too.
264 * @return boolean whether any question in this category is in use.
266 function question_category_in_use($categoryid, $recursive = false) {
269 //Look at each question in the category
270 if ($questions = $DB->get_records_menu('question',
271 array('category' => $categoryid), '', 'id, 1')) {
272 if (questions_in_use(array_keys($questions))) {
280 //Look under child categories recursively
281 if ($children = $DB->get_records('question_categories',
282 array('parent' => $categoryid), '', 'id, 1')) {
283 foreach ($children as $child) {
284 if (question_category_in_use($child->id
, $recursive)) {
294 * Deletes question and all associated data from the database
296 * It will not delete a question if it is used by an activity module
297 * @param object $question The question being deleted
299 function question_delete_question($questionid) {
302 $question = $DB->get_record_sql('
303 SELECT q.*, qc.contextid
305 JOIN {question_categories} qc ON qc.id = q.category
306 WHERE q.id = ?', array($questionid));
308 // In some situations, for example if this was a child of a
309 // Cloze question that was previously deleted, the question may already
310 // have gone. In this case, just do nothing.
314 // Do not delete a question if it is used by an activity module
315 if (questions_in_use(array($questionid))) {
319 // Check permissions.
320 question_require_capability_on($question, 'edit');
322 $dm = new question_engine_data_mapper();
323 $dm->delete_previews($questionid);
325 // delete questiontype-specific data
326 question_bank
::get_qtype($question->qtype
, false)->delete_question(
327 $questionid, $question->contextid
);
329 // Now recursively delete all child questions
330 if ($children = $DB->get_records('question',
331 array('parent' => $questionid), '', 'id, qtype')) {
332 foreach ($children as $child) {
333 if ($child->id
!= $questionid) {
334 question_delete_question($child->id
);
339 // Finally delete the question record itself
340 $DB->delete_records('question', array('id' => $questionid));
344 * All question categories and their questions are deleted for this course.
346 * @param object $mod an object representing the activity
347 * @param boolean $feedback to specify if the process must output a summary of its work
350 function question_delete_course($course, $feedback=true) {
353 //To store feedback to be showed at the end of the process
354 $feedbackdata = array();
357 $strcatdeleted = get_string('unusedcategorydeleted', 'quiz');
358 $coursecontext = get_context_instance(CONTEXT_COURSE
, $course->id
);
359 $categoriescourse = $DB->get_records('question_categories',
360 array('contextid' => $coursecontext->id
), 'parent', 'id, parent, name, contextid');
362 if ($categoriescourse) {
364 //Sort categories following their tree (parent-child) relationships
365 //this will make the feedback more readable
366 $categoriescourse = sort_categories_by_tree($categoriescourse);
368 foreach ($categoriescourse as $category) {
370 //Delete it completely (questions and category itself)
372 if ($questions = $DB->get_records('question',
373 array('category' => $category->id
), '', 'id,qtype')) {
374 foreach ($questions as $question) {
375 question_delete_question($question->id
);
377 $DB->delete_records("question", array("category" => $category->id
));
379 //delete the category
380 $DB->delete_records('question_categories', array('id' => $category->id
));
383 $feedbackdata[] = array($category->name
, $strcatdeleted);
385 //Inform about changes performed if feedback is enabled
387 $table = new html_table();
388 $table->head
= array(get_string('category', 'quiz'), get_string('action'));
389 $table->data
= $feedbackdata;
390 echo html_writer
::table($table);
397 * Category is about to be deleted,
398 * 1/ All question categories and their questions are deleted for this course category.
399 * 2/ All questions are moved to new category
401 * @param object $category course category object
402 * @param object $newcategory empty means everything deleted, otherwise id of
403 * category where content moved
404 * @param boolean $feedback to specify if the process must output a summary of its work
407 function question_delete_course_category($category, $newcategory, $feedback=true) {
410 $context = get_context_instance(CONTEXT_COURSECAT
, $category->id
);
411 if (empty($newcategory)) {
412 $feedbackdata = array(); // To store feedback to be showed at the end of the process
413 $rescueqcategory = null; // See the code around the call to question_save_from_deletion.
414 $strcatdeleted = get_string('unusedcategorydeleted', 'quiz');
416 // Loop over question categories.
417 if ($categories = $DB->get_records('question_categories',
418 array('contextid'=>$context->id
), 'parent', 'id, parent, name')) {
419 foreach ($categories as $category) {
421 // Deal with any questions in the category.
422 if ($questions = $DB->get_records('question',
423 array('category' => $category->id
), '', 'id,qtype')) {
425 // Try to delete each question.
426 foreach ($questions as $question) {
427 question_delete_question($question->id
);
430 // Check to see if there were any questions that were kept because
431 // they are still in use somehow, even though quizzes in courses
432 // in this category will already have been deteted. This could
433 // happen, for example, if questions are added to a course,
434 // and then that course is moved to another category (MDL-14802).
435 $questionids = $DB->get_records_menu('question',
436 array('category'=>$category->id
), '', 'id, 1');
437 if (!empty($questionids)) {
438 if (!$rescueqcategory = question_save_from_deletion(
439 array_keys($questionids), get_parent_contextid($context),
440 print_context_name($context), $rescueqcategory)) {
443 $feedbackdata[] = array($category->name
,
444 get_string('questionsmovedto', 'question', $rescueqcategory->name
));
448 // Now delete the category.
449 if (!$DB->delete_records('question_categories', array('id'=>$category->id
))) {
452 $feedbackdata[] = array($category->name
, $strcatdeleted);
454 } // End loop over categories.
457 // Output feedback if requested.
458 if ($feedback and $feedbackdata) {
459 $table = new html_table();
460 $table->head
= array(get_string('questioncategory', 'question'), get_string('action'));
461 $table->data
= $feedbackdata;
462 echo html_writer
::table($table);
466 // Move question categories ot the new context.
467 if (!$newcontext = get_context_instance(CONTEXT_COURSECAT
, $newcategory->id
)) {
470 $DB->set_field('question_categories', 'contextid', $newcontext->id
,
471 array('contextid'=>$context->id
));
474 $a->oldplace
= print_context_name($context);
475 $a->newplace
= print_context_name($newcontext);
476 echo $OUTPUT->notification(
477 get_string('movedquestionsandcategories', 'question', $a), 'notifysuccess');
485 * Enter description here...
487 * @param string $questionids list of questionids
488 * @param object $newcontext the context to create the saved category in.
489 * @param string $oldplace a textual description of the think being deleted,
490 * e.g. from get_context_name
491 * @param object $newcategory
492 * @return mixed false on
494 function question_save_from_deletion($questionids, $newcontextid, $oldplace,
495 $newcategory = null) {
498 // Make a category in the parent context to move the questions to.
499 if (is_null($newcategory)) {
500 $newcategory = new stdClass();
501 $newcategory->parent
= 0;
502 $newcategory->contextid
= $newcontextid;
503 $newcategory->name
= get_string('questionsrescuedfrom', 'question', $oldplace);
504 $newcategory->info
= get_string('questionsrescuedfrominfo', 'question', $oldplace);
505 $newcategory->sortorder
= 999;
506 $newcategory->stamp
= make_unique_id_code();
507 $newcategory->id
= $DB->insert_record('question_categories', $newcategory);
510 // Move any remaining questions to the 'saved' category.
511 if (!question_move_questions_to_category($questionids, $newcategory->id
)) {
518 * All question categories and their questions are deleted for this activity.
520 * @param object $cm the course module object representing the activity
521 * @param boolean $feedback to specify if the process must output a summary of its work
524 function question_delete_activity($cm, $feedback=true) {
527 //To store feedback to be showed at the end of the process
528 $feedbackdata = array();
531 $strcatdeleted = get_string('unusedcategorydeleted', 'quiz');
532 $modcontext = get_context_instance(CONTEXT_MODULE
, $cm->id
);
533 if ($categoriesmods = $DB->get_records('question_categories',
534 array('contextid' => $modcontext->id
), 'parent', 'id, parent, name, contextid')) {
535 //Sort categories following their tree (parent-child) relationships
536 //this will make the feedback more readable
537 $categoriesmods = sort_categories_by_tree($categoriesmods);
539 foreach ($categoriesmods as $category) {
541 //Delete it completely (questions and category itself)
543 if ($questions = $DB->get_records('question',
544 array('category' => $category->id
), '', 'id,qtype')) {
545 foreach ($questions as $question) {
546 question_delete_question($question->id
);
548 $DB->delete_records("question", array("category"=>$category->id
));
550 //delete the category
551 $DB->delete_records('question_categories', array('id'=>$category->id
));
554 $feedbackdata[] = array($category->name
, $strcatdeleted);
556 //Inform about changes performed if feedback is enabled
558 $table = new html_table();
559 $table->head
= array(get_string('category', 'quiz'), get_string('action'));
560 $table->data
= $feedbackdata;
561 echo html_writer
::table($table);
568 * This function should be considered private to the question bank, it is called from
569 * question/editlib.php question/contextmoveq.php and a few similar places to to the
570 * work of acutally moving questions and associated data. However, callers of this
571 * function also have to do other work, which is why you should not call this method
572 * directly from outside the questionbank.
574 * @param string $questionids a comma-separated list of question ids.
575 * @param integer $newcategoryid the id of the category to move to.
577 function question_move_questions_to_category($questionids, $newcategoryid) {
580 $newcontextid = $DB->get_field('question_categories', 'contextid',
581 array('id' => $newcategoryid));
582 list($questionidcondition, $params) = $DB->get_in_or_equal($questionids);
583 $questions = $DB->get_records_sql("
584 SELECT q.id, q.qtype, qc.contextid
586 JOIN {question_categories} qc ON q.category = qc.id
587 WHERE q.id $questionidcondition", $params);
588 foreach ($questions as $question) {
589 if ($newcontextid != $question->contextid
) {
590 question_bank
::get_qtype($question->qtype
)->move_files(
591 $question->id
, $question->contextid
, $newcontextid);
595 // Move the questions themselves.
596 $DB->set_field_select('question', 'category', $newcategoryid,
597 "id $questionidcondition", $params);
599 // Move any subquestions belonging to them.
600 $DB->set_field_select('question', 'category', $newcategoryid,
601 "parent $questionidcondition", $params);
603 // TODO Deal with datasets.
609 * This function helps move a question cateogry to a new context by moving all
610 * the files belonging to all the questions to the new context.
611 * Also moves subcategories.
612 * @param integer $categoryid the id of the category being moved.
613 * @param integer $oldcontextid the old context id.
614 * @param integer $newcontextid the new context id.
616 function question_move_category_to_context($categoryid, $oldcontextid, $newcontextid) {
619 $questionids = $DB->get_records_menu('question',
620 array('category' => $categoryid), '', 'id,qtype');
621 foreach ($questionids as $questionid => $qtype) {
622 question_bank
::get_qtype($qtype)->move_files(
623 $questionid, $oldcontextid, $newcontextid);
626 $subcatids = $DB->get_records_menu('question_categories',
627 array('parent' => $categoryid), '', 'id,1');
628 foreach ($subcatids as $subcatid => $notused) {
629 $DB->set_field('question_categories', 'contextid', $newcontextid,
630 array('id' => $subcatid));
631 question_move_category_to_context($subcatid, $oldcontextid, $newcontextid);
636 * Generate the URL for starting a new preview of a given question with the given options.
637 * @param integer $questionid the question to preview.
638 * @param string $preferredbehaviour the behaviour to use for the preview.
639 * @param float $maxmark the maximum to mark the question out of.
640 * @param question_display_options $displayoptions the display options to use.
641 * @param int $variant the variant of the question to preview. If null, one will
642 * be picked randomly.
643 * @param object $context context to run the preview in (affects things like
644 * filter settings, theme, lang, etc.) Defaults to $PAGE->context.
645 * @return string the URL.
647 function question_preview_url($questionid, $preferredbehaviour = null,
648 $maxmark = null, $displayoptions = null, $variant = null, $context = null) {
650 $params = array('id' => $questionid);
652 if (is_null($context)) {
654 $context = $PAGE->context
;
656 if ($context->contextlevel
== CONTEXT_MODULE
) {
657 $params['cmid'] = $context->instanceid
;
658 } else if ($context->contextlevel
== CONTEXT_COURSE
) {
659 $params['courseid'] = $context->instanceid
;
662 if (!is_null($preferredbehaviour)) {
663 $params['behaviour'] = $preferredbehaviour;
666 if (!is_null($maxmark)) {
667 $params['maxmark'] = $maxmark;
670 if (!is_null($displayoptions)) {
671 $params['correctness'] = $displayoptions->correctness
;
672 $params['marks'] = $displayoptions->marks
;
673 $params['markdp'] = $displayoptions->markdp
;
674 $params['feedback'] = (bool) $displayoptions->feedback
;
675 $params['generalfeedback'] = (bool) $displayoptions->generalfeedback
;
676 $params['rightanswer'] = (bool) $displayoptions->rightanswer
;
677 $params['history'] = (bool) $displayoptions->history
;
681 $params['variant'] = $variant;
684 return new moodle_url('/question/preview.php', $params);
688 * @return array that can be passed as $params to the {@link popup_action} constructor.
690 function question_preview_popup_params() {
698 * Given a list of ids, load the basic information about a set of questions from
699 * the questions table. The $join and $extrafields arguments can be used together
700 * to pull in extra data. See, for example, the usage in mod/quiz/attemptlib.php, and
701 * read the code below to see how the SQL is assembled. Throws exceptions on error.
705 * @param array $questionids array of question ids.
706 * @param string $extrafields extra SQL code to be added to the query.
707 * @param string $join extra SQL code to be added to the query.
708 * @param array $extraparams values for any placeholders in $join.
709 * You are strongly recommended to use named placeholder.
711 * @return array partially complete question objects. You need to call get_question_options
712 * on them before they can be properly used.
714 function question_preload_questions($questionids, $extrafields = '', $join = '',
715 $extraparams = array()) {
717 if (empty($questionids)) {
721 $join = ' JOIN '.$join;
724 $extrafields = ', ' . $extrafields;
726 list($questionidcondition, $params) = $DB->get_in_or_equal(
727 $questionids, SQL_PARAMS_NAMED
, 'qid0000');
728 $sql = 'SELECT q.*, qc.contextid' . $extrafields . ' FROM {question} q
729 JOIN {question_categories} qc ON q.category = qc.id' .
731 ' WHERE q.id ' . $questionidcondition;
733 // Load the questions
734 if (!$questions = $DB->get_records_sql($sql, $extraparams +
$params)) {
738 foreach ($questions as $question) {
739 $question->_partiallyloaded
= true;
742 // Note, a possible optimisation here would be to not load the TEXT fields
743 // (that is, questiontext and generalfeedback) here, and instead load them in
744 // question_load_questions. That would add one DB query, but reduce the amount
745 // of data transferred most of the time. I am not going to do this optimisation
746 // until it is shown to be worthwhile.
752 * Load a set of questions, given a list of ids. The $join and $extrafields arguments can be used
753 * together to pull in extra data. See, for example, the usage in mod/quiz/attempt.php, and
754 * read the code below to see how the SQL is assembled. Throws exceptions on error.
756 * @param array $questionids array of question ids.
757 * @param string $extrafields extra SQL code to be added to the query.
758 * @param string $join extra SQL code to be added to the query.
759 * @param array $extraparams values for any placeholders in $join.
760 * You are strongly recommended to use named placeholder.
762 * @return array question objects.
764 function question_load_questions($questionids, $extrafields = '', $join = '') {
765 $questions = question_preload_questions($questionids, $extrafields, $join);
767 // Load the question type specific information
768 if (!get_question_options($questions)) {
769 return 'Could not load the question options';
776 * Private function to factor common code out of get_question_options().
778 * @param object $question the question to tidy.
779 * @param boolean $loadtags load the question tags from the tags table. Optional, default false.
781 function _tidy_question($question, $loadtags = false) {
783 if (!question_bank
::is_qtype_installed($question->qtype
)) {
784 $question->questiontext
= html_writer
::tag('p', get_string('warningmissingtype',
785 'qtype_missingtype')) . $question->questiontext
;
787 question_bank
::get_qtype($question->qtype
)->get_question_options($question);
788 if (isset($question->_partiallyloaded
)) {
789 unset($question->_partiallyloaded
);
791 if ($loadtags && !empty($CFG->usetags
)) {
792 require_once($CFG->dirroot
. '/tag/lib.php');
793 $question->tags
= tag_get_tags_array('question', $question->id
);
798 * Updates the question objects with question type specific
799 * information by calling {@link get_question_options()}
801 * Can be called either with an array of question objects or with a single
804 * @param mixed $questions Either an array of question objects to be updated
805 * or just a single question object
806 * @param boolean $loadtags load the question tags from the tags table. Optional, default false.
807 * @return bool Indicates success or failure.
809 function get_question_options(&$questions, $loadtags = false) {
810 if (is_array($questions)) { // deal with an array of questions
811 foreach ($questions as $i => $notused) {
812 _tidy_question($questions[$i], $loadtags);
814 } else { // deal with single question
815 _tidy_question($questions, $loadtags);
821 * Print the icon for the question type
823 * @param object $question The question object for which the icon is required.
824 * Only $question->qtype is used.
825 * @return string the HTML for the img tag.
827 function print_question_icon($question) {
830 $qtype = question_bank
::get_qtype($question->qtype
, false);
831 $namestr = $qtype->menu_name();
833 // TODO convert to return a moodle_icon object, or whatever the class is.
834 $html = '<img src="' . $OUTPUT->pix_url('icon', $qtype->plugin_name()) . '" alt="' .
835 $namestr . '" title="' . $namestr . '" />';
841 * Creates a stamp that uniquely identifies this version of the question
843 * In future we want this to use a hash of the question data to guarantee that
844 * identical versions have the same version stamp.
846 * @param object $question
847 * @return string A unique version stamp
849 function question_hash($question) {
850 return make_unique_id_code();
853 /// FUNCTIONS THAT SIMPLY WRAP QUESTIONTYPE METHODS //////////////////////////////////
855 * Get anything that needs to be included in the head of the question editing page
856 * for a particular question type. This function is called by question/question.php.
858 * @param $question A question object. Only $question->qtype is used.
859 * @return string Deprecated. Some HTML code that can go inside the head tag.
861 function question_get_editing_head_contributions($question) {
862 question_bank
::get_qtype($question->qtype
, false)->get_editing_head_contributions();
866 * Saves question options
868 * Simply calls the question type specific save_question_options() method.
870 function save_question_options($question) {
871 question_bank
::get_qtype($question->qtype
)->save_question_options($question);
874 /// CATEGORY FUNCTIONS /////////////////////////////////////////////////////////////////
877 * returns the categories with their names ordered following parent-child relationships
878 * finally it tries to return pending categories (those being orphaned, whose parent is
879 * incorrect) to avoid missing any category from original array.
881 function sort_categories_by_tree(&$categories, $id = 0, $level = 1) {
885 $keys = array_keys($categories);
887 foreach ($keys as $key) {
888 if (!isset($categories[$key]->processed
) && $categories[$key]->parent
== $id) {
889 $children[$key] = $categories[$key];
890 $categories[$key]->processed
= true;
891 $children = $children +
sort_categories_by_tree(
892 $categories, $children[$key]->id
, $level+
1);
895 //If level = 1, we have finished, try to look for non processed categories
896 // (bad parent) and sort them too
898 foreach ($keys as $key) {
899 // If not processed and it's a good candidate to start (because its
900 // parent doesn't exist in the course)
901 if (!isset($categories[$key]->processed
) && !$DB->record_exists('question_categories',
902 array('contextid' => $categories[$key]->contextid
,
903 'id' => $categories[$key]->parent
))) {
904 $children[$key] = $categories[$key];
905 $categories[$key]->processed
= true;
906 $children = $children +
sort_categories_by_tree(
907 $categories, $children[$key]->id
, $level +
1);
915 * Private method, only for the use of add_indented_names().
917 * Recursively adds an indentedname field to each category, starting with the category
918 * with id $id, and dealing with that category and all its children, and
919 * return a new array, with those categories in the right order.
921 * @param array $categories an array of categories which has had childids
922 * fields added by flatten_category_tree(). Passed by reference for
923 * performance only. It is not modfied.
924 * @param int $id the category to start the indenting process from.
925 * @param int $depth the indent depth. Used in recursive calls.
926 * @return array a new array of categories, in the right order for the tree.
928 function flatten_category_tree(&$categories, $id, $depth = 0, $nochildrenof = -1) {
930 // Indent the name of this category.
931 $newcategories = array();
932 $newcategories[$id] = $categories[$id];
933 $newcategories[$id]->indentedname
= str_repeat(' ', $depth) .
934 $categories[$id]->name
;
936 // Recursively indent the children.
937 foreach ($categories[$id]->childids
as $childid) {
938 if ($childid != $nochildrenof) {
939 $newcategories = $newcategories +
flatten_category_tree(
940 $categories, $childid, $depth +
1, $nochildrenof);
944 // Remove the childids array that were temporarily added.
945 unset($newcategories[$id]->childids
);
947 return $newcategories;
951 * Format categories into an indented list reflecting the tree structure.
953 * @param array $categories An array of category objects, for example from the.
954 * @return array The formatted list of categories.
956 function add_indented_names($categories, $nochildrenof = -1) {
958 // Add an array to each category to hold the child category ids. This array
959 // will be removed again by flatten_category_tree(). It should not be used
960 // outside these two functions.
961 foreach (array_keys($categories) as $id) {
962 $categories[$id]->childids
= array();
965 // Build the tree structure, and record which categories are top-level.
966 // We have to be careful, because the categories array may include published
967 // categories from other courses, but not their parents.
968 $toplevelcategoryids = array();
969 foreach (array_keys($categories) as $id) {
970 if (!empty($categories[$id]->parent
) &&
971 array_key_exists($categories[$id]->parent
, $categories)) {
972 $categories[$categories[$id]->parent
]->childids
[] = $id;
974 $toplevelcategoryids[] = $id;
978 // Flatten the tree to and add the indents.
979 $newcategories = array();
980 foreach ($toplevelcategoryids as $id) {
981 $newcategories = $newcategories +
flatten_category_tree(
982 $categories, $id, 0, $nochildrenof);
985 return $newcategories;
989 * Output a select menu of question categories.
991 * Categories from this course and (optionally) published categories from other courses
992 * are included. Optionally, only categories the current user may edit can be included.
994 * @param integer $courseid the id of the course to get the categories for.
995 * @param integer $published if true, include publised categories from other courses.
996 * @param integer $only_editable if true, exclude categories this user is not allowed to edit.
997 * @param integer $selected optionally, the id of a category to be selected by
998 * default in the dropdown.
1000 function question_category_select_menu($contexts, $top = false, $currentcat = 0,
1001 $selected = "", $nochildrenof = -1) {
1003 $categoriesarray = question_category_options($contexts, $top, $currentcat,
1004 false, $nochildrenof);
1008 $choose = 'choosedots';
1011 foreach ($categoriesarray as $group => $opts) {
1012 $options[] = array($group => $opts);
1015 echo html_writer
::select($options, 'category', $selected, $choose);
1019 * @param integer $contextid a context id.
1020 * @return object the default question category for that context, or false if none.
1022 function question_get_default_category($contextid) {
1024 $category = $DB->get_records('question_categories',
1025 array('contextid' => $contextid), 'id', '*', 0, 1);
1026 if (!empty($category)) {
1027 return reset($category);
1034 * Gets the default category in the most specific context.
1035 * If no categories exist yet then default ones are created in all contexts.
1037 * @param array $contexts The context objects for this context and all parent contexts.
1038 * @return object The default category - the category in the course context
1040 function question_make_default_categories($contexts) {
1042 static $preferredlevels = array(
1043 CONTEXT_COURSE
=> 4,
1044 CONTEXT_MODULE
=> 3,
1045 CONTEXT_COURSECAT
=> 2,
1046 CONTEXT_SYSTEM
=> 1,
1051 // If it already exists, just return it.
1052 foreach ($contexts as $key => $context) {
1053 if (!$exists = $DB->record_exists("question_categories",
1054 array('contextid' => $context->id
))) {
1055 // Otherwise, we need to make one
1056 $category = new stdClass();
1057 $contextname = print_context_name($context, false, true);
1058 $category->name
= get_string('defaultfor', 'question', $contextname);
1059 $category->info
= get_string('defaultinfofor', 'question', $contextname);
1060 $category->contextid
= $context->id
;
1061 $category->parent
= 0;
1062 // By default, all categories get this number, and are sorted alphabetically.
1063 $category->sortorder
= 999;
1064 $category->stamp
= make_unique_id_code();
1065 $category->id
= $DB->insert_record('question_categories', $category);
1067 $category = question_get_default_category($context->id
);
1069 if ($preferredlevels[$context->contextlevel
] > $preferredness && has_any_capability(
1070 array('moodle/question:usemine', 'moodle/question:useall'), $context)) {
1071 $toreturn = $category;
1072 $preferredness = $preferredlevels[$context->contextlevel
];
1076 if (!is_null($toreturn)) {
1077 $toreturn = clone($toreturn);
1083 * Get all the category objects, including a count of the number of questions in that category,
1084 * for all the categories in the lists $contexts.
1086 * @param mixed $contexts either a single contextid, or a comma-separated list of context ids.
1087 * @param string $sortorder used as the ORDER BY clause in the select statement.
1088 * @return array of category objects.
1090 function get_categories_for_contexts($contexts, $sortorder = 'parent, sortorder, name ASC') {
1092 return $DB->get_records_sql("
1093 SELECT c.*, (SELECT count(1) FROM {question} q
1094 WHERE c.id = q.category AND q.hidden='0' AND q.parent='0') AS questioncount
1095 FROM {question_categories} c
1096 WHERE c.contextid IN ($contexts)
1097 ORDER BY $sortorder");
1101 * Output an array of question categories.
1103 function question_category_options($contexts, $top = false, $currentcat = 0,
1104 $popupform = false, $nochildrenof = -1) {
1106 $pcontexts = array();
1107 foreach ($contexts as $context) {
1108 $pcontexts[] = $context->id
;
1110 $contextslist = join($pcontexts, ', ');
1112 $categories = get_categories_for_contexts($contextslist);
1114 $categories = question_add_context_in_key($categories);
1117 $categories = question_add_tops($categories, $pcontexts);
1119 $categories = add_indented_names($categories, $nochildrenof);
1121 // sort cats out into different contexts
1122 $categoriesarray = array();
1123 foreach ($pcontexts as $pcontext) {
1124 $contextstring = print_context_name(
1125 get_context_instance_by_id($pcontext), true, true);
1126 foreach ($categories as $category) {
1127 if ($category->contextid
== $pcontext) {
1128 $cid = $category->id
;
1129 if ($currentcat != $cid ||
$currentcat == 0) {
1130 $countstring = !empty($category->questioncount
) ?
1131 " ($category->questioncount)" : '';
1132 $categoriesarray[$contextstring][$cid] = $category->indentedname
.$countstring;
1138 $popupcats = array();
1139 foreach ($categoriesarray as $contextstring => $optgroup) {
1141 foreach ($optgroup as $key => $value) {
1142 $key = str_replace($CFG->wwwroot
, '', $key);
1143 $group[$key] = $value;
1145 $popupcats[] = array($contextstring => $group);
1149 return $categoriesarray;
1153 function question_add_context_in_key($categories) {
1154 $newcatarray = array();
1155 foreach ($categories as $id => $category) {
1156 $category->parent
= "$category->parent,$category->contextid";
1157 $category->id
= "$category->id,$category->contextid";
1158 $newcatarray["$id,$category->contextid"] = $category;
1160 return $newcatarray;
1163 function question_add_tops($categories, $pcontexts) {
1165 foreach ($pcontexts as $context) {
1166 $newcat = new stdClass();
1167 $newcat->id
= "0,$context";
1168 $newcat->name
= get_string('top');
1169 $newcat->parent
= -1;
1170 $newcat->contextid
= $context;
1171 $topcats["0,$context"] = $newcat;
1173 //put topcats in at beginning of array - they'll be sorted into different contexts later.
1174 return array_merge($topcats, $categories);
1178 * @return array of question category ids of the category and all subcategories.
1180 function question_categorylist($categoryid) {
1183 $subcategories = $DB->get_records('question_categories',
1184 array('parent' => $categoryid), 'sortorder ASC', 'id, 1');
1186 $categorylist = array($categoryid);
1187 foreach ($subcategories as $subcategory) {
1188 $categorylist = array_merge($categorylist, question_categorylist($subcategory->id
));
1191 return $categorylist;
1194 //===========================
1195 // Import/Export Functions
1196 //===========================
1199 * Get list of available import or export formats
1200 * @param string $type 'import' if import list, otherwise export list assumed
1201 * @return array sorted list of import/export formats available
1203 function get_import_export_formats($type) {
1206 $fileformats = get_plugin_list('qformat');
1208 $fileformatname = array();
1209 require_once($CFG->dirroot
. '/question/format.php');
1210 foreach ($fileformats as $fileformat => $fdir) {
1211 $formatfile = $fdir . '/format.php';
1212 if (is_readable($formatfile)) {
1213 include_once($formatfile);
1218 $classname = 'qformat_' . $fileformat;
1219 $formatclass = new $classname();
1220 if ($type == 'import') {
1221 $provided = $formatclass->provide_import();
1223 $provided = $formatclass->provide_export();
1227 $fileformatnames[$fileformat] = get_string($fileformat, 'qformat_' . $fileformat);
1231 collatorlib
::asort($fileformatnames);
1232 return $fileformatnames;
1237 * Create a reasonable default file name for exporting questions from a particular
1239 * @param object $course the course the questions are in.
1240 * @param object $category the question category.
1241 * @return string the filename.
1243 function question_default_export_filename($course, $category) {
1244 // We build a string that is an appropriate name (questions) from the lang pack,
1245 // then the corse shortname, then the question category name, then a timestamp.
1247 $base = clean_filename(get_string('exportfilename', 'question'));
1249 $dateformat = str_replace(' ', '_', get_string('exportnameformat', 'question'));
1250 $timestamp = clean_filename(userdate(time(), $dateformat, 99, false));
1252 $shortname = clean_filename($course->shortname
);
1253 if ($shortname == '' ||
$shortname == '_' ) {
1254 $shortname = $course->id
;
1257 $categoryname = clean_filename(format_string($category->name
));
1259 return "{$base}-{$shortname}-{$categoryname}-{$timestamp}";
1261 return $export_name;
1265 * Converts contextlevels to strings and back to help with reading/writing contexts
1266 * to/from import/export files.
1268 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
1269 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1271 class context_to_string_translator
{
1273 * @var array used to translate between contextids and strings for this context.
1275 protected $contexttostringarray = array();
1277 public function __construct($contexts) {
1278 $this->generate_context_to_string_array($contexts);
1281 public function context_to_string($contextid) {
1282 return $this->contexttostringarray
[$contextid];
1285 public function string_to_context($contextname) {
1286 $contextid = array_search($contextname, $this->contexttostringarray
);
1290 protected function generate_context_to_string_array($contexts) {
1291 if (!$this->contexttostringarray
) {
1293 foreach ($contexts as $context) {
1294 switch ($context->contextlevel
) {
1295 case CONTEXT_MODULE
:
1296 $contextstring = 'module';
1298 case CONTEXT_COURSE
:
1299 $contextstring = 'course';
1301 case CONTEXT_COURSECAT
:
1302 $contextstring = "cat$catno";
1305 case CONTEXT_SYSTEM
:
1306 $contextstring = 'system';
1309 $this->contexttostringarray
[$context->id
] = $contextstring;
1317 * Check capability on category
1319 * @param mixed $question object or id
1320 * @param string $cap 'add', 'edit', 'view', 'use', 'move'
1321 * @param integer $cachecat useful to cache all question records in a category
1322 * @return boolean this user has the capability $cap for this question $question?
1324 function question_has_capability_on($question, $cap, $cachecat = -1) {
1327 // these are capabilities on existing questions capabilties are
1328 //set per category. Each of these has a mine and all version. Append 'mine' and 'all'
1329 $question_questioncaps = array('edit', 'view', 'use', 'move');
1330 static $questions = array();
1331 static $categories = array();
1332 static $cachedcat = array();
1333 if ($cachecat != -1 && array_search($cachecat, $cachedcat) === false) {
1334 $questions +
= $DB->get_records('question', array('category' => $cachecat));
1335 $cachedcat[] = $cachecat;
1337 if (!is_object($question)) {
1338 if (!isset($questions[$question])) {
1339 if (!$questions[$question] = $DB->get_record('question',
1340 array('id' => $question), 'id,category,createdby')) {
1341 print_error('questiondoesnotexist', 'question');
1344 $question = $questions[$question];
1346 if (empty($question->category
)) {
1347 // This can happen when we have created a fake 'missingtype' question to
1348 // take the place of a deleted question.
1351 if (!isset($categories[$question->category
])) {
1352 if (!$categories[$question->category
] = $DB->get_record('question_categories',
1353 array('id'=>$question->category
))) {
1354 print_error('invalidcategory', 'quiz');
1357 $category = $categories[$question->category
];
1358 $context = get_context_instance_by_id($category->contextid
);
1360 if (array_search($cap, $question_questioncaps)!== false) {
1361 if (!has_capability('moodle/question:' . $cap . 'all', $context)) {
1362 if ($question->createdby
== $USER->id
) {
1363 return has_capability('moodle/question:' . $cap . 'mine', $context);
1371 return has_capability('moodle/question:' . $cap, $context);
1377 * Require capability on question.
1379 function question_require_capability_on($question, $cap) {
1380 if (!question_has_capability_on($question, $cap)) {
1381 print_error('nopermissions', '', '', $cap);
1387 * Get the real state - the correct question id and answer - for a random
1389 * @param object $state with property answer.
1390 * @return mixed return integer real question id or false if there was an
1393 function question_get_real_state($state) {
1395 $realstate = clone($state);
1397 if (!preg_match('|^random([0-9]+)-(.*)|', $state->answer
, $matches)) {
1398 echo $OUTPUT->notification(get_string('errorrandom', 'quiz_statistics'));
1401 $realstate->question
= $matches[1];
1402 $realstate->answer
= $matches[2];
1408 * @param object $context a context
1409 * @return string A URL for editing questions in this context.
1411 function question_edit_url($context) {
1413 if (!has_any_capability(question_get_question_capabilities(), $context)) {
1416 $baseurl = $CFG->wwwroot
. '/question/edit.php?';
1417 $defaultcategory = question_get_default_category($context->id
);
1418 if ($defaultcategory) {
1419 $baseurl .= 'cat=' . $defaultcategory->id
. ',' . $context->id
. '&';
1421 switch ($context->contextlevel
) {
1422 case CONTEXT_SYSTEM
:
1423 return $baseurl . 'courseid=' . $SITE->id
;
1424 case CONTEXT_COURSECAT
:
1425 // This is nasty, becuase we can only edit questions in a course
1426 // context at the moment, so for now we just return false.
1428 case CONTEXT_COURSE
:
1429 return $baseurl . 'courseid=' . $context->instanceid
;
1430 case CONTEXT_MODULE
:
1431 return $baseurl . 'cmid=' . $context->instanceid
;
1437 * Adds question bank setting links to the given navigation node if caps are met.
1439 * @param navigation_node $navigationnode The navigation node to add the question branch to
1440 * @param object $context
1441 * @return navigation_node Returns the question branch that was added
1443 function question_extend_settings_navigation(navigation_node
$navigationnode, $context) {
1446 if ($context->contextlevel
== CONTEXT_COURSE
) {
1447 $params = array('courseid'=>$context->instanceid
);
1448 } else if ($context->contextlevel
== CONTEXT_MODULE
) {
1449 $params = array('cmid'=>$context->instanceid
);
1454 if (($cat = $PAGE->url
->param('cat')) && preg_match('~\d+,\d+~', $cat)) {
1455 $params['cat'] = $cat;
1458 $questionnode = $navigationnode->add(get_string('questionbank', 'question'),
1459 new moodle_url('/question/edit.php', $params), navigation_node
::TYPE_CONTAINER
);
1461 $contexts = new question_edit_contexts($context);
1462 if ($contexts->have_one_edit_tab_cap('questions')) {
1463 $questionnode->add(get_string('questions', 'quiz'), new moodle_url(
1464 '/question/edit.php', $params), navigation_node
::TYPE_SETTING
);
1466 if ($contexts->have_one_edit_tab_cap('categories')) {
1467 $questionnode->add(get_string('categories', 'quiz'), new moodle_url(
1468 '/question/category.php', $params), navigation_node
::TYPE_SETTING
);
1470 if ($contexts->have_one_edit_tab_cap('import')) {
1471 $questionnode->add(get_string('import', 'quiz'), new moodle_url(
1472 '/question/import.php', $params), navigation_node
::TYPE_SETTING
);
1474 if ($contexts->have_one_edit_tab_cap('export')) {
1475 $questionnode->add(get_string('export', 'quiz'), new moodle_url(
1476 '/question/export.php', $params), navigation_node
::TYPE_SETTING
);
1479 return $questionnode;
1483 * @return array all the capabilities that relate to accessing particular questions.
1485 function question_get_question_capabilities() {
1487 'moodle/question:add',
1488 'moodle/question:editmine',
1489 'moodle/question:editall',
1490 'moodle/question:viewmine',
1491 'moodle/question:viewall',
1492 'moodle/question:usemine',
1493 'moodle/question:useall',
1494 'moodle/question:movemine',
1495 'moodle/question:moveall',
1500 * @return array all the question bank capabilities.
1502 function question_get_all_capabilities() {
1503 $caps = question_get_question_capabilities();
1504 $caps[] = 'moodle/question:managecategory';
1505 $caps[] = 'moodle/question:flag';
1509 class question_edit_contexts
{
1511 public static $caps = array(
1512 'editq' => array('moodle/question:add',
1513 'moodle/question:editmine',
1514 'moodle/question:editall',
1515 'moodle/question:viewmine',
1516 'moodle/question:viewall',
1517 'moodle/question:usemine',
1518 'moodle/question:useall',
1519 'moodle/question:movemine',
1520 'moodle/question:moveall'),
1521 'questions'=>array('moodle/question:add',
1522 'moodle/question:editmine',
1523 'moodle/question:editall',
1524 'moodle/question:viewmine',
1525 'moodle/question:viewall',
1526 'moodle/question:movemine',
1527 'moodle/question:moveall'),
1528 'categories'=>array('moodle/question:managecategory'),
1529 'import'=>array('moodle/question:add'),
1530 'export'=>array('moodle/question:viewall', 'moodle/question:viewmine'));
1532 protected $allcontexts;
1535 * @param current context
1537 public function __construct($thiscontext) {
1538 $pcontextids = get_parent_contexts($thiscontext);
1539 $contexts = array($thiscontext);
1540 foreach ($pcontextids as $pcontextid) {
1541 $contexts[] = get_context_instance_by_id($pcontextid);
1543 $this->allcontexts
= $contexts;
1546 * @return array all parent contexts
1548 public function all() {
1549 return $this->allcontexts
;
1552 * @return object lowest context which must be either the module or course context
1554 public function lowest() {
1555 return $this->allcontexts
[0];
1558 * @param string $cap capability
1559 * @return array parent contexts having capability, zero based index
1561 public function having_cap($cap) {
1562 $contextswithcap = array();
1563 foreach ($this->allcontexts
as $context) {
1564 if (has_capability($cap, $context)) {
1565 $contextswithcap[] = $context;
1568 return $contextswithcap;
1571 * @param array $caps capabilities
1572 * @return array parent contexts having at least one of $caps, zero based index
1574 public function having_one_cap($caps) {
1575 $contextswithacap = array();
1576 foreach ($this->allcontexts
as $context) {
1577 foreach ($caps as $cap) {
1578 if (has_capability($cap, $context)) {
1579 $contextswithacap[] = $context;
1580 break; //done with caps loop
1584 return $contextswithacap;
1587 * @param string $tabname edit tab name
1588 * @return array parent contexts having at least one of $caps, zero based index
1590 public function having_one_edit_tab_cap($tabname) {
1591 return $this->having_one_cap(self
::$caps[$tabname]);
1594 * Has at least one parent context got the cap $cap?
1596 * @param string $cap capability
1599 public function have_cap($cap) {
1600 return (count($this->having_cap($cap)));
1604 * Has at least one parent context got one of the caps $caps?
1606 * @param array $caps capability
1609 public function have_one_cap($caps) {
1610 foreach ($caps as $cap) {
1611 if ($this->have_cap($cap)) {
1619 * Has at least one parent context got one of the caps for actions on $tabname
1621 * @param string $tabname edit tab name
1624 public function have_one_edit_tab_cap($tabname) {
1625 return $this->have_one_cap(self
::$caps[$tabname]);
1629 * Throw error if at least one parent context hasn't got the cap $cap
1631 * @param string $cap capability
1633 public function require_cap($cap) {
1634 if (!$this->have_cap($cap)) {
1635 print_error('nopermissions', '', '', $cap);
1640 * Throw error if at least one parent context hasn't got one of the caps $caps
1642 * @param array $cap capabilities
1644 public function require_one_cap($caps) {
1645 if (!$this->have_one_cap($caps)) {
1646 $capsstring = join($caps, ', ');
1647 print_error('nopermissions', '', '', $capsstring);
1652 * Throw error if at least one parent context hasn't got one of the caps $caps
1654 * @param string $tabname edit tab name
1656 public function require_one_edit_tab_cap($tabname) {
1657 if (!$this->have_one_edit_tab_cap($tabname)) {
1658 print_error('nopermissions', '', '', 'access question edit tab '.$tabname);
1664 * Rewrite question url, file_rewrite_pluginfile_urls always build url by
1665 * $file/$contextid/$component/$filearea/$itemid/$pathname_in_text, so we cannot add
1666 * extra questionid and attempted in url by it, so we create quiz_rewrite_question_urls
1669 * @param string $text text being processed
1670 * @param string $file the php script used to serve files
1671 * @param int $contextid
1672 * @param string $component component
1673 * @param string $filearea filearea
1674 * @param array $ids other IDs will be used to check file permission
1675 * @param int $itemid
1676 * @param array $options
1679 function question_rewrite_question_urls($text, $file, $contextid, $component,
1680 $filearea, array $ids, $itemid, array $options=null) {
1683 $options = (array)$options;
1684 if (!isset($options['forcehttps'])) {
1685 $options['forcehttps'] = false;
1688 if (!$CFG->slasharguments
) {
1689 $file = $file . '?file=';
1692 $baseurl = "$CFG->wwwroot/$file/$contextid/$component/$filearea/";
1695 $baseurl .= (implode('/', $ids) . '/');
1698 if ($itemid !== null) {
1699 $baseurl .= "$itemid/";
1702 if ($options['forcehttps']) {
1703 $baseurl = str_replace('http://', 'https://', $baseurl);
1706 return str_replace('@@PLUGINFILE@@/', $baseurl, $text);
1710 * Called by pluginfile.php to serve files related to the 'question' core
1711 * component and for files belonging to qtypes.
1713 * For files that relate to questions in a question_attempt, then we delegate to
1714 * a function in the component that owns the attempt (for example in the quiz,
1715 * or in core question preview) to get necessary inforation.
1717 * (Note that, at the moment, all question file areas relate to questions in
1718 * attempts, so the If at the start of the last paragraph is always true.)
1720 * Does not return, either calls send_file_not_found(); or serves the file.
1722 * @param object $course course settings object
1723 * @param object $context context object
1724 * @param string $component the name of the component we are serving files for.
1725 * @param string $filearea the name of the file area.
1726 * @param array $args the remaining bits of the file path.
1727 * @param bool $forcedownload whether the user must be forced to download the file.
1729 function question_pluginfile($course, $context, $component, $filearea, $args, $forcedownload) {
1732 list($context, $course, $cm) = get_context_info_array($context->id
);
1733 require_login($course, false, $cm);
1735 if ($filearea === 'export') {
1736 require_once($CFG->dirroot
. '/question/editlib.php');
1737 $contexts = new question_edit_contexts($context);
1738 // check export capability
1739 $contexts->require_one_edit_tab_cap('export');
1740 $category_id = (int)array_shift($args);
1741 $format = array_shift($args);
1742 $cattofile = array_shift($args);
1743 $contexttofile = array_shift($args);
1744 $filename = array_shift($args);
1746 // load parent class for import/export
1747 require_once($CFG->dirroot
. '/question/format.php');
1748 require_once($CFG->dirroot
. '/question/editlib.php');
1749 require_once($CFG->dirroot
. '/question/format/' . $format . '/format.php');
1751 $classname = 'qformat_' . $format;
1752 if (!class_exists($classname)) {
1753 send_file_not_found();
1756 $qformat = new $classname();
1758 if (!$category = $DB->get_record('question_categories', array('id' => $category_id))) {
1759 send_file_not_found();
1762 $qformat->setCategory($category);
1763 $qformat->setContexts($contexts->having_one_edit_tab_cap('export'));
1764 $qformat->setCourse($course);
1766 if ($cattofile == 'withcategories') {
1767 $qformat->setCattofile(true);
1769 $qformat->setCattofile(false);
1772 if ($contexttofile == 'withcontexts') {
1773 $qformat->setContexttofile(true);
1775 $qformat->setContexttofile(false);
1778 if (!$qformat->exportpreprocess()) {
1779 send_file_not_found();
1780 print_error('exporterror', 'question', $thispageurl->out());
1783 // export data to moodle file pool
1784 if (!$content = $qformat->exportprocess(true)) {
1785 send_file_not_found();
1788 send_file($content, $filename, 0, 0, true, true, $qformat->mime_type());
1791 $qubaid = (int)array_shift($args);
1792 $slot = (int)array_shift($args);
1794 $module = $DB->get_field('question_usages', 'component',
1795 array('id' => $qubaid));
1797 if ($module === 'core_question_preview') {
1798 require_once($CFG->dirroot
. '/question/previewlib.php');
1799 return question_preview_question_pluginfile($course, $context,
1800 $component, $filearea, $qubaid, $slot, $args, $forcedownload);
1803 $dir = get_component_directory($module);
1804 if (!file_exists("$dir/lib.php")) {
1805 send_file_not_found();
1807 include_once("$dir/lib.php");
1809 $filefunction = $module . '_question_pluginfile';
1810 if (!function_exists($filefunction)) {
1811 send_file_not_found();
1814 $filefunction($course, $context, $component, $filearea, $qubaid, $slot,
1815 $args, $forcedownload);
1817 send_file_not_found();
1822 * Create url for question export
1824 * @param int $contextid, current context
1825 * @param int $categoryid, categoryid
1826 * @param string $format
1827 * @param string $withcategories
1828 * @param string $ithcontexts
1829 * @param moodle_url export file url
1831 function question_make_export_url($contextid, $categoryid, $format, $withcategories,
1832 $withcontexts, $filename) {
1834 $urlbase = "$CFG->httpswwwroot/pluginfile.php";
1835 return moodle_url
::make_file_url($urlbase,
1836 "/$contextid/question/export/{$categoryid}/{$format}/{$withcategories}" .
1837 "/{$withcontexts}/{$filename}", true);
1841 * Return a list of page types
1842 * @param string $pagetype current page type
1843 * @param stdClass $parentcontext Block's parent context
1844 * @param stdClass $currentcontext Current context of block
1846 function question_page_type_list($pagetype, $parentcontext, $currentcontext) {
1849 'question-*'=>get_string('page-question-x', 'question'),
1850 'question-edit'=>get_string('page-question-edit', 'question'),
1851 'question-category'=>get_string('page-question-category', 'question'),
1852 'question-export'=>get_string('page-question-export', 'question'),
1853 'question-import'=>get_string('page-question-import', 'question')
1855 if ($currentcontext->contextlevel
== CONTEXT_COURSE
) {
1856 require_once($CFG->dirroot
. '/course/lib.php');
1857 return array_merge(course_page_type_list($pagetype, $parentcontext, $currentcontext), $types);