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/>.
  16
  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  */
  25
  26
  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');
  31
  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);
  44
  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);
  80
  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);
  87
  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 }
  99
 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');
 111 }
 112 $contexts = new question_edit_contexts($thiscontext);
 113 $PAGE->set_pagelayout('admin');
 114
 115 if (optional_param('addcancel', false, PARAM_BOOL)) {
 116     redirect($returnurl);
 117 }
 118
 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]);
 127
 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;
 133
 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     }
 138
 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);
 145
 146 } else {
 147     print_error('notenoughdatatoeditaquestion', 'question', $returnurl);
 148 }
 149
 150 $qtypeobj = question_bank::get_qtype($question->qtype);
 151
 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     }
 159 }
 160
 161 // Check permissions
 162 $question->formoptions = new stdClass();
 163
 164 $categorycontext = context::instance_by_id($category->contextid);
 165 $question->contextid = $category->contextid;
 166 $addpermission = has_capability('moodle/question:add', $categorycontext);
 167
 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->beingcopied = true;
 182     }
 183
 184 } else  { // creating a new question
 185     $question->formoptions->canedit = question_has_capability_on($question, 'edit');
 186     $question->formoptions->canmove = (question_has_capability_on($question, 'move') && $addpermission);
 187     $question->formoptions->cansaveasnew = false;
 188     $question->formoptions->repeatelements = true;
 189     $formeditable = true;
 190     require_capability('moodle/question:add', $categorycontext);
 191 }
 192 $question->formoptions->mustbeusable = (bool) $appendqnumstring;
 193
 194 // Validate the question type.
 195 $PAGE->set_pagetype('question-type-' . $question->qtype);
 196
 197 // Create the question editing form.
 198 if ($wizardnow !== '') {
 199     $mform = $qtypeobj->next_wizard_form('question.php', $question, $wizardnow, $formeditable);
 200 } else {
 201     $mform = $qtypeobj->create_editing_form('question.php', $question, $category, $contexts, $formeditable);
 202 }
 203 $toform = fullclone($question); // send the question object and a few more parameters to the form
 204 $toform->category = "{$category->id},{$category->contextid}";
 205 $toform->scrollpos = $scrollpos;
 206 if ($formeditable && $id){
 207     $toform->categorymoveto = $toform->category;
 208 }
 209
 210 $toform->appendqnumstring = $appendqnumstring;
 211 $toform->returnurl = $originalreturnurl;
 212 $toform->makecopy = $makecopy;
 213 if ($cm !== null){
 214     $toform->cmid = $cm->id;
 215     $toform->courseid = $cm->course;
 216 } else {
 217     $toform->courseid = $COURSE->id;
 218 }
 219
 220 $toform->inpopup = $inpopup;
 221
 222 $mform->set_data($toform);
 223
 224 if ($mform->is_cancelled()) {
 225     if ($inpopup) {
 226         close_window();
 227     } else {
 228         redirect($returnurl);
 229     }
 230
 231 } else if ($fromform = $mform->get_data()) {
 232     // If we are saving as a copy, break the connection to the old question.
 233     if ($makecopy) {
 234         $question->id = 0;
 235         $question->hidden = 0; // Copies should not be hidden.
 236     }
 237
 238     /// Process the combination of usecurrentcat, categorymoveto and category form
 239     /// fields, so the save_question method only has to consider $fromform->category
 240     if (!empty($fromform->usecurrentcat)) {
 241         // $fromform->category is the right category to save in.
 242     } else {
 243         if (!empty($fromform->categorymoveto)) {
 244             $fromform->category = $fromform->categorymoveto;
 245         } else {
 246             // $fromform->category is the right category to save in.
 247         }
 248     }
 249
 250     /// If we are moving a question, check we have permission to move it from
 251     /// whence it came. (Where we are moving to is validated by the form.)
 252     list($newcatid, $newcontextid) = explode(',', $fromform->category);
 253     if (!empty($question->id) && $newcatid != $question->category) {
 254         $contextid = $newcontextid;
 255         question_require_capability_on($question, 'move');
 256     } else {
 257         $contextid = $category->contextid;
 258     }
 259
 260     // Ensure we redirect back to the category the question is being saved into.
 261     $returnurl->param('category', $fromform->category);
 262
 263     // We are acutally saving the question.
 264     if (!empty($question->id)) {
 265         question_require_capability_on($question, 'edit');
 266     } else {
 267         require_capability('moodle/question:add', context::instance_by_id($contextid));
 268         if (!empty($fromform->makecopy) && !$question->formoptions->cansaveasnew) {
 269             print_error('nopermissions', '', '', 'edit');
 270         }
 271     }
 272
 273     $question = $qtypeobj->save_question($question, $fromform);
 274     if (isset($fromform->tags)) {
 275         // If we have any question context level tags then set those tags now.
 276         core_tag_tag::set_item_tags('core_question', 'question', $question->id,
 277                 context::instance_by_id($contextid), $fromform->tags, 0);
 278     }
 279
 280     if (isset($fromform->coursetags)) {
 281         // If we have and course context level tags then set those now.
 282         core_tag_tag::set_item_tags('core_question', 'question', $question->id,
 283                 context_course::instance($fromform->courseid), $fromform->coursetags, 0);
 284     }
 285
 286     // Purge this question from the cache.
 287     question_bank::notify_question_edited($question->id);
 288
 289     // If we are saving and continuing to edit the question.
 290     if (!empty($fromform->updatebutton)) {
 291         $url->param('id', $question->id);
 292         $url->remove_params('makecopy');
 293         redirect($url);
 294     }
 295
 296     if ($qtypeobj->finished_edit_wizard($fromform)) {
 297         if ($inpopup) {
 298             echo $OUTPUT->notification(get_string('changessaved'), '');
 299             close_window(3);
 300         } else {
 301             $returnurl->param('lastchanged', $question->id);
 302             if ($appendqnumstring) {
 303                 $returnurl->param($appendqnumstring, $question->id);
 304                 $returnurl->param('sesskey', sesskey());
 305                 $returnurl->param('cmid', $cmid);
 306             }
 307             redirect($returnurl);
 308         }
 309
 310     } else {
 311         $nexturlparams = array(
 312                 'returnurl' => $originalreturnurl,
 313                 'appendqnumstring' => $appendqnumstring,
 314                 'scrollpos' => $scrollpos);
 315         if (isset($fromform->nextpageparam) && is_array($fromform->nextpageparam)){
 316             //useful for passing data to the next page which is not saved in the database.
 317             $nexturlparams += $fromform->nextpageparam;
 318         }
 319         $nexturlparams['id'] = $question->id;
 320         $nexturlparams['wizardnow'] = $fromform->wizard;
 321         $nexturl = new moodle_url('/question/question.php', $nexturlparams);
 322         if ($cmid){
 323             $nexturl->param('cmid', $cmid);
 324         } else {
 325             $nexturl->param('courseid', $COURSE->id);
 326         }
 327         redirect($nexturl);
 328     }
 329
 330 }
 331
 332 $streditingquestion = $qtypeobj->get_heading();
 333 $PAGE->set_title($streditingquestion);
 334 $PAGE->set_heading($COURSE->fullname);
 335 $PAGE->navbar->add($streditingquestion);
 336
 337 // Display a heading, question editing form and possibly some extra content needed for
 338 // for this question type.
 339 echo $OUTPUT->header();
 340 $qtypeobj->display_question_editing_page($mform, $question, $wizardnow);
 341 echo $OUTPUT->footer();