MDL-16094 File storage conversion Quiz and Questions
[moodle.git] / question / question.php
1 <?php
2 /**
3  * Page for editing questions using the new form library.
4  *
5  * @author T.J.Hunt@open.ac.uk
6  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
7  * @package questionbank
8  *//** */
10 // Includes.
11 require_once(dirname(__FILE__) . '/../config.php');
12 require_once(dirname(__FILE__) . '/editlib.php');
13 require_once($CFG->libdir . '/filelib.php');
14 require_once($CFG->libdir . '/formslib.php');
16 // Read URL parameters telling us which question to edit.
17 $id = optional_param('id', 0, PARAM_INT); // question id
18 $qtype = optional_param('qtype', '', PARAM_FILE);
19 $categoryid = optional_param('category', 0, PARAM_INT);
20 $cmid = optional_param('cmid', 0, PARAM_INT);
21 $courseid = optional_param('courseid', 0, PARAM_INT);
22 $wizardnow = optional_param('wizardnow', '', PARAM_ALPHA);
23 $movecontext = optional_param('movecontext', 0, PARAM_BOOL); // Switch to make
24         // question uneditable - form is displayed to edit category only
25 $originalreturnurl = optional_param('returnurl', 0, PARAM_LOCALURL);
26 $appendqnumstring = optional_param('appendqnumstring', '', PARAM_ALPHA);
27 $inpopup = optional_param('inpopup', 0, PARAM_BOOL);
29 $url = new moodle_url('/question/question.php');
30 if ($id !== 0) {
31     $url->param('id', $id);
32 }
33 if ($qtype !== '') {
34     $url->param('qtype', $qtype);
35 }
36 if ($categoryid !== 0) {
37     $url->param('category', $categoryid);
38 }
39 if ($cmid !== 0) {
40     $url->param('cmid', $cmid);
41 }
42 if ($courseid !== 0) {
43     $url->param('courseid', $courseid);
44 }
45 if ($wizardnow !== '') {
46     $url->param('wizardnow', $wizardnow);
47 }
48 if ($movecontext !== 0) {
49     $url->param('movecontext', $movecontext);
50 }
51 if ($originalreturnurl !== 0) {
52     $url->param('returnurl', $originalreturnurl);
53 }
54 if ($appendqnumstring !== '') {
55     $url->param('appendqnumstring', $appendqnumstring);
56 }
57 if ($inpopup !== 0) {
58     $url->param('inpopup', $inpopup);
59 }
60 $PAGE->set_url($url);
62 if ($originalreturnurl) {
63     $returnurl = $CFG->wwwroot . '/' . $originalreturnurl;
64 } else {
65     $returnurl = "{$CFG->wwwroot}/question/edit.php?courseid={$COURSE->id}";
66 }
68 if ($movecontext && !$id){
69     print_error('questiondoesnotexist', 'question', $returnurl);
70 }
72 if ($cmid){
73     list($module, $cm) = get_module_from_cmid($cmid);
74     require_login($cm->course, false, $cm);
75     $thiscontext = get_context_instance(CONTEXT_MODULE, $cmid);
76 } elseif ($courseid) {
77     require_login($courseid, false);
78     $PAGE->set_pagelayout('course');
79     $thiscontext = get_context_instance(CONTEXT_COURSE, $courseid);
80     $module = null;
81     $cm = null;
82 } else {
83     print_error('missingcourseorcmid', 'question');
84 }
85 $contexts = new question_edit_contexts($thiscontext);
87 if (optional_param('addcancel', false, PARAM_BOOL)) {
88     redirect($returnurl);
89 }
91 if ($id) {
92     if (!$question = $DB->get_record('question', array('id' => $id))) {
93         print_error('questiondoesnotexist', 'question', $returnurl);
94     }
95     get_question_options($question, true);
97 } else if ($categoryid && $qtype) { // only for creating new questions
98     $question = new stdClass;
99     $question->category = $categoryid;
100     $question->qtype = $qtype;
102     // Check that users are allowed to create this question type at the moment.
103     $allowedtypes = question_type_menu();
104     if (!isset($allowedtypes[$qtype])) {
105         print_error('cannotenable', 'question', $returnurl, $qtype);
106     }
108 } else if ($categoryid) {
109     // Category, but no qtype. They probably came from the addquestion.php
110     // script without choosing a question type. Send them back.
111     $addurl = new moodle_url('/question/addquestion.php', $url->params());
112     $addurl->param('validationerror', 1);
113     redirect($addurl);
115 } else {
116     print_error('notenoughdatatoeditaquestion', 'question', $returnurl);
119 // Validate the question category.
120 if (!$category = $DB->get_record('question_categories', array('id' => $question->category))) {
121     print_error('categorydoesnotexist', 'question', $returnurl);
124 // Check permissions
125 $question->formoptions = new stdClass;
127 $categorycontext = get_context_instance_by_id($category->contextid);
128 $addpermission = has_capability('moodle/question:add', $categorycontext);
130 if ($id) {
131     $canview = question_has_capability_on($question, 'view');
132     if ($movecontext){
133         $question->formoptions->canedit = false;
134         $question->formoptions->canmove = (question_has_capability_on($question, 'move') && $contexts->have_cap('moodle/question:add'));
135         $question->formoptions->cansaveasnew = false;
136         $question->formoptions->repeatelements = false;
137         $question->formoptions->movecontext = true;
138         $formeditable = true;
139         question_require_capability_on($question, 'view');
140     } else {
141         $question->formoptions->canedit = question_has_capability_on($question, 'edit');
142         $question->formoptions->canmove = (question_has_capability_on($question, 'move') && $addpermission);
143         $question->formoptions->cansaveasnew = (($canview ||question_has_capability_on($question, 'edit')) && $addpermission);
144         $question->formoptions->repeatelements = ($question->formoptions->canedit || $question->formoptions->cansaveasnew);
145         $formeditable =  $question->formoptions->canedit || $question->formoptions->cansaveasnew || $question->formoptions->canmove;
146         $question->formoptions->movecontext = false;
147         if (!$formeditable){
148             question_require_capability_on($question, 'view');
149         }
150     }
152 } else  { // creating a new question
153     require_capability('moodle/question:add', $categorycontext);
154     $formeditable = true;
155     $question->formoptions->canedit = question_has_capability_on($question, 'edit');
156     $question->formoptions->canmove = (question_has_capability_on($question, 'move') && $addpermission);
157     $question->formoptions->repeatelements = true;
158     $question->formoptions->movecontext = false;
161 // Validate the question type.
162 if (!isset($QTYPES[$question->qtype])) {
163     print_error('unknownquestiontype', 'question', $returnurl, $question->qtype);
165 $PAGE->set_pagetype('question-type-' . $question->qtype);
167 // Create the question editing form.
168 if ($wizardnow!=='' && !$movecontext){
169     if (!method_exists($QTYPES[$question->qtype], 'next_wizard_form')){
170         print_error('missingimportantcode', 'question', $returnurl, 'wizard form definition');
171     } else {
172         $mform = $QTYPES[$question->qtype]->next_wizard_form('question.php', $question, $wizardnow, $formeditable);
173     }
174 } else {
175     $mform = $QTYPES[$question->qtype]->create_editing_form('question.php', $question, $category, $contexts, $formeditable);
177 if ($mform === null) {
178     print_error('missingimportantcode', 'question', $returnurl, 'question editing form definition for "'.$question->qtype.'"');
180 $toform = fullclone($question); // send the question object and a few more parameters to the form
181 $toform->category = "$category->id,$category->contextid";
182 if ($formeditable && $id){
183     $toform->categorymoveto = $toform->category;
186 $toform->appendqnumstring = $appendqnumstring;
187 $toform->returnurl = $originalreturnurl;
188 $toform->movecontext = $movecontext;
189 if ($cm !== null){
190     $toform->cmid = $cm->id;
191     $toform->courseid = $cm->course;
192 } else {
193     $toform->courseid = $COURSE->id;
196 $toform->inpopup = $inpopup;
198 $mform->set_data($toform);
200 if ($mform->is_cancelled()){
201     if ($inpopup) {
202         close_window();
203     } else {
204         $nexturl = new moodle_url($returnurl);
205         $nexturl->param('lastchanged', $question->id);
206         redirect($nexturl->out());
207     }
208 } elseif ($fromform = $mform->get_data()) {
209     /// If we are saving as a copy, break the connection to the old question.
210     if (!empty($fromform->makecopy)) {
211         $question->id = 0;
212         $question->hidden = 0; // Copies should not be hidden
213     }
215     /// Process the combination of usecurrentcat, categorymoveto and category form
216     /// fields, so the save_question method only has to consider $fromform->category
217     if (!empty($fromform->usecurrentcat)) {
218         // $fromform->category is the right category to save in.
219     } else {
220         if (!empty($fromform->categorymoveto)) {
221             $fromform->category = $fromform->categorymoveto;
222         } else {
223             // $fromform->category is the right category to save in.
224         }
225     }
227     /// If we are moving a question, check we have permission to move it from
228     /// whence it came. (Where we are moving to is validated by the form.)
229     list($newcatid) = explode(',', $fromform->category);
230     if (!empty($question->id) && $newcatid != $question->category) {
231         question_require_capability_on($question, 'move');
232     }
234     /// Ensure we redirect back to the category the question is being saved into.
235     $returnurl = new moodle_url($returnurl);
236     $returnurl->param('category', $fromform->category);
237     // TODO: it is sloppy to pass arounf full URLs through page parameters and some servers do not like that
238     $returnurl = $returnurl->out(false);
240     /// Call the appropriate method.
241     if ($movecontext) {
242         list($tocatid, $tocontextid) = explode(',', $fromform->categorymoveto);
243         $tocontext = get_context_instance_by_id($tocontextid);
244         require_capability('moodle/question:add', $tocontext);
245         if (get_filesdir_from_context($categorycontext) != get_filesdir_from_context($tocontext)){
246             $movecontexturl  = new moodle_url('/question/contextmoveq.php',
247                                             array('returnurl' => $returnurl,
248                                                     'ids'=>$question->id,
249                                                     'tocatid'=> $tocatid));
250             if ($cmid){
251                 $movecontexturl->param('cmid', $cmid);
252             } else {
253                 $movecontexturl->param('courseid', $COURSE->id);
254             }
255             redirect($movecontexturl);
256         }
257     }
259     $question = $QTYPES[$question->qtype]->save_question($question, $fromform, $COURSE, $wizardnow, true);
260     // a wizardpage from multipe pages questiontype like calculated may not allow editing the question tags
261     if (!empty($CFG->usetags) && isset($fromform->tags)) {
262         require_once($CFG->dirroot.'/tag/lib.php');
263         tag_set('question', $question->id, $fromform->tags);
264     }
266     if (($QTYPES[$question->qtype]->finished_edit_wizard($fromform)) || $movecontext){
267         if ($inpopup) {
268             echo $OUTPUT->notification(get_string('changessaved'), '');
269             close_window(3);
270         } else {
271             $nexturl = new moodle_url($returnurl);
272             $nexturl->param('lastchanged', $question->id);
273             if($appendqnumstring) {
274                 $nexturl->params(array($appendqnumstring=>($question->id), "sesskey"=>sesskey(), "cmid"=>$cmid));
275             }
276             redirect($nexturl);
277         }
278     } else {
279         $nexturlparams = array('returnurl'=>$returnurl, 'appendqnumstring'=>$appendqnumstring);
280         if (isset($fromform->nextpageparam) && is_array($fromform->nextpageparam)){
281             $nexturlparams += $fromform->nextpageparam;//useful for passing data to the next page which is not saved in the database
282         }
283         $nexturlparams['id'] = $question->id;
284         $nexturlparams['wizardnow'] = $fromform->wizard;
285         $nexturl = new moodle_url('question.php', $nexturlparams);
286         if ($cmid){
287             $nexturl->param('cmid', $cmid);
288         } else {
289             $nexturl->param('courseid', $COURSE->id);
290         }
291         redirect($nexturl);
292     }
293 } else {
295     $streditingquestion = $QTYPES[$question->qtype]->get_heading();
296     $PAGE->set_title($streditingquestion);
297     $PAGE->set_heading($COURSE->fullname);
298     if ($cm !== null) {
299         $strmodule = get_string('modulename', $cm->modname);
300         $streditingmodule = get_string('editinga', 'moodle', $strmodule);
301         $PAGE->navbar->add(get_string('modulenameplural', $cm->modname), new moodle_url('/mod/'.$cm->modname.'/index.php', array('id'=>$cm->course)));
302         $PAGE->navbar->add(format_string($module->name), new moodle_url('/mod/'.$cm->modname.'/view.php', array('id'=>$cm->id)));
303         if (stripos($returnurl, "$CFG->wwwroot/mod/{$cm->modname}/view.php")!== 0){
304             //don't need this link if returnurl returns to view.php
305             $PAGE->navbar->add($streditingmodule, $returnurl);
306         }
307         $PAGE->navbar->add($streditingquestion);
308         echo $OUTPUT->header();
310     } else {
311         $strediting = '<a href="edit.php?courseid='.$COURSE->id.'">'.get_string("editquestions", "quiz").'</a> -> '.$streditingquestion;
312         $PAGE->navbar->add(get_string('editquestions', "quiz"), $returnurl);
313         $PAGE->navbar->add($streditingquestion);
314         echo $OUTPUT->header();
315     }
317     // Display a heading, question editing form and possibly some extra content needed for
318     // for this question type.
319     $QTYPES[$question->qtype]->display_question_editing_page($mform, $question, $wizardnow);
320     echo $OUTPUT->footer();