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  *//** */
   9
  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');
  15
  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);
  28
  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);
  61
  62 if ($originalreturnurl) {
  63     $returnurl = $CFG->wwwroot . '/' . $originalreturnurl;
  64 } else {
  65     $returnurl = "{$CFG->wwwroot}/question/edit.php?courseid={$COURSE->id}";
  66 }
  67
  68 if ($movecontext && !$id){
  69     print_error('questiondoesnotexist', 'question', $returnurl);
  70 }
  71
  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);
  86
  87 if (optional_param('addcancel', false, PARAM_BOOL)) {
  88     redirect($returnurl);
  89 }
  90
  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);
  96
  97 } else if ($categoryid && $qtype) { // only for creating new questions
  98     $question = new stdClass;
  99     $question->category = $categoryid;
 100     $question->qtype = $qtype;
 101
 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     }
 107
 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);
 114
 115 } else {
 116     print_error('notenoughdatatoeditaquestion', 'question', $returnurl);
 117 }
 118
 119 // Validate the question category.
 120 if (!$category = $DB->get_record('question_categories', array('id' => $question->category))) {
 121     print_error('categorydoesnotexist', 'question', $returnurl);
 122 }
 123
 124 // Check permissions
 125 $question->formoptions = new stdClass;
 126
 127 $categorycontext = get_context_instance_by_id($category->contextid);
 128 $addpermission = has_capability('moodle/question:add', $categorycontext);
 129
 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     }
 151
 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;
 159 }
 160
 161 // Validate the question type.
 162 if (!isset($QTYPES[$question->qtype])) {
 163     print_error('unknownquestiontype', 'question', $returnurl, $question->qtype);
 164 }
 165 $PAGE->set_pagetype('question-type-' . $question->qtype);
 166
 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);
 176 }
 177 if ($mform === null) {
 178     print_error('missingimportantcode', 'question', $returnurl, 'question editing form definition for "'.$question->qtype.'"');
 179 }
 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;
 184 }
 185
 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;
 194 }
 195
 196 $toform->inpopup = $inpopup;
 197
 198 $mform->set_data($toform);
 199
 200 if ($mform->is_cancelled()){
 201     if ($inpopup) {
 202         close_window();
 203     } else {
 204         $nexturl = new moodle_url($returnurl);
 205         if (!empty($question->id)) {
 206             $nexturl->param('lastchanged', $question->id);
 207         }
 208         redirect($nexturl->out());
 209     }
 210 } elseif ($fromform = $mform->get_data()) {
 211     /// If we are saving as a copy, break the connection to the old question.
 212     if (!empty($fromform->makecopy)) {
 213         $question->id = 0;
 214         $question->hidden = 0; // Copies should not be hidden
 215     }
 216
 217     /// Process the combination of usecurrentcat, categorymoveto and category form
 218     /// fields, so the save_question method only has to consider $fromform->category
 219     if (!empty($fromform->usecurrentcat)) {
 220         // $fromform->category is the right category to save in.
 221     } else {
 222         if (!empty($fromform->categorymoveto)) {
 223             $fromform->category = $fromform->categorymoveto;
 224         } else {
 225             // $fromform->category is the right category to save in.
 226         }
 227     }
 228
 229     /// If we are moving a question, check we have permission to move it from
 230     /// whence it came. (Where we are moving to is validated by the form.)
 231     list($newcatid) = explode(',', $fromform->category);
 232     if (!empty($question->id) && $newcatid != $question->category) {
 233         question_require_capability_on($question, 'move');
 234     }
 235
 236     /// Ensure we redirect back to the category the question is being saved into.
 237     $returnurl = new moodle_url($returnurl);
 238     $returnurl->param('category', $fromform->category);
 239     // TODO: it is sloppy to pass arounf full URLs through page parameters and some servers do not like that
 240     $returnurl = $returnurl->out(false);
 241
 242     /// Call the appropriate method.
 243     if ($movecontext) {
 244         list($tocatid, $tocontextid) = explode(',', $fromform->categorymoveto);
 245         $tocontext = get_context_instance_by_id($tocontextid);
 246         require_capability('moodle/question:add', $tocontext);
 247         if (get_filesdir_from_context($categorycontext) != get_filesdir_from_context($tocontext)){
 248             $movecontexturl  = new moodle_url('/question/contextmoveq.php',
 249                                             array('returnurl' => $returnurl,
 250                                                     'ids'=>$question->id,
 251                                                     'tocatid'=> $tocatid));
 252             if ($cmid){
 253                 $movecontexturl->param('cmid', $cmid);
 254             } else {
 255                 $movecontexturl->param('courseid', $COURSE->id);
 256             }
 257             redirect($movecontexturl);
 258         }
 259     }
 260
 261     $question = $QTYPES[$question->qtype]->save_question($question, $fromform, $COURSE, $wizardnow, true);
 262     // a wizardpage from multipe pages questiontype like calculated may not allow editing the question tags
 263     if (!empty($CFG->usetags) && isset($fromform->tags)) {
 264         require_once($CFG->dirroot.'/tag/lib.php');
 265         tag_set('question', $question->id, $fromform->tags);
 266     }
 267
 268     if (($QTYPES[$question->qtype]->finished_edit_wizard($fromform)) || $movecontext){
 269         if ($inpopup) {
 270             echo $OUTPUT->notification(get_string('changessaved'), '');
 271             close_window(3);
 272         } else {
 273             $nexturl = new moodle_url($returnurl);
 274             $nexturl->param('lastchanged', $question->id);
 275             if($appendqnumstring) {
 276                 $nexturl->params(array($appendqnumstring=>($question->id), "sesskey"=>sesskey(), "cmid"=>$cmid));
 277             }
 278             redirect($nexturl);
 279         }
 280     } else {
 281         $nexturlparams = array('returnurl'=>$returnurl, 'appendqnumstring'=>$appendqnumstring);
 282         if (isset($fromform->nextpageparam) && is_array($fromform->nextpageparam)){
 283             $nexturlparams += $fromform->nextpageparam;//useful for passing data to the next page which is not saved in the database
 284         }
 285         $nexturlparams['id'] = $question->id;
 286         $nexturlparams['wizardnow'] = $fromform->wizard;
 287         $nexturl = new moodle_url('question.php', $nexturlparams);
 288         if ($cmid){
 289             $nexturl->param('cmid', $cmid);
 290         } else {
 291             $nexturl->param('courseid', $COURSE->id);
 292         }
 293         redirect($nexturl);
 294     }
 295 } else {
 296
 297     $streditingquestion = $QTYPES[$question->qtype]->get_heading();
 298     $PAGE->set_title($streditingquestion);
 299     $PAGE->set_heading($COURSE->fullname);
 300     if ($cm !== null) {
 301         $strmodule = get_string('modulename', $cm->modname);
 302         $streditingmodule = get_string('editinga', 'moodle', $strmodule);
 303         $PAGE->navbar->add(get_string('modulenameplural', $cm->modname), new moodle_url('/mod/'.$cm->modname.'/index.php', array('id'=>$cm->course)));
 304         $PAGE->navbar->add(format_string($module->name), new moodle_url('/mod/'.$cm->modname.'/view.php', array('id'=>$cm->id)));
 305         if (stripos($returnurl, "$CFG->wwwroot/mod/{$cm->modname}/view.php")!== 0){
 306             //don't need this link if returnurl returns to view.php
 307             $PAGE->navbar->add($streditingmodule, $returnurl);
 308         }
 309         $PAGE->navbar->add($streditingquestion);
 310         echo $OUTPUT->header();
 311
 312     } else {
 313         $strediting = '<a href="edit.php?courseid='.$COURSE->id.'">'.get_string("editquestions", "quiz").'</a> -> '.$streditingquestion;
 314         $PAGE->navbar->add(get_string('editquestions', "quiz"), $returnurl);
 315         $PAGE->navbar->add($streditingquestion);
 316         echo $OUTPUT->header();
 317     }
 318
 319     // Display a heading, question editing form and possibly some extra content needed for
 320     // for this question type.
 321     $QTYPES[$question->qtype]->display_question_editing_page($mform, $question, $wizardnow);
 322     echo $OUTPUT->footer();
 323 }
 324