95f02101fec0491f2f7c2826558800ca72cea86c
[moodle.git] / mod / quiz / report / attemptsreport.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  * The file defines a base class that can be used to build a report like the
19  * overview or responses report, that has one row per attempt.
20  *
21  * @package   mod_quiz
22  * @copyright 2010 The Open University
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->libdir.'/tablelib.php');
32 /**
33  * Base class for quiz reports that are basically a table with one row for each attempt.
34  *
35  * @copyright 2010 The Open University
36  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 abstract class quiz_attempts_report extends quiz_default_report {
39     /** @var int default page size for reports. */
40     const DEFAULT_PAGE_SIZE = 30;
42     /** @var string constant used for the options, means all users with attempts. */
43     const ALL_WITH = 'all_with';
44     /** @var string constant used for the options, means only enrolled users with attempts. */
45     const ENROLLED_WITH = 'enrolled_with';
46     /** @var string constant used for the options, means only enrolled users without attempts. */
47     const ENROLLED_WITHOUT = 'enrolled_without';
48     /** @var string constant used for the options, means all enrolled users. */
49     const ENROLLED_ALL = 'enrolled_any';
51     /** @var string the mode this report is. */
52     protected $mode;
54     /** @var object the quiz context. */
55     protected $context;
57     /** @var mod_quiz_attempts_report_form The settings form to use. */
58     protected $form;
60     /** @var string SQL fragment for selecting the attempt that gave the final grade,
61      * if applicable. */
62     protected $qmsubselect;
64     /** @var boolean caches the results of {@link should_show_grades()}. */
65     protected $showgrades = null;
67     /**
68      *  Initialise various aspects of this report.
69      *
70      * @param string $mode
71      * @param string $formclass
72      * @param object $quiz
73      * @param object $cm
74      * @param object $course
75      * @return array with four elements:
76      *      0 => integer the current group id (0 for none).
77      *      1 => \core\dml\sql_join Contains joins, wheres, params for all the students in this course.
78      *      2 => \core\dml\sql_join Contains joins, wheres, params for all the students in the current group.
79      *      3 => \core\dml\sql_join Contains joins, wheres, params for all the students to show in the report.
80      *              Will be the same as either element 1 or 2.
81      */
82     protected function init($mode, $formclass, $quiz, $cm, $course) {
83         $this->mode = $mode;
85         $this->context = context_module::instance($cm->id);
87         list($currentgroup, $studentsjoins, $groupstudentsjoins, $allowedjoins) = $this->get_students_joins(
88                 $cm, $course);
90         $this->qmsubselect = quiz_report_qm_filter_select($quiz);
92         $this->form = new $formclass($this->get_base_url(),
93                 array('quiz' => $quiz, 'currentgroup' => $currentgroup, 'context' => $this->context));
95         return array($currentgroup, $studentsjoins, $groupstudentsjoins, $allowedjoins);
96     }
98     /**
99      * Get the base URL for this report.
100      * @return moodle_url the URL.
101      */
102     protected function get_base_url() {
103         return new moodle_url('/mod/quiz/report.php',
104                 array('id' => $this->context->instanceid, 'mode' => $this->mode));
105     }
107     /**
108      * Get sql fragments (joins) which can be used to build queries that
109      * will select an appropriate set of students to show in the reports.
110      *
111      * @param object $cm the course module.
112      * @param object $course the course settings.
113      * @return array with four elements:
114      *      0 => integer the current group id (0 for none).
115      *      1 => \core\dml\sql_join Contains joins, wheres, params for all the students in this course.
116      *      2 => \core\dml\sql_join Contains joins, wheres, params for all the students in the current group.
117      *      3 => \core\dml\sql_join Contains joins, wheres, params for all the students to show in the report.
118      *              Will be the same as either element 1 or 2.
119      */
120     protected function get_students_joins($cm, $course = null) {
121         $currentgroup = $this->get_current_group($cm, $course, $this->context);
123         $empty = new \core\dml\sql_join();
124         if ($currentgroup == self::NO_GROUPS_ALLOWED) {
125             return array($currentgroup, $empty, $empty, $empty);
126         }
128         $studentsjoins = get_enrolled_with_capabilities_join($this->context);
130         if (empty($currentgroup)) {
131             return array($currentgroup, $studentsjoins, $empty, $studentsjoins);
132         }
134         // We have a currently selected group.
135         $groupstudentsjoins = get_enrolled_with_capabilities_join($this->context, '',
136                 array('mod/quiz:attempt', 'mod/quiz:reviewmyattempts'), $currentgroup);
138         return array($currentgroup, $studentsjoins, $groupstudentsjoins, $groupstudentsjoins);
139     }
141     /**
142      * Outputs the things you commonly want at the top of a quiz report.
143      *
144      * Calls through to {@link print_header_and_tabs()} and then
145      * outputs the standard group selector, number of attempts summary,
146      * and messages to cover common cases when the report can't be shown.
147      *
148      * @param stdClass $cm the course_module information.
149      * @param stdClass $course the course settings.
150      * @param stdClass $quiz the quiz settings.
151      * @param mod_quiz_attempts_report_options $options the current report settings.
152      * @param int $currentgroup the current group.
153      * @param bool $hasquestions whether there are any questions in the quiz.
154      * @param bool $hasstudents whether there are any relevant students.
155      */
156     protected function print_standard_header_and_messages($cm, $course, $quiz,
157             $options, $currentgroup, $hasquestions, $hasstudents) {
158         global $OUTPUT;
160         $this->print_header_and_tabs($cm, $course, $quiz, $this->mode);
162         if (groups_get_activity_groupmode($cm)) {
163             // Groups are being used, so output the group selector if we are not downloading.
164             groups_print_activity_menu($cm, $options->get_url());
165         }
167         // Print information on the number of existing attempts.
168         if ($strattemptnum = quiz_num_attempt_summary($quiz, $cm, true, $currentgroup)) {
169             echo '<div class="quizattemptcounts">' . $strattemptnum . '</div>';
170         }
172         if (!$hasquestions) {
173             echo quiz_no_questions_message($quiz, $cm, $this->context);
174         } else if ($currentgroup == self::NO_GROUPS_ALLOWED) {
175             echo $OUTPUT->notification(get_string('notingroup'));
176         } else if (!$hasstudents) {
177             echo $OUTPUT->notification(get_string('nostudentsyet'));
178         } else if ($currentgroup && !$this->hasgroupstudents) {
179             echo $OUTPUT->notification(get_string('nostudentsingroup'));
180         }
181     }
183     /**
184      * Add all the user-related columns to the $columns and $headers arrays.
185      * @param table_sql $table the table being constructed.
186      * @param array $columns the list of columns. Added to.
187      * @param array $headers the columns headings. Added to.
188      */
189     protected function add_user_columns($table, &$columns, &$headers) {
190         global $CFG;
191         if (!$table->is_downloading() && $CFG->grade_report_showuserimage) {
192             $columns[] = 'picture';
193             $headers[] = '';
194         }
195         if (!$table->is_downloading()) {
196             $columns[] = 'fullname';
197             $headers[] = get_string('name');
198         } else {
199             $columns[] = 'lastname';
200             $headers[] = get_string('lastname');
201             $columns[] = 'firstname';
202             $headers[] = get_string('firstname');
203         }
205         $extrafields = get_extra_user_fields($this->context);
206         foreach ($extrafields as $field) {
207             $columns[] = $field;
208             $headers[] = get_user_field_name($field);
209         }
210     }
212     /**
213      * Set the display options for the user-related columns in the table.
214      * @param table_sql $table the table being constructed.
215      */
216     protected function configure_user_columns($table) {
217         $table->column_suppress('picture');
218         $table->column_suppress('fullname');
219         $extrafields = get_extra_user_fields($this->context);
220         foreach ($extrafields as $field) {
221             $table->column_suppress($field);
222         }
224         $table->column_class('picture', 'picture');
225         $table->column_class('lastname', 'bold');
226         $table->column_class('firstname', 'bold');
227         $table->column_class('fullname', 'bold');
228     }
230     /**
231      * Add the state column to the $columns and $headers arrays.
232      * @param array $columns the list of columns. Added to.
233      * @param array $headers the columns headings. Added to.
234      */
235     protected function add_state_column(&$columns, &$headers) {
236         $columns[] = 'state';
237         $headers[] = get_string('attemptstate', 'quiz');
238     }
240     /**
241      * Add all the time-related columns to the $columns and $headers arrays.
242      * @param array $columns the list of columns. Added to.
243      * @param array $headers the columns headings. Added to.
244      */
245     protected function add_time_columns(&$columns, &$headers) {
246         $columns[] = 'timestart';
247         $headers[] = get_string('startedon', 'quiz');
249         $columns[] = 'timefinish';
250         $headers[] = get_string('timecompleted', 'quiz');
252         $columns[] = 'duration';
253         $headers[] = get_string('attemptduration', 'quiz');
254     }
256     /**
257      * Add all the grade and feedback columns, if applicable, to the $columns
258      * and $headers arrays.
259      * @param object $quiz the quiz settings.
260      * @param bool $usercanseegrades whether the user is allowed to see grades for this quiz.
261      * @param array $columns the list of columns. Added to.
262      * @param array $headers the columns headings. Added to.
263      * @param bool $includefeedback whether to include the feedbacktext columns
264      */
265     protected function add_grade_columns($quiz, $usercanseegrades, &$columns, &$headers, $includefeedback = true) {
266         if ($usercanseegrades) {
267             $columns[] = 'sumgrades';
268             $headers[] = get_string('grade', 'quiz') . '/' .
269                     quiz_format_grade($quiz, $quiz->grade);
270         }
272         if ($includefeedback && quiz_has_feedback($quiz)) {
273             $columns[] = 'feedbacktext';
274             $headers[] = get_string('feedback', 'quiz');
275         }
276     }
278     /**
279      * Set up the table.
280      * @param table_sql $table the table being constructed.
281      * @param array $columns the list of columns.
282      * @param array $headers the columns headings.
283      * @param moodle_url $reporturl the URL of this report.
284      * @param mod_quiz_attempts_report_options $options the display options.
285      * @param bool $collapsible whether to allow columns in the report to be collapsed.
286      */
287     protected function set_up_table_columns($table, $columns, $headers, $reporturl,
288             mod_quiz_attempts_report_options $options, $collapsible) {
289         $table->define_columns($columns);
290         $table->define_headers($headers);
291         $table->sortable(true, 'uniqueid');
293         $table->define_baseurl($options->get_url());
295         $this->configure_user_columns($table);
297         $table->no_sorting('feedbacktext');
298         $table->column_class('sumgrades', 'bold');
300         $table->set_attribute('id', 'attempts');
302         $table->collapsible($collapsible);
303     }
305     /**
306      * Process any submitted actions.
307      * @param object $quiz the quiz settings.
308      * @param object $cm the cm object for the quiz.
309      * @param int $currentgroup the currently selected group.
310      * @param \core\dml\sql_join $groupstudentsjoins (joins, wheres, params) the students in the current group.
311      * @param \core\dml\sql_join $allowedjoins (joins, wheres, params) the users whose attempt this user is allowed to modify.
312      * @param moodle_url $redirecturl where to redircet to after a successful action.
313      */
314     protected function process_actions($quiz, $cm, $currentgroup, \core\dml\sql_join $groupstudentsjoins,
315             \core\dml\sql_join $allowedjoins, $redirecturl) {
316         if (empty($currentgroup) || $this->hasgroupstudents) {
317             if (optional_param('delete', 0, PARAM_BOOL) && confirm_sesskey()) {
318                 if ($attemptids = optional_param_array('attemptid', array(), PARAM_INT)) {
319                     require_capability('mod/quiz:deleteattempts', $this->context);
320                     $this->delete_selected_attempts($quiz, $cm, $attemptids, $allowedjoins);
321                     redirect($redirecturl);
322                 }
323             }
324         }
325     }
327     /**
328      * Delete the quiz attempts
329      * @param object $quiz the quiz settings. Attempts that don't belong to
330      * this quiz are not deleted.
331      * @param object $cm the course_module object.
332      * @param array $attemptids the list of attempt ids to delete.
333      * @param \core\dml\sql_join $allowedjoins (joins, wheres, params) This list of userids that are visible in the report.
334      *      Users can only delete attempts that they are allowed to see in the report.
335      *      Empty means all users.
336      */
337     protected function delete_selected_attempts($quiz, $cm, $attemptids, \core\dml\sql_join $allowedjoins) {
338         global $DB;
340         foreach ($attemptids as $attemptid) {
341             if (empty($allowedjoins->joins)) {
342                 $sql = "SELECT quiza.*
343                           FROM {quiz_attempts} quiza
344                           JOIN {user} u ON u.id = quiza.userid
345                          WHERE quiza.id = :attemptid";
346             } else {
347                 $sql = "SELECT quiza.*
348                           FROM {quiz_attempts} quiza
349                           JOIN {user} u ON u.id = quiza.userid
350                         {$allowedjoins->joins}
351                          WHERE {$allowedjoins->wheres} AND quiza.id = :attemptid";
352             }
353             $params = $allowedjoins->params + array('attemptid' => $attemptid);
354             $attempt = $DB->get_record_sql($sql, $params);
355             if (!$attempt || $attempt->quiz != $quiz->id || $attempt->preview != 0) {
356                 // Ensure the attempt exists, belongs to this quiz and belongs to
357                 // a student included in the report. If not skip.
358                 continue;
359             }
361             // Set the course module id before calling quiz_delete_attempt().
362             $quiz->cmid = $cm->id;
363             quiz_delete_attempt($attempt, $quiz);
364         }
365     }
367     /**
368      * Get information about which students to show in the report.
369      * @param object $cm the coures module.
370      * @param object $course the course settings.
371      * @return array with four elements:
372      *      0 => integer the current group id (0 for none).
373      *      1 => array ids of all the students in this course.
374      *      2 => array ids of all the students in the current group.
375      *      3 => array ids of all the students to show in the report. Will be the
376      *              same as either element 1 or 2.
377      * @deprecated since Moodle 3.2 Please use get_students_joins() instead.
378      */
379     protected function load_relevant_students($cm, $course = null) {
380         $msg = 'The function load_relevant_students() is deprecated. Please use get_students_joins() instead.';
381         throw new coding_exception($msg);
382     }