Merge branch 'MDL-70067-310_theme_classic' of https://github.com/alexmorrisnz/moodle...
[moodle.git] / question / question.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Page for editing questions.
19  *
20  * @package    moodlecore
21  * @subpackage questionbank
22  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 require_once(__DIR__ . '/../config.php');
28 require_once(__DIR__ . '/editlib.php');
29 require_once($CFG->libdir . '/filelib.php');
30 require_once($CFG->libdir . '/formslib.php');
32 // Read URL parameters telling us which question to edit.
33 $id = optional_param('id', 0, PARAM_INT); // question id
34 $makecopy = optional_param('makecopy', 0, PARAM_BOOL);
35 $qtype = optional_param('qtype', '', PARAM_COMPONENT);
36 $categoryid = optional_param('category', 0, PARAM_INT);
37 $cmid = optional_param('cmid', 0, PARAM_INT);
38 $courseid = optional_param('courseid', 0, PARAM_INT);
39 $wizardnow = optional_param('wizardnow', '', PARAM_ALPHA);
40 $originalreturnurl = optional_param('returnurl', 0, PARAM_LOCALURL);
41 $appendqnumstring = optional_param('appendqnumstring', '', PARAM_ALPHA);
42 $inpopup = optional_param('inpopup', 0, PARAM_BOOL);
43 $scrollpos = optional_param('scrollpos', 0, PARAM_INT);
45 $url = new moodle_url('/question/question.php');
46 if ($id !== 0) {
47     $url->param('id', $id);
48 }
49 if ($makecopy) {
50     $url->param('makecopy', $makecopy);
51 }
52 if ($qtype !== '') {
53     $url->param('qtype', $qtype);
54 }
55 if ($categoryid !== 0) {
56     $url->param('category', $categoryid);
57 }
58 if ($cmid !== 0) {
59     $url->param('cmid', $cmid);
60 }
61 if ($courseid !== 0) {
62     $url->param('courseid', $courseid);
63 }
64 if ($wizardnow !== '') {
65     $url->param('wizardnow', $wizardnow);
66 }
67 if ($originalreturnurl !== 0) {
68     $url->param('returnurl', $originalreturnurl);
69 }
70 if ($appendqnumstring !== '') {
71     $url->param('appendqnumstring', $appendqnumstring);
72 }
73 if ($inpopup !== 0) {
74     $url->param('inpopup', $inpopup);
75 }
76 if ($scrollpos) {
77     $url->param('scrollpos', $scrollpos);
78 }
79 $PAGE->set_url($url);
81 if ($cmid) {
82     $questionbankurl = new moodle_url('/question/edit.php', array('cmid' => $cmid));
83 } else {
84     $questionbankurl = new moodle_url('/question/edit.php', array('courseid' => $courseid));
85 }
86 navigation_node::override_active_url($questionbankurl);
88 if ($originalreturnurl) {
89     if (strpos($originalreturnurl, '/') !== 0) {
90         throw new coding_exception("returnurl must be a local URL starting with '/'. $originalreturnurl was given.");
91     }
92     $returnurl = new moodle_url($originalreturnurl);
93 } else {
94     $returnurl = $questionbankurl;
95 }
96 if ($scrollpos) {
97     $returnurl->param('scrollpos', $scrollpos);
98 }
100 if ($cmid){
101     list($module, $cm) = get_module_from_cmid($cmid);
102     require_login($cm->course, false, $cm);
103     $thiscontext = context_module::instance($cmid);
104 } elseif ($courseid) {
105     require_login($courseid, false);
106     $thiscontext = context_course::instance($courseid);
107     $module = null;
108     $cm = null;
109 } else {
110     print_error('missingcourseorcmid', 'question');
112 $contexts = new question_edit_contexts($thiscontext);
113 $PAGE->set_pagelayout('admin');
115 if (optional_param('addcancel', false, PARAM_BOOL)) {
116     redirect($returnurl);
119 if ($id) {
120     if (!$question = $DB->get_record('question', array('id' => $id))) {
121         print_error('questiondoesnotexist', 'question', $returnurl);
122     }
123     // We can use $COURSE here because it's been initialised as part of the
124     // require_login above. Passing it as the third parameter tells the function
125     // to filter the course tags by that course.
126     get_question_options($question, true, [$COURSE]);
128 } else if ($categoryid && $qtype) { // only for creating new questions
129     $question = new stdClass();
130     $question->category = $categoryid;
131     $question->qtype = $qtype;
132     $question->createdby = $USER->id;
134     // Check that users are allowed to create this question type at the moment.
135     if (!question_bank::qtype_enabled($qtype)) {
136         print_error('cannotenable', 'question', $returnurl, $qtype);
137     }
139 } else if ($categoryid) {
140     // Category, but no qtype. They probably came from the addquestion.php
141     // script without choosing a question type. Send them back.
142     $addurl = new moodle_url('/question/addquestion.php', $url->params());
143     $addurl->param('validationerror', 1);
144     redirect($addurl);
146 } else {
147     print_error('notenoughdatatoeditaquestion', 'question', $returnurl);
150 $qtypeobj = question_bank::get_qtype($question->qtype);
152 if (isset($question->categoryobject)) {
153     $category = $question->categoryobject;
154 } else {
155     // Validate the question category.
156     if (!$category = $DB->get_record('question_categories', array('id' => $question->category))) {
157         print_error('categorydoesnotexist', 'question', $returnurl);
158     }
161 // Check permissions
162 $question->formoptions = new stdClass();
164 $categorycontext = context::instance_by_id($category->contextid);
165 $question->contextid = $category->contextid;
166 $addpermission = has_capability('moodle/question:add', $categorycontext);
168 if ($id) {
169     $question->formoptions->canedit = question_has_capability_on($question, 'edit');
170     $question->formoptions->canmove = $addpermission && question_has_capability_on($question, 'move');
171     $question->formoptions->cansaveasnew = $addpermission &&
172             (question_has_capability_on($question, 'view') || $question->formoptions->canedit);
173     $question->formoptions->repeatelements = $question->formoptions->canedit || $question->formoptions->cansaveasnew;
174     $formeditable =  $question->formoptions->canedit || $question->formoptions->cansaveasnew || $question->formoptions->canmove;
175     if (!$formeditable) {
176         question_require_capability_on($question, 'view');
177     }
178     if ($makecopy) {
179         // If we are duplicating a question, add some indication to the question name.
180         $question->name = get_string('questionnamecopy', 'question', $question->name);
181         $question->idnumber = core_question_find_next_unused_idnumber($question->idnumber, $category->id);
182         $question->beingcopied = true;
183     }
185 } else  { // creating a new question
186     $question->formoptions->canedit = question_has_capability_on($question, 'edit');
187     $question->formoptions->canmove = (question_has_capability_on($question, 'move') && $addpermission);
188     $question->formoptions->cansaveasnew = false;
189     $question->formoptions->repeatelements = true;
190     $formeditable = true;
191     require_capability('moodle/question:add', $categorycontext);
193 $question->formoptions->mustbeusable = (bool) $appendqnumstring;
195 // Validate the question type.
196 $PAGE->set_pagetype('question-type-' . $question->qtype);
198 // Create the question editing form.
199 if ($wizardnow !== '') {
200     $mform = $qtypeobj->next_wizard_form('question.php', $question, $wizardnow, $formeditable);
201 } else {
202     $mform = $qtypeobj->create_editing_form('question.php', $question, $category, $contexts, $formeditable);
204 $toform = fullclone($question); // send the question object and a few more parameters to the form
205 $toform->category = "{$category->id},{$category->contextid}";
206 $toform->scrollpos = $scrollpos;
207 if ($formeditable && $id){
208     $toform->categorymoveto = $toform->category;
211 $toform->appendqnumstring = $appendqnumstring;
212 $toform->returnurl = $originalreturnurl;
213 $toform->makecopy = $makecopy;
214 if ($cm !== null){
215     $toform->cmid = $cm->id;
216     $toform->courseid = $cm->course;
217 } else {
218     $toform->courseid = $COURSE->id;
221 $toform->inpopup = $inpopup;
223 $mform->set_data($toform);
225 if ($mform->is_cancelled()) {
226     if ($inpopup) {
227         close_window();
228     } else {
229         redirect($returnurl);
230     }
232 } else if ($fromform = $mform->get_data()) {
233     // If we are saving as a copy, break the connection to the old question.
234     if ($makecopy) {
235         $question->id = 0;
236         $question->hidden = 0; // Copies should not be hidden.
237     }
239     /// Process the combination of usecurrentcat, categorymoveto and category form
240     /// fields, so the save_question method only has to consider $fromform->category
241     if (!empty($fromform->usecurrentcat)) {
242         // $fromform->category is the right category to save in.
243     } else {
244         if (!empty($fromform->categorymoveto)) {
245             $fromform->category = $fromform->categorymoveto;
246         } else {
247             // $fromform->category is the right category to save in.
248         }
249     }
251     /// If we are moving a question, check we have permission to move it from
252     /// whence it came. (Where we are moving to is validated by the form.)
253     list($newcatid, $newcontextid) = explode(',', $fromform->category);
254     if (!empty($question->id) && $newcatid != $question->category) {
255         $contextid = $newcontextid;
256         question_require_capability_on($question, 'move');
257     } else {
258         $contextid = $category->contextid;
259     }
261     // Ensure we redirect back to the category the question is being saved into.
262     $returnurl->param('category', $fromform->category);
264     // We are actually saving the question.
265     if (!empty($question->id)) {
266         question_require_capability_on($question, 'edit');
267     } else {
268         require_capability('moodle/question:add', context::instance_by_id($contextid));
269         if (!empty($fromform->makecopy) && !$question->formoptions->cansaveasnew) {
270             print_error('nopermissions', '', '', 'edit');
271         }
272     }
274     $question = $qtypeobj->save_question($question, $fromform);
275     if (isset($fromform->tags)) {
276         // If we have any question context level tags then set those tags now.
277         core_tag_tag::set_item_tags('core_question', 'question', $question->id,
278                 context::instance_by_id($contextid), $fromform->tags, 0);
279     }
281     if (isset($fromform->coursetags)) {
282         // If we have and course context level tags then set those now.
283         core_tag_tag::set_item_tags('core_question', 'question', $question->id,
284                 context_course::instance($fromform->courseid), $fromform->coursetags, 0);
285     }
287     // Purge this question from the cache.
288     question_bank::notify_question_edited($question->id);
290     // If we are saving and continuing to edit the question.
291     if (!empty($fromform->updatebutton)) {
292         $url->param('id', $question->id);
293         $url->remove_params('makecopy');
294         redirect($url);
295     }
297     if ($qtypeobj->finished_edit_wizard($fromform)) {
298         if ($inpopup) {
299             echo $OUTPUT->notification(get_string('changessaved'), '');
300             close_window(3);
301         } else {
302             $returnurl->param('lastchanged', $question->id);
303             if ($appendqnumstring) {
304                 $returnurl->param($appendqnumstring, $question->id);
305                 $returnurl->param('sesskey', sesskey());
306                 $returnurl->param('cmid', $cmid);
307             }
308             redirect($returnurl);
309         }
311     } else {
312         $nexturlparams = array(
313                 'returnurl' => $originalreturnurl,
314                 'appendqnumstring' => $appendqnumstring,
315                 'scrollpos' => $scrollpos);
316         if (isset($fromform->nextpageparam) && is_array($fromform->nextpageparam)){
317             //useful for passing data to the next page which is not saved in the database.
318             $nexturlparams += $fromform->nextpageparam;
319         }
320         $nexturlparams['id'] = $question->id;
321         $nexturlparams['wizardnow'] = $fromform->wizard;
322         $nexturl = new moodle_url('/question/question.php', $nexturlparams);
323         if ($cmid){
324             $nexturl->param('cmid', $cmid);
325         } else {
326             $nexturl->param('courseid', $COURSE->id);
327         }
328         redirect($nexturl);
329     }
333 $streditingquestion = $qtypeobj->get_heading();
334 $PAGE->set_title($streditingquestion);
335 $PAGE->set_heading($COURSE->fullname);
336 $PAGE->navbar->add($streditingquestion);
338 // Display a heading, question editing form and possibly some extra content needed for
339 // for this question type.
340 echo $OUTPUT->header();
341 $qtypeobj->display_question_editing_page($mform, $question, $wizardnow);
342 echo $OUTPUT->footer();