Merge branch 'wip-mdl-40400' of git://github.com/rajeshtaneja/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', context_course::instance($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_students_per_page();
141         if (!empty($this->page) && !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));
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         $this->load_users();
179         $this->load_final_grades();
181         // Were any changes made?
182         $changedgrades = false;
184         foreach ($data as $varname => $students) {
186             $needsupdate = false;
188             // skip, not a grade nor feedback
189             if (strpos($varname, 'grade') === 0) {
190                 $datatype = 'grade';
191             } else if (strpos($varname, 'feedback') === 0) {
192                 $datatype = 'feedback';
193             } else {
194                 continue;
195             }
197             foreach ($students as $userid => $items) {
198                 $userid = clean_param($userid, PARAM_INT);
199                 foreach ($items as $itemid => $postedvalue) {
200                     $itemid = clean_param($itemid, PARAM_INT);
202                     // Was change requested?
203                     $oldvalue = $this->grades[$userid][$itemid];
204                     if ($datatype === 'grade') {
205                         // If there was no grade and there still isn't
206                         if (is_null($oldvalue->finalgrade) && $postedvalue == -1) {
207                             // -1 means no grade
208                             continue;
209                         }
211                         // If the grade item uses a custom scale
212                         if (!empty($oldvalue->grade_item->scaleid)) {
214                             if ((int)$oldvalue->finalgrade === (int)$postedvalue) {
215                                 continue;
216                             }
217                         } else {
218                             // The grade item uses a numeric scale
220                             // Format the finalgrade from the DB so that it matches the grade from the client
221                             if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) {
222                                 continue;
223                             }
224                         }
226                         $changedgrades = true;
228                     } else if ($datatype === 'feedback') {
229                         if (($oldvalue->feedback === $postedvalue) or ($oldvalue->feedback === NULL and empty($postedvalue))) {
230                             continue;
231                         }
232                     }
234                     if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) {
235                         print_error('invalidgradeitemid');
236                     }
238                     // Pre-process grade
239                     if ($datatype == 'grade') {
240                         $feedback = false;
241                         $feedbackformat = false;
242                         if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
243                             if ($postedvalue == -1) { // -1 means no grade
244                                 $finalgrade = null;
245                             } else {
246                                 $finalgrade = $postedvalue;
247                             }
248                         } else {
249                             $finalgrade = unformat_float($postedvalue);
250                         }
252                         $errorstr = '';
253                         // Warn if the grade is out of bounds.
254                         if (is_null($finalgrade)) {
255                             // ok
256                         } else {
257                             $bounded = $gradeitem->bounded_grade($finalgrade);
258                             if ($bounded > $finalgrade) {
259                                 $errorstr = 'lessthanmin';
260                             } else if ($bounded < $finalgrade) {
261                                 $errorstr = 'morethanmax';
262                             }
263                         }
264                         if ($errorstr) {
265                             $user = $DB->get_record('user', array('id' => $userid), 'id, firstname, lastname');
266                             $gradestr = new stdClass();
267                             $gradestr->username = fullname($user);
268                             $gradestr->itemname = $gradeitem->get_name();
269                             $warnings[] = get_string($errorstr, 'grades', $gradestr);
270                         }
272                     } else if ($datatype == 'feedback') {
273                         $finalgrade = false;
274                         $trimmed = trim($postedvalue);
275                         if (empty($trimmed)) {
276                              $feedback = NULL;
277                         } else {
278                              $feedback = $postedvalue;
279                         }
280                     }
282                     // group access control
283                     if ($separategroups) {
284                         // note: we can not use $this->currentgroup because it would fail badly
285                         //       when having two browser windows each with different group
286                         $sharinggroup = false;
287                         foreach($mygroups as $groupid) {
288                             if (groups_is_member($groupid, $userid)) {
289                                 $sharinggroup = true;
290                                 break;
291                             }
292                         }
293                         if (!$sharinggroup) {
294                             // either group membership changed or somebody is hacking grades of other group
295                             $warnings[] = get_string('errorsavegrade', 'grades');
296                             continue;
297                         }
298                     }
300                     $url = '/report/grader/index.php?id=' . $this->course->id;
301                     $fullname = fullname($this->users[$userid]);
303                     $info = "{$gradeitem->itemname}: $fullname";
304                     add_to_log($this->course->id, 'grade', 'update', $url, $info);
306                     $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
308                     // We can update feedback without reloading the grade item as it doesn't affect grade calculations
309                     if ($datatype === 'feedback') {
310                         $this->grades[$userid][$itemid]->feedback = $feedback;
311                     }
312                 }
313             }
314         }
316         if ($changedgrades) {
317             // If a final grade was overriden reload grades so dependent grades like course total will be correct
318             $this->grades = null;
319         }
321         return $warnings;
322     }
325     /**
326      * Setting the sort order, this depends on last state
327      * all this should be in the new table class that we might need to use
328      * for displaying grades.
329      */
330     private function setup_sortitemid() {
332         global $SESSION;
334         if (!isset($SESSION->gradeuserreport)) {
335             $SESSION->gradeuserreport = new stdClass();
336         }
338         if ($this->sortitemid) {
339             if (!isset($SESSION->gradeuserreport->sort)) {
340                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
341                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
342                 } else {
343                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
344                 }
345             } else {
346                 // this is the first sort, i.e. by last name
347                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
348                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
349                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
350                     } else {
351                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
352                     }
353                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
354                     // same as last sort
355                     if ($SESSION->gradeuserreport->sort == 'ASC') {
356                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
357                     } else {
358                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
359                     }
360                 } else {
361                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
362                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
363                     } else {
364                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
365                     }
366                 }
367             }
368             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
369         } else {
370             // not requesting sort, use last setting (for paging)
372             if (isset($SESSION->gradeuserreport->sortitemid)) {
373                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
374             }else{
375                 $this->sortitemid = 'lastname';
376             }
378             if (isset($SESSION->gradeuserreport->sort)) {
379                 $this->sortorder = $SESSION->gradeuserreport->sort;
380             } else {
381                 $this->sortorder = 'ASC';
382             }
383         }
384     }
386     /**
387      * pulls out the userids of the users to be display, and sorts them
388      */
389     public function load_users() {
390         global $CFG, $DB;
392         if (!empty($this->users)) {
393             return;
394         }
396         //limit to users with a gradeable role
397         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
399         //limit to users with an active enrollment
400         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
402         //fields we need from the user table
403         $userfields = user_picture::fields('u', get_extra_user_fields($this->context));
405         $sortjoin = $sort = $params = null;
407         //if the user has clicked one of the sort asc/desc arrows
408         if (is_numeric($this->sortitemid)) {
409             $params = array_merge(array('gitemid'=>$this->sortitemid), $gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
411             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
412             $sort = "g.finalgrade $this->sortorder";
414         } else {
415             $sortjoin = '';
416             switch($this->sortitemid) {
417                 case 'lastname':
418                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
419                     break;
420                 case 'firstname':
421                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
422                     break;
423                 case 'email':
424                     $sort = "u.email $this->sortorder";
425                     break;
426                 case 'idnumber':
427                 default:
428                     $sort = "u.idnumber $this->sortorder";
429                     break;
430             }
432             $params = array_merge($gradebookrolesparams, $this->groupwheresql_params, $enrolledparams);
433         }
435         $sql = "SELECT $userfields
436                   FROM {user} u
437                   JOIN ($enrolledsql) je ON je.id = u.id
438                        $this->groupsql
439                        $sortjoin
440                   JOIN (
441                            SELECT DISTINCT ra.userid
442                              FROM {role_assignments} ra
443                             WHERE ra.roleid IN ($this->gradebookroles)
444                               AND ra.contextid " . get_related_contexts_string($this->context) . "
445                        ) rainner ON rainner.userid = u.id
446                    AND u.deleted = 0
447                    $this->groupwheresql
448               ORDER BY $sort";
450         $studentsperpage = $this->get_students_per_page();
451         $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage);
453         if (empty($this->users)) {
454             $this->userselect = '';
455             $this->users = array();
456             $this->userselect_params = array();
457         } else {
458             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
459             $this->userselect = "AND g.userid $usql";
460             $this->userselect_params = $uparams;
462             // Add a flag to each user indicating whether their enrolment is active.
463             $sql = "SELECT ue.userid
464                       FROM {user_enrolments} ue
465                       JOIN {enrol} e ON e.id = ue.enrolid
466                      WHERE ue.userid $usql
467                            AND ue.status = :uestatus
468                            AND e.status = :estatus
469                            AND e.courseid = :courseid
470                   GROUP BY ue.userid";
471             $coursecontext = get_course_context($this->context);
472             $params = array_merge($uparams, array('estatus'=>ENROL_INSTANCE_ENABLED, 'uestatus'=>ENROL_USER_ACTIVE, 'courseid'=>$coursecontext->instanceid));
473             $useractiveenrolments = $DB->get_records_sql($sql, $params);
475             $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
476             $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
477             $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
478             foreach ($this->users as $user) {
479                 // If we are showing only active enrolments, then remove suspended users from list.
480                 if ($showonlyactiveenrol && !array_key_exists($user->id, $useractiveenrolments)) {
481                     unset($this->users[$user->id]);
482                 } else {
483                     $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
484                 }
485             }
486         }
488         return $this->users;
489     }
491     /**
492      * we supply the userids in this query, and get all the grades
493      * pulls out all the grades, this does not need to worry about paging
494      */
495     public function load_final_grades() {
496         global $CFG, $DB;
498         if (!empty($this->grades)) {
499             return;
500         }
502         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
503         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
504         $sql = "SELECT g.*
505                   FROM {grade_items} gi,
506                        {grade_grades} g
507                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
509         $userids = array_keys($this->users);
512         if ($grades = $DB->get_records_sql($sql, $params)) {
513             foreach ($grades as $graderec) {
514                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
515                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
516                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
517                 }
518             }
519         }
521         // prefil grades that do not exist yet
522         foreach ($userids as $userid) {
523             foreach ($this->gtree->get_items() as $itemid=>$unused) {
524                 if (!isset($this->grades[$userid][$itemid])) {
525                     $this->grades[$userid][$itemid] = new grade_grade();
526                     $this->grades[$userid][$itemid]->itemid = $itemid;
527                     $this->grades[$userid][$itemid]->userid = $userid;
528                     $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
529                 }
530             }
531         }
532     }
534     /**
535      * @deprecated since Moodle 2.4 as it appears not to be used any more.
536      */
537     public function get_toggles_html() {
538         throw new coding_exception('get_toggles_html() can not be used any more');
539     }
541     /**
542      * @deprecated since 2.4 as it appears not to be used any more.
543      */
544     public function print_toggle($type) {
545         throw new coding_exception('print_toggle() can not be used any more');
546     }
548     /**
549      * Builds and returns the rows that will make up the left part of the grader report
550      * This consists of student names and icons, links to user reports and id numbers, as well
551      * as header cells for these columns. It also includes the fillers required for the
552      * categories displayed on the right side of the report.
553      * @return array Array of html_table_row objects
554      */
555     public function get_left_rows() {
556         global $CFG, $USER, $OUTPUT;
558         $rows = array();
560         $showuserimage = $this->get_pref('showuserimage');
562         $strfeedback  = $this->get_lang_string("feedback");
563         $strgrade     = $this->get_lang_string('grade');
565         $extrafields = get_extra_user_fields($this->context);
567         $arrows = $this->get_sort_arrows($extrafields);
569         $colspan = 1;
570         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
571             $colspan++;
572         }
573         $colspan += count($extrafields);
575         $levels = count($this->gtree->levels) - 1;
577         for ($i = 0; $i < $levels; $i++) {
578             $fillercell = new html_table_cell();
579             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
580             $fillercell->text = ' ';
581             $fillercell->colspan = $colspan;
582             $row = new html_table_row(array($fillercell));
583             $rows[] = $row;
584         }
586         $headerrow = new html_table_row();
587         $headerrow->attributes['class'] = 'heading';
589         $studentheader = new html_table_cell();
590         $studentheader->attributes['class'] = 'header';
591         $studentheader->scope = 'col';
592         $studentheader->header = true;
593         $studentheader->id = 'studentheader';
594         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
595             $studentheader->colspan = 2;
596         }
597         $studentheader->text = $arrows['studentname'];
599         $headerrow->cells[] = $studentheader;
601         foreach ($extrafields as $field) {
602             $fieldheader = new html_table_cell();
603             $fieldheader->attributes['class'] = 'header userfield user' . $field;
604             $fieldheader->scope = 'col';
605             $fieldheader->header = true;
606             $fieldheader->text = $arrows[$field];
608             $headerrow->cells[] = $fieldheader;
609         }
611         $rows[] = $headerrow;
613         $rows = $this->get_left_icons_row($rows, $colspan);
615         $rowclasses = array('even', 'odd');
617         $suspendedstring = null;
618         foreach ($this->users as $userid => $user) {
619             $userrow = new html_table_row();
620             $userrow->id = 'fixed_user_'.$userid;
621             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
623             $usercell = new html_table_cell();
624             $usercell->attributes['class'] = 'user';
626             $usercell->header = true;
627             $usercell->scope = 'row';
629             if ($showuserimage) {
630                 $usercell->text = $OUTPUT->user_picture($user);
631             }
633             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
635             if (!empty($user->suspendedenrolment)) {
636                 $usercell->attributes['class'] .= ' usersuspended';
638                 //may be lots of suspended users so only get the string once
639                 if (empty($suspendedstring)) {
640                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
641                 }
642                 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring, 'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
643             }
645             $userrow->cells[] = $usercell;
647             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
648                 $userreportcell = new html_table_cell();
649                 $userreportcell->attributes['class'] = 'userreport';
650                 $userreportcell->header = true;
651                 $a = new stdClass();
652                 $a->user = fullname($user);
653                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
654                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
655                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
656                 $userrow->cells[] = $userreportcell;
657             }
659             foreach ($extrafields as $field) {
660                 $fieldcell = new html_table_cell();
661                 $fieldcell->attributes['class'] = 'header userfield user' . $field;
662                 $fieldcell->header = true;
663                 $fieldcell->scope = 'row';
664                 $fieldcell->text = $user->{$field};
665                 $userrow->cells[] = $fieldcell;
666             }
668             $rows[] = $userrow;
669         }
671         $rows = $this->get_left_range_row($rows, $colspan);
672         $rows = $this->get_left_avg_row($rows, $colspan, true);
673         $rows = $this->get_left_avg_row($rows, $colspan);
675         return $rows;
676     }
678     /**
679      * Builds and returns the rows that will make up the right part of the grader report
680      * @return array Array of html_table_row objects
681      */
682     public function get_right_rows() {
683         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
685         $rows = array();
686         $this->rowcount = 0;
687         $numrows = count($this->gtree->get_levels());
688         $numusers = count($this->users);
689         $gradetabindex = 1;
690         $columnstounset = array();
691         $strgrade = $this->get_lang_string('grade');
692         $strfeedback  = $this->get_lang_string("feedback");
693         $arrows = $this->get_sort_arrows();
695         $jsarguments = array(
696             'id'        => '#fixed_column',
697             'cfg'       => array('ajaxenabled'=>false),
698             'items'     => array(),
699             'users'     => array(),
700             'feedback'  => array()
701         );
702         $jsscales = array();
704         foreach ($this->gtree->get_levels() as $key=>$row) {
705             if ($key == 0) {
706                 // do not display course grade category
707                 // continue;
708             }
710             $headingrow = new html_table_row();
711             $headingrow->attributes['class'] = 'heading_name_row';
713             foreach ($row as $columnkey => $element) {
714                 $sortlink = clone($this->baseurl);
715                 if (isset($element['object']->id)) {
716                     $sortlink->param('sortitemid', $element['object']->id);
717                 }
719                 $eid    = $element['eid'];
720                 $object = $element['object'];
721                 $type   = $element['type'];
722                 $categorystate = @$element['categorystate'];
724                 if (!empty($element['colspan'])) {
725                     $colspan = $element['colspan'];
726                 } else {
727                     $colspan = 1;
728                 }
730                 if (!empty($element['depth'])) {
731                     $catlevel = 'catlevel'.$element['depth'];
732                 } else {
733                     $catlevel = '';
734                 }
736 // Element is a filler
737                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
738                     $fillercell = new html_table_cell();
739                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
740                     $fillercell->colspan = $colspan;
741                     $fillercell->text = '&nbsp;';
742                     $fillercell->header = true;
743                     $fillercell->scope = 'col';
744                     $headingrow->cells[] = $fillercell;
745                 }
746 // Element is a category
747                 else if ($type == 'category') {
748                     $categorycell = new html_table_cell();
749                     $categorycell->attributes['class'] = 'category ' . $catlevel;
750                     $categorycell->colspan = $colspan;
751                     $categorycell->text = shorten_text($element['object']->get_name());
752                     $categorycell->text .= $this->get_collapsing_icon($element);
753                     $categorycell->header = true;
754                     $categorycell->scope = 'col';
756                     // Print icons
757                     if ($USER->gradeediting[$this->courseid]) {
758                         $categorycell->text .= $this->get_icons($element);
759                     }
761                     $headingrow->cells[] = $categorycell;
762                 }
763 // Element is a grade_item
764                 else {
765                     //$itemmodule = $element['object']->itemmodule;
766                     //$iteminstance = $element['object']->iteminstance;
768                     if ($element['object']->id == $this->sortitemid) {
769                         if ($this->sortorder == 'ASC') {
770                             $arrow = $this->get_sort_arrow('up', $sortlink);
771                         } else {
772                             $arrow = $this->get_sort_arrow('down', $sortlink);
773                         }
774                     } else {
775                         $arrow = $this->get_sort_arrow('move', $sortlink);
776                     }
778                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
780                     $itemcell = new html_table_cell();
781                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable';
783                     if ($element['object']->is_hidden()) {
784                         $itemcell->attributes['class'] .= ' dimmed_text';
785                     }
787                     $itemcell->colspan = $colspan;
788                     $itemcell->text = shorten_text($headerlink) . $arrow;
789                     $itemcell->header = true;
790                     $itemcell->scope = 'col';
792                     $headingrow->cells[] = $itemcell;
793                 }
794             }
795             $rows[] = $headingrow;
796         }
798         $rows = $this->get_right_icons_row($rows);
800         // Preload scale objects for items with a scaleid and initialize tab indices
801         $scaleslist = array();
802         $tabindices = array();
804         foreach ($this->gtree->get_items() as $itemid=>$item) {
805             $scale = null;
806             if (!empty($item->scaleid)) {
807                 $scaleslist[] = $item->scaleid;
808                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
809             } else {
810                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
811             }
812             $tabindices[$item->id]['grade'] = $gradetabindex;
813             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
814             $gradetabindex += $numusers * 2;
815         }
816         $scalesarray = array();
818         if (!empty($scaleslist)) {
819             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
820         }
821         $jsscales = $scalesarray;
823         $rowclasses = array('even', 'odd');
825         foreach ($this->users as $userid => $user) {
827             if ($this->canviewhidden) {
828                 $altered = array();
829                 $unknown = array();
830             } else {
831                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
832                 $altered = $hidingaffected['altered'];
833                 $unknown = $hidingaffected['unknown'];
834                 unset($hidingaffected);
835             }
838             $itemrow = new html_table_row();
839             $itemrow->id = 'user_'.$userid;
840             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
842             $jsarguments['users'][$userid] = fullname($user);
844             foreach ($this->gtree->items as $itemid=>$unused) {
845                 $item =& $this->gtree->items[$itemid];
846                 $grade = $this->grades[$userid][$item->id];
848                 $itemcell = new html_table_cell();
850                 $itemcell->id = 'u'.$userid.'i'.$itemid;
852                 // Get the decimal points preference for this item
853                 $decimalpoints = $item->get_decimals();
855                 if (in_array($itemid, $unknown)) {
856                     $gradeval = null;
857                 } else if (array_key_exists($itemid, $altered)) {
858                     $gradeval = $altered[$itemid];
859                 } else {
860                     $gradeval = $grade->finalgrade;
861                 }
862                 if (!empty($grade->finalgrade)) {
863                     $gradevalforJS = null;
864                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
865                         $gradevalforJS = (int)$gradeval;
866                     } else {
867                         $gradevalforJS = format_float($gradeval, $decimalpoints);
868                     }
869                     $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforJS);
870                 }
872                 // MDL-11274
873                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
874                 if (!$this->canviewhidden and $grade->is_hidden()) {
875                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
876                         // 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
877                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
878                     } else {
879                         $itemcell->text = '-';
880                     }
881                     $itemrow->cells[] = $itemcell;
882                     continue;
883                 }
885                 // emulate grade element
886                 $eid = $this->gtree->get_grade_eid($grade);
887                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
889                 $itemcell->attributes['class'] .= ' grade';
890                 if ($item->is_category_item()) {
891                     $itemcell->attributes['class'] .= ' cat';
892                 }
893                 if ($item->is_course_item()) {
894                     $itemcell->attributes['class'] .= ' course';
895                 }
896                 if ($grade->is_overridden()) {
897                     $itemcell->attributes['class'] .= ' overridden';
898                 }
900                 if ($grade->is_excluded()) {
901                     // $itemcell->attributes['class'] .= ' excluded';
902                 }
904                 if (!empty($grade->feedback)) {
905                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
906                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
907                 }
909                 if ($grade->is_excluded()) {
910                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
911                 }
913                 // Do not show any icons if no grade (no record in DB to match)
914                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
915                     $itemcell->text .= $this->get_icons($element);
916                 }
918                 $hidden = '';
919                 if ($grade->is_hidden()) {
920                     $hidden = ' hidden ';
921                 }
923                 $gradepass = ' gradefail ';
924                 if ($grade->is_passed($item)) {
925                     $gradepass = ' gradepass ';
926                 } elseif (is_null($grade->is_passed($item))) {
927                     $gradepass = '';
928                 }
930                 // if in editing mode, we need to print either a text box
931                 // or a drop down (for scales)
932                 // grades in item of type grade category or course are not directly editable
933                 if ($item->needsupdate) {
934                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
936                 } else if ($USER->gradeediting[$this->courseid]) {
938                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
939                         $scale = $scalesarray[$item->scaleid];
940                         $gradeval = (int)$gradeval; // scales use only integers
941                         $scales = explode(",", $scale->scale);
942                         // reindex because scale is off 1
944                         // MDL-12104 some previous scales might have taken up part of the array
945                         // so this needs to be reset
946                         $scaleopt = array();
947                         $i = 0;
948                         foreach ($scales as $scaleoption) {
949                             $i++;
950                             $scaleopt[$i] = $scaleoption;
951                         }
953                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
954                             $oldval = empty($gradeval) ? -1 : $gradeval;
955                             if (empty($item->outcomeid)) {
956                                 $nogradestr = $this->get_lang_string('nograde');
957                             } else {
958                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
959                             }
960                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
961                             $itemcell->text .= html_writer::label(get_string('typescale', 'grades'), $attributes['id'], false, array('class' => 'accesshide'));
962                             $itemcell->text .= html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, array(-1=>$nogradestr), $attributes);
963                         } elseif(!empty($scale)) {
964                             $scales = explode(",", $scale->scale);
966                             // invalid grade if gradeval < 1
967                             if ($gradeval < 1) {
968                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
969                             } else {
970                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
971                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
972                             }
973                         } else {
974                             // no such scale, throw error?
975                         }
977                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
978                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
979                             $value = format_float($gradeval, $decimalpoints);
980                             $gradelabel = fullname($user) . ' ' . $item->itemname;
981                             $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">'
982                                           .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>';
983                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
984                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade['
985                                           .$userid.'][' .$item->id.']" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
986                         } else {
987                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
988                         }
989                     }
992                     // If quickfeedback is on, print an input element
993                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
994                         $feedbacklabel = fullname($user) . ' ' . $item->itemname;
995                         $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">'
996                                       .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>';
997                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
998                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback['.$userid.']['.$item->id.']" value="' . s($grade->feedback) . '" />';
999                     }
1001                 } else { // Not editing
1002                     $gradedisplaytype = $item->get_displaytype();
1004                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1005                         $itemcell->attributes['class'] .= ' grade_type_scale';
1006                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
1007                         $itemcell->attributes['class'] .= ' grade_type_text';
1008                     }
1010                     if ($this->get_pref('enableajax')) {
1011                         $itemcell->attributes['class'] .= ' clickable';
1012                     }
1014                     if ($item->needsupdate) {
1015                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
1016                     } else {
1017                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
1018                         if ($this->get_pref('showanalysisicon')) {
1019                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1020                         }
1021                     }
1022                 }
1024                 if (!empty($this->gradeserror[$item->id][$userid])) {
1025                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1026                 }
1028                 $itemrow->cells[] = $itemcell;
1029             }
1030             $rows[] = $itemrow;
1031         }
1033         if ($this->get_pref('enableajax')) {
1034             $jsarguments['cfg']['ajaxenabled'] = true;
1035             $jsarguments['cfg']['scales'] = array();
1036             foreach ($jsscales as $scale) {
1037                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
1038             }
1039             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1041             // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades']
1042         }
1043         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1044         $jsarguments['cfg']['courseid'] =  $this->courseid;
1045         $jsarguments['cfg']['studentsperpage'] =  $this->get_students_per_page();
1046         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1048         $module = array(
1049             'name'      => 'gradereport_grader',
1050             'fullpath'  => '/grade/report/grader/module.js',
1051             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1052         );
1053         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1054         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1055         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1057         $rows = $this->get_right_range_row($rows);
1058         $rows = $this->get_right_avg_row($rows, true);
1059         $rows = $this->get_right_avg_row($rows);
1061         return $rows;
1062     }
1064     /**
1065      * Depending on the style of report (fixedstudents vs traditional one-table),
1066      * arranges the rows of data in one or two tables, and returns the output of
1067      * these tables in HTML
1068      * @return string HTML
1069      */
1070     public function get_grade_table() {
1071         global $OUTPUT;
1072         $fixedstudents = $this->is_fixed_students();
1074         $leftrows = $this->get_left_rows();
1075         $rightrows = $this->get_right_rows();
1077         $html = '';
1080         if ($fixedstudents) {
1081             $fixedcolumntable = new html_table();
1082             $fixedcolumntable->id = 'fixed_column';
1083             $fixedcolumntable->data = $leftrows;
1084             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1086             $righttable = new html_table();
1087             $righttable->id = 'user-grades';
1088             $righttable->data = $rightrows;
1090             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1091         } else {
1092             $fulltable = new html_table();
1093             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1094             $fulltable->id = 'user-grades';
1096             // Extract rows from each side (left and right) and collate them into one row each
1097             foreach ($leftrows as $key => $row) {
1098                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1099                 $fulltable->data[] = $row;
1100             }
1101             $html .= html_writer::table($fulltable);
1102         }
1103         return $OUTPUT->container($html, 'gradeparent');
1104     }
1106     /**
1107      * Builds and return the row of icons for the left side of the report.
1108      * It only has one cell that says "Controls"
1109      * @param array $rows The Array of rows for the left part of the report
1110      * @param int $colspan The number of columns this cell has to span
1111      * @return array Array of rows for the left part of the report
1112      */
1113     public function get_left_icons_row($rows=array(), $colspan=1) {
1114         global $USER;
1116         if ($USER->gradeediting[$this->courseid]) {
1117             $controlsrow = new html_table_row();
1118             $controlsrow->attributes['class'] = 'controls';
1119             $controlscell = new html_table_cell();
1120             $controlscell->attributes['class'] = 'header controls';
1121             $controlscell->colspan = $colspan;
1122             $controlscell->text = $this->get_lang_string('controls','grades');
1124             $controlsrow->cells[] = $controlscell;
1125             $rows[] = $controlsrow;
1126         }
1127         return $rows;
1128     }
1130     /**
1131      * Builds and return the header for the row of ranges, for the left part of the grader report.
1132      * @param array $rows The Array of rows for the left part of the report
1133      * @param int $colspan The number of columns this cell has to span
1134      * @return array Array of rows for the left part of the report
1135      */
1136     public function get_left_range_row($rows=array(), $colspan=1) {
1137         global $CFG, $USER;
1139         if ($this->get_pref('showranges')) {
1140             $rangerow = new html_table_row();
1141             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1142             $rangecell = new html_table_cell();
1143             $rangecell->attributes['class'] = 'header range';
1144             $rangecell->colspan = $colspan;
1145             $rangecell->header = true;
1146             $rangecell->scope = 'row';
1147             $rangecell->text = $this->get_lang_string('range','grades');
1148             $rangerow->cells[] = $rangecell;
1149             $rows[] = $rangerow;
1150         }
1152         return $rows;
1153     }
1155     /**
1156      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1157      * @param array $rows The Array of rows for the left part of the report
1158      * @param int $colspan The number of columns this cell has to span
1159      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1160      * @return array Array of rows for the left part of the report
1161      */
1162     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1163         if (!$this->canviewhidden) {
1164             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1165             // better not show them at all if user can not see all hideen grades
1166             return $rows;
1167         }
1169         $showaverages = $this->get_pref('showaverages');
1170         $showaveragesgroup = $this->currentgroup && $showaverages;
1171         $straveragegroup = get_string('groupavg', 'grades');
1173         if ($groupavg) {
1174             if ($showaveragesgroup) {
1175                 $groupavgrow = new html_table_row();
1176                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1177                 $groupavgcell = new html_table_cell();
1178                 $groupavgcell->attributes['class'] = 'header range';
1179                 $groupavgcell->colspan = $colspan;
1180                 $groupavgcell->header = true;
1181                 $groupavgcell->scope = 'row';
1182                 $groupavgcell->text = $straveragegroup;
1183                 $groupavgrow->cells[] = $groupavgcell;
1184                 $rows[] = $groupavgrow;
1185             }
1186         } else {
1187             $straverage = get_string('overallaverage', 'grades');
1189             if ($showaverages) {
1190                 $avgrow = new html_table_row();
1191                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1192                 $avgcell = new html_table_cell();
1193                 $avgcell->attributes['class'] = 'header range';
1194                 $avgcell->colspan = $colspan;
1195                 $avgcell->header = true;
1196                 $avgcell->scope = 'row';
1197                 $avgcell->text = $straverage;
1198                 $avgrow->cells[] = $avgcell;
1199                 $rows[] = $avgrow;
1200             }
1201         }
1203         return $rows;
1204     }
1206     /**
1207      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1208      * @param array $rows The Array of rows for the right part of the report
1209      * @return array Array of rows for the right part of the report
1210      */
1211     public function get_right_icons_row($rows=array()) {
1212         global $USER;
1213         if ($USER->gradeediting[$this->courseid]) {
1214             $iconsrow = new html_table_row();
1215             $iconsrow->attributes['class'] = 'controls';
1217             foreach ($this->gtree->items as $itemid=>$unused) {
1218                 // emulate grade element
1219                 $item = $this->gtree->get_item($itemid);
1221                 $eid = $this->gtree->get_item_eid($item);
1222                 $element = $this->gtree->locate_element($eid);
1223                 $itemcell = new html_table_cell();
1224                 $itemcell->attributes['class'] = 'controls icons';
1225                 $itemcell->text = $this->get_icons($element);
1226                 $iconsrow->cells[] = $itemcell;
1227             }
1228             $rows[] = $iconsrow;
1229         }
1230         return $rows;
1231     }
1233     /**
1234      * Builds and return the row of ranges for the right part of the grader report.
1235      * @param array $rows The Array of rows for the right part of the report
1236      * @return array Array of rows for the right part of the report
1237      */
1238     public function get_right_range_row($rows=array()) {
1239         global $OUTPUT;
1241         if ($this->get_pref('showranges')) {
1242             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1243             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1244             $rangerow = new html_table_row();
1245             $rangerow->attributes['class'] = 'heading range';
1247             foreach ($this->gtree->items as $itemid=>$unused) {
1248                 $item =& $this->gtree->items[$itemid];
1249                 $itemcell = new html_table_cell();
1250                 $itemcell->header = true;
1251                 $itemcell->attributes['class'] .= ' header range';
1253                 $hidden = '';
1254                 if ($item->is_hidden()) {
1255                     $hidden = ' hidden ';
1256                 }
1258                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1260                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1261                 $rangerow->cells[] = $itemcell;
1262             }
1263             $rows[] = $rangerow;
1264         }
1265         return $rows;
1266     }
1268     /**
1269      * Builds and return the row of averages for the right part of the grader report.
1270      * @param array $rows Whether to return only group averages or all averages.
1271      * @param bool $grouponly Whether to return only group averages or all averages.
1272      * @return array Array of rows for the right part of the report
1273      */
1274     public function get_right_avg_row($rows=array(), $grouponly=false) {
1275         global $CFG, $USER, $DB, $OUTPUT;
1277         if (!$this->canviewhidden) {
1278             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1279             // better not show them at all if user can not see all hidden grades
1280             return $rows;
1281         }
1283         $showaverages = $this->get_pref('showaverages');
1284         $showaveragesgroup = $this->currentgroup && $showaverages;
1286         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1287         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1288         $meanselection         = $this->get_pref('meanselection');
1289         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1291         $avghtml = '';
1292         $avgcssclass = 'avg';
1294         if ($grouponly) {
1295             $straverage = get_string('groupavg', 'grades');
1296             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1297             $groupsql = $this->groupsql;
1298             $groupwheresql = $this->groupwheresql;
1299             $groupwheresqlparams = $this->groupwheresql_params;
1300             $avgcssclass = 'groupavg';
1301         } else {
1302             $straverage = get_string('overallaverage', 'grades');
1303             $showaverages = $this->get_pref('showaverages');
1304             $groupsql = "";
1305             $groupwheresql = "";
1306             $groupwheresqlparams = array();
1307         }
1309         if ($shownumberofgrades) {
1310             $straverage .= ' (' . get_string('submissions', 'grades') . ') ';
1311         }
1313         $totalcount = $this->get_numusers($grouponly);
1315         //limit to users with a gradeable role
1316         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1318         //limit to users with an active enrollment
1319         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
1321         if ($showaverages) {
1322             $params = array_merge(array('courseid'=>$this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams);
1324             // find sums of all grade items in course
1325             $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1326                       FROM {grade_items} gi
1327                       JOIN {grade_grades} g ON g.itemid = gi.id
1328                       JOIN {user} u ON u.id = g.userid
1329                       JOIN ($enrolledsql) je ON je.id = u.id
1330                       JOIN (
1331                                SELECT DISTINCT ra.userid
1332                                  FROM {role_assignments} ra
1333                                 WHERE ra.roleid $gradebookrolessql
1334                                   AND ra.contextid " . get_related_contexts_string($this->context) . "
1335                            ) rainner ON rainner.userid = u.id
1336                       $groupsql
1337                      WHERE gi.courseid = :courseid
1338                        AND u.deleted = 0
1339                        AND g.finalgrade IS NOT NULL
1340                        $groupwheresql
1341                      GROUP BY g.itemid";
1342             $sumarray = array();
1343             if ($sums = $DB->get_records_sql($sql, $params)) {
1344                 foreach ($sums as $itemid => $csum) {
1345                     $sumarray[$itemid] = $csum->sum;
1346                 }
1347             }
1349             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1350             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1351             $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1352                       FROM {grade_items} gi
1353                       CROSS JOIN {user} u
1354                       JOIN ($enrolledsql) je
1355                            ON je.id = u.id
1356                       JOIN {role_assignments} ra
1357                            ON ra.userid = u.id
1358                       LEFT OUTER JOIN {grade_grades} g
1359                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1360                       $groupsql
1361                      WHERE gi.courseid = :courseid
1362                            AND ra.roleid $gradebookrolessql
1363                            AND ra.contextid ".get_related_contexts_string($this->context)."
1364                            AND u.deleted = 0
1365                            AND g.id IS NULL
1366                            $groupwheresql
1367                   GROUP BY gi.id";
1369             $ungradedcounts = $DB->get_records_sql($sql, $params);
1371             $avgrow = new html_table_row();
1372             $avgrow->attributes['class'] = 'avg';
1374             foreach ($this->gtree->items as $itemid=>$unused) {
1375                 $item =& $this->gtree->items[$itemid];
1377                 if ($item->needsupdate) {
1378                     $avgcell = new html_table_cell();
1379                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1380                     $avgrow->cells[] = $avgcell;
1381                     continue;
1382                 }
1384                 if (!isset($sumarray[$item->id])) {
1385                     $sumarray[$item->id] = 0;
1386                 }
1388                 if (empty($ungradedcounts[$itemid])) {
1389                     $ungradedcount = 0;
1390                 } else {
1391                     $ungradedcount = $ungradedcounts[$itemid]->count;
1392                 }
1394                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1395                     $meancount = $totalcount - $ungradedcount;
1396                 } else { // Bump up the sum by the number of ungraded items * grademin
1397                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1398                     $meancount = $totalcount;
1399                 }
1401                 $decimalpoints = $item->get_decimals();
1403                 // Determine which display type to use for this average
1404                 if ($USER->gradeediting[$this->courseid]) {
1405                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1407                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1408                     $displaytype = $item->get_displaytype();
1410                 } else {
1411                     $displaytype = $averagesdisplaytype;
1412                 }
1414                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1415                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1416                     $decimalpoints = $item->get_decimals();
1418                 } else {
1419                     $decimalpoints = $averagesdecimalpoints;
1420                 }
1422                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1423                     $avgcell = new html_table_cell();
1424                     $avgcell->text = '-';
1425                     $avgrow->cells[] = $avgcell;
1427                 } else {
1428                     $sum = $sumarray[$item->id];
1429                     $avgradeval = $sum/$meancount;
1430                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1432                     $numberofgrades = '';
1433                     if ($shownumberofgrades) {
1434                         $numberofgrades = " ($meancount)";
1435                     }
1437                     $avgcell = new html_table_cell();
1438                     $avgcell->text = $gradehtml.$numberofgrades;
1439                     $avgrow->cells[] = $avgcell;
1440                 }
1441             }
1442             $rows[] = $avgrow;
1443         }
1444         return $rows;
1445     }
1447     /**
1448      * Given a grade_category, grade_item or grade_grade, this function
1449      * figures out the state of the object and builds then returns a div
1450      * with the icons needed for the grader report.
1451      *
1452      * @param array $object
1453      * @return string HTML
1454      */
1455     protected function get_icons($element) {
1456         global $CFG, $USER, $OUTPUT;
1458         if (!$USER->gradeediting[$this->courseid]) {
1459             return '<div class="grade_icons" />';
1460         }
1462         // Init all icons
1463         $editicon = '';
1465         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1466             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1467         }
1469         $editcalculationicon = '';
1470         $showhideicon        = '';
1471         $lockunlockicon      = '';
1473         if (has_capability('moodle/grade:manage', $this->context)) {
1474             if ($this->get_pref('showcalculations')) {
1475                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1476             }
1478             if ($this->get_pref('showeyecons')) {
1479                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1480             }
1482             if ($this->get_pref('showlocks')) {
1483                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1484             }
1486         }
1488         $gradeanalysisicon   = '';
1489         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1490             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1491         }
1493         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1494     }
1496     /**
1497      * Given a category element returns collapsing +/- icon if available
1498      * @param object $object
1499      * @return string HTML
1500      */
1501     protected function get_collapsing_icon($element) {
1502         global $OUTPUT;
1504         $icon = '';
1505         // If object is a category, display expand/contract icon
1506         if ($element['type'] == 'category') {
1507             // Load language strings
1508             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1509             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1510             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1512             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1514             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1515                 $url->param('action', 'switch_plus');
1516                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1518             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1519                 $url->param('action', 'switch_whole');
1520                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1522             } else {
1523                 $url->param('action', 'switch_minus');
1524                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1525             }
1526         }
1527         return $icon;
1528     }
1530     public function process_action($target, $action) {
1531         return self::do_process_action($target, $action);
1532     }
1534     /**
1535      * Processes a single action against a category, grade_item or grade.
1536      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1537      * @param string $action Which action to take (edit, delete etc...)
1538      * @return
1539      */
1540     public static function do_process_action($target, $action) {
1541         // TODO: this code should be in some grade_tree static method
1542         $targettype = substr($target, 0, 1);
1543         $targetid = substr($target, 1);
1544         // TODO: end
1546         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1547             $collapsed = unserialize($collapsed);
1548         } else {
1549             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1550         }
1552         switch ($action) {
1553             case 'switch_minus': // Add category to array of aggregatesonly
1554                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1555                     $collapsed['aggregatesonly'][] = $targetid;
1556                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1557                 }
1558                 break;
1560             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1561                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1562                 if ($key !== false) {
1563                     unset($collapsed['aggregatesonly'][$key]);
1564                 }
1565                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1566                     $collapsed['gradesonly'][] = $targetid;
1567                 }
1568                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1569                 break;
1570             case 'switch_whole': // Remove the category from the array of collapsed cats
1571                 $key = array_search($targetid, $collapsed['gradesonly']);
1572                 if ($key !== false) {
1573                     unset($collapsed['gradesonly'][$key]);
1574                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1575                 }
1577                 break;
1578             default:
1579                 break;
1580         }
1582         return true;
1583     }
1585     /**
1586      * Returns whether or not to display fixed students column.
1587      * Includes a browser check, because IE6 doesn't support the scrollbar.
1588      *
1589      * @return bool
1590      */
1591     public function is_fixed_students() {
1592         global $USER, $CFG;
1593         return $CFG->grade_report_fixedstudents &&
1594             (check_browser_version('MSIE', '7.0') ||
1595              check_browser_version('Firefox', '2.0') ||
1596              check_browser_version('Gecko', '2006010100') ||
1597              check_browser_version('Camino', '1.0') ||
1598              check_browser_version('Opera', '6.0') ||
1599              check_browser_version('Chrome', '6') ||
1600              check_browser_version('Safari', '300'));
1601     }
1603     /**
1604      * Refactored function for generating HTML of sorting links with matching arrows.
1605      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1606      * to inject into a table header cell.
1607      * @param array $extrafields Array of extra fields being displayed, such as
1608      *   user idnumber
1609      * @return array An associative array of HTML sorting links+arrows
1610      */
1611     public function get_sort_arrows(array $extrafields = array()) {
1612         global $OUTPUT;
1613         $arrows = array();
1615         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1616         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1617         $strfirstname = $this->get_lang_string('firstname');
1618         $strlastname  = $this->get_lang_string('lastname');
1619         $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon'));
1620         $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon'));
1622         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1623         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1625         $arrows['studentname'] = $lastlink;
1627         if ($this->sortitemid === 'lastname') {
1628             if ($this->sortorder == 'ASC') {
1629                 $arrows['studentname'] .= $iconasc;
1630             } else {
1631                 $arrows['studentname'] .= $icondesc;
1632             }
1633         }
1635         $arrows['studentname'] .= ' ' . $firstlink;
1637         if ($this->sortitemid === 'firstname') {
1638             if ($this->sortorder == 'ASC') {
1639                 $arrows['studentname'] .= $iconasc;
1640             } else {
1641                 $arrows['studentname'] .= $icondesc;
1642             }
1643         }
1645         foreach ($extrafields as $field) {
1646             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1647                     array('sortitemid'=>$field)), get_user_field_name($field));
1648             $arrows[$field] = $fieldlink;
1650             if ($field == $this->sortitemid) {
1651                 if ($this->sortorder == 'ASC') {
1652                     $arrows[$field] .= $iconasc;
1653                 } else {
1654                     $arrows[$field] .= $icondesc;
1655                 }
1656             }
1657         }
1659         return $arrows;
1660     }
1662     /**
1663      * Returns the maximum number of students to be displayed on each page
1664      *
1665      * Takes into account the 'studentsperpage' user preference and the 'max_input_vars'
1666      * PHP setting. Too many fields is only a problem when submitting grades but
1667      * we respect 'max_input_vars' even when viewing grades to prevent students disappearing
1668      * when toggling editing on and off.
1669      *
1670      * @return int The maximum number of students to display per page
1671      */
1672     public function get_students_per_page() {
1673         global $USER;
1674         static $studentsperpage = null;
1676         if ($studentsperpage === null) {
1677             $originalstudentsperpage = $studentsperpage = $this->get_pref('studentsperpage');
1679             // Will this number of students result in more fields that we are allowed?
1680             $maxinputvars = ini_get('max_input_vars');
1681             if ($maxinputvars !== false) {
1682                 // We can't do anything about there being more grade items than max_input_vars,
1683                 // but we can decrease number of students per page if there are >= max_input_vars
1684                 $fieldsperstudent = 0; // The number of fields output per student
1686                 if ($this->get_pref('quickgrading') || $this->get_pref('showquickfeedback')) {
1687                     // Each array (grade, feedback) will gain one element
1688                     $fieldsperstudent ++;
1689                 }
1691                 $fieldsrequired = $studentsperpage * $fieldsperstudent;
1692                 if ($fieldsrequired >= $maxinputvars) {
1693                     $studentsperpage = $maxinputvars - 1; // Subtract one to be on the safe side
1694                     if ($studentsperpage<1) {
1695                         // Make sure students per page doesn't fall below 1, though if your
1696                         // max_input_vars is only 1 you've got bigger problems!
1697                         $studentsperpage = 1;
1698                     }
1700                     $a = new stdClass();
1701                     $a->originalstudentsperpage = $originalstudentsperpage;
1702                     $a->studentsperpage = $studentsperpage;
1703                     $a->maxinputvars = $maxinputvars;
1704                     debugging(get_string('studentsperpagereduced', 'grades', $a));
1705                 }
1706             }
1707         }
1709         return $studentsperpage;
1710     }