44c392c97c7f68fe8bc8b133b4433b3abdbe2a00
[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;
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;
120         $fields = user_picture::fields('u') . ', ';
121         $fields .= 'u.id as userid, ';
122         $fields .= 's.status as status, ';
123         $fields .= 's.id as submissionid, ';
124         $fields .= 's.timecreated as firstsubmission, ';
125         $fields .= 's.timemodified as timesubmitted, ';
126         $fields .= 'g.id as gradeid, ';
127         $fields .= 'g.grade as grade, ';
128         $fields .= 'g.timemodified as timemarked, ';
129         $fields .= 'g.timecreated as firstmarked, ';
130         $fields .= 'g.mailed as mailed, ';
131         $fields .= 'g.locked as locked, ';
132         $fields .= 'g.extensionduedate as extensionduedate';
133         $from = '{user} u LEFT JOIN {assign_submission} s ON u.id = s.userid AND s.assignment = :assignmentid1' .
134                         ' LEFT JOIN {assign_grades} g ON u.id = g.userid AND g.assignment = :assignmentid2';
136         $userparams = array();
137         $userindex = 0;
139         list($userwhere, $userparams) = $DB->get_in_or_equal($users, SQL_PARAMS_NAMED, 'user');
140         $where = 'u.id ' . $userwhere;
141         $params = array_merge($params, $userparams);
143         // The filters do not make sense when there are no submissions, so do not apply them.
144         if ($this->assignment->is_any_submission_plugin_enabled()) {
145             if ($filter == ASSIGN_FILTER_SUBMITTED) {
146                 $where .= ' AND s.timecreated > 0 ';
147             }
148             if ($filter == ASSIGN_FILTER_REQUIRE_GRADING) {
149                 $where .= ' AND (s.timemodified IS NOT NULL AND
150                                  s.status = :submitted AND
151                                  (s.timemodified > g.timemodified OR g.timemodified IS NULL))';
152                 $params['submitted'] = ASSIGN_SUBMISSION_STATUS_SUBMITTED;
153             }
154             if (strpos($filter, ASSIGN_FILTER_SINGLE_USER) === 0) {
155                 $userfilter = (int) array_pop(explode('=', $filter));
156                 $where .= ' AND (u.id = :userid)';
157                 $params['userid'] = $userfilter;
158             }
159         }
160         $this->set_sql($fields, $from, $where, $params);
162         if ($downloadfilename) {
163             $this->is_downloading('csv', $downloadfilename);
164         }
166         $columns = array();
167         $headers = array();
169         // Select.
170         if (!$this->is_downloading()) {
171             $columns[] = 'select';
172             $headers[] = get_string('select') .
173                     '<div class="selectall"><label class="accesshide" for="selectall">' . get_string('selectall') . '</label>
174                     <input type="checkbox" id="selectall" name="selectall" title="' . get_string('selectall') . '"/></div>';
175         }
177         // User picture.
178         if (!$this->assignment->is_blind_marking()) {
179             if (!$this->is_downloading()) {
180                 $columns[] = 'picture';
181                 $headers[] = get_string('pictureofuser');
182             } else {
183                 $columns[] = 'recordid';
184                 $headers[] = get_string('recordid', 'assign');
185             }
187             // Fullname.
188             $columns[] = 'fullname';
189             $headers[] = get_string('fullname');
190         } else {
191             // Record ID.
192             $columns[] = 'recordid';
193             $headers[] = get_string('recordid', 'assign');
194         }
196         // Submission status.
197         if ($assignment->is_any_submission_plugin_enabled()) {
198             $columns[] = 'status';
199             $headers[] = get_string('status');
200         }
202         // Team submission columns.
203         if ($assignment->get_instance()->teamsubmission) {
204             $columns[] = 'team';
205             $headers[] = get_string('submissionteam', 'assign');
207             $columns[] = 'teamstatus';
208             $headers[] = get_string('teamsubmissionstatus', 'assign');
209         }
211         // Grade.
212         $columns[] = 'grade';
213         $headers[] = get_string('grade');
214         if ($this->is_downloading()) {
215             if ($this->assignment->get_instance()->grade >= 0) {
216                 $columns[] = 'grademax';
217                 $headers[] = get_string('maxgrade', 'assign');
218             } else {
219                 // This is a custom scale.
220                 $columns[] = 'scale';
221                 $headers[] = get_string('scale', 'assign');
222             }
223         }
224         if (!$this->is_downloading()) {
225             // We have to call this column userid so we can use userid as a default sortable column.
226             $columns[] = 'userid';
227             $headers[] = get_string('edit');
228         }
230         // Submission plugins.
231         if ($assignment->is_any_submission_plugin_enabled()) {
232             $columns[] = 'timesubmitted';
233             $headers[] = get_string('lastmodifiedsubmission', 'assign');
235             foreach ($this->assignment->get_submission_plugins() as $plugin) {
236                 if ($this->is_downloading()) {
237                     if ($plugin->is_visible() && $plugin->is_enabled()) {
238                         foreach ($plugin->get_editor_fields() as $field => $description) {
239                             $index = 'plugin' . count($this->plugincache);
240                             $this->plugincache[$index] = array($plugin, $field);
241                             $columns[] = $index;
242                             $headers[] = $plugin->get_name();
243                         }
244                     }
245                 } else {
246                     if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
247                         $index = 'plugin' . count($this->plugincache);
248                         $this->plugincache[$index] = array($plugin);
249                         $columns[] = $index;
250                         $headers[] = $plugin->get_name();
251                     }
252                 }
253             }
254         }
256         // Time marked.
257         $columns[] = 'timemarked';
258         $headers[] = get_string('lastmodifiedgrade', 'assign');
260         // Feedback plugins.
261         foreach ($this->assignment->get_feedback_plugins() as $plugin) {
262             if ($this->is_downloading()) {
263                 if ($plugin->is_visible() && $plugin->is_enabled()) {
264                     foreach ($plugin->get_editor_fields() as $field => $description) {
265                         $index = 'plugin' . count($this->plugincache);
266                         $this->plugincache[$index] = array($plugin, $field);
267                         $columns[] = $index;
268                         $headers[] = $description;
269                     }
270                 }
271             } else if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
272                 $index = 'plugin' . count($this->plugincache);
273                 $this->plugincache[$index] = array($plugin);
274                 $columns[] = $index;
275                 $headers[] = $plugin->get_name();
276             }
277         }
279         // Exclude 'Final grade' column in downloaded grading worksheets.
280         if (!$this->is_downloading()) {
281             // Final grade.
282             $columns[] = 'finalgrade';
283             $headers[] = get_string('finalgrade', 'grades');
284         }
286         // Load the grading info for all users.
287         $this->gradinginfo = grade_get_grades($this->assignment->get_course()->id,
288                                               'mod',
289                                               'assign',
290                                               $this->assignment->get_instance()->id,
291                                               $users);
292         $this->hasgrantextension = has_capability('mod/assign:grantextension',
293                                                   $this->assignment->get_context());
295         if (!empty($CFG->enableoutcomes) && !empty($this->gradinginfo->outcomes)) {
296             $columns[] = 'outcomes';
297             $headers[] = get_string('outcomes', 'grades');
298         }
300         // Set the columns.
301         $this->define_columns($columns);
302         $this->define_headers($headers);
303         // We require at least one unique column for the sort.
304         $this->sortable(true, 'userid');
305         $this->no_sorting('recordid');
306         $this->no_sorting('finalgrade');
307         $this->no_sorting('userid');
308         $this->no_sorting('select');
309         $this->no_sorting('outcomes');
311         if ($assignment->get_instance()->teamsubmission) {
312             $this->no_sorting('team');
313             $this->no_sorting('teamstatus');
314         }
316         $plugincolumnindex = 0;
317         foreach ($this->assignment->get_submission_plugins() as $plugin) {
318             if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
319                 $submissionpluginindex = 'plugin' . $plugincolumnindex++;
320                 $this->no_sorting($submissionpluginindex);
321             }
322         }
323         foreach ($this->assignment->get_feedback_plugins() as $plugin) {
324             if ($plugin->is_visible() && $plugin->is_enabled() && $plugin->has_user_summary()) {
325                 $feedbackpluginindex = 'plugin' . $plugincolumnindex++;
326                 $this->no_sorting($feedbackpluginindex);
327             }
328         }
330         // When there is no data we still want the column headers printed in the csv file.
331         if ($this->is_downloading()) {
332             $this->start_output();
333         }
334     }
336     /**
337      * Before adding each row to the table make sure rownum is incremented.
338      *
339      * @param array $row row of data from db used to make one row of the table.
340      * @return array one row for the table
341      */
342     public function format_row($row) {
343         if ($this->rownum < 0) {
344             $this->rownum = $this->currpage * $this->pagesize;
345         } else {
346             $this->rownum += 1;
347         }
349         return parent::format_row($row);
350     }
352     /**
353      * Add a column with an ID that uniquely identifies this user in this assignment.
354      *
355      * @return string
356      */
357     public function col_recordid(stdClass $row) {
358         return get_string('hiddenuser', 'assign') .
359                $this->assignment->get_uniqueid_for_user($row->userid);
360     }
363     /**
364      * Add the userid to the row class so it can be updated via ajax.
365      *
366      * @param stdClass $row The row of data
367      * @return string The row class
368      */
369     public function get_row_class($row) {
370         return 'user' . $row->userid;
371     }
373     /**
374      * Return the number of rows to display on a single page.
375      *
376      * @return int The number of rows per page
377      */
378     public function get_rows_per_page() {
379         return $this->perpage;
380     }
382     /**
383      * For download only - list all the valid options for this custom scale.
384      *
385      * @param stdClass $row - The row of data
386      * @return string A list of valid options for the current scale
387      */
388     public function col_scale($row) {
389         global $DB;
391         if (empty($this->scale)) {
392             $dbparams = array('id'=>-($this->assignment->get_instance()->grade));
393             $this->scale = $DB->get_record('scale', $dbparams);
394         }
396         if (!empty($this->scale->scale)) {
397             return implode("\n", explode(',', $this->scale->scale));
398         }
399         return '';
400     }
402     /**
403      * Display a grade with scales etc.
404      *
405      * @param string $grade
406      * @param boolean $editable
407      * @param int $userid The user id of the user this grade belongs to
408      * @param int $modified Timestamp showing when the grade was last modified
409      * @return string The formatted grade
410      */
411     public function display_grade($grade, $editable, $userid, $modified) {
412         if ($this->is_downloading()) {
413             if ($this->assignment->get_instance()->grade >= 0) {
414                 if ($grade == -1 || $grade === null) {
415                     return '';
416                 }
417                 return format_float($grade);
418             } else {
419                 // This is a custom scale.
420                 $scale = $this->assignment->display_grade($grade, false);
421                 if ($scale == '-') {
422                     $scale = '';
423                 }
424                 return $scale;
425             }
426         }
427         return $this->assignment->display_grade($grade, $editable, $userid, $modified);
428     }
430     /**
431      * Get the team info for this user.
432      *
433      * @param stdClass $row
434      * @return string The team name
435      */
436     public function col_team(stdClass $row) {
437         $submission = false;
438         $group = false;
439         $this->get_group_and_submission($row->id, $group, $submission);
440         if ($group) {
441             return $group->name;
442         }
443         return get_string('defaultteam', 'assign');
444     }
446     /**
447      * Use a static cache to try and reduce DB calls.
448      *
449      * @param int $userid The user id for this submission
450      * @param int $groupid The groupid (returned)
451      * @param mixed $submission The stdClass submission or false (returned)
452      */
453     public function get_group_and_submission($userid, &$group, &$submission) {
454         $group = false;
455         if (isset($this->submissiongroups[$userid])) {
456             $group = $this->submissiongroups[$userid];
457         } else {
458             $group = $this->assignment->get_submission_group($userid, false);
459             $this->submissiongroups[$userid] = $group;
460         }
462         $groupid = 0;
463         if ($group) {
464             $groupid = $group->id;
465         }
467         if (isset($this->groupsubmissions[$groupid])) {
468             $submission = $this->groupsubmissions[$groupid];
469         } else {
470             $submission = $this->assignment->get_group_submission($userid, $groupid, false);
471             $this->groupsubmissions[$groupid] = $submission;
472         }
473     }
476     /**
477      * Get the team status for this user.
478      *
479      * @param stdClass $row
480      * @return string The team name
481      */
482     public function col_teamstatus(stdClass $row) {
483         $submission = false;
484         $group = false;
485         $this->get_group_and_submission($row->id, $group, $submission);
487         $status = '';
488         if ($submission) {
489             $status = $submission->status;
490         }
491         return get_string('submissionstatus_' . $status, 'assign');
492     }
495     /**
496      * Format a list of outcomes.
497      *
498      * @param stdClass $row
499      * @return string
500      */
501     public function col_outcomes(stdClass $row) {
502         $outcomes = '';
503         foreach ($this->gradinginfo->outcomes as $index => $outcome) {
504             $options = make_grades_menu(-$outcome->scaleid);
506             $options[0] = get_string('nooutcome', 'grades');
507             if ($this->quickgrading && !($outcome->grades[$row->userid]->locked)) {
508                 $select = '<select name="outcome_' . $index . '_' . $row->userid . '" class="quickgrade">';
509                 foreach ($options as $optionindex => $optionvalue) {
510                     $selected = '';
511                     if ($outcome->grades[$row->userid]->grade == $optionindex) {
512                         $selected = 'selected="selected"';
513                     }
514                     $select .= '<option value="' . $optionindex . '"' . $selected . '>' . $optionvalue . '</option>';
515                 }
516                 $select .= '</select>';
517                 $outcomes .= $this->output->container($outcome->name . ': ' . $select, 'outcome');
518             } else {
519                 $name = $outcome->name . ': ' . $options[$outcome->grades[$row->userid]->grade];
520                 $outcomes .= $this->output->container($name, 'outcome');
521             }
522         }
524         return $outcomes;
525     }
528     /**
529      * Format a user picture for display.
530      *
531      * @param stdClass $row
532      * @return string
533      */
534     public function col_picture(stdClass $row) {
535         if ($row->picture) {
536             return $this->output->user_picture($row);
537         }
538         return '';
539     }
541     /**
542      * Format a user record for display (link to profile).
543      *
544      * @param stdClass $row
545      * @return string
546      */
547     public function col_fullname($row) {
548         if (!$this->is_downloading()) {
549             $courseid = $this->assignment->get_course()->id;
550             $link= new moodle_url('/user/view.php', array('id' =>$row->id, 'course'=>$courseid));
551             return $this->output->action_link($link, fullname($row));
552         } else {
553             return fullname($row);
554         }
555     }
557     /**
558      * Insert a checkbox for selecting the current row for batch operations.
559      *
560      * @param stdClass $row
561      * @return string
562      */
563     public function col_select(stdClass $row) {
564         $selectcol = '<label class="accesshide" for="selectuser_' . $row->userid . '">';
565         $selectcol .= get_string('selectuser', 'assign', fullname($row));
566         $selectcol .= '</label>';
567         $selectcol .= '<input type="checkbox"
568                               id="selectuser_' . $row->userid . '"
569                               name="selectedusers"
570                               value="' . $row->userid . '"/>';
571         return $selectcol;
572     }
574     /**
575      * Return a users grades from the listing of all grade data for this assignment.
576      *
577      * @param int $userid
578      * @return mixed stdClass or false
579      */
580     private function get_gradebook_data_for_user($userid) {
581         if (isset($this->gradinginfo->items[0]) && $this->gradinginfo->items[0]->grades[$userid]) {
582             return $this->gradinginfo->items[0]->grades[$userid];
583         }
584         return false;
585     }
587     /**
588      * Format a column of data for display.
589      *
590      * @param stdClass $row
591      * @return string
592      */
593     public function col_grademax(stdClass $row) {
594         return format_float($this->assignment->get_instance()->grade, 2);
595     }
597     /**
598      * Format a column of data for display.
599      *
600      * @param stdClass $row
601      * @return string
602      */
603     public function col_grade(stdClass $row) {
604         $o = '';
606         $link = '';
607         $separator = '';
608         $grade = '';
609         $gradingdisabled = $this->assignment->grading_disabled($row->id);
611         if (!$this->is_downloading()) {
612             $name = fullname($row);
613             if ($this->assignment->is_blind_marking()) {
614                 $name = get_string('hiddenuser', 'assign') .
615                         $this->assignment->get_uniqueid_for_user($row->userid);
616             }
617             $icon = $this->output->pix_icon('gradefeedback',
618                                             get_string('gradeuser', 'assign', $name),
619                                             'mod_assign');
620             $urlparams = array('id' => $this->assignment->get_course_module()->id,
621                                'rownum'=>$this->rownum,
622                                'action'=>'grade');
623             $url = new moodle_url('/mod/assign/view.php', $urlparams);
624             $link = $this->output->action_link($url, $icon);
625             $separator = $this->output->spacer(array(), true);
626         }
627         $grade = $this->display_grade($row->grade,
628                                       $this->quickgrading && !$gradingdisabled,
629                                       $row->userid,
630                                       $row->timemarked);
632         return $link . $separator . $grade;
633     }
635     /**
636      * Format a column of data for display.
637      *
638      * @param stdClass $row
639      * @return string
640      */
641     public function col_finalgrade(stdClass $row) {
642         $o = '';
644         $grade = $this->get_gradebook_data_for_user($row->userid);
645         if ($grade) {
646             $o = $this->display_grade($grade->grade, false, $row->userid, $row->timemarked);
647         }
649         return $o;
650     }
652     /**
653      * Format a column of data for display.
654      *
655      * @param stdClass $row
656      * @return string
657      */
658     public function col_timemarked(stdClass $row) {
659         $o = '-';
661         if ($row->timemarked && $row->grade !== null && $row->grade >= 0) {
662             $o = userdate($row->timemarked);
663         }
665         return $o;
666     }
668     /**
669      * Format a column of data for display.
670      *
671      * @param stdClass $row
672      * @return string
673      */
674     public function col_timesubmitted(stdClass $row) {
675         $o = '-';
677         if ($row->timesubmitted) {
678             $o = userdate($row->timesubmitted);
679         }
681         return $o;
682     }
684     /**
685      * Format a column of data for display
686      *
687      * @param stdClass $row
688      * @return string
689      */
690     public function col_status(stdClass $row) {
691         $o = '';
693         $instance = $this->assignment->get_instance();
695         if ($this->assignment->is_any_submission_plugin_enabled()) {
697             $o .= $this->output->container(get_string('submissionstatus_' . $row->status, 'assign'),
698                                            array('class'=>'submissionstatus' .$row->status));
699             if ($instance->duedate &&
700                     $row->timesubmitted > $instance->duedate) {
701                 if (!$row->extensionduedate ||
702                         $row->timesubmitted > $row->extensionduedate) {
703                     $usertime = format_time($row->timesubmitted - $instance->duedate);
704                     $latemessage = get_string('submittedlateshort',
705                                               'assign',
706                                               $usertime);
707                     $o .= $this->output->container($latemessage, 'latesubmission');
708                 }
709             }
710             if ($row->locked) {
711                 $lockedstr = get_string('submissionslockedshort', 'assign');
712                 $o .= $this->output->container($lockedstr, 'lockedsubmission');
713             }
714             if ($row->grade !== null && $row->grade >= 0) {
715                 $o .= $this->output->container(get_string('graded', 'assign'), 'submissiongraded');
716             }
717             if (!$row->timesubmitted) {
718                 $now = time();
719                 $due = $instance->duedate;
720                 if ($row->extensionduedate) {
721                     $due = $row->extensionduedate;
722                 }
723                 if ($due && ($now > $due)) {
724                     $overduestr = get_string('overdue', 'assign', format_time($now - $due));
725                     $o .= $this->output->container($overduestr, 'overduesubmission');
726                 }
727             }
728             if ($row->extensionduedate) {
729                 $userdate = userdate($row->extensionduedate);
730                 $extensionstr = get_string('userextensiondate', 'assign', $userdate);
731                 $o .= $this->output->container($extensionstr, 'extensiondate');
732             }
733         }
735         if ($this->is_downloading()) {
736             $o = strip_tags(str_replace('</div>', "\n", $o));
737         }
739         return $o;
740     }
742     /**
743      * Format a column of data for display.
744      *
745      * @param stdClass $row
746      * @return string
747      */
748     public function col_userid(stdClass $row) {
749         $edit = '';
751         $actions = array();
753         $urlparams = array('id'=>$this->assignment->get_course_module()->id,
754                            'rownum'=>$this->rownum,
755                            'action'=>'grade');
756         $url = new moodle_url('/mod/assign/view.php', $urlparams);
758         if (!$row->grade) {
759             $description = get_string('grade');
760         } else {
761             $description = get_string('updategrade', 'assign');
762         }
763         $actions[$url->out(false)] = $description;
765         // Hide for offline assignments.
766         if ($this->assignment->is_any_submission_plugin_enabled()) {
767             if (!$row->status ||
768                     $row->status == ASSIGN_SUBMISSION_STATUS_DRAFT ||
769                     !$this->assignment->get_instance()->submissiondrafts) {
771                 if (!$row->locked) {
772                     $urlparams = array('id' => $this->assignment->get_course_module()->id,
773                                        'userid'=>$row->id,
774                                        'action'=>'lock',
775                                        'sesskey'=>sesskey(),
776                                        'page'=>$this->currpage);
777                     $url = new moodle_url('/mod/assign/view.php', $urlparams);
779                     $description = get_string('preventsubmissionsshort', 'assign');
780                     $actions[$url->out(false)] = $description;
781                 } else {
782                     $urlparams = array('id' => $this->assignment->get_course_module()->id,
783                                        'userid'=>$row->id,
784                                        'action'=>'unlock',
785                                        'sesskey'=>sesskey(),
786                                        'page'=>$this->currpage);
787                     $url = new moodle_url('/mod/assign/view.php', $urlparams);
788                     $description = get_string('allowsubmissionsshort', 'assign');
789                     $actions[$url->out(false)] = $description;
790                 }
791             }
793             if (($this->assignment->get_instance()->duedate ||
794                    $this->assignment->get_instance()->cutoffdate) &&
795                    $this->hasgrantextension) {
796                 $urlparams = array('id' => $this->assignment->get_course_module()->id,
797                                    'userid'=>$row->id,
798                                    'action'=>'grantextension',
799                                    'sesskey'=>sesskey(),
800                                    'page'=>$this->currpage);
801                 $url = new moodle_url('/mod/assign/view.php', $urlparams);
802                 $description = get_string('grantextension', 'assign');
803                 $actions[$url->out(false)] = $description;
804             }
805         }
806         if ($row->status == ASSIGN_SUBMISSION_STATUS_SUBMITTED &&
807                 $this->assignment->get_instance()->submissiondrafts) {
808             $urlparams = array('id' => $this->assignment->get_course_module()->id,
809                                'userid'=>$row->id,
810                                'action'=>'reverttodraft',
811                                'sesskey'=>sesskey(),
812                                'page'=>$this->currpage);
813             $url = new moodle_url('/mod/assign/view.php', $urlparams);
814             $description = get_string('reverttodraftshort', 'assign');
815             $actions[$url->out(false)] = $description;
816         }
818         $edit .= $this->output->container_start(array('yui3-menu', 'actionmenu'), 'actionselect' . $row->id);
819         $edit .= $this->output->container_start(array('yui3-menu-content'));
820         $edit .= html_writer::start_tag('ul');
821         $edit .= html_writer::start_tag('li', array('class'=>'menuicon'));
823         $menuicon = $this->output->pix_icon('t/contextmenu', get_string('actions'));
824         $edit .= $this->output->action_link('#menu' . $row->id, $menuicon, null, array('class'=>'yui3-menu-label'));
825         $edit .= $this->output->container_start(array('yui3-menu', 'yui3-loading'), 'menu' . $row->id);
826         $edit .= $this->output->container_start(array('yui3-menu-content'));
827         $edit .= html_writer::start_tag('ul');
829         foreach ($actions as $url => $description) {
830             $edit .= html_writer::start_tag('li', array('class'=>'yui3-menuitem'));
832             $edit .= $this->output->action_link($url, $description, null, array('class'=>'yui3-menuitem-content'));
834             $edit .= html_writer::end_tag('li');
835         }
836         $edit .= html_writer::end_tag('ul');
837         $edit .= $this->output->container_end();
838         $edit .= $this->output->container_end();
839         $edit .= html_writer::end_tag('li');
840         $edit .= html_writer::end_tag('ul');
842         $edit .= $this->output->container_end();
843         $edit .= $this->output->container_end();
845         return $edit;
846     }
848     /**
849      * Write the plugin summary with an optional link to view the full feedback/submission.
850      *
851      * @param assign_plugin $plugin Submission plugin or feedback plugin
852      * @param stdClass $item Submission or grade
853      * @param string $returnaction The return action to pass to the
854      *                             view_submission page (the current page)
855      * @param string $returnparams The return params to pass to the view_submission
856      *                             page (the current page)
857      * @return string The summary with an optional link
858      */
859     private function format_plugin_summary_with_link(assign_plugin $plugin,
860                                                      stdClass $item,
861                                                      $returnaction,
862                                                      $returnparams) {
863         $link = '';
864         $showviewlink = false;
866         $summary = $plugin->view_summary($item, $showviewlink);
867         $separator = '';
868         if ($showviewlink) {
869             $viewstr = get_string('view' . substr($plugin->get_subtype(), strlen('assign')), 'assign');
870             $icon = $this->output->pix_icon('t/preview', $viewstr);
871             $urlparams = array('id' => $this->assignment->get_course_module()->id,
872                                                      'sid'=>$item->id,
873                                                      'gid'=>$item->id,
874                                                      'plugin'=>$plugin->get_type(),
875                                                      'action'=>'viewplugin' . $plugin->get_subtype(),
876                                                      'returnaction'=>$returnaction,
877                                                      'returnparams'=>http_build_query($returnparams));
878             $url = new moodle_url('/mod/assign/view.php', $urlparams);
879             $link = $this->output->action_link($url, $icon);
880             $separator = $this->output->spacer(array(), true);
881         }
883         return $link . $separator . $summary;
884     }
887     /**
888      * Format the submission and feedback columns.
889      *
890      * @param string $colname The column name
891      * @param stdClass $row The submission row
892      * @return mixed string or NULL
893      */
894     public function other_cols($colname, $row) {
895         $plugincache = $this->plugincache[$colname];
897         $plugin = $plugincache[0];
899         $field = null;
900         if (isset($plugincache[1])) {
901             $field = $plugincache[1];
902         }
904         if ($plugin->is_visible() && $plugin->is_enabled()) {
905             if ($plugin->get_subtype() == 'assignsubmission') {
906                 if ($this->assignment->get_instance()->teamsubmission) {
907                     $group = false;
908                     $submission = false;
909                     $this->get_group_and_submission($row->id, $group, $submission);
910                     if ($submission) {
911                         if (isset($field)) {
912                             return $plugin->get_editor_text($field, $submission->id);
913                         }
914                         return $this->format_plugin_summary_with_link($plugin,
915                                                                       $submission,
916                                                                       'grading',
917                                                                       array());
918                     }
919                 } else if ($row->submissionid) {
920                     if (isset($field)) {
921                         return $plugin->get_editor_text($field, $row->submissionid);
922                     }
923                     $submission = new stdClass();
924                     $submission->id = $row->submissionid;
925                     $submission->timecreated = $row->firstsubmission;
926                     $submission->timemodified = $row->timesubmitted;
927                     $submission->assignment = $this->assignment->get_instance()->id;
928                     $submission->userid = $row->userid;
929                     return $this->format_plugin_summary_with_link($plugin,
930                                                                   $submission,
931                                                                   'grading',
932                                                                   array());
933                 }
934             } else {
935                 $grade = null;
936                 if (isset($field)) {
937                     return $plugin->get_editor_text($field, $row->gradeid);
938                 }
940                 if ($row->gradeid) {
941                     $grade = new stdClass();
942                     $grade->id = $row->gradeid;
943                     $grade->timecreated = $row->firstmarked;
944                     $grade->timemodified = $row->timemarked;
945                     $grade->assignment = $this->assignment->get_instance()->id;
946                     $grade->userid = $row->userid;
947                     $grade->grade = $row->grade;
948                     $grade->mailed = $row->mailed;
949                 }
950                 if ($this->quickgrading && $plugin->supports_quickgrading()) {
951                     return $plugin->get_quickgrading_html($row->userid, $grade);
952                 } else if ($grade) {
953                     return $this->format_plugin_summary_with_link($plugin,
954                                                                   $grade,
955                                                                   'grading',
956                                                                   array());
957                 }
958             }
959         }
960         return '';
961     }
963     /**
964      * Using the current filtering and sorting - load all rows and return a single column from them.
965      *
966      * @param string $columnname The name of the raw column data
967      * @return array of data
968      */
969     public function get_column_data($columnname) {
970         $this->setup();
971         $this->currpage = 0;
972         $this->query_db($this->tablemaxrows);
973         $result = array();
974         foreach ($this->rawdata as $row) {
975             $result[] = $row->$columnname;
976         }
977         return $result;
978     }
980     /**
981      * Return things to the renderer.
982      *
983      * @return string the assignment name
984      */
985     public function get_assignment_name() {
986         return $this->assignment->get_instance()->name;
987     }
989     /**
990      * Return things to the renderer.
991      *
992      * @return int the course module id
993      */
994     public function get_course_module_id() {
995         return $this->assignment->get_course_module()->id;
996     }
998     /**
999      * Return things to the renderer.
1000      *
1001      * @return int the course id
1002      */
1003     public function get_course_id() {
1004         return $this->assignment->get_course()->id;
1005     }
1007     /**
1008      * Return things to the renderer.
1009      *
1010      * @return stdClass The course context
1011      */
1012     public function get_course_context() {
1013         return $this->assignment->get_course_context();
1014     }
1016     /**
1017      * Return things to the renderer.
1018      *
1019      * @return bool Does this assignment accept submissions
1020      */
1021     public function submissions_enabled() {
1022         return $this->assignment->is_any_submission_plugin_enabled();
1023     }
1025     /**
1026      * Return things to the renderer.
1027      *
1028      * @return bool Can this user view all grades (the gradebook)
1029      */
1030     public function can_view_all_grades() {
1031         $context = $this->assignment->get_course_context();
1032         return has_capability('gradereport/grader:view', $context) &&
1033                has_capability('moodle/grade:viewall', $context);
1034     }
1036     /**
1037      * Override the table show_hide_link to not show for select column.
1038      *
1039      * @param string $column the column name, index into various names.
1040      * @param int $index numerical index of the column.
1041      * @return string HTML fragment.
1042      */
1043     protected function show_hide_link($column, $index) {
1044         if ($index > 0) {
1045             return parent::show_hide_link($column, $index);
1046         }
1047         return '';
1048     }