Merge branch 'MDL-47132' of git://github.com/timhunt/moodle
[moodle.git] / mod / quiz / edit.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/>.
18 /**
19  * Page to edit quizzes
20  *
21  * This page generally has two columns:
22  * The right column lists all available questions in a chosen category and
23  * allows them to be edited or more to be added. This column is only there if
24  * the quiz does not already have student attempts
25  * The left column lists all questions that have been added to the current quiz.
26  * The lecturer can add questions from the right hand list to the quiz or remove them
27  *
28  * The script also processes a number of actions:
29  * Actions affecting a quiz:
30  * up and down  Changes the order of questions and page breaks
31  * addquestion  Adds a single question to the quiz
32  * add          Adds several selected questions to the quiz
33  * addrandom    Adds a certain number of random questions to the quiz
34  * repaginate   Re-paginates the quiz
35  * delete       Removes a question from the quiz
36  * savechanges  Saves the order and grades for questions in the quiz
37  *
38  * @package    mod_quiz
39  * @copyright  1999 onwards Martin Dougiamas and others {@link http://moodle.com}
40  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
41  */
44 require_once(__DIR__ . '/../../config.php');
45 require_once($CFG->dirroot . '/mod/quiz/locallib.php');
46 require_once($CFG->dirroot . '/mod/quiz/addrandomform.php');
47 require_once($CFG->dirroot . '/question/editlib.php');
48 require_once($CFG->dirroot . '/question/category_class.php');
50 // These params are only passed from page request to request while we stay on
51 // this page otherwise they would go in question_edit_setup.
52 $scrollpos = optional_param('scrollpos', '', PARAM_INT);
54 list($thispageurl, $contexts, $cmid, $cm, $quiz, $pagevars) =
55         question_edit_setup('editq', '/mod/quiz/edit.php', true);
57 $defaultcategoryobj = question_make_default_categories($contexts->all());
58 $defaultcategory = $defaultcategoryobj->id . ',' . $defaultcategoryobj->contextid;
60 $quizhasattempts = quiz_has_attempts($quiz->id);
62 $PAGE->set_url($thispageurl);
64 // Get the course object and related bits.
65 $course = $DB->get_record('course', array('id' => $quiz->course), '*', MUST_EXIST);
66 $quizobj = new quiz($quiz, $cm, $course);
67 $structure = $quizobj->get_structure();
69 // You need mod/quiz:manage in addition to question capabilities to access this page.
70 require_capability('mod/quiz:manage', $contexts->lowest());
72 // Log this visit.
73 $params = array(
74     'courseid' => $course->id,
75     'context' => $contexts->lowest(),
76     'other' => array(
77         'quizid' => $quiz->id
78     )
79 );
80 $event = \mod_quiz\event\edit_page_viewed::create($params);
81 $event->trigger();
83 // Process commands ============================================================.
85 // Get the list of question ids had their check-boxes ticked.
86 $selectedslots = array();
87 $params = (array) data_submitted();
88 foreach ($params as $key => $value) {
89     if (preg_match('!^s([0-9]+)$!', $key, $matches)) {
90         $selectedslots[] = $matches[1];
91     }
92 }
94 $afteractionurl = new moodle_url($thispageurl);
95 if ($scrollpos) {
96     $afteractionurl->param('scrollpos', $scrollpos);
97 }
99 if (optional_param('repaginate', false, PARAM_BOOL) && confirm_sesskey()) {
100     // Re-paginate the quiz.
101     $questionsperpage = optional_param('questionsperpage', $quiz->questionsperpage, PARAM_INT);
102     quiz_repaginate_questions($quiz->id, $questionsperpage );
103     quiz_delete_previews($quiz);
104     redirect($afteractionurl);
107 if (($addquestion = optional_param('addquestion', 0, PARAM_INT)) && confirm_sesskey()) {
108     // Add a single question to the current quiz.
109     quiz_require_question_use($addquestion);
110     $addonpage = optional_param('addonpage', 0, PARAM_INT);
111     quiz_add_quiz_question($addquestion, $quiz, $addonpage);
112     quiz_delete_previews($quiz);
113     quiz_update_sumgrades($quiz);
114     $thispageurl->param('lastchanged', $addquestion);
115     redirect($afteractionurl);
118 if (optional_param('add', false, PARAM_BOOL) && confirm_sesskey()) {
119     $addonpage = optional_param('addonpage', 0, PARAM_INT);
120     // Add selected questions to the current quiz.
121     $rawdata = (array) data_submitted();
122     foreach ($rawdata as $key => $value) { // Parse input for question ids.
123         if (preg_match('!^q([0-9]+)$!', $key, $matches)) {
124             $key = $matches[1];
125             quiz_require_question_use($key);
126             quiz_add_quiz_question($key, $quiz, $addonpage);
127         }
128     }
129     quiz_delete_previews($quiz);
130     quiz_update_sumgrades($quiz);
131     redirect($afteractionurl);
134 if ((optional_param('addrandom', false, PARAM_BOOL)) && confirm_sesskey()) {
135     // Add random questions to the quiz.
136     $recurse = optional_param('recurse', 0, PARAM_BOOL);
137     $addonpage = optional_param('addonpage', 0, PARAM_INT);
138     $categoryid = required_param('categoryid', PARAM_INT);
139     $randomcount = required_param('randomcount', PARAM_INT);
140     quiz_add_random_questions($quiz, $addonpage, $categoryid, $randomcount, $recurse);
142     quiz_delete_previews($quiz);
143     quiz_update_sumgrades($quiz);
144     redirect($afteractionurl);
147 if (optional_param('savechanges', false, PARAM_BOOL) && confirm_sesskey()) {
148     $deletepreviews = false;
149     $recomputesummarks = false;
151     $rawdata = (array) data_submitted();
152     $moveonpagequestions = array();
153     $moveselectedonpage = optional_param('moveselectedonpagetop', 0, PARAM_INT);
154     if (!$moveselectedonpage) {
155         $moveselectedonpage = optional_param('moveselectedonpagebottom', 0, PARAM_INT);
156     }
158     $newslotorder = array();
159     foreach ($rawdata as $key => $value) {
160         if (preg_match('!^g([0-9]+)$!', $key, $matches)) {
161             // Parse input for question -> grades.
162             $slotnumber = $matches[1];
163             $newgrade = unformat_float($value);
164             quiz_update_slot_maxmark($DB->get_record('quiz_slots',
165                     array('quizid' => $quiz->id, 'slot' => $slotnumber), '*', MUST_EXIST), $newgrade);
166             $deletepreviews = true;
167             $recomputesummarks = true;
169         } else if (preg_match('!^o(pg)?([0-9]+)$!', $key, $matches)) {
170             // Parse input for ordering info.
171             $slotnumber = $matches[2];
172             // Make sure two questions don't overwrite each other. If we get a second
173             // question with the same position, shift the second one along to the next gap.
174             $value = clean_param($value, PARAM_INT);
175             while (array_key_exists($value, $newslotorder)) {
176                 $value++;
177             }
178             if ($matches[1]) {
179                 // This is a page-break entry.
180                 $newslotorder[$value] = 0;
181             } else {
182                 $newslotorder[$value] = $slotnumber;
183             }
184             $deletepreviews = true;
185         }
186     }
188     if ($moveselectedonpage) {
190         // Make up a $newslotorder, then let the next if statement do the work.
191         $oldslots = $DB->get_records('quiz_slots', array('quizid' => $quiz->id), 'slot');
193         $beforepage = array();
194         $onpage = array();
195         $afterpage = array();
196         foreach ($oldslots as $oldslot) {
197             if (in_array($oldslot->slot, $selectedslots)) {
198                 $onpage[] = $oldslot;
199             } else if ($oldslot->page <= $moveselectedonpage) {
200                 $beforepage[] = $oldslot;
201             } else {
202                 $afterpage[] = $oldslot;
203             }
204         }
206         $newslotorder = array();
207         $currentpage = 1;
208         $index = 10;
209         foreach ($beforepage as $slot) {
210             while ($currentpage < $slot->page) {
211                 $newslotorder[$index] = 0;
212                 $index += 10;
213                 $currentpage += 1;
214             }
215             $newslotorder[$index] = $slot->slot;
216             $index += 10;
217         }
219         while ($currentpage < $moveselectedonpage) {
220             $newslotorder[$index] = 0;
221             $index += 10;
222             $currentpage += 1;
223         }
224         foreach ($onpage as $slot) {
225             $newslotorder[$index] = $slot->slot;
226             $index += 10;
227         }
229         foreach ($afterpage as $slot) {
230             while ($currentpage < $slot->page) {
231                 $newslotorder[$index] = 0;
232                 $index += 10;
233                 $currentpage += 1;
234             }
235             $newslotorder[$index] = $slot->slot;
236             $index += 10;
237         }
238     }
240     // If ordering info was given, reorder the questions.
241     if ($newslotorder) {
242         ksort($newslotorder);
243         $currentpage = 1;
244         $currentslot = 1;
245         $slotreorder = array();
246         $slotpages = array();
247         foreach ($newslotorder as $slotnumber) {
248             if ($slotnumber == 0) {
249                 $currentpage += 1;
250                 continue;
251             }
252             $slotreorder[$slotnumber] = $currentslot;
253             $slotpages[$currentslot] = $currentpage;
254             $currentslot += 1;
255         }
256         $trans = $DB->start_delegated_transaction();
257         update_field_with_unique_index('quiz_slots',
258                 'slot', $slotreorder, array('quizid' => $quiz->id));
259         foreach ($slotpages as $slotnumber => $page) {
260             $DB->set_field('quiz_slots', 'page', $page, array('quizid' => $quiz->id, 'slot' => $slotnumber));
261         }
262         $trans->allow_commit();
263         $deletepreviews = true;
264     }
266     // If rescaling is required save the new maximum.
267     $maxgrade = unformat_float(optional_param('maxgrade', -1, PARAM_RAW));
268     if ($maxgrade >= 0) {
269         quiz_set_grade($maxgrade, $quiz);
270     }
272     if ($deletepreviews) {
273         quiz_delete_previews($quiz);
274     }
275     if ($recomputesummarks) {
276         quiz_update_sumgrades($quiz);
277         quiz_update_all_attempt_sumgrades($quiz);
278         quiz_update_all_final_grades($quiz);
279         quiz_update_grades($quiz, 0, true);
280     }
281     redirect($afteractionurl);
284 // Get the question bank view.
285 $questionbank = new mod_quiz\question\bank\custom_view($contexts, $thispageurl, $course, $cm, $quiz);
286 $questionbank->set_quiz_has_attempts($quizhasattempts);
287 $questionbank->process_actions($thispageurl, $cm);
289 // End of process commands =====================================================.
291 $PAGE->set_pagelayout('incourse');
292 $PAGE->set_pagetype('mod-quiz-edit');
294 $output = $PAGE->get_renderer('mod_quiz', 'edit');
296 $PAGE->set_title(get_string('editingquizx', 'quiz', format_string($quiz->name)));
297 $PAGE->set_heading($course->fullname);
298 $node = $PAGE->settingsnav->find('mod_quiz_edit', navigation_node::TYPE_SETTING);
299 if ($node) {
300     $node->make_active();
302 echo $OUTPUT->header();
304 // Initialise the JavaScript.
305 $quizeditconfig = new stdClass();
306 $quizeditconfig->url = $thispageurl->out(true, array('qbanktool' => '0'));
307 $quizeditconfig->dialoglisteners = array();
308 $numberoflisteners = $DB->get_field_sql("
309     SELECT COALESCE(MAX(page), 1)
310       FROM {quiz_slots}
311      WHERE quizid = ?", array($quiz->id));
313 for ($pageiter = 1; $pageiter <= $numberoflisteners; $pageiter++) {
314     $quizeditconfig->dialoglisteners[] = 'addrandomdialoglaunch_' . $pageiter;
317 $PAGE->requires->data_for_js('quiz_edit_config', $quizeditconfig);
318 $PAGE->requires->js('/question/qengine.js');
320 // Questions wrapper start.
321 echo html_writer::start_tag('div', array('class' => 'mod-quiz-edit-content'));
323 echo $output->edit_page($quizobj, $structure, $contexts, $thispageurl, $pagevars);
325 // Questions wrapper end.
326 echo html_writer::end_tag('div');
328 echo $OUTPUT->footer();