MDL-37065 - Change get_string('status') token in assignment submissions page to a...
[moodle.git] / mod / assign / gradingtable.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  * This file contains the definition for the grading table which subclassses easy_table
19  *
20  * @package   mod_assign
21  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->libdir.'/tablelib.php');
28 require_once($CFG->libdir.'/gradelib.php');
29 require_once($CFG->dirroot.'/mod/assign/locallib.php');
31 /**
32  * Extends table_sql to provide a table of assignment submissions
33  *
34  * @package   mod_assign
35  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
36  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class assign_grading_table extends table_sql implements renderable {
39     /** @var assign $assignment */
40     private $assignment = null;
41     /** @var int $perpage */
42     private $perpage = 10;
43     /** @var int $rownum (global index of current row in table) */
44     private $rownum = -1;
45     /** @var renderer_base for getting output */
46     private $output = null;
47     /** @var stdClass gradinginfo */
48     private $gradinginfo = null;
49     /** @var int $tablemaxrows */
50     private $tablemaxrows = 10000;
51     /** @var boolean $quickgrading */
52     private $quickgrading = false;
53     /** @var boolean $hasgrantextension - Only do the capability check once for the entire table */
54     private $hasgrantextension = false;
55     /** @var array $groupsubmissions - A static cache of group submissions */
56     private $groupsubmissions = array();
57     /** @var array $submissiongroups - A static cache of submission groups */
58     private $submissiongroups = array();
59     /** @var string $plugingradingbatchoperations - List of plugin supported batch operations */
60     public $plugingradingbatchoperations = array();
61     /** @var array $plugincache - A cache of plugin lookups to match a column name to a plugin efficiently */
62     private $plugincache = array();
63     /** @var array $scale - A list of the keys and descriptions for the custom scale */
64     private $scale = null;
66     /**
67      * overridden constructor keeps a reference to the assignment class that is displaying this table
68      *
69      * @param assign $assignment The assignment class
70      * @param int $perpage how many per page
71      * @param string $filter The current filter
72      * @param int $rowoffset For showing a subsequent page of results
73      * @param bool $quickgrading Is this table wrapped in a quickgrading form?
74      */
75     public function __construct(assign $assignment,
76                                 $perpage,
77                                 $filter,
78                                 $rowoffset,
79                                 $quickgrading,
80                                 $downloadfilename = null) {
81         global $CFG, $PAGE, $DB, $USER;
82         parent::__construct('mod_assign_grading');
83         $this->assignment = $assignment;
85         foreach ($assignment->get_feedback_plugins() as $plugin) {
86             if ($plugin->is_visible() && $plugin->is_enabled()) {
87                 foreach ($plugin->get_grading_batch_operations() as $action => $description) {
88                     if (empty($this->plugingradingbatchoperations)) {
89                         $this->plugingradingbatchoperations[$plugin->get_type()] = array();
90                     }
91                     $this->plugingradingbatchoperations[$plugin->get_type()][$action] = $description;
92                 }
93             }
94         }
95         $this->perpage = $perpage;
96         $this->quickgrading = $quickgrading;
97         $this->output = $PAGE->get_renderer('mod_assign');
99         $urlparams = array('action'=>'grading', 'id'=>$assignment->get_course_module()->id);
100         $url = new moodle_url($CFG->wwwroot . '/mod/assign/view.php', $urlparams);
101         $this->define_baseurl($url);
103         // Do some business - then set the sql.
104         $currentgroup = groups_get_activity_group($assignment->get_course_module(), true);
106         if ($rowoffset) {
107             $this->rownum = $rowoffset - 1;
108         }
110         $users = array_keys( $assignment->list_participants($currentgroup, true));
111         if (count($users) == 0) {
112             // Insert a record that will never match to the sql is still valid.
113             $users[] = -1;
114         }
116         $params = array();
117         $params['assignmentid1'] = (int)$this->assignment->get_instance()->id;
118         $params['assignmentid2'] = (int)$this->assignment->get_instance()->id;
119         $params['assignmentid3'] = (int)$this->assignment->get_instance()->id;
120         $params['assignmentid4'] = (int)$this->assignment->get_instance()->id;
121         $params['assignmentid5'] = (int)$this->assignment->get_instance()->id;
123         $extrauserfields = get_extra_user_fields($this->assignment->get_context());
125         $fields = user_picture::fields('u', $extrauserfields) . ', ';
126         $fields .= 'u.id as userid, ';
127         $fields .= 's.status as status, ';
128         $fields .= 's.id as submissionid, ';
129         $fields .= 's.timecreated as firstsubmission, ';
130         $fields .= 's.timemodified as timesubmitted, ';
131         $fields .= 's.attemptnumber as attemptnumber, ';
132         $fields .= 'g.id as gradeid, ';
133         $fields .= 'g.grade as grade, ';
134         $fields .= 'g.timemodified as timemarked, ';
135         $fields .= 'g.timecreated as firstmarked, ';
136         $fields .= 'uf.mailed as mailed, ';
137         $fields .= 'uf.locked as locked, ';
138         $fields .= 'uf.extensionduedate as extensionduedate, ';
139         $fields .= 'uf.workflowstate as workflowstate, ';
140         $fields .= 'uf.allocatedmarker as allocatedmarker ';
142         $submissionmaxattempt = 'SELECT mxs.userid, MAX(mxs.attemptnumber) AS maxattempt
143                                  FROM {assign_submission} mxs
144                                  WHERE mxs.assignment = :assignmentid4 GROUP BY mxs.userid';
145         $grademaxattempt = 'SELECT mxg.userid, MAX(mxg.attemptnumber) AS maxattempt
146                             FROM {assign_grades} mxg
147                             WHERE mxg.assignment = :assignmentid5 GROUP BY mxg.userid';
148         $from = '{user} u
149                          LEFT JOIN ( ' . $submissionmaxattempt . ' ) smx ON u.id = smx.userid
150                          LEFT JOIN ( ' . $grademaxattempt . ' ) gmx ON u.id = gmx.userid
151                          LEFT JOIN {assign_submission} s ON
152                             u.id = s.userid AND
153                             s.assignment = :assignmentid1 AND
154                             s.attemptnumber = smx.maxattempt
155                          LEFT JOIN {assign_grades} g ON
156                             u.id = g.userid AND
157                             g.assignment = :assignmentid2 AND
158                             g.attemptnumber = gmx.maxattempt
159                          LEFT JOIN {assign_user_flags} uf ON u.id = uf.userid AND uf.assignment = :assignmentid3';
161         $userparams = array();
162         $userindex = 0;
164         list($userwhere, $userparams) = $DB->get_in_or_equal($users, SQL_PARAMS_NAMED, 'user');
165         $where = 'u.id ' . $userwhere;
166         $params = array_merge($params, $userparams);
168         // The filters do not make sense when there are no submissions, so do not apply them.
169         if ($this->assignment->is_any_submission_plugin_enabled()) {
170             if ($filter == ASSIGN_FILTER_SUBMITTED) {
171                 $where .= ' AND (s.timemodified IS NOT NULL AND
172                                  s.status = :submitted) ';
173                 $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
175             } else if ($filter == ASSIGN_FILTER_REQUIRE_GRADING) {
176                 $where .= ' AND (s.timemodified IS NOT NULL AND
177                                  s.status = :submitted AND
178                                  (s.timemodified > g.timemodified OR g.timemodified IS NULL))';
179                 $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
181             } else if (strpos($filter, ASSIGN_FILTER_SINGLE_USER) === 0) {
182                 $userfilter = (int) array_pop(explode('=', $filter));
183                 $where .= ' AND (u.id = :userid)';
184                 $params['userid'] = $userfilter;
185             }
186         }
188         if ($this->assignment->get_instance()->markingallocation) {
189             if (has_capability('mod/assign:manageallocations', $this->assignment->get_context())) {
190                 //Check to see if marker filter is set
191                 $markerfilter = (int)get_user_preferences('assign_markerfilter', '');
192                 if (!empty($markerfilter)) {
193                     $where .= ' AND uf.allocatedmarker = :markerid';
194                     $params['markerid'] = $markerfilter;
195                 }
196             } else { // Only show users allocated to this marker.
197                 $where .= ' AND uf.allocatedmarker = :markerid';
198                 $params['markerid'] = $USER->id;
199             }
200         }
202         if ($this->assignment->get_instance()->markingworkflow) {
203             $workflowstates = $this->assignment->get_marking_workflow_states_for_current_user();
204             if (!empty($workflowstates)) {
205                 $workflowfilter = get_user_preferences('assign_workflowfilter', '');
206                 if (array_key_exists($workflowfilter, $workflowstates) || $workflowfilter == ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED) {
207                     if ($workflowfilter == ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED) {
208                         $where .= ' AND (uf.workflowstate = :workflowstate OR uf.workflowstate IS NULL OR '.
209                             $DB->sql_isempty('assign_user_flags', 'workflowstate', true, true).')';
210                         $params['workflowstate'] = $workflowfilter;
211                     } else {
212                         $where .= ' AND uf.workflowstate = :workflowstate';
213                         $params['workflowstate'] = $workflowfilter;
214                     }
215                 }
216             }
217         }
219         $this->set_sql($fields, $from, $where, $params);
221         if ($downloadfilename) {
222             $this->is_downloading('csv', $downloadfilename);
223         }
225         $columns = array();
226         $headers = array();
228         // Select.
229         if (!$this->is_downloading()) {
230             $columns[] = 'select';
231             $headers[] = get_string('select') .
232                     '<div class="selectall"><label class="accesshide" for="selectall">' . get_string('selectall') . '</label>
233                     <input type="checkbox" id="selectall" name="selectall" title="' . get_string('selectall') . '"/></div>';
234         }
236         // User picture.
237         if (!$this->assignment->is_blind_marking()) {
238             if (!$this->is_downloading()) {
239                 $columns[] = 'picture';
240                 $headers[] = get_string('pictureofuser');
241             } else {
242                 $columns[] = 'recordid';
243                 $headers[] = get_string('recordid', 'assign');
244             }
246             // Fullname.
247             $columns[] = 'fullname';
248             $headers[] = get_string('fullname');
250             foreach ($extrauserfields as $extrafield) {
251                 $columns[] = $extrafield;
252                 $headers[] = get_user_field_name($extrafield);
253             }
254         } else {
255             // Record ID.
256             $columns[] = 'recordid';
257             $headers[] = get_string('recordid', 'assign');
258         }
260         // Submission status.
261         if ($assignment->is_any_submission_plugin_enabled()) {
262             $columns[] = 'status';
263             $headers[] = get_string('status', 'assign');
264         } else if ($this->assignment->get_instance()->markingworkflow) {
265             $columns[] = 'workflowstatus';
266             $headers[] = get_string('status', 'assign');
267         }
269         // Team submission columns.
270         if ($assignment->get_instance()->teamsubmission) {
271             $columns[] = 'team';
272             $headers[] = get_string('submissionteam', 'assign');
274             $columns[] = 'teamstatus';
275             $headers[] = get_string('teamsubmissionstatus', 'assign');
276         }
277         //allocated marker
278         if ($this->assignment->get_instance()->markingallocation &&
279             has_capability('mod/assign:manageallocations', $this->assignment->get_context())) {
280             // Add a column for the allocated marker.
281             $columns[] = 'allocatedmarker';
282             $headers[] = get_string('marker', 'assign');
283         }
284         // Grade.
285         $columns[] = 'grade';
286         $headers[] = get_string('grade');
287         if ($this->is_downloading()) {
288             if ($this->assignment->get_instance()->grade >= 0) {
289                 $columns[] = 'grademax';
290                 $headers[] = get_string('maxgrade', 'assign');
291             } else {
292                 // This is a custom scale.
293                 $columns[] = 'scale';
294                 $headers[] = get_string('scale', 'assign');
295             }
297             if ($this->assignment->get_instance()->markingworkflow) {
298                 // Add a column for the marking workflow state.
299                 $columns[] = 'workflowstate';
300                 $headers[] = get_string('markingworkflowstate', 'assign');
301             }
302             // Add a column for the list of valid marking workflow states.
303             $columns[] = 'gradecanbechanged';
304             $headers[] = get_string('gradecanbechanged', 'assign');
305         }
306         if (!$this->is_downloading()) {
307             // We have to call this column userid so we can use userid as a default sortable column.
308             $columns[] = 'userid';
309             $headers[] = get_string('edit');
310         }
312         // Submission plugins.
313         if ($assignment->is_any_submission_plugin_enabled()) {
314             $columns[] = 'timesubmitted';
315             $headers[] = get_string('lastmodifiedsubmission', 'assign');
317             foreach ($this->assignment->get_submission_plugins() as $plugin) {
318                 if ($this->is_downloading()) {
319                     if ($plugin->is_visible() && $plugin->is_enabled()) {
320                         foreach ($plugin->get_editor_fields() as $field => $description) {
321                             $index = 'plugin' . count($this->plugincache);
322                             $this->plugincache[$index] = array($plugin, $field);
323                             $columns[] = $index;
324                             $headers[] = $plugin->get_name();
325                         }
326                     }
327                 } else {
328                     if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
329                         $index = 'plugin' . count($this->plugincache);
330                         $this->plugincache[$index] = array($plugin);
331                         $columns[] = $index;
332                         $headers[] = $plugin->get_name();
333                     }
334                 }
335             }
336         }
338         // Time marked.
339         $columns[] = 'timemarked';
340         $headers[] = get_string('lastmodifiedgrade', 'assign');
342         // Feedback plugins.
343         foreach ($this->assignment->get_feedback_plugins() as $plugin) {
344             if ($this->is_downloading()) {
345                 if ($plugin->is_visible() && $plugin->is_enabled()) {
346                     foreach ($plugin->get_editor_fields() as $field => $description) {
347                         $index = 'plugin' . count($this->plugincache);
348                         $this->plugincache[$index] = array($plugin, $field);
349                         $columns[] = $index;
350                         $headers[] = $description;
351                     }
352                 }
353             } else if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
354                 $index = 'plugin' . count($this->plugincache);
355                 $this->plugincache[$index] = array($plugin);
356                 $columns[] = $index;
357                 $headers[] = $plugin->get_name();
358             }
359         }
361         // Exclude 'Final grade' column in downloaded grading worksheets.
362         if (!$this->is_downloading()) {
363             // Final grade.
364             $columns[] = 'finalgrade';
365             $headers[] = get_string('finalgrade', 'grades');
366         }
368         // Load the grading info for all users.
369         $this->gradinginfo = grade_get_grades($this->assignment->get_course()->id,
370                                               'mod',
371                                               'assign',
372                                               $this->assignment->get_instance()->id,
373                                               $users);
374         $this->hasgrantextension = has_capability('mod/assign:grantextension',
375                                                   $this->assignment->get_context());
377         if (!empty($CFG->enableoutcomes) && !empty($this->gradinginfo->outcomes)) {
378             $columns[] = 'outcomes';
379             $headers[] = get_string('outcomes', 'grades');
380         }
382         // Set the columns.
383         $this->define_columns($columns);
384         $this->define_headers($headers);
385         foreach ($extrauserfields as $extrafield) {
386              $this->column_class($extrafield, $extrafield);
387         }
388         // We require at least one unique column for the sort.
389         $this->sortable(true, 'userid');
390         $this->no_sorting('recordid');
391         $this->no_sorting('finalgrade');
392         $this->no_sorting('userid');
393         $this->no_sorting('select');
394         $this->no_sorting('outcomes');
396         if ($assignment->get_instance()->teamsubmission) {
397             $this->no_sorting('team');
398             $this->no_sorting('teamstatus');
399         }
401         $plugincolumnindex = 0;
402         foreach ($this->assignment->get_submission_plugins() as $plugin) {
403             if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
404                 $submissionpluginindex = 'plugin' . $plugincolumnindex++;
405                 $this->no_sorting($submissionpluginindex);
406             }
407         }
408         foreach ($this->assignment->get_feedback_plugins() as $plugin) {
409             if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
410                 $feedbackpluginindex = 'plugin' . $plugincolumnindex++;
411                 $this->no_sorting($feedbackpluginindex);
412             }
413         }
415         // When there is no data we still want the column headers printed in the csv file.
416         if ($this->is_downloading()) {
417             $this->start_output();
418         }
419     }
421     /**
422      * Before adding each row to the table make sure rownum is incremented.
423      *
424      * @param array $row row of data from db used to make one row of the table.
425      * @return array one row for the table
426      */
427     public function format_row($row) {
428         if ($this->rownum < 0) {
429             $this->rownum = $this->currpage * $this->pagesize;
430         } else {
431             $this->rownum += 1;
432         }
434         return parent::format_row($row);
435     }
437     /**
438      * Add a column with an ID that uniquely identifies this user in this assignment.
439      *
440      * @return string
441      */
442     public function col_recordid(stdClass $row) {
443         return get_string('hiddenuser', 'assign') .
444                $this->assignment->get_uniqueid_for_user($row->userid);
445     }
448     /**
449      * Add the userid to the row class so it can be updated via ajax.
450      *
451      * @param stdClass $row The row of data
452      * @return string The row class
453      */
454     public function get_row_class($row) {
455         return 'user' . $row->userid;
456     }
458     /**
459      * Return the number of rows to display on a single page.
460      *
461      * @return int The number of rows per page
462      */
463     public function get_rows_per_page() {
464         return $this->perpage;
465     }
467     /**
468      * list current marking workflow state
469      *
470      * @param stdClass $row
471      * @return string
472      */
473     public function col_workflowstatus(stdClass $row) {
474         $o = '';
476         $gradingdisabled = $this->assignment->grading_disabled($row->id);
477         if ($this->assignment->get_instance()->markingworkflow) {
478             // The function in the assignment keeps a static cache of this list of states.
479             $workflowstates = $this->assignment->get_marking_workflow_states_for_current_user();
480             $workflowstate = $row->workflowstate;
481             if (empty($workflowstate)) {
482                 $workflowstate = ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED;
483             }
484             if ($this->quickgrading && !$gradingdisabled) {
485                 $name = 'quickgrade_' . $row->id . '_workflowstate';
486                 $o .= html_writer::select($workflowstates, $name, $workflowstate, array('' => get_string('markingworkflowstatenotmarked', 'assign')));
487                 // Check if this user is a marker that can't manage allocations and doesn't have the marker column added.
488                 if ($this->assignment->get_instance()->markingallocation &&
489                     !has_capability('mod/assign:manageallocations', $this->assignment->get_context())) {
491                     $name = 'quickgrade_' . $row->id . '_allocatedmarker';
492                     $o .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$row->allocatedmarker));
493                 }
494             } else {
495                 $o .= $this->output->container(get_string('markingworkflowstate' . $workflowstate, 'assign'), $workflowstate);
496             }
497         }
498         return $o;
499     }
501     /**
502      * For download only - list current marking workflow state
503      *
504      * @param stdClass $row - The row of data
505      * @return string The current marking workflow state
506      */
507     public function col_workflowstate($row) {
508         $state = $row->workflowstate;
509         if (empty($state)) {
510             $state = ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED;
511         }
513         return get_string('markingworkflowstate' . $state, 'assign');
514     }
516     /**
517      * list current marker
518      *
519      * @param stdClass $row - The row of data
520      * @return id the user->id of the marker.
521      */
522     function col_allocatedmarker(stdClass $row) {
523         static $markers = null;
524         static $markerlist = array();
525         if ($markers === null) {
526             $markers = get_users_by_capability($this->assignment->get_context(), 'mod/assign:grade');
527             $markerlist[0] = get_string('choosemarker', 'assign');
528             foreach ($markers as $marker) {
529                 $markerlist[$marker->id] = fullname($marker);
530             }
531         }
532         if (empty($markerlist)) {
533             // TODO: add some form of notification here that no markers are available.
534             return '';
535         }
536         if ($this->is_downloading()) {
537             return $markers[$row->allocatedmarker];
538         }
540         if ($this->quickgrading && has_capability('mod/assign:manageallocations', $this->assignment->get_context()) &&
541             (empty($row->workflowstate) ||
542              $row->workflowstate == ASSIGN_MARKING_WORKFLOW_STATE_INMARKING ||
543              $row->workflowstate == ASSIGN_MARKING_WORKFLOW_STATE_NOTMARKED)) {
545             $name = 'quickgrade_' . $row->id . '_allocatedmarker';
546             return  html_writer::select($markerlist, $name, $row->allocatedmarker, false);
547         } else if (!empty($row->allocatedmarker)) {
548             $output = '';
549             if ($this->quickgrading) { // Add hidden field for quickgrading page.
550                 $name = 'quickgrade_' . $row->id . '_allocatedmarker';
551                 $output .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>$name, 'value'=>$row->allocatedmarker));
552             }
553             $output .= $markerlist[$row->allocatedmarker];
554             return $output;
555         }
556     }
557     /**
558      * For download only - list all the valid options for this custom scale.
559      *
560      * @param stdClass $row - The row of data
561      * @return string A list of valid options for the current scale
562      */
563     public function col_scale($row) {
564         global $DB;
566         if (empty($this->scale)) {
567             $dbparams = array('id'=>-($this->assignment->get_instance()->grade));
568             $this->scale = $DB->get_record('scale', $dbparams);
569         }
571         if (!empty($this->scale->scale)) {
572             return implode("\n", explode(',', $this->scale->scale));
573         }
574         return '';
575     }
577     /**
578      * Display a grade with scales etc.
579      *
580      * @param string $grade
581      * @param boolean $editable
582      * @param int $userid The user id of the user this grade belongs to
583      * @param int $modified Timestamp showing when the grade was last modified
584      * @return string The formatted grade
585      */
586     public function display_grade($grade, $editable, $userid, $modified) {
587         if ($this->is_downloading()) {
588             if ($this->assignment->get_instance()->grade >= 0) {
589                 if ($grade == -1 || $grade === null) {
590                     return '';
591                 }
592                 return format_float($grade, 2);
593             } else {
594                 // This is a custom scale.
595                 $scale = $this->assignment->display_grade($grade, false);
596                 if ($scale == '-') {
597                     $scale = '';
598                 }
599                 return $scale;
600             }
601         }
602         return $this->assignment->display_grade($grade, $editable, $userid, $modified);
603     }
605     /**
606      * Get the team info for this user.
607      *
608      * @param stdClass $row
609      * @return string The team name
610      */
611     public function col_team(stdClass $row) {
612         $submission = false;
613         $group = false;
614         $this->get_group_and_submission($row->id, $group, $submission, -1);
615         if ($group) {
616             return $group->name;
617         }
618         return get_string('defaultteam', 'assign');
619     }
621     /**
622      * Use a static cache to try and reduce DB calls.
623      *
624      * @param int $userid The user id for this submission
625      * @param int $groupid The groupid (returned)
626      * @param mixed $submission The stdClass submission or false (returned)
627      * @param int $attemptnumber Return a specific attempt number (-1 for latest)
628      */
629     protected function get_group_and_submission($userid, &$group, &$submission, $attemptnumber) {
630         $group = false;
631         if (isset($this->submissiongroups[$userid])) {
632             $group = $this->submissiongroups[$userid];
633         } else {
634             $group = $this->assignment->get_submission_group($userid, false);
635             $this->submissiongroups[$userid] = $group;
636         }
638         $groupid = 0;
639         if ($group) {
640             $groupid = $group->id;
641         }
643         // Static cache is keyed by groupid and attemptnumber.
644         // We may need both the latest and previous attempt in the same page.
645         if (isset($this->groupsubmissions[$groupid . ':' . $attemptnumber])) {
646             $submission = $this->groupsubmissions[$groupid . ':' . $attemptnumber];
647         } else {
648             $submission = $this->assignment->get_group_submission($userid, $groupid, false, $attemptnumber);
649             $this->groupsubmissions[$groupid . ':' . $attemptnumber] = $submission;
650         }
651     }
654     /**
655      * Get the team status for this user.
656      *
657      * @param stdClass $row
658      * @return string The team name
659      */
660     public function col_teamstatus(stdClass $row) {
661         $submission = false;
662         $group = false;
663         $this->get_group_and_submission($row->id, $group, $submission, -1);
665         $status = '';
666         if ($submission) {
667             $status = $submission->status;
668         }
669         return get_string('submissionstatus_' . $status, 'assign');
670     }
673     /**
674      * Format a list of outcomes.
675      *
676      * @param stdClass $row
677      * @return string
678      */
679     public function col_outcomes(stdClass $row) {
680         $outcomes = '';
681         foreach ($this->gradinginfo->outcomes as $index => $outcome) {
682             $options = make_grades_menu(-$outcome->scaleid);
684             $options[0] = get_string('nooutcome', 'grades');
685             if ($this->quickgrading && !($outcome->grades[$row->userid]->locked)) {
686                 $select = '<select name="outcome_' . $index . '_' . $row->userid . '" class="quickgrade">';
687                 foreach ($options as $optionindex => $optionvalue) {
688                     $selected = '';
689                     if ($outcome->grades[$row->userid]->grade == $optionindex) {
690                         $selected = 'selected="selected"';
691                     }
692                     $select .= '<option value="' . $optionindex . '"' . $selected . '>' . $optionvalue . '</option>';
693                 }
694                 $select .= '</select>';
695                 $outcomes .= $this->output->container($outcome->name . ': ' . $select, 'outcome');
696             } else {
697                 $name = $outcome->name . ': ' . $options[$outcome->grades[$row->userid]->grade];
698                 $outcomes .= $this->output->container($name, 'outcome');
699             }
700         }
702         return $outcomes;
703     }
706     /**
707      * Format a user picture for display.
708      *
709      * @param stdClass $row
710      * @return string
711      */
712     public function col_picture(stdClass $row) {
713         if ($row->picture) {
714             return $this->output->user_picture($row);
715         }
716         return '';
717     }
719     /**
720      * Format a user record for display (link to profile).
721      *
722      * @param stdClass $row
723      * @return string
724      */
725     public function col_fullname($row) {
726         if (!$this->is_downloading()) {
727             $courseid = $this->assignment->get_course()->id;
728             $link= new moodle_url('/user/view.php', array('id' =>$row->id, 'course'=>$courseid));
729             return $this->output->action_link($link, fullname($row));
730         } else {
731             return fullname($row);
732         }
733     }
735     /**
736      * Insert a checkbox for selecting the current row for batch operations.
737      *
738      * @param stdClass $row
739      * @return string
740      */
741     public function col_select(stdClass $row) {
742         $selectcol = '<label class="accesshide" for="selectuser_' . $row->userid . '">';
743         $selectcol .= get_string('selectuser', 'assign', fullname($row));
744         $selectcol .= '</label>';
745         $selectcol .= '<input type="checkbox"
746                               id="selectuser_' . $row->userid . '"
747                               name="selectedusers"
748                               value="' . $row->userid . '"/>';
749         return $selectcol;
750     }
752     /**
753      * Return a users grades from the listing of all grade data for this assignment.
754      *
755      * @param int $userid
756      * @return mixed stdClass or false
757      */
758     private function get_gradebook_data_for_user($userid) {
759         if (isset($this->gradinginfo->items[0]) && $this->gradinginfo->items[0]->grades[$userid]) {
760             return $this->gradinginfo->items[0]->grades[$userid];
761         }
762         return false;
763     }
765     /**
766      * Format a column of data for display.
767      *
768      * @param stdClass $row
769      * @return string
770      */
771     public function col_gradecanbechanged(stdClass $row) {
772         $gradingdisabled = $this->assignment->grading_disabled($row->id);
773         if ($gradingdisabled) {
774             return get_string('no');
775         } else {
776             return get_string('yes');
777         }
778     }
780     /**
781      * Format a column of data for display
782      *
783      * @param stdClass $row
784      * @return string
785      */
786     public function col_grademax(stdClass $row) {
787         return format_float($this->assignment->get_instance()->grade, 2);
788     }
790     /**
791      * Format a column of data for display.
792      *
793      * @param stdClass $row
794      * @return string
795      */
796     public function col_grade(stdClass $row) {
797         $o = '';
799         $link = '';
800         $separator = $this->output->spacer(array(), true);
801         $grade = '';
802         $gradingdisabled = $this->assignment->grading_disabled($row->id);
804         if (!$this->is_downloading()) {
805             $name = fullname($row);
806             if ($this->assignment->is_blind_marking()) {
807                 $name = get_string('hiddenuser', 'assign') .
808                         $this->assignment->get_uniqueid_for_user($row->userid);
809             }
810             $icon = $this->output->pix_icon('gradefeedback',
811                                             get_string('gradeuser', 'assign', $name),
812                                             'mod_assign');
813             $urlparams = array('id' => $this->assignment->get_course_module()->id,
814                                'rownum'=>$this->rownum,
815                                'action'=>'grade');
816             $url = new moodle_url('/mod/assign/view.php', $urlparams);
817             $link = $this->output->action_link($url, $icon);
818             $grade .= $link . $separator;
819         }
821         $grade .= $this->display_grade($row->grade,
822                                        $this->quickgrading && !$gradingdisabled,
823                                        $row->userid,
824                                        $row->timemarked);
826         return $grade;
827     }
829     /**
830      * Format a column of data for display.
831      *
832      * @param stdClass $row
833      * @return string
834      */
835     public function col_finalgrade(stdClass $row) {
836         $o = '';
838         $grade = $this->get_gradebook_data_for_user($row->userid);
839         if ($grade) {
840             $o = $this->display_grade($grade->grade, false, $row->userid, $row->timemarked);
841         }
843         return $o;
844     }
846     /**
847      * Format a column of data for display.
848      *
849      * @param stdClass $row
850      * @return string
851      */
852     public function col_timemarked(stdClass $row) {
853         $o = '-';
855         if ($row->timemarked && $row->grade !== null && $row->grade >= 0) {
856             $o = userdate($row->timemarked);
857         }
858         if ($row->timemarked && $this->is_downloading()) {
859             // Force it for downloads as it affects import.
860             $o = userdate($row->timemarked);
861         }
863         return $o;
864     }
866     /**
867      * Format a column of data for display.
868      *
869      * @param stdClass $row
870      * @return string
871      */
872     public function col_timesubmitted(stdClass $row) {
873         $o = '-';
875         if ($row->timesubmitted) {
876             $o = userdate($row->timesubmitted);
877         }
879         return $o;
880     }
882     /**
883      * Format a column of data for display
884      *
885      * @param stdClass $row
886      * @return string
887      */
888     public function col_status(stdClass $row) {
889         $o = '';
891         $instance = $this->assignment->get_instance();
893         if ($this->assignment->is_any_submission_plugin_enabled()) {
895             $o .= $this->output->container(get_string('submissionstatus_' . $row->status, 'assign'),
896                                            array('class'=>'submissionstatus' .$row->status));
897             if ($instance->duedate &&
898                     $row->timesubmitted > $instance->duedate) {
899                 if (!$row->extensionduedate ||
900                         $row->timesubmitted > $row->extensionduedate) {
901                     $usertime = format_time($row->timesubmitted - $instance->duedate);
902                     $latemessage = get_string('submittedlateshort',
903                                               'assign',
904                                               $usertime);
905                     $o .= $this->output->container($latemessage, 'latesubmission');
906                 }
907             }
908             if ($row->locked) {
909                 $lockedstr = get_string('submissionslockedshort', 'assign');
910                 $o .= $this->output->container($lockedstr, 'lockedsubmission');
911             }
912             $o .= $this->col_workflowstatus($row);
913             if (!$row->timesubmitted) {
914                 $now = time();
915                 $due = $instance->duedate;
916                 if ($row->extensionduedate) {
917                     $due = $row->extensionduedate;
918                 }
919                 if ($due && ($now > $due)) {
920                     $overduestr = get_string('overdue', 'assign', format_time($now - $due));
921                     $o .= $this->output->container($overduestr, 'overduesubmission');
922                 }
923             }
924             if ($row->extensionduedate) {
925                 $userdate = userdate($row->extensionduedate);
926                 $extensionstr = get_string('userextensiondate', 'assign', $userdate);
927                 $o .= $this->output->container($extensionstr, 'extensiondate');
928             }
929         }
931         if ($this->is_downloading()) {
932             $o = strip_tags(str_replace('</div>', "\n", $o));
933         }
935         return $o;
936     }
938     /**
939      * Format a column of data for display.
940      *
941      * @param stdClass $row
942      * @return string
943      */
944     public function col_userid(stdClass $row) {
945         $edit = '';
947         $actions = array();
949         $urlparams = array('id'=>$this->assignment->get_course_module()->id,
950                            'rownum'=>$this->rownum,
951                            'action'=>'grade');
952         $url = new moodle_url('/mod/assign/view.php', $urlparams);
954         if (!$row->grade) {
955             $description = get_string('grade');
956         } else {
957             $description = get_string('updategrade', 'assign');
958         }
959         $actions[$url->out(false)] = $description;
961         // Hide for offline assignments.
962         if ($this->assignment->is_any_submission_plugin_enabled()) {
963             if (!$row->status ||
964                     $row->status == ASSIGN_SUBMISSION_STATUS_DRAFT ||
965                     !$this->assignment->get_instance()->submissiondrafts) {
967                 if (!$row->locked) {
968                     $urlparams = array('id' => $this->assignment->get_course_module()->id,
969                                        'userid'=>$row->id,
970                                        'action'=>'lock',
971                                        'sesskey'=>sesskey(),
972                                        'page'=>$this->currpage);
973                     $url = new moodle_url('/mod/assign/view.php', $urlparams);
975                     $description = get_string('preventsubmissionsshort', 'assign');
976                     $actions[$url->out(false)] = $description;
977                 } else {
978                     $urlparams = array('id' => $this->assignment->get_course_module()->id,
979                                        'userid'=>$row->id,
980                                        'action'=>'unlock',
981                                        'sesskey'=>sesskey(),
982                                        'page'=>$this->currpage);
983                     $url = new moodle_url('/mod/assign/view.php', $urlparams);
984                     $description = get_string('allowsubmissionsshort', 'assign');
985                     $actions[$url->out(false)] = $description;
986                 }
987             }
989             if (($this->assignment->get_instance()->duedate ||
990                    $this->assignment->get_instance()->cutoffdate) &&
991                    $this->hasgrantextension) {
992                 $urlparams = array('id' => $this->assignment->get_course_module()->id,
993                                    'userid'=>$row->id,
994                                    'action'=>'grantextension',
995                                    'sesskey'=>sesskey(),
996                                    'page'=>$this->currpage);
997                 $url = new moodle_url('/mod/assign/view.php', $urlparams);
998                 $description = get_string('grantextension', 'assign');
999                 $actions[$url->out(false)] = $description;
1000             }
1001         }
1002         if ($row->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED &&
1003                 $this->assignment->get_instance()->submissiondrafts) {
1004             $urlparams = array('id' => $this->assignment->get_course_module()->id,
1005                                'userid'=>$row->id,
1006                                'action'=>'reverttodraft',
1007                                'sesskey'=>sesskey(),
1008                                'page'=>$this->currpage);
1009             $url = new moodle_url('/mod/assign/view.php', $urlparams);
1010             $description = get_string('reverttodraftshort', 'assign');
1011             $actions[$url->out(false)] = $description;
1012         }
1014         $ismanual = $this->assignment->get_instance()->attemptreopenmethod == ASSIGN_ATTEMPT_REOPEN_METHOD_MANUAL;
1015         $hassubmission = !empty($row->status);
1016         $notreopened = $hassubmission && $row->status != ASSIGN_SUBMISSION_STATUS_REOPENED;
1017         $isunlimited = $this->assignment->get_instance()->maxattempts == ASSIGN_UNLIMITED_ATTEMPTS;
1018         $hasattempts = $isunlimited || $row->attemptnumber < $this->assignment->get_instance()->maxattempts - 1;
1020         if ($ismanual && $hassubmission && $notreopened && $hasattempts) {
1021             $urlparams = array('id' => $this->assignment->get_course_module()->id,
1022                                'userid'=>$row->id,
1023                                'action'=>'addattempt',
1024                                'sesskey'=>sesskey(),
1025                                'page'=>$this->currpage);
1026             $url = new moodle_url('/mod/assign/view.php', $urlparams);
1027             $description = get_string('addattempt', 'assign');
1028             $actions[$url->out(false)] = $description;
1029         }
1031         $edit .= $this->output->container_start(array('yui3-menu', 'actionmenu'), 'actionselect' . $row->id);
1032         $edit .= $this->output->container_start(array('yui3-menu-content'));
1033         $edit .= html_writer::start_tag('ul');
1034         $edit .= html_writer::start_tag('li', array('class'=>'menuicon'));
1036         $menuicon = $this->output->pix_icon('t/contextmenu', get_string('actions'));
1037         $edit .= $this->output->action_link('#menu' . $row->id, $menuicon, null, array('class'=>'yui3-menu-label'));
1038         $edit .= $this->output->container_start(array('yui3-menu', 'yui3-loading'), 'menu' . $row->id);
1039         $edit .= $this->output->container_start(array('yui3-menu-content'));
1040         $edit .= html_writer::start_tag('ul');
1042         foreach ($actions as $url => $description) {
1043             $edit .= html_writer::start_tag('li', array('class'=>'yui3-menuitem'));
1045             $edit .= $this->output->action_link($url, $description, null, array('class'=>'yui3-menuitem-content'));
1047             $edit .= html_writer::end_tag('li');
1048         }
1049         $edit .= html_writer::end_tag('ul');
1050         $edit .= $this->output->container_end();
1051         $edit .= $this->output->container_end();
1052         $edit .= html_writer::end_tag('li');
1053         $edit .= html_writer::end_tag('ul');
1055         $edit .= $this->output->container_end();
1056         $edit .= $this->output->container_end();
1058         return $edit;
1059     }
1061     /**
1062      * Write the plugin summary with an optional link to view the full feedback/submission.
1063      *
1064      * @param assign_plugin $plugin Submission plugin or feedback plugin
1065      * @param stdClass $item Submission or grade
1066      * @param string $returnaction The return action to pass to the
1067      *                             view_submission page (the current page)
1068      * @param string $returnparams The return params to pass to the view_submission
1069      *                             page (the current page)
1070      * @return string The summary with an optional link
1071      */
1072     private function format_plugin_summary_with_link(assign_plugin $plugin,
1073                                                      stdClass $item,
1074                                                      $returnaction,
1075                                                      $returnparams) {
1076         $link = '';
1077         $showviewlink = false;
1079         $summary = $plugin->view_summary($item, $showviewlink);
1080         $separator = '';
1081         if ($showviewlink) {
1082             $viewstr = get_string('view' . substr($plugin->get_subtype(), strlen('assign')), 'assign');
1083             $icon = $this->output->pix_icon('t/preview', $viewstr);
1084             $urlparams = array('id' => $this->assignment->get_course_module()->id,
1085                                                      'sid'=>$item->id,
1086                                                      'gid'=>$item->id,
1087                                                      'plugin'=>$plugin->get_type(),
1088                                                      'action'=>'viewplugin' . $plugin->get_subtype(),
1089                                                      'returnaction'=>$returnaction,
1090                                                      'returnparams'=>http_build_query($returnparams));
1091             $url = new moodle_url('/mod/assign/view.php', $urlparams);
1092             $link = $this->output->action_link($url, $icon);
1093             $separator = $this->output->spacer(array(), true);
1094         }
1096         return $link . $separator . $summary;
1097     }
1100     /**
1101      * Format the submission and feedback columns.
1102      *
1103      * @param string $colname The column name
1104      * @param stdClass $row The submission row
1105      * @return mixed string or NULL
1106      */
1107     public function other_cols($colname, $row) {
1108         // For extra user fields the result is already in $row.
1109         if (empty($this->plugincache[$colname])) {
1110             return $row->$colname;
1111         }
1113         // This must be a plugin field.
1114         $plugincache = $this->plugincache[$colname];
1116         $plugin = $plugincache[0];
1118         $field = null;
1119         if (isset($plugincache[1])) {
1120             $field = $plugincache[1];
1121         }
1123         if ($plugin->is_visible() && $plugin->is_enabled()) {
1124             if ($plugin->get_subtype() == 'assignsubmission') {
1125                 if ($this->assignment->get_instance()->teamsubmission) {
1126                     $group = false;
1127                     $submission = false;
1129                     $this->get_group_and_submission($row->id, $group, $submission, -1);
1130                     if ($submission) {
1131                         if ($submission->status == ASSIGN_SUBMISSION_STATUS_REOPENED) {
1132                             // For a newly reopened submission - we want to show the previous submission in the table.
1133                             $this->get_group_and_submission($row->id, $group, $submission, $submission->attemptnumber-1);
1134                         }
1135                         if (isset($field)) {
1136                             return $plugin->get_editor_text($field, $submission->id);
1137                         }
1138                         return $this->format_plugin_summary_with_link($plugin,
1139                                                                       $submission,
1140                                                                       'grading',
1141                                                                       array());
1142                     }
1143                 } else if ($row->submissionid) {
1144                     if ($row->status == ASSIGN_SUBMISSION_STATUS_REOPENED) {
1145                         // For a newly reopened submission - we want to show the previous submission in the table.
1146                         $submission = $this->assignment->get_user_submission($row->userid, false, $row->attemptnumber - 1);
1147                     } else {
1148                         $submission = new stdClass();
1149                         $submission->id = $row->submissionid;
1150                         $submission->timecreated = $row->firstsubmission;
1151                         $submission->timemodified = $row->timesubmitted;
1152                         $submission->assignment = $this->assignment->get_instance()->id;
1153                         $submission->userid = $row->userid;
1154                     }
1155                     // Field is used for only for import/export and refers the the fieldname for the text editor.
1156                     if (isset($field)) {
1157                         return $plugin->get_editor_text($field, $submission->id);
1158                     }
1159                     return $this->format_plugin_summary_with_link($plugin,
1160                                                                   $submission,
1161                                                                   'grading',
1162                                                                   array());
1163                 }
1164             } else {
1165                 $grade = null;
1166                 if (isset($field)) {
1167                     return $plugin->get_editor_text($field, $row->gradeid);
1168                 }
1170                 if ($row->gradeid) {
1171                     $grade = new stdClass();
1172                     $grade->id = $row->gradeid;
1173                     $grade->timecreated = $row->firstmarked;
1174                     $grade->timemodified = $row->timemarked;
1175                     $grade->assignment = $this->assignment->get_instance()->id;
1176                     $grade->userid = $row->userid;
1177                     $grade->grade = $row->grade;
1178                     $grade->mailed = $row->mailed;
1179                 }
1180                 if ($this->quickgrading && $plugin->supports_quickgrading()) {
1181                     return $plugin->get_quickgrading_html($row->userid, $grade);
1182                 } else if ($grade) {
1183                     return $this->format_plugin_summary_with_link($plugin,
1184                                                                   $grade,
1185                                                                   'grading',
1186                                                                   array());
1187                 }
1188             }
1189         }
1190         return '';
1191     }
1193     /**
1194      * Using the current filtering and sorting - load all rows and return a single column from them.
1195      *
1196      * @param string $columnname The name of the raw column data
1197      * @return array of data
1198      */
1199     public function get_column_data($columnname) {
1200         $this->setup();
1201         $this->currpage = 0;
1202         $this->query_db($this->tablemaxrows);
1203         $result = array();
1204         foreach ($this->rawdata as $row) {
1205             $result[] = $row->$columnname;
1206         }
1207         return $result;
1208     }
1210     /**
1211      * Return things to the renderer.
1212      *
1213      * @return string the assignment name
1214      */
1215     public function get_assignment_name() {
1216         return $this->assignment->get_instance()->name;
1217     }
1219     /**
1220      * Return things to the renderer.
1221      *
1222      * @return int the course module id
1223      */
1224     public function get_course_module_id() {
1225         return $this->assignment->get_course_module()->id;
1226     }
1228     /**
1229      * Return things to the renderer.
1230      *
1231      * @return int the course id
1232      */
1233     public function get_course_id() {
1234         return $this->assignment->get_course()->id;
1235     }
1237     /**
1238      * Return things to the renderer.
1239      *
1240      * @return stdClass The course context
1241      */
1242     public function get_course_context() {
1243         return $this->assignment->get_course_context();
1244     }
1246     /**
1247      * Return things to the renderer.
1248      *
1249      * @return bool Does this assignment accept submissions
1250      */
1251     public function submissions_enabled() {
1252         return $this->assignment->is_any_submission_plugin_enabled();
1253     }
1255     /**
1256      * Return things to the renderer.
1257      *
1258      * @return bool Can this user view all grades (the gradebook)
1259      */
1260     public function can_view_all_grades() {
1261         $context = $this->assignment->get_course_context();
1262         return has_capability('gradereport/grader:view', $context) &&
1263                has_capability('moodle/grade:viewall', $context);
1264     }
1266     /**
1267      * Override the table show_hide_link to not show for select column.
1268      *
1269      * @param string $column the column name, index into various names.
1270      * @param int $index numerical index of the column.
1271      * @return string HTML fragment.
1272      */
1273     protected function show_hide_link($column, $index) {
1274         if ($index > 0) {
1275             return parent::show_hide_link($column, $index);
1276         }
1277         return '';
1278     }