Merge branch 'MDL-31353_grader_io' of git://github.com/andyjdavis/moodle
[moodle.git] / grade / report / grader / lib.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  * Definition of the grader report class
19  *
20  * @package   gradereport_grader
21  * @copyright 2007 Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->dirroot . '/grade/report/lib.php');
26 require_once($CFG->libdir.'/tablelib.php');
28 /**
29  * Class providing an API for the grader report building and displaying.
30  * @uses grade_report
31  * @package gradereport_grader
32  */
33 class grade_report_grader extends grade_report {
34     /**
35      * The final grades.
36      * @var array $grades
37      */
38     public $grades;
40     /**
41      * Array of errors for bulk grades updating.
42      * @var array $gradeserror
43      */
44     public $gradeserror = array();
46 //// SQL-RELATED
48     /**
49      * The id of the grade_item by which this report will be sorted.
50      * @var int $sortitemid
51      */
52     public $sortitemid;
54     /**
55      * Sortorder used in the SQL selections.
56      * @var int $sortorder
57      */
58     public $sortorder;
60     /**
61      * An SQL fragment affecting the search for users.
62      * @var string $userselect
63      */
64     public $userselect;
66     /**
67      * The bound params for $userselect
68      * @var array $userselectparams
69      */
70     public $userselectparams = array();
72     /**
73      * List of collapsed categories from user preference
74      * @var array $collapsed
75      */
76     public $collapsed;
78     /**
79      * A count of the rows, used for css classes.
80      * @var int $rowcount
81      */
82     public $rowcount = 0;
84     /**
85      * Capability check caching
86      * */
87     public $canviewhidden;
89     var $preferencespage=false;
91     /**
92      * Length at which feedback will be truncated (to the nearest word) and an ellipsis be added.
93      * TODO replace this by a report preference
94      * @var int $feedback_trunc_length
95      */
96     protected $feedback_trunc_length = 50;
98     /**
99      * Constructor. Sets local copies of user preferences and initialises grade_tree.
100      * @param int $courseid
101      * @param object $gpr grade plugin return tracking object
102      * @param string $context
103      * @param int $page The current page being viewed (when report is paged)
104      * @param int $sortitemid The id of the grade_item by which to sort the table
105      */
106     public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
107         global $CFG;
108         parent::__construct($courseid, $gpr, $context, $page);
110         $this->canviewhidden = has_capability('moodle/grade:viewhidden', get_context_instance(CONTEXT_COURSE, $this->course->id));
112         // load collapsed settings for this report
113         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
114             $this->collapsed = unserialize($collapsed);
115         } else {
116             $this->collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
117         }
119         if (empty($CFG->enableoutcomes)) {
120             $nooutcomes = false;
121         } else {
122             $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
123         }
125         // if user report preference set or site report setting set use it, otherwise use course or site setting
126         $switch = $this->get_pref('aggregationposition');
127         if ($switch == '') {
128             $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
129         }
131         // Grab the grade_tree for this course
132         $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
134         $this->sortitemid = $sortitemid;
136         // base url for sorting by first/last name
138         $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
140         $studentsperpage = $this->get_pref('studentsperpage');
141         if (!empty($studentsperpage)) {
142             $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
143         }
145         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid, 'perpage' => $studentsperpage));
147         $this->setup_groups();
149         $this->setup_sortitemid();
150     }
152     /**
153      * Processes the data sent by the form (grades and feedbacks).
154      * Caller is responsible for all access control checks
155      * @param array $data form submission (with magic quotes)
156      * @return array empty array if success, array of warnings if something fails.
157      */
158     public function process_data($data) {
159         global $DB;
160         $warnings = array();
162         $separategroups = false;
163         $mygroups       = array();
164         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
165             $separategroups = true;
166             $mygroups = groups_get_user_groups($this->course->id);
167             $mygroups = $mygroups[0]; // ignore groupings
168             // reorder the groups fro better perf below
169             $current = array_search($this->currentgroup, $mygroups);
170             if ($current !== false) {
171                 unset($mygroups[$current]);
172                 array_unshift($mygroups, $this->currentgroup);
173             }
174         }
176         // always initialize all arrays
177         $queue = array();
178         foreach ($data as $varname => $postedvalue) {
180             $needsupdate = false;
182             // skip, not a grade nor feedback
183             if (strpos($varname, 'grade') === 0) {
184                 $datatype = 'grade';
185             } else if (strpos($varname, 'feedback') === 0) {
186                 $datatype = 'feedback';
187             } else {
188                 continue;
189             }
191             $gradeinfo = explode("_", $varname);
192             $userid = clean_param($gradeinfo[1], PARAM_INT);
193             $itemid = clean_param($gradeinfo[2], PARAM_INT);
195             $oldvalue = $data->{'old'.$varname};
197             // was change requested?
198             if ($oldvalue == $postedvalue) { // string comparison
199                 continue;
200             }
202             if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) { // we must verify course id here!
203                 print_error('invalidgradeitmeid');
204             }
206             // Pre-process grade
207             if ($datatype == 'grade') {
208                 $feedback = false;
209                 $feedbackformat = false;
210                 if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
211                     if ($postedvalue == -1) { // -1 means no grade
212                         $finalgrade = null;
213                     } else {
214                         $finalgrade = $postedvalue;
215                     }
216                 } else {
217                     $finalgrade = unformat_float($postedvalue);
218                 }
220                 $errorstr = '';
221                 // Warn if the grade is out of bounds.
222                 if (is_null($finalgrade)) {
223                     // ok
224                 } else {
225                     $bounded = $gradeitem->bounded_grade($finalgrade);
226                     if ($bounded > $finalgrade) {
227                     $errorstr = 'lessthanmin';
228                     } else if ($bounded < $finalgrade) {
229                         $errorstr = 'morethanmax';
230                     }
231                 }
232                 if ($errorstr) {
233                     $user = $DB->get_record('user', array('id' => $userid), 'id, firstname, lastname');
234                     $gradestr = new stdClass();
235                     $gradestr->username = fullname($user);
236                     $gradestr->itemname = $gradeitem->get_name();
237                     $warnings[] = get_string($errorstr, 'grades', $gradestr);
238                 }
240             } else if ($datatype == 'feedback') {
241                 $finalgrade = false;
242                 $trimmed = trim($postedvalue);
243                 if (empty($trimmed)) {
244                      $feedback = NULL;
245                 } else {
246                      $feedback = $postedvalue;
247                 }
248             }
250             // group access control
251             if ($separategroups) {
252                 // note: we can not use $this->currentgroup because it would fail badly
253                 //       when having two browser windows each with different group
254                 $sharinggroup = false;
255                 foreach($mygroups as $groupid) {
256                     if (groups_is_member($groupid, $userid)) {
257                         $sharinggroup = true;
258                         break;
259                     }
260                 }
261                 if (!$sharinggroup) {
262                     // either group membership changed or somebody is hacking grades of other group
263                     $warnings[] = get_string('errorsavegrade', 'grades');
264                     continue;
265                 }
266             }
268             $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
269         }
271         return $warnings;
272     }
275     /**
276      * Setting the sort order, this depends on last state
277      * all this should be in the new table class that we might need to use
278      * for displaying grades.
279      */
280     private function setup_sortitemid() {
282         global $SESSION;
284         if ($this->sortitemid) {
285             if (!isset($SESSION->gradeuserreport->sort)) {
286                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
287                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
288                 } else {
289                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
290                 }
291             } else {
292                 // this is the first sort, i.e. by last name
293                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
294                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
295                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
296                     } else {
297                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
298                     }
299                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
300                     // same as last sort
301                     if ($SESSION->gradeuserreport->sort == 'ASC') {
302                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
303                     } else {
304                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
305                     }
306                 } else {
307                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
308                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
309                     } else {
310                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
311                     }
312                 }
313             }
314             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
315         } else {
316             // not requesting sort, use last setting (for paging)
318             if (isset($SESSION->gradeuserreport->sortitemid)) {
319                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
320             }else{
321                 $this->sortitemid = 'lastname';
322             }
324             if (isset($SESSION->gradeuserreport->sort)) {
325                 $this->sortorder = $SESSION->gradeuserreport->sort;
326             } else {
327                 $this->sortorder = 'ASC';
328             }
329         }
330     }
332     /**
333      * pulls out the userids of the users to be display, and sorts them
334      */
335     public function load_users() {
336         global $CFG, $DB;
338         //limit to users with a gradeable role
339         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
341         //limit to users with an active enrollment
342         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
344         //fields we need from the user table
345         $userfields = user_picture::fields('u');
346         $userfields .= get_extra_user_fields_sql($this->context);
348         $sortjoin = $sort = $params = null;
350         //if the user has clicked one of the sort asc/desc arrows
351         if (is_numeric($this->sortitemid)) {
352             $params = array_merge(array('gitemid'=>$this->sortitemid), $gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
354             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
355             $sort = "g.finalgrade $this->sortorder";
357         } else {
358             $sortjoin = '';
359             switch($this->sortitemid) {
360                 case 'lastname':
361                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
362                     break;
363                 case 'firstname':
364                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
365                     break;
366                 case 'idnumber':
367                 default:
368                     $sort = "u.idnumber $this->sortorder";
369                     break;
370             }
372             $params = array_merge($gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
373         }
375         $sql = "SELECT $userfields
376                   FROM {user} u
377                   JOIN ($enrolledsql) je ON je.id = u.id
378                        $this->groupsql
379                        $sortjoin
380                   JOIN (
381                            SELECT DISTINCT ra.userid
382                              FROM {role_assignments} ra
383                             WHERE ra.roleid IN ($this->gradebookroles)
384                               AND ra.contextid " . get_related_contexts_string($this->context) . "
385                        ) rainner ON rainner.userid = u.id
386                    AND u.deleted = 0
387                    $this->groupwheresql
388               ORDER BY $sort";
390         $this->users = $DB->get_records_sql($sql, $params, $this->get_pref('studentsperpage') * $this->page, $this->get_pref('studentsperpage'));
392         if (empty($this->users)) {
393             $this->userselect = '';
394             $this->users = array();
395             $this->userselect_params = array();
396         } else {
397             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
398             $this->userselect = "AND g.userid $usql";
399             $this->userselect_params = $uparams;
401             //add a flag to each user indicating whether their enrolment is active
402             $sql = "SELECT ue.userid
403                       FROM {user_enrolments} ue
404                       JOIN {enrol} e ON e.id = ue.enrolid
405                      WHERE ue.userid $usql
406                            AND ue.status = :uestatus
407                            AND e.status = :estatus
408                            AND e.courseid = :courseid
409                   GROUP BY ue.userid";
410             $coursecontext = get_course_context($this->context);
411             $params = array_merge($uparams, array('estatus'=>ENROL_INSTANCE_ENABLED, 'uestatus'=>ENROL_USER_ACTIVE, 'courseid'=>$coursecontext->instanceid));
412             $useractiveenrolments = $DB->get_records_sql($sql, $params);
414             foreach ($this->users as $user) {
415                 $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
416             }
417         }
419         return $this->users;
420     }
422     /**
423      * we supply the userids in this query, and get all the grades
424      * pulls out all the grades, this does not need to worry about paging
425      */
426     public function load_final_grades() {
427         global $CFG, $DB;
429         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
430         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
431         $sql = "SELECT g.*
432                   FROM {grade_items} gi,
433                        {grade_grades} g
434                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
436         $userids = array_keys($this->users);
439         if ($grades = $DB->get_records_sql($sql, $params)) {
440             foreach ($grades as $graderec) {
441                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
442                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
443                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item =& $this->gtree->get_item($graderec->itemid); // db caching
444                 }
445             }
446         }
448         // prefil grades that do not exist yet
449         foreach ($userids as $userid) {
450             foreach ($this->gtree->get_items() as $itemid=>$unused) {
451                 if (!isset($this->grades[$userid][$itemid])) {
452                     $this->grades[$userid][$itemid] = new grade_grade();
453                     $this->grades[$userid][$itemid]->itemid = $itemid;
454                     $this->grades[$userid][$itemid]->userid = $userid;
455                     $this->grades[$userid][$itemid]->grade_item =& $this->gtree->get_item($itemid); // db caching
456                 }
457             }
458         }
459     }
461     /**
462      * Builds and returns a div with on/off toggles.
463      * @return string HTML code
464      */
465     public function get_toggles_html() {
466         global $CFG, $USER, $COURSE, $OUTPUT;
468         $html = '';
469         if ($USER->gradeediting[$this->courseid]) {
470             if (has_capability('moodle/grade:manage', $this->context) or has_capability('moodle/grade:hide', $this->context)) {
471                 $html .= $this->print_toggle('eyecons');
472             }
473             if (has_capability('moodle/grade:manage', $this->context)
474              or has_capability('moodle/grade:lock', $this->context)
475              or has_capability('moodle/grade:unlock', $this->context)) {
476                 $html .= $this->print_toggle('locks');
477             }
478             if (has_capability('moodle/grade:manage', $this->context)) {
479                 $html .= $this->print_toggle('quickfeedback');
480             }
482             if (has_capability('moodle/grade:manage', $this->context)) {
483                 $html .= $this->print_toggle('calculations');
484             }
485         }
487         if ($this->canviewhidden) {
488             $html .= $this->print_toggle('averages');
489         }
491         $html .= $this->print_toggle('ranges');
492         if (!empty($CFG->enableoutcomes)) {
493             $html .= $this->print_toggle('nooutcomes');
494         }
496         return $OUTPUT->container($html, 'grade-report-toggles');
497     }
499     /**
500     * Shortcut function for printing the grader report toggles.
501     * @param string $type The type of toggle
502     * @param bool $return Whether to return the HTML string rather than printing it
503     * @return void
504     */
505     public function print_toggle($type) {
506         global $CFG, $OUTPUT;
508         $icons = array('eyecons' => 't/hide',
509                        'calculations' => 't/calc',
510                        'locks' => 't/lock',
511                        'averages' => 't/mean',
512                        'quickfeedback' => 't/feedback',
513                        'nooutcomes' => 't/outcomes');
515         $prefname = 'grade_report_show' . $type;
517         if (array_key_exists($prefname, $CFG)) {
518             $showpref = get_user_preferences($prefname, $CFG->$prefname);
519         } else {
520             $showpref = get_user_preferences($prefname);
521         }
523         $strshow = $this->get_lang_string('show' . $type, 'grades');
524         $strhide = $this->get_lang_string('hide' . $type, 'grades');
526         $showhide = 'show';
527         $toggleaction = 1;
529         if ($showpref) {
530             $showhide = 'hide';
531             $toggleaction = 0;
532         }
534         if (array_key_exists($type, $icons)) {
535             $imagename = $icons[$type];
536         } else {
537             $imagename = "t/$type";
538         }
540         $string = ${'str' . $showhide};
542         $url = new moodle_url($this->baseurl, array('toggle' => $toggleaction, 'toggle_type' => $type));
544         $retval = $OUTPUT->container($OUTPUT->action_icon($url, new pix_icon($imagename, $string))); // TODO: this container looks wrong here
546         return $retval;
547     }
549     /**
550      * Builds and returns the rows that will make up the left part of the grader report
551      * This consists of student names and icons, links to user reports and id numbers, as well
552      * as header cells for these columns. It also includes the fillers required for the
553      * categories displayed on the right side of the report.
554      * @return array Array of html_table_row objects
555      */
556     public function get_left_rows() {
557         global $CFG, $USER, $OUTPUT;
559         $rows = array();
561         $showuserimage = $this->get_pref('showuserimage');
562         $fixedstudents = $this->is_fixed_students();
564         $strfeedback  = $this->get_lang_string("feedback");
565         $strgrade     = $this->get_lang_string('grade');
567         $extrafields = get_extra_user_fields($this->context);
569         $arrows = $this->get_sort_arrows($extrafields);
571         $colspan = 1;
572         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
573             $colspan++;
574         }
575         $colspan += count($extrafields);
577         $levels = count($this->gtree->levels) - 1;
579         for ($i = 0; $i < $levels; $i++) {
580             $fillercell = new html_table_cell();
581             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
582             $fillercell->text = ' ';
583             $fillercell->colspan = $colspan;
584             $row = new html_table_row(array($fillercell));
585             $rows[] = $row;
586         }
588         $headerrow = new html_table_row();
589         $headerrow->attributes['class'] = 'heading';
591         $studentheader = new html_table_cell();
592         $studentheader->attributes['class'] = 'header';
593         $studentheader->scope = 'col';
594         $studentheader->header = true;
595         $studentheader->id = 'studentheader';
596         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
597             $studentheader->colspan = 2;
598         }
599         $studentheader->text = $arrows['studentname'];
601         $headerrow->cells[] = $studentheader;
603         foreach ($extrafields as $field) {
604             $fieldheader = new html_table_cell();
605             $fieldheader->attributes['class'] = 'header userfield user' . $field;
606             $fieldheader->scope = 'col';
607             $fieldheader->header = true;
608             $fieldheader->text = $arrows[$field];
610             $headerrow->cells[] = $fieldheader;
611         }
613         $rows[] = $headerrow;
615         $rows = $this->get_left_icons_row($rows, $colspan);
617         $rowclasses = array('even', 'odd');
619         $suspendedstring = null;
620         foreach ($this->users as $userid => $user) {
621             $userrow = new html_table_row();
622             $userrow->id = 'fixed_user_'.$userid;
623             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
625             $usercell = new html_table_cell();
626             $usercell->attributes['class'] = 'user';
628             $usercell->header = true;
629             $usercell->scope = 'row';
631             if ($showuserimage) {
632                 $usercell->text = $OUTPUT->user_picture($user);
633             }
635             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
637             if (!empty($user->suspendedenrolment)) {
638                 $usercell->attributes['class'] .= ' usersuspended';
640                 //may be lots of suspended users so only get the string once
641                 if (empty($suspendedstring)) {
642                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
643                 }
644                 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring, 'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
645             }
647             $userrow->cells[] = $usercell;
649             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
650                 $userreportcell = new html_table_cell();
651                 $userreportcell->attributes['class'] = 'userreport';
652                 $userreportcell->header = true;
653                 $a = new stdClass();
654                 $a->user = fullname($user);
655                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
656                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
657                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
658                 $userrow->cells[] = $userreportcell;
659             }
661             foreach ($extrafields as $field) {
662                 $fieldcell = new html_table_cell();
663                 $fieldcell->attributes['class'] = 'header userfield user' . $field;
664                 $fieldcell->header = true;
665                 $fieldcell->scope = 'row';
666                 $fieldcell->text = $user->{$field};
667                 $userrow->cells[] = $fieldcell;
668             }
670             $rows[] = $userrow;
671         }
673         $rows = $this->get_left_range_row($rows, $colspan);
674         $rows = $this->get_left_avg_row($rows, $colspan, true);
675         $rows = $this->get_left_avg_row($rows, $colspan);
677         return $rows;
678     }
680     /**
681      * Builds and returns the rows that will make up the right part of the grader report
682      * @return array Array of html_table_row objects
683      */
684     public function get_right_rows() {
685         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
687         $rows = array();
688         $this->rowcount = 0;
689         $numrows = count($this->gtree->get_levels());
690         $numusers = count($this->users);
691         $gradetabindex = 1;
692         $columnstounset = array();
693         $strgrade = $this->get_lang_string('grade');
694         $strfeedback  = $this->get_lang_string("feedback");
695         $arrows = $this->get_sort_arrows();
697         $jsarguments = array(
698             'id'        => '#fixed_column',
699             'cfg'       => array('ajaxenabled'=>false),
700             'items'     => array(),
701             'users'     => array(),
702             'feedback'  => array()
703         );
704         $jsscales = array();
706         foreach ($this->gtree->get_levels() as $key=>$row) {
707             if ($key == 0) {
708                 // do not display course grade category
709                 // continue;
710             }
712             $headingrow = new html_table_row();
713             $headingrow->attributes['class'] = 'heading_name_row';
715             foreach ($row as $columnkey => $element) {
716                 $sortlink = clone($this->baseurl);
717                 if (isset($element['object']->id)) {
718                     $sortlink->param('sortitemid', $element['object']->id);
719                 }
721                 $eid    = $element['eid'];
722                 $object = $element['object'];
723                 $type   = $element['type'];
724                 $categorystate = @$element['categorystate'];
726                 if (!empty($element['colspan'])) {
727                     $colspan = $element['colspan'];
728                 } else {
729                     $colspan = 1;
730                 }
732                 if (!empty($element['depth'])) {
733                     $catlevel = 'catlevel'.$element['depth'];
734                 } else {
735                     $catlevel = '';
736                 }
738 // Element is a filler
739                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
740                     $fillercell = new html_table_cell();
741                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
742                     $fillercell->colspan = $colspan;
743                     $fillercell->text = '&nbsp;';
744                     $fillercell->header = true;
745                     $fillercell->scope = 'col';
746                     $headingrow->cells[] = $fillercell;
747                 }
748 // Element is a category
749                 else if ($type == 'category') {
750                     $categorycell = new html_table_cell();
751                     $categorycell->attributes['class'] = 'category ' . $catlevel;
752                     $categorycell->colspan = $colspan;
753                     $categorycell->text = shorten_text($element['object']->get_name());
754                     $categorycell->text .= $this->get_collapsing_icon($element);
755                     $categorycell->header = true;
756                     $categorycell->scope = 'col';
758                     // Print icons
759                     if ($USER->gradeediting[$this->courseid]) {
760                         $categorycell->text .= $this->get_icons($element);
761                     }
763                     $headingrow->cells[] = $categorycell;
764                 }
765 // Element is a grade_item
766                 else {
767                     //$itemmodule = $element['object']->itemmodule;
768                     //$iteminstance = $element['object']->iteminstance;
770                     if ($element['object']->id == $this->sortitemid) {
771                         if ($this->sortorder == 'ASC') {
772                             $arrow = $this->get_sort_arrow('up', $sortlink);
773                         } else {
774                             $arrow = $this->get_sort_arrow('down', $sortlink);
775                         }
776                     } else {
777                         $arrow = $this->get_sort_arrow('move', $sortlink);
778                     }
780                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
782                     $itemcell = new html_table_cell();
783                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . 'highlightable';
785                     if ($element['object']->is_hidden()) {
786                         $itemcell->attributes['class'] .= ' hidden';
787                     }
789                     $itemcell->colspan = $colspan;
790                     $itemcell->text = shorten_text($headerlink) . $arrow;
791                     $itemcell->header = true;
792                     $itemcell->scope = 'col';
794                     $headingrow->cells[] = $itemcell;
795                 }
796             }
797             $rows[] = $headingrow;
798         }
800         $rows = $this->get_right_icons_row($rows);
802         // Preload scale objects for items with a scaleid and initialize tab indices
803         $scaleslist = array();
804         $tabindices = array();
806         foreach ($this->gtree->get_items() as $itemid=>$item) {
807             $scale = null;
808             if (!empty($item->scaleid)) {
809                 $scaleslist[] = $item->scaleid;
810                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
811             } else {
812                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
813             }
814             $tabindices[$item->id]['grade'] = $gradetabindex;
815             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
816             $gradetabindex += $numusers * 2;
817         }
818         $scalesarray = array();
820         if (!empty($scaleslist)) {
821             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
822         }
823         $jsscales = $scalesarray;
825         $rowclasses = array('even', 'odd');
827         foreach ($this->users as $userid => $user) {
829             if ($this->canviewhidden) {
830                 $altered = array();
831                 $unknown = array();
832             } else {
833                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
834                 $altered = $hidingaffected['altered'];
835                 $unknown = $hidingaffected['unknown'];
836                 unset($hidingaffected);
837             }
840             $itemrow = new html_table_row();
841             $itemrow->id = 'user_'.$userid;
842             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
844             $jsarguments['users'][$userid] = fullname($user);
846             foreach ($this->gtree->items as $itemid=>$unused) {
847                 $item =& $this->gtree->items[$itemid];
848                 $grade = $this->grades[$userid][$item->id];
850                 $itemcell = new html_table_cell();
852                 $itemcell->id = 'u'.$userid.'i'.$itemid;
854                 // Get the decimal points preference for this item
855                 $decimalpoints = $item->get_decimals();
857                 if (in_array($itemid, $unknown)) {
858                     $gradeval = null;
859                 } else if (array_key_exists($itemid, $altered)) {
860                     $gradeval = $altered[$itemid];
861                 } else {
862                     $gradeval = $grade->finalgrade;
863                 }
865                 // MDL-11274
866                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
867                 if (!$this->canviewhidden and $grade->is_hidden()) {
868                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
869                         // the problem here is that we do not have the time when grade value was modified, 'timemodified' is general modification date for grade_grades records
870                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
871                     } else {
872                         $itemcell->text = '-';
873                     }
874                     $itemrow->cells[] = $itemcell;
875                     continue;
876                 }
878                 // emulate grade element
879                 $eid = $this->gtree->get_grade_eid($grade);
880                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
882                 $itemcell->attributes['class'] .= ' grade';
883                 if ($item->is_category_item()) {
884                     $itemcell->attributes['class'] .= ' cat';
885                 }
886                 if ($item->is_course_item()) {
887                     $itemcell->attributes['class'] .= ' course';
888                 }
889                 if ($grade->is_overridden()) {
890                     $itemcell->attributes['class'] .= ' overridden';
891                 }
893                 if ($grade->is_excluded()) {
894                     // $itemcell->attributes['class'] .= ' excluded';
895                 }
897                 if (!empty($grade->feedback)) {
898                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
899                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
900                 }
902                 if ($grade->is_excluded()) {
903                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
904                 }
906                 // Do not show any icons if no grade (no record in DB to match)
907                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
908                     $itemcell->text .= $this->get_icons($element);
909                 }
911                 $hidden = '';
912                 if ($grade->is_hidden()) {
913                     $hidden = ' hidden ';
914                 }
916                 $gradepass = ' gradefail ';
917                 if ($grade->is_passed($item)) {
918                     $gradepass = ' gradepass ';
919                 } elseif (is_null($grade->is_passed($item))) {
920                     $gradepass = '';
921                 }
923                 // if in editing mode, we need to print either a text box
924                 // or a drop down (for scales)
925                 // grades in item of type grade category or course are not directly editable
926                 if ($item->needsupdate) {
927                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
929                 } else if ($USER->gradeediting[$this->courseid]) {
931                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
932                         $scale = $scalesarray[$item->scaleid];
933                         $gradeval = (int)$gradeval; // scales use only integers
934                         $scales = explode(",", $scale->scale);
935                         // reindex because scale is off 1
937                         // MDL-12104 some previous scales might have taken up part of the array
938                         // so this needs to be reset
939                         $scaleopt = array();
940                         $i = 0;
941                         foreach ($scales as $scaleoption) {
942                             $i++;
943                             $scaleopt[$i] = $scaleoption;
944                         }
946                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
947                             $oldval = empty($gradeval) ? -1 : $gradeval;
948                             if (empty($item->outcomeid)) {
949                                 $nogradestr = $this->get_lang_string('nograde');
950                             } else {
951                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
952                             }
953                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$oldval.'"/>';
954                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
955                             $itemcell->text .= html_writer::select($scaleopt, 'grade_'.$userid.'_'.$item->id, $gradeval, array(-1=>$nogradestr), $attributes);;
956                         } elseif(!empty($scale)) {
957                             $scales = explode(",", $scale->scale);
959                             // invalid grade if gradeval < 1
960                             if ($gradeval < 1) {
961                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
962                             } else {
963                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
964                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
965                             }
966                         } else {
967                             // no such scale, throw error?
968                         }
970                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
971                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
972                             $value = format_float($gradeval, $decimalpoints);
973                             $itemcell->text .= '<input type="hidden" id="oldgrade_'.$userid.'_'.$item->id.'" name="oldgrade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
974                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
975                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade_'
976                                           .$userid.'_' .$item->id.'" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
977                         } else {
978                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
979                         }
980                     }
983                     // If quickfeedback is on, print an input element
984                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
986                         $itemcell->text .= '<input type="hidden" id="oldfeedback_'.$userid.'_'.$item->id.'" name="oldfeedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
987                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
988                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback_'.$userid.'_'.$item->id.'" value="' . s($grade->feedback) . '" />';
989                     }
991                 } else { // Not editing
992                     $gradedisplaytype = $item->get_displaytype();
994                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
995                         $itemcell->attributes['class'] .= ' grade_type_scale';
996                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
997                         $itemcell->attributes['class'] .= ' grade_type_text';
998                     }
1000                     if ($this->get_pref('enableajax')) {
1001                         $itemcell->attributes['class'] .= ' clickable';
1002                     }
1004                     if ($item->needsupdate) {
1005                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
1006                     } else {
1007                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
1008                         if ($this->get_pref('showanalysisicon')) {
1009                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1010                         }
1011                     }
1012                 }
1014                 if (!empty($this->gradeserror[$item->id][$userid])) {
1015                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1016                 }
1018                 $itemrow->cells[] = $itemcell;
1019             }
1020             $rows[] = $itemrow;
1021         }
1023         if ($this->get_pref('enableajax')) {
1024             $jsarguments['cfg']['ajaxenabled'] = true;
1025             $jsarguments['cfg']['scales'] = array();
1026             foreach ($jsscales as $scale) {
1027                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
1028             }
1029             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1031             //feedbacks are now being stored in $jsarguments['feedback'] in get_right_rows()
1032             //$jsarguments['cfg']['feedback'] =  $this->feedbacks;
1033         }
1034         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1035         $jsarguments['cfg']['courseid'] =  $this->courseid;
1036         $jsarguments['cfg']['studentsperpage'] =  $this->get_pref('studentsperpage');
1037         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1039         $module = array(
1040             'name'      => 'gradereport_grader',
1041             'fullpath'  => '/grade/report/grader/module.js',
1042             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1043         );
1044         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1045         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1046         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1048         $rows = $this->get_right_range_row($rows);
1049         $rows = $this->get_right_avg_row($rows, true);
1050         $rows = $this->get_right_avg_row($rows);
1052         return $rows;
1053     }
1055     /**
1056      * Depending on the style of report (fixedstudents vs traditional one-table),
1057      * arranges the rows of data in one or two tables, and returns the output of
1058      * these tables in HTML
1059      * @return string HTML
1060      */
1061     public function get_grade_table() {
1062         global $OUTPUT;
1063         $fixedstudents = $this->is_fixed_students();
1065         $leftrows = $this->get_left_rows();
1066         $rightrows = $this->get_right_rows();
1068         $html = '';
1071         if ($fixedstudents) {
1072             $fixedcolumntable = new html_table();
1073             $fixedcolumntable->id = 'fixed_column';
1074             $fixedcolumntable->data = $leftrows;
1075             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1077             $righttable = new html_table();
1078             $righttable->id = 'user-grades';
1079             $righttable->data = $rightrows;
1081             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1082         } else {
1083             $fulltable = new html_table();
1084             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1085             $fulltable->id = 'user-grades';
1087             // Extract rows from each side (left and right) and collate them into one row each
1088             foreach ($leftrows as $key => $row) {
1089                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1090                 $fulltable->data[] = $row;
1091             }
1092             $html .= html_writer::table($fulltable);
1093         }
1094         return $OUTPUT->container($html, 'gradeparent');
1095     }
1097     /**
1098      * Builds and return the row of icons for the left side of the report.
1099      * It only has one cell that says "Controls"
1100      * @param array $rows The Array of rows for the left part of the report
1101      * @param int $colspan The number of columns this cell has to span
1102      * @return array Array of rows for the left part of the report
1103      */
1104     public function get_left_icons_row($rows=array(), $colspan=1) {
1105         global $USER;
1107         if ($USER->gradeediting[$this->courseid]) {
1108             $controlsrow = new html_table_row();
1109             $controlsrow->attributes['class'] = 'controls';
1110             $controlscell = new html_table_cell();
1111             $controlscell->attributes['class'] = 'header controls';
1112             $controlscell->colspan = $colspan;
1113             $controlscell->text = $this->get_lang_string('controls','grades');
1115             $controlsrow->cells[] = $controlscell;
1116             $rows[] = $controlsrow;
1117         }
1118         return $rows;
1119     }
1121     /**
1122      * Builds and return the header for the row of ranges, for the left part of the grader report.
1123      * @param array $rows The Array of rows for the left part of the report
1124      * @param int $colspan The number of columns this cell has to span
1125      * @return array Array of rows for the left part of the report
1126      */
1127     public function get_left_range_row($rows=array(), $colspan=1) {
1128         global $CFG, $USER;
1130         if ($this->get_pref('showranges')) {
1131             $rangerow = new html_table_row();
1132             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1133             $rangecell = new html_table_cell();
1134             $rangecell->attributes['class'] = 'header range';
1135             $rangecell->colspan = $colspan;
1136             $rangecell->header = true;
1137             $rangecell->scope = 'row';
1138             $rangecell->text = $this->get_lang_string('range','grades');
1139             $rangerow->cells[] = $rangecell;
1140             $rows[] = $rangerow;
1141         }
1143         return $rows;
1144     }
1146     /**
1147      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1148      * @param array $rows The Array of rows for the left part of the report
1149      * @param int $colspan The number of columns this cell has to span
1150      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1151      * @return array Array of rows for the left part of the report
1152      */
1153     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1154         if (!$this->canviewhidden) {
1155             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1156             // better not show them at all if user can not see all hideen grades
1157             return $rows;
1158         }
1160         $showaverages = $this->get_pref('showaverages');
1161         $showaveragesgroup = $this->currentgroup && $showaverages;
1162         $straveragegroup = get_string('groupavg', 'grades');
1164         if ($groupavg) {
1165             if ($showaveragesgroup) {
1166                 $groupavgrow = new html_table_row();
1167                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1168                 $groupavgcell = new html_table_cell();
1169                 $groupavgcell->attributes['class'] = 'header range';
1170                 $groupavgcell->colspan = $colspan;
1171                 $groupavgcell->header = true;
1172                 $groupavgcell->scope = 'row';
1173                 $groupavgcell->text = $straveragegroup;
1174                 $groupavgrow->cells[] = $groupavgcell;
1175                 $rows[] = $groupavgrow;
1176             }
1177         } else {
1178             $straverage = get_string('overallaverage', 'grades');
1180             if ($showaverages) {
1181                 $avgrow = new html_table_row();
1182                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1183                 $avgcell = new html_table_cell();
1184                 $avgcell->attributes['class'] = 'header range';
1185                 $avgcell->colspan = $colspan;
1186                 $avgcell->header = true;
1187                 $avgcell->scope = 'row';
1188                 $avgcell->text = $straverage;
1189                 $avgrow->cells[] = $avgcell;
1190                 $rows[] = $avgrow;
1191             }
1192         }
1194         return $rows;
1195     }
1197     /**
1198      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1199      * @param array $rows The Array of rows for the right part of the report
1200      * @return array Array of rows for the right part of the report
1201      */
1202     public function get_right_icons_row($rows=array()) {
1203         global $USER;
1204         if ($USER->gradeediting[$this->courseid]) {
1205             $iconsrow = new html_table_row();
1206             $iconsrow->attributes['class'] = 'controls';
1208             foreach ($this->gtree->items as $itemid=>$unused) {
1209                 // emulate grade element
1210                 $item =& $this->gtree->get_item($itemid);
1212                 $eid = $this->gtree->get_item_eid($item);
1213                 $element = $this->gtree->locate_element($eid);
1214                 $itemcell = new html_table_cell();
1215                 $itemcell->attributes['class'] = 'controls icons';
1216                 $itemcell->text = $this->get_icons($element);
1217                 $iconsrow->cells[] = $itemcell;
1218             }
1219             $rows[] = $iconsrow;
1220         }
1221         return $rows;
1222     }
1224     /**
1225      * Builds and return the row of ranges for the right part of the grader report.
1226      * @param array $rows The Array of rows for the right part of the report
1227      * @return array Array of rows for the right part of the report
1228      */
1229     public function get_right_range_row($rows=array()) {
1230         global $OUTPUT;
1232         if ($this->get_pref('showranges')) {
1233             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1234             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1235             $rangerow = new html_table_row();
1236             $rangerow->attributes['class'] = 'heading range';
1238             foreach ($this->gtree->items as $itemid=>$unused) {
1239                 $item =& $this->gtree->items[$itemid];
1240                 $itemcell = new html_table_cell();
1241                 $itemcell->header = true;
1242                 $itemcell->attributes['class'] .= ' header range';
1244                 $hidden = '';
1245                 if ($item->is_hidden()) {
1246                     $hidden = ' hidden ';
1247                 }
1249                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1251                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1252                 $rangerow->cells[] = $itemcell;
1253             }
1254             $rows[] = $rangerow;
1255         }
1256         return $rows;
1257     }
1259     /**
1260      * Builds and return the row of averages for the right part of the grader report.
1261      * @param array $rows Whether to return only group averages or all averages.
1262      * @param bool $grouponly Whether to return only group averages or all averages.
1263      * @return array Array of rows for the right part of the report
1264      */
1265     public function get_right_avg_row($rows=array(), $grouponly=false) {
1266         global $CFG, $USER, $DB, $OUTPUT;
1268         if (!$this->canviewhidden) {
1269             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1270             // better not show them at all if user can not see all hidden grades
1271             return $rows;
1272         }
1274         $showaverages = $this->get_pref('showaverages');
1275         $showaveragesgroup = $this->currentgroup && $showaverages;
1277         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1278         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1279         $meanselection         = $this->get_pref('meanselection');
1280         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1282         $avghtml = '';
1283         $avgcssclass = 'avg';
1285         if ($grouponly) {
1286             $straverage = get_string('groupavg', 'grades');
1287             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1288             $groupsql = $this->groupsql;
1289             $groupwheresql = $this->groupwheresql;
1290             $groupwheresqlparams = $this->groupwheresql_params;
1291             $avgcssclass = 'groupavg';
1292         } else {
1293             $straverage = get_string('overallaverage', 'grades');
1294             $showaverages = $this->get_pref('showaverages');
1295             $groupsql = "";
1296             $groupwheresql = "";
1297             $groupwheresqlparams = array();
1298         }
1300         if ($shownumberofgrades) {
1301             $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
1302         }
1304         $totalcount = $this->get_numusers($grouponly);
1306         //limit to users with a gradeable role
1307         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1309         //limit to users with an active enrollment
1310         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
1312         if ($showaverages) {
1313             $params = array_merge(array('courseid'=>$this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams);
1315             // find sums of all grade items in course
1316             $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1317                       FROM {grade_items} gi
1318                       JOIN {grade_grades} g ON g.itemid = gi.id
1319                       JOIN {user} u ON u.id = g.userid
1320                       JOIN ($enrolledsql) je ON je.id = u.id
1321                       JOIN (
1322                                SELECT DISTINCT ra.userid
1323                                  FROM {role_assignments} ra
1324                                 WHERE ra.roleid $gradebookrolessql
1325                                   AND ra.contextid " . get_related_contexts_string($this->context) . "
1326                            ) rainner ON rainner.userid = u.id
1327                       $groupsql
1328                      WHERE gi.courseid = :courseid
1329                        AND u.deleted = 0
1330                        AND g.finalgrade IS NOT NULL
1331                        $groupwheresql
1332                      GROUP BY g.itemid";
1333             $sumarray = array();
1334             if ($sums = $DB->get_records_sql($sql, $params)) {
1335                 foreach ($sums as $itemid => $csum) {
1336                     $sumarray[$itemid] = $csum->sum;
1337                 }
1338             }
1340             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1341             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1342             $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1343                       FROM {grade_items} gi
1344                       CROSS JOIN {user} u
1345                       JOIN ($enrolledsql) je
1346                            ON je.id = u.id
1347                       JOIN {role_assignments} ra
1348                            ON ra.userid = u.id
1349                       LEFT OUTER JOIN {grade_grades} g
1350                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1351                       $groupsql
1352                      WHERE gi.courseid = :courseid
1353                            AND ra.roleid $gradebookrolessql
1354                            AND ra.contextid ".get_related_contexts_string($this->context)."
1355                            AND u.deleted = 0
1356                            AND g.id IS NULL
1357                            $groupwheresql
1358                   GROUP BY gi.id";
1360             $ungradedcounts = $DB->get_records_sql($sql, $params);
1362             $avgrow = new html_table_row();
1363             $avgrow->attributes['class'] = 'avg';
1365             foreach ($this->gtree->items as $itemid=>$unused) {
1366                 $item =& $this->gtree->items[$itemid];
1368                 if ($item->needsupdate) {
1369                     $avgcell = new html_table_cell();
1370                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1371                     $avgrow->cells[] = $avgcell;
1372                     continue;
1373                 }
1375                 if (!isset($sumarray[$item->id])) {
1376                     $sumarray[$item->id] = 0;
1377                 }
1379                 if (empty($ungradedcounts[$itemid])) {
1380                     $ungradedcount = 0;
1381                 } else {
1382                     $ungradedcount = $ungradedcounts[$itemid]->count;
1383                 }
1385                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1386                     $meancount = $totalcount - $ungradedcount;
1387                 } else { // Bump up the sum by the number of ungraded items * grademin
1388                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1389                     $meancount = $totalcount;
1390                 }
1392                 $decimalpoints = $item->get_decimals();
1394                 // Determine which display type to use for this average
1395                 if ($USER->gradeediting[$this->courseid]) {
1396                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1398                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1399                     $displaytype = $item->get_displaytype();
1401                 } else {
1402                     $displaytype = $averagesdisplaytype;
1403                 }
1405                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1406                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1407                     $decimalpoints = $item->get_decimals();
1409                 } else {
1410                     $decimalpoints = $averagesdecimalpoints;
1411                 }
1413                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1414                     $avgcell = new html_table_cell();
1415                     $avgcell->text = '-';
1416                     $avgrow->cells[] = $avgcell;
1418                 } else {
1419                     $sum = $sumarray[$item->id];
1420                     $avgradeval = $sum/$meancount;
1421                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1423                     $numberofgrades = '';
1424                     if ($shownumberofgrades) {
1425                         $numberofgrades = " ($meancount)";
1426                     }
1428                     $avgcell = new html_table_cell();
1429                     $avgcell->text = $gradehtml.$numberofgrades;
1430                     $avgrow->cells[] = $avgcell;
1431                 }
1432             }
1433             $rows[] = $avgrow;
1434         }
1435         return $rows;
1436     }
1438     /**
1439      * Given a grade_category, grade_item or grade_grade, this function
1440      * figures out the state of the object and builds then returns a div
1441      * with the icons needed for the grader report.
1442      *
1443      * @param array $object
1444      * @return string HTML
1445      */
1446     protected function get_icons($element) {
1447         global $CFG, $USER, $OUTPUT;
1449         if (!$USER->gradeediting[$this->courseid]) {
1450             return '<div class="grade_icons" />';
1451         }
1453         // Init all icons
1454         $editicon = '';
1456         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1457             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1458         }
1460         $editcalculationicon = '';
1461         $showhideicon        = '';
1462         $lockunlockicon      = '';
1464         if (has_capability('moodle/grade:manage', $this->context)) {
1465             if ($this->get_pref('showcalculations')) {
1466                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1467             }
1469             if ($this->get_pref('showeyecons')) {
1470                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1471             }
1473             if ($this->get_pref('showlocks')) {
1474                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1475             }
1477         }
1479         $gradeanalysisicon   = '';
1480         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1481             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1482         }
1484         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1485     }
1487     /**
1488      * Given a category element returns collapsing +/- icon if available
1489      * @param object $object
1490      * @return string HTML
1491      */
1492     protected function get_collapsing_icon($element) {
1493         global $OUTPUT;
1495         $icon = '';
1496         // If object is a category, display expand/contract icon
1497         if ($element['type'] == 'category') {
1498             // Load language strings
1499             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1500             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1501             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1503             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1505             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1506                 $url->param('action', 'switch_plus');
1507                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1509             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1510                 $url->param('action', 'switch_whole');
1511                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1513             } else {
1514                 $url->param('action', 'switch_minus');
1515                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1516             }
1517         }
1518         return $icon;
1519     }
1521     /**
1522      * Processes a single action against a category, grade_item or grade.
1523      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1524      * @param string $action Which action to take (edit, delete etc...)
1525      * @return
1526      */
1527     public function process_action($target, $action) {
1528         // TODO: this code should be in some grade_tree static method
1529         $targettype = substr($target, 0, 1);
1530         $targetid = substr($target, 1);
1531         // TODO: end
1533         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1534             $collapsed = unserialize($collapsed);
1535         } else {
1536             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1537         }
1539         switch ($action) {
1540             case 'switch_minus': // Add category to array of aggregatesonly
1541                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1542                     $collapsed['aggregatesonly'][] = $targetid;
1543                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1544                 }
1545                 break;
1547             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1548                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1549                 if ($key !== false) {
1550                     unset($collapsed['aggregatesonly'][$key]);
1551                 }
1552                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1553                     $collapsed['gradesonly'][] = $targetid;
1554                 }
1555                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1556                 break;
1557             case 'switch_whole': // Remove the category from the array of collapsed cats
1558                 $key = array_search($targetid, $collapsed['gradesonly']);
1559                 if ($key !== false) {
1560                     unset($collapsed['gradesonly'][$key]);
1561                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1562                 }
1564                 break;
1565             default:
1566                 break;
1567         }
1569         return true;
1570     }
1572     /**
1573      * Returns whether or not to display fixed students column.
1574      * Includes a browser check, because IE6 doesn't support the scrollbar.
1575      *
1576      * @return bool
1577      */
1578     public function is_fixed_students() {
1579         global $USER, $CFG;
1580         return empty($USER->screenreader) && $CFG->grade_report_fixedstudents &&
1581             (check_browser_version('MSIE', '7.0') ||
1582              check_browser_version('Firefox', '2.0') ||
1583              check_browser_version('Gecko', '2006010100') ||
1584              check_browser_version('Camino', '1.0') ||
1585              check_browser_version('Opera', '6.0') ||
1586              check_browser_version('Chrome', '6') ||
1587              check_browser_version('Safari', '300'));
1588     }
1590     /**
1591      * Refactored function for generating HTML of sorting links with matching arrows.
1592      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1593      * to inject into a table header cell.
1594      * @param array $extrafields Array of extra fields being displayed, such as
1595      *   user idnumber
1596      * @return array An associative array of HTML sorting links+arrows
1597      */
1598     public function get_sort_arrows(array $extrafields = array()) {
1599         global $OUTPUT;
1600         $arrows = array();
1602         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1603         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1604         $strfirstname = $this->get_lang_string('firstname');
1605         $strlastname  = $this->get_lang_string('lastname');
1607         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1608         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1610         $arrows['studentname'] = $lastlink;
1612         if ($this->sortitemid === 'lastname') {
1613             if ($this->sortorder == 'ASC') {
1614                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1615             } else {
1616                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1617             }
1618         }
1620         $arrows['studentname'] .= ' ' . $firstlink;
1622         if ($this->sortitemid === 'firstname') {
1623             if ($this->sortorder == 'ASC') {
1624                 $arrows['studentname'] .= print_arrow('up', $strsortasc, true);
1625             } else {
1626                 $arrows['studentname'] .= print_arrow('down', $strsortdesc, true);
1627             }
1628         }
1630         foreach ($extrafields as $field) {
1631             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1632                     array('sortitemid'=>$field)), get_user_field_name($field));
1633             $arrows[$field] = $fieldlink;
1635             if ($field == $this->sortitemid) {
1636                 if ($this->sortorder == 'ASC') {
1637                     $arrows[$field] .= print_arrow('up', $strsortasc, true);
1638                 } else {
1639                     $arrows[$field] .= print_arrow('down', $strsortdesc, true);
1640                 }
1641             }
1642         }
1644         return $arrows;
1645     }