a58e189ba18c68389a44698332b6a9797cecbcce
[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                             $userfields = 'id, ' . get_all_user_name_fields(true);
266                             $user = $DB->get_record('user', array('id' => $userid), $userfields);
267                             $gradestr = new stdClass();
268                             $gradestr->username = fullname($user);
269                             $gradestr->itemname = $gradeitem->get_name();
270                             $warnings[] = get_string($errorstr, 'grades', $gradestr);
271                         }
273                     } else if ($datatype == 'feedback') {
274                         $finalgrade = false;
275                         $trimmed = trim($postedvalue);
276                         if (empty($trimmed)) {
277                              $feedback = NULL;
278                         } else {
279                              $feedback = $postedvalue;
280                         }
281                     }
283                     // group access control
284                     if ($separategroups) {
285                         // note: we can not use $this->currentgroup because it would fail badly
286                         //       when having two browser windows each with different group
287                         $sharinggroup = false;
288                         foreach($mygroups as $groupid) {
289                             if (groups_is_member($groupid, $userid)) {
290                                 $sharinggroup = true;
291                                 break;
292                             }
293                         }
294                         if (!$sharinggroup) {
295                             // either group membership changed or somebody is hacking grades of other group
296                             $warnings[] = get_string('errorsavegrade', 'grades');
297                             continue;
298                         }
299                     }
301                     $url = '/report/grader/index.php?id=' . $this->course->id;
302                     $fullname = fullname($this->users[$userid]);
304                     $info = "{$gradeitem->itemname}: $fullname";
305                     add_to_log($this->course->id, 'grade', 'update', $url, $info);
307                     $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
309                     // We can update feedback without reloading the grade item as it doesn't affect grade calculations
310                     if ($datatype === 'feedback') {
311                         $this->grades[$userid][$itemid]->feedback = $feedback;
312                     }
313                 }
314             }
315         }
317         if ($changedgrades) {
318             // If a final grade was overriden reload grades so dependent grades like course total will be correct
319             $this->grades = null;
320         }
322         return $warnings;
323     }
326     /**
327      * Setting the sort order, this depends on last state
328      * all this should be in the new table class that we might need to use
329      * for displaying grades.
330      */
331     private function setup_sortitemid() {
333         global $SESSION;
335         if (!isset($SESSION->gradeuserreport)) {
336             $SESSION->gradeuserreport = new stdClass();
337         }
339         if ($this->sortitemid) {
340             if (!isset($SESSION->gradeuserreport->sort)) {
341                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
342                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
343                 } else {
344                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
345                 }
346             } else {
347                 // this is the first sort, i.e. by last name
348                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
349                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
350                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
351                     } else {
352                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
353                     }
354                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
355                     // same as last sort
356                     if ($SESSION->gradeuserreport->sort == 'ASC') {
357                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
358                     } else {
359                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
360                     }
361                 } else {
362                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
363                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
364                     } else {
365                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
366                     }
367                 }
368             }
369             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
370         } else {
371             // not requesting sort, use last setting (for paging)
373             if (isset($SESSION->gradeuserreport->sortitemid)) {
374                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
375             }else{
376                 $this->sortitemid = 'lastname';
377             }
379             if (isset($SESSION->gradeuserreport->sort)) {
380                 $this->sortorder = $SESSION->gradeuserreport->sort;
381             } else {
382                 $this->sortorder = 'ASC';
383             }
384         }
385     }
387     /**
388      * pulls out the userids of the users to be display, and sorts them
389      */
390     public function load_users() {
391         global $CFG, $DB;
393         if (!empty($this->users)) {
394             return;
395         }
397         // Limit to users with a gradeable role.
398         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
400         // Limit to users with an active enrollment.
401         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
403         // Fields we need from the user table.
404         $userfields = user_picture::fields('u', get_extra_user_fields($this->context));
406         // We want to query both the current context and parent contexts.
407         list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
409         // If the user has clicked one of the sort asc/desc arrows.
410         if (is_numeric($this->sortitemid)) {
411             $params = array_merge(array('gitemid' => $this->sortitemid), $gradebookrolesparams, $this->groupwheresql_params, $enrolledparams,
412                 $relatedctxparams);
414             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
415             $sort = "g.finalgrade $this->sortorder";
416         } else {
417             $sortjoin = '';
418             switch($this->sortitemid) {
419                 case 'lastname':
420                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
421                     break;
422                 case 'firstname':
423                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
424                     break;
425                 case 'email':
426                     $sort = "u.email $this->sortorder";
427                     break;
428                 case 'idnumber':
429                 default:
430                     $sort = "u.idnumber $this->sortorder";
431                     break;
432             }
434             $params = array_merge($gradebookrolesparams, $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
435         }
437         $sql = "SELECT $userfields
438                   FROM {user} u
439                   JOIN ($enrolledsql) je ON je.id = u.id
440                        $this->groupsql
441                        $sortjoin
442                   JOIN (
443                            SELECT DISTINCT ra.userid
444                              FROM {role_assignments} ra
445                             WHERE ra.roleid IN ($this->gradebookroles)
446                               AND ra.contextid $relatedctxsql
447                        ) rainner ON rainner.userid = u.id
448                    AND u.deleted = 0
449                    $this->groupwheresql
450               ORDER BY $sort";
451         $studentsperpage = $this->get_students_per_page();
452         $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage);
454         if (empty($this->users)) {
455             $this->userselect = '';
456             $this->users = array();
457             $this->userselect_params = array();
458         } else {
459             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
460             $this->userselect = "AND g.userid $usql";
461             $this->userselect_params = $uparams;
463             // Add a flag to each user indicating whether their enrolment is active.
464             $sql = "SELECT ue.userid
465                       FROM {user_enrolments} ue
466                       JOIN {enrol} e ON e.id = ue.enrolid
467                      WHERE ue.userid $usql
468                            AND ue.status = :uestatus
469                            AND e.status = :estatus
470                            AND e.courseid = :courseid
471                   GROUP BY ue.userid";
472             $coursecontext = $this->context->get_course_context(true);
473             $params = array_merge($uparams, array('estatus'=>ENROL_INSTANCE_ENABLED, 'uestatus'=>ENROL_USER_ACTIVE, 'courseid'=>$coursecontext->instanceid));
474             $useractiveenrolments = $DB->get_records_sql($sql, $params);
476             $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
477             $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
478             $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
479             foreach ($this->users as $user) {
480                 // If we are showing only active enrolments, then remove suspended users from list.
481                 if ($showonlyactiveenrol && !array_key_exists($user->id, $useractiveenrolments)) {
482                     unset($this->users[$user->id]);
483                 } else {
484                     $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
485                 }
486             }
487         }
489         return $this->users;
490     }
492     /**
493      * we supply the userids in this query, and get all the grades
494      * pulls out all the grades, this does not need to worry about paging
495      */
496     public function load_final_grades() {
497         global $CFG, $DB;
499         if (!empty($this->grades)) {
500             return;
501         }
503         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
504         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
505         $sql = "SELECT g.*
506                   FROM {grade_items} gi,
507                        {grade_grades} g
508                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
510         $userids = array_keys($this->users);
513         if ($grades = $DB->get_records_sql($sql, $params)) {
514             foreach ($grades as $graderec) {
515                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
516                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
517                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
518                 }
519             }
520         }
522         // prefil grades that do not exist yet
523         foreach ($userids as $userid) {
524             foreach ($this->gtree->get_items() as $itemid=>$unused) {
525                 if (!isset($this->grades[$userid][$itemid])) {
526                     $this->grades[$userid][$itemid] = new grade_grade();
527                     $this->grades[$userid][$itemid]->itemid = $itemid;
528                     $this->grades[$userid][$itemid]->userid = $userid;
529                     $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
530                 }
531             }
532         }
533     }
535     /**
536      * @deprecated since Moodle 2.4 as it appears not to be used any more.
537      */
538     public function get_toggles_html() {
539         throw new coding_exception('get_toggles_html() can not be used any more');
540     }
542     /**
543      * @deprecated since 2.4 as it appears not to be used any more.
544      */
545     public function print_toggle($type) {
546         throw new coding_exception('print_toggle() can not be used any more');
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');
563         $strfeedback  = $this->get_lang_string("feedback");
564         $strgrade     = $this->get_lang_string('grade');
566         $extrafields = get_extra_user_fields($this->context);
568         $arrows = $this->get_sort_arrows($extrafields);
570         $colspan = 1;
571         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
572             $colspan++;
573         }
574         $colspan += count($extrafields);
576         $levels = count($this->gtree->levels) - 1;
578         for ($i = 0; $i < $levels; $i++) {
579             $fillercell = new html_table_cell();
580             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
581             $fillercell->text = ' ';
582             $fillercell->colspan = $colspan;
583             $row = new html_table_row(array($fillercell));
584             $rows[] = $row;
585         }
587         $headerrow = new html_table_row();
588         $headerrow->attributes['class'] = 'heading';
590         $studentheader = new html_table_cell();
591         $studentheader->attributes['class'] = 'header';
592         $studentheader->scope = 'col';
593         $studentheader->header = true;
594         $studentheader->id = 'studentheader';
595         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
596             $studentheader->colspan = 2;
597         }
598         $studentheader->text = $arrows['studentname'];
600         $headerrow->cells[] = $studentheader;
602         foreach ($extrafields as $field) {
603             $fieldheader = new html_table_cell();
604             $fieldheader->attributes['class'] = 'header userfield user' . $field;
605             $fieldheader->scope = 'col';
606             $fieldheader->header = true;
607             $fieldheader->text = $arrows[$field];
609             $headerrow->cells[] = $fieldheader;
610         }
612         $rows[] = $headerrow;
614         $rows = $this->get_left_icons_row($rows, $colspan);
616         $rowclasses = array('even', 'odd');
618         $suspendedstring = null;
619         foreach ($this->users as $userid => $user) {
620             $userrow = new html_table_row();
621             $userrow->id = 'fixed_user_'.$userid;
622             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
624             $usercell = new html_table_cell();
625             $usercell->attributes['class'] = 'user';
627             $usercell->header = true;
628             $usercell->scope = 'row';
630             if ($showuserimage) {
631                 $usercell->text = $OUTPUT->user_picture($user);
632             }
634             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), fullname($user));
636             if (!empty($user->suspendedenrolment)) {
637                 $usercell->attributes['class'] .= ' usersuspended';
639                 //may be lots of suspended users so only get the string once
640                 if (empty($suspendedstring)) {
641                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
642                 }
643                 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring, 'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
644             }
646             $userrow->cells[] = $usercell;
648             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
649                 $userreportcell = new html_table_cell();
650                 $userreportcell->attributes['class'] = 'userreport';
651                 $userreportcell->header = true;
652                 $a = new stdClass();
653                 $a->user = fullname($user);
654                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
655                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
656                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
657                 $userrow->cells[] = $userreportcell;
658             }
660             foreach ($extrafields as $field) {
661                 $fieldcell = new html_table_cell();
662                 $fieldcell->attributes['class'] = 'header userfield user' . $field;
663                 $fieldcell->header = true;
664                 $fieldcell->scope = 'row';
665                 $fieldcell->text = $user->{$field};
666                 $userrow->cells[] = $fieldcell;
667             }
669             $rows[] = $userrow;
670         }
672         $rows = $this->get_left_range_row($rows, $colspan);
673         $rows = $this->get_left_avg_row($rows, $colspan, true);
674         $rows = $this->get_left_avg_row($rows, $colspan);
676         return $rows;
677     }
679     /**
680      * Builds and returns the rows that will make up the right part of the grader report
681      * @return array Array of html_table_row objects
682      */
683     public function get_right_rows() {
684         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
686         $rows = array();
687         $this->rowcount = 0;
688         $numrows = count($this->gtree->get_levels());
689         $numusers = count($this->users);
690         $gradetabindex = 1;
691         $columnstounset = array();
692         $strgrade = $this->get_lang_string('grade');
693         $strfeedback  = $this->get_lang_string("feedback");
694         $arrows = $this->get_sort_arrows();
696         $jsarguments = array(
697             'id'        => '#fixed_column',
698             'cfg'       => array('ajaxenabled'=>false),
699             'items'     => array(),
700             'users'     => array(),
701             'feedback'  => array()
702         );
703         $jsscales = array();
705         foreach ($this->gtree->get_levels() as $key=>$row) {
706             if ($key == 0) {
707                 // do not display course grade category
708                 // continue;
709             }
711             $headingrow = new html_table_row();
712             $headingrow->attributes['class'] = 'heading_name_row';
714             foreach ($row as $columnkey => $element) {
715                 $sortlink = clone($this->baseurl);
716                 if (isset($element['object']->id)) {
717                     $sortlink->param('sortitemid', $element['object']->id);
718                 }
720                 $eid    = $element['eid'];
721                 $object = $element['object'];
722                 $type   = $element['type'];
723                 $categorystate = @$element['categorystate'];
725                 if (!empty($element['colspan'])) {
726                     $colspan = $element['colspan'];
727                 } else {
728                     $colspan = 1;
729                 }
731                 if (!empty($element['depth'])) {
732                     $catlevel = 'catlevel'.$element['depth'];
733                 } else {
734                     $catlevel = '';
735                 }
737 // Element is a filler
738                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
739                     $fillercell = new html_table_cell();
740                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
741                     $fillercell->colspan = $colspan;
742                     $fillercell->text = '&nbsp;';
743                     $fillercell->header = true;
744                     $fillercell->scope = 'col';
745                     $headingrow->cells[] = $fillercell;
746                 }
747 // Element is a category
748                 else if ($type == 'category') {
749                     $categorycell = new html_table_cell();
750                     $categorycell->attributes['class'] = 'category ' . $catlevel;
751                     $categorycell->colspan = $colspan;
752                     $categorycell->text = shorten_text($element['object']->get_name());
753                     $categorycell->text .= $this->get_collapsing_icon($element);
754                     $categorycell->header = true;
755                     $categorycell->scope = 'col';
757                     // Print icons
758                     if ($USER->gradeediting[$this->courseid]) {
759                         $categorycell->text .= $this->get_icons($element);
760                     }
762                     $headingrow->cells[] = $categorycell;
763                 }
764 // Element is a grade_item
765                 else {
766                     //$itemmodule = $element['object']->itemmodule;
767                     //$iteminstance = $element['object']->iteminstance;
769                     if ($element['object']->id == $this->sortitemid) {
770                         if ($this->sortorder == 'ASC') {
771                             $arrow = $this->get_sort_arrow('up', $sortlink);
772                         } else {
773                             $arrow = $this->get_sort_arrow('down', $sortlink);
774                         }
775                     } else {
776                         $arrow = $this->get_sort_arrow('move', $sortlink);
777                     }
779                     $headerlink = $this->gtree->get_element_header($element, true, $this->get_pref('showactivityicons'), false);
781                     $itemcell = new html_table_cell();
782                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable';
784                     if ($element['object']->is_hidden()) {
785                         $itemcell->attributes['class'] .= ' dimmed_text';
786                     }
788                     $itemcell->colspan = $colspan;
789                     $itemcell->text = shorten_text($headerlink) . $arrow;
790                     $itemcell->header = true;
791                     $itemcell->scope = 'col';
793                     $headingrow->cells[] = $itemcell;
794                 }
795             }
796             $rows[] = $headingrow;
797         }
799         $rows = $this->get_right_icons_row($rows);
801         // Preload scale objects for items with a scaleid and initialize tab indices
802         $scaleslist = array();
803         $tabindices = array();
805         foreach ($this->gtree->get_items() as $itemid=>$item) {
806             $scale = null;
807             if (!empty($item->scaleid)) {
808                 $scaleslist[] = $item->scaleid;
809                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
810             } else {
811                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
812             }
813             $tabindices[$item->id]['grade'] = $gradetabindex;
814             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
815             $gradetabindex += $numusers * 2;
816         }
817         $scalesarray = array();
819         if (!empty($scaleslist)) {
820             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
821         }
822         $jsscales = $scalesarray;
824         $rowclasses = array('even', 'odd');
826         foreach ($this->users as $userid => $user) {
828             if ($this->canviewhidden) {
829                 $altered = array();
830                 $unknown = array();
831             } else {
832                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
833                 $altered = $hidingaffected['altered'];
834                 $unknown = $hidingaffected['unknown'];
835                 unset($hidingaffected);
836             }
839             $itemrow = new html_table_row();
840             $itemrow->id = 'user_'.$userid;
841             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
843             $jsarguments['users'][$userid] = fullname($user);
845             foreach ($this->gtree->items as $itemid=>$unused) {
846                 $item =& $this->gtree->items[$itemid];
847                 $grade = $this->grades[$userid][$item->id];
849                 $itemcell = new html_table_cell();
851                 $itemcell->id = 'u'.$userid.'i'.$itemid;
853                 // Get the decimal points preference for this item
854                 $decimalpoints = $item->get_decimals();
856                 if (in_array($itemid, $unknown)) {
857                     $gradeval = null;
858                 } else if (array_key_exists($itemid, $altered)) {
859                     $gradeval = $altered[$itemid];
860                 } else {
861                     $gradeval = $grade->finalgrade;
862                 }
863                 if (!empty($grade->finalgrade)) {
864                     $gradevalforJS = null;
865                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
866                         $gradevalforJS = (int)$gradeval;
867                     } else {
868                         $gradevalforJS = format_float($gradeval, $decimalpoints);
869                     }
870                     $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforJS);
871                 }
873                 // MDL-11274
874                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
875                 if (!$this->canviewhidden and $grade->is_hidden()) {
876                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
877                         // 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
878                         $itemcell->text = html_writer::tag('span', userdate($grade->get_datesubmitted(),get_string('strftimedatetimeshort')), array('class'=>'datesubmitted'));
879                     } else {
880                         $itemcell->text = '-';
881                     }
882                     $itemrow->cells[] = $itemcell;
883                     continue;
884                 }
886                 // emulate grade element
887                 $eid = $this->gtree->get_grade_eid($grade);
888                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
890                 $itemcell->attributes['class'] .= ' grade';
891                 if ($item->is_category_item()) {
892                     $itemcell->attributes['class'] .= ' cat';
893                 }
894                 if ($item->is_course_item()) {
895                     $itemcell->attributes['class'] .= ' course';
896                 }
897                 if ($grade->is_overridden()) {
898                     $itemcell->attributes['class'] .= ' overridden';
899                 }
901                 if ($grade->is_excluded()) {
902                     // $itemcell->attributes['class'] .= ' excluded';
903                 }
905                 if (!empty($grade->feedback)) {
906                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
907                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br/ >'));
908                 }
910                 if ($grade->is_excluded()) {
911                     $itemcell->text .= html_writer::tag('span', get_string('excluded', 'grades'), array('class'=>'excludedfloater'));
912                 }
914                 // Do not show any icons if no grade (no record in DB to match)
915                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
916                     $itemcell->text .= $this->get_icons($element);
917                 }
919                 $hidden = '';
920                 if ($grade->is_hidden()) {
921                     $hidden = ' hidden ';
922                 }
924                 $gradepass = ' gradefail ';
925                 if ($grade->is_passed($item)) {
926                     $gradepass = ' gradepass ';
927                 } elseif (is_null($grade->is_passed($item))) {
928                     $gradepass = '';
929                 }
931                 // if in editing mode, we need to print either a text box
932                 // or a drop down (for scales)
933                 // grades in item of type grade category or course are not directly editable
934                 if ($item->needsupdate) {
935                     $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden"));
937                 } else if ($USER->gradeediting[$this->courseid]) {
939                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
940                         $scale = $scalesarray[$item->scaleid];
941                         $gradeval = (int)$gradeval; // scales use only integers
942                         $scales = explode(",", $scale->scale);
943                         // reindex because scale is off 1
945                         // MDL-12104 some previous scales might have taken up part of the array
946                         // so this needs to be reset
947                         $scaleopt = array();
948                         $i = 0;
949                         foreach ($scales as $scaleoption) {
950                             $i++;
951                             $scaleopt[$i] = $scaleoption;
952                         }
954                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
955                             $oldval = empty($gradeval) ? -1 : $gradeval;
956                             if (empty($item->outcomeid)) {
957                                 $nogradestr = $this->get_lang_string('nograde');
958                             } else {
959                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
960                             }
961                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
962                             $itemcell->text .= html_writer::label(get_string('typescale', 'grades'), $attributes['id'], false, array('class' => 'accesshide'));
963                             $itemcell->text .= html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, array(-1=>$nogradestr), $attributes);
964                         } elseif(!empty($scale)) {
965                             $scales = explode(",", $scale->scale);
967                             // invalid grade if gradeval < 1
968                             if ($gradeval < 1) {
969                                 $itemcell->text .= html_writer::tag('span', '-', array('class'=>"gradevalue$hidden$gradepass"));
970                             } else {
971                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
972                                 $itemcell->text .= html_writer::tag('span', $scales[$gradeval-1], array('class'=>"gradevalue$hidden$gradepass"));
973                             }
974                         } else {
975                             // no such scale, throw error?
976                         }
978                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
979                         if ($this->get_pref('quickgrading') and $grade->is_editable()) {
980                             $value = format_float($gradeval, $decimalpoints);
981                             $gradelabel = fullname($user) . ' ' . $item->itemname;
982                             $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">'
983                                           .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>';
984                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
985                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade['
986                                           .$userid.'][' .$item->id.']" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
987                         } else {
988                             $itemcell->text .= html_writer::tag('span', format_float($gradeval, $decimalpoints), array('class'=>"gradevalue$hidden$gradepass"));
989                         }
990                     }
993                     // If quickfeedback is on, print an input element
994                     if ($this->get_pref('showquickfeedback') and $grade->is_editable()) {
995                         $feedbacklabel = fullname($user) . ' ' . $item->itemname;
996                         $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">'
997                                       .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>';
998                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
999                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback['.$userid.']['.$item->id.']" value="' . s($grade->feedback) . '" />';
1000                     }
1002                 } else { // Not editing
1003                     $gradedisplaytype = $item->get_displaytype();
1005                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1006                         $itemcell->attributes['class'] .= ' grade_type_scale';
1007                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
1008                         $itemcell->attributes['class'] .= ' grade_type_text';
1009                     }
1011                     if ($this->get_pref('enableajax')) {
1012                         $itemcell->attributes['class'] .= ' clickable';
1013                     }
1015                     if ($item->needsupdate) {
1016                         $itemcell->text .= html_writer::tag('span', get_string('error'), array('class'=>"gradingerror$hidden$gradepass"));
1017                     } else {
1018                         $itemcell->text .= html_writer::tag('span', grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null), array('class'=>"gradevalue$hidden$gradepass"));
1019                         if ($this->get_pref('showanalysisicon')) {
1020                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1021                         }
1022                     }
1023                 }
1025                 if (!empty($this->gradeserror[$item->id][$userid])) {
1026                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1027                 }
1029                 $itemrow->cells[] = $itemcell;
1030             }
1031             $rows[] = $itemrow;
1032         }
1034         if ($this->get_pref('enableajax')) {
1035             $jsarguments['cfg']['ajaxenabled'] = true;
1036             $jsarguments['cfg']['scales'] = array();
1037             foreach ($jsscales as $scale) {
1038                 $jsarguments['cfg']['scales'][$scale->id] = explode(',',$scale->scale);
1039             }
1040             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1042             // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades']
1043         }
1044         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1045         $jsarguments['cfg']['courseid'] =  $this->courseid;
1046         $jsarguments['cfg']['studentsperpage'] =  $this->get_students_per_page();
1047         $jsarguments['cfg']['showquickfeedback'] =  (bool)$this->get_pref('showquickfeedback');
1049         $module = array(
1050             'name'      => 'gradereport_grader',
1051             'fullpath'  => '/grade/report/grader/module.js',
1052             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1053         );
1054         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1055         $PAGE->requires->strings_for_js(array('addfeedback','feedback', 'grade'), 'grades');
1056         $PAGE->requires->strings_for_js(array('ajaxchoosescale','ajaxclicktoclose','ajaxerror','ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1058         $rows = $this->get_right_range_row($rows);
1059         $rows = $this->get_right_avg_row($rows, true);
1060         $rows = $this->get_right_avg_row($rows);
1062         return $rows;
1063     }
1065     /**
1066      * Depending on the style of report (fixedstudents vs traditional one-table),
1067      * arranges the rows of data in one or two tables, and returns the output of
1068      * these tables in HTML
1069      * @return string HTML
1070      */
1071     public function get_grade_table() {
1072         global $OUTPUT;
1073         $fixedstudents = $this->is_fixed_students();
1075         $leftrows = $this->get_left_rows();
1076         $rightrows = $this->get_right_rows();
1078         $html = '';
1081         if ($fixedstudents) {
1082             $fixedcolumntable = new html_table();
1083             $fixedcolumntable->id = 'fixed_column';
1084             $fixedcolumntable->data = $leftrows;
1085             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1087             $righttable = new html_table();
1088             $righttable->id = 'user-grades';
1089             $righttable->data = $rightrows;
1091             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1092         } else {
1093             $fulltable = new html_table();
1094             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1095             $fulltable->id = 'user-grades';
1097             // Extract rows from each side (left and right) and collate them into one row each
1098             foreach ($leftrows as $key => $row) {
1099                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1100                 $fulltable->data[] = $row;
1101             }
1102             $html .= html_writer::table($fulltable);
1103         }
1104         return $OUTPUT->container($html, 'gradeparent');
1105     }
1107     /**
1108      * Builds and return the row of icons for the left side of the report.
1109      * It only has one cell that says "Controls"
1110      * @param array $rows The Array of rows for the left part of the report
1111      * @param int $colspan The number of columns this cell has to span
1112      * @return array Array of rows for the left part of the report
1113      */
1114     public function get_left_icons_row($rows=array(), $colspan=1) {
1115         global $USER;
1117         if ($USER->gradeediting[$this->courseid]) {
1118             $controlsrow = new html_table_row();
1119             $controlsrow->attributes['class'] = 'controls';
1120             $controlscell = new html_table_cell();
1121             $controlscell->attributes['class'] = 'header controls';
1122             $controlscell->colspan = $colspan;
1123             $controlscell->text = $this->get_lang_string('controls','grades');
1125             $controlsrow->cells[] = $controlscell;
1126             $rows[] = $controlsrow;
1127         }
1128         return $rows;
1129     }
1131     /**
1132      * Builds and return the header for the row of ranges, for the left part of the grader report.
1133      * @param array $rows The Array of rows for the left part of the report
1134      * @param int $colspan The number of columns this cell has to span
1135      * @return array Array of rows for the left part of the report
1136      */
1137     public function get_left_range_row($rows=array(), $colspan=1) {
1138         global $CFG, $USER;
1140         if ($this->get_pref('showranges')) {
1141             $rangerow = new html_table_row();
1142             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1143             $rangecell = new html_table_cell();
1144             $rangecell->attributes['class'] = 'header range';
1145             $rangecell->colspan = $colspan;
1146             $rangecell->header = true;
1147             $rangecell->scope = 'row';
1148             $rangecell->text = $this->get_lang_string('range','grades');
1149             $rangerow->cells[] = $rangecell;
1150             $rows[] = $rangerow;
1151         }
1153         return $rows;
1154     }
1156     /**
1157      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1158      * @param array $rows The Array of rows for the left part of the report
1159      * @param int $colspan The number of columns this cell has to span
1160      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1161      * @return array Array of rows for the left part of the report
1162      */
1163     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1164         if (!$this->canviewhidden) {
1165             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1166             // better not show them at all if user can not see all hideen grades
1167             return $rows;
1168         }
1170         $showaverages = $this->get_pref('showaverages');
1171         $showaveragesgroup = $this->currentgroup && $showaverages;
1172         $straveragegroup = get_string('groupavg', 'grades');
1174         if ($groupavg) {
1175             if ($showaveragesgroup) {
1176                 $groupavgrow = new html_table_row();
1177                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1178                 $groupavgcell = new html_table_cell();
1179                 $groupavgcell->attributes['class'] = 'header range';
1180                 $groupavgcell->colspan = $colspan;
1181                 $groupavgcell->header = true;
1182                 $groupavgcell->scope = 'row';
1183                 $groupavgcell->text = $straveragegroup;
1184                 $groupavgrow->cells[] = $groupavgcell;
1185                 $rows[] = $groupavgrow;
1186             }
1187         } else {
1188             $straverage = get_string('overallaverage', 'grades');
1190             if ($showaverages) {
1191                 $avgrow = new html_table_row();
1192                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1193                 $avgcell = new html_table_cell();
1194                 $avgcell->attributes['class'] = 'header range';
1195                 $avgcell->colspan = $colspan;
1196                 $avgcell->header = true;
1197                 $avgcell->scope = 'row';
1198                 $avgcell->text = $straverage;
1199                 $avgrow->cells[] = $avgcell;
1200                 $rows[] = $avgrow;
1201             }
1202         }
1204         return $rows;
1205     }
1207     /**
1208      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1209      * @param array $rows The Array of rows for the right part of the report
1210      * @return array Array of rows for the right part of the report
1211      */
1212     public function get_right_icons_row($rows=array()) {
1213         global $USER;
1214         if ($USER->gradeediting[$this->courseid]) {
1215             $iconsrow = new html_table_row();
1216             $iconsrow->attributes['class'] = 'controls';
1218             foreach ($this->gtree->items as $itemid=>$unused) {
1219                 // emulate grade element
1220                 $item = $this->gtree->get_item($itemid);
1222                 $eid = $this->gtree->get_item_eid($item);
1223                 $element = $this->gtree->locate_element($eid);
1224                 $itemcell = new html_table_cell();
1225                 $itemcell->attributes['class'] = 'controls icons';
1226                 $itemcell->text = $this->get_icons($element);
1227                 $iconsrow->cells[] = $itemcell;
1228             }
1229             $rows[] = $iconsrow;
1230         }
1231         return $rows;
1232     }
1234     /**
1235      * Builds and return the row of ranges for the right part of the grader report.
1236      * @param array $rows The Array of rows for the right part of the report
1237      * @return array Array of rows for the right part of the report
1238      */
1239     public function get_right_range_row($rows=array()) {
1240         global $OUTPUT;
1242         if ($this->get_pref('showranges')) {
1243             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1244             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1245             $rangerow = new html_table_row();
1246             $rangerow->attributes['class'] = 'heading range';
1248             foreach ($this->gtree->items as $itemid=>$unused) {
1249                 $item =& $this->gtree->items[$itemid];
1250                 $itemcell = new html_table_cell();
1251                 $itemcell->header = true;
1252                 $itemcell->attributes['class'] .= ' header range';
1254                 $hidden = '';
1255                 if ($item->is_hidden()) {
1256                     $hidden = ' hidden ';
1257                 }
1259                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1261                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1262                 $rangerow->cells[] = $itemcell;
1263             }
1264             $rows[] = $rangerow;
1265         }
1266         return $rows;
1267     }
1269     /**
1270      * Builds and return the row of averages for the right part of the grader report.
1271      * @param array $rows Whether to return only group averages or all averages.
1272      * @param bool $grouponly Whether to return only group averages or all averages.
1273      * @return array Array of rows for the right part of the report
1274      */
1275     public function get_right_avg_row($rows=array(), $grouponly=false) {
1276         global $USER, $DB, $OUTPUT;
1278         if (!$this->canviewhidden) {
1279             // Totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1280             // better not show them at all if user can not see all hidden grades.
1281             return $rows;
1282         }
1284         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1285         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1286         $meanselection         = $this->get_pref('meanselection');
1287         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1289         if ($grouponly) {
1290             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1291             $groupsql = $this->groupsql;
1292             $groupwheresql = $this->groupwheresql;
1293             $groupwheresqlparams = $this->groupwheresql_params;
1294         } else {
1295             $showaverages = $this->get_pref('showaverages');
1296             $groupsql = "";
1297             $groupwheresql = "";
1298             $groupwheresqlparams = array();
1299         }
1301         if ($showaverages) {
1302             $totalcount = $this->get_numusers($grouponly);
1304             // Limit to users with a gradeable role.
1305             list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1307             // Limit to users with an active enrollment.
1308             list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
1310             // We want to query both the current context and parent contexts.
1311             list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
1313             $params = array_merge(array('courseid' => $this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams, $relatedctxparams);
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 $relatedctxsql
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 $relatedctxsql
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                 // Determine which display type to use for this average
1393                 if ($USER->gradeediting[$this->courseid]) {
1394                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1396                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1397                     $displaytype = $item->get_displaytype();
1399                 } else {
1400                     $displaytype = $averagesdisplaytype;
1401                 }
1403                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1404                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1405                     $decimalpoints = $item->get_decimals();
1407                 } else {
1408                     $decimalpoints = $averagesdecimalpoints;
1409                 }
1411                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1412                     $avgcell = new html_table_cell();
1413                     $avgcell->text = '-';
1414                     $avgrow->cells[] = $avgcell;
1416                 } else {
1417                     $sum = $sumarray[$item->id];
1418                     $avgradeval = $sum/$meancount;
1419                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1421                     $numberofgrades = '';
1422                     if ($shownumberofgrades) {
1423                         $numberofgrades = " ($meancount)";
1424                     }
1426                     $avgcell = new html_table_cell();
1427                     $avgcell->text = $gradehtml.$numberofgrades;
1428                     $avgrow->cells[] = $avgcell;
1429                 }
1430             }
1431             $rows[] = $avgrow;
1432         }
1433         return $rows;
1434     }
1436     /**
1437      * Given a grade_category, grade_item or grade_grade, this function
1438      * figures out the state of the object and builds then returns a div
1439      * with the icons needed for the grader report.
1440      *
1441      * @param array $object
1442      * @return string HTML
1443      */
1444     protected function get_icons($element) {
1445         global $CFG, $USER, $OUTPUT;
1447         if (!$USER->gradeediting[$this->courseid]) {
1448             return '<div class="grade_icons" />';
1449         }
1451         // Init all icons
1452         $editicon = '';
1454         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem') {
1455             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1456         }
1458         $editcalculationicon = '';
1459         $showhideicon        = '';
1460         $lockunlockicon      = '';
1462         if (has_capability('moodle/grade:manage', $this->context)) {
1463             if ($this->get_pref('showcalculations')) {
1464                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1465             }
1467             if ($this->get_pref('showeyecons')) {
1468                $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1469             }
1471             if ($this->get_pref('showlocks')) {
1472                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1473             }
1475         }
1477         $gradeanalysisicon   = '';
1478         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1479             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1480         }
1482         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1483     }
1485     /**
1486      * Given a category element returns collapsing +/- icon if available
1487      * @param object $object
1488      * @return string HTML
1489      */
1490     protected function get_collapsing_icon($element) {
1491         global $OUTPUT;
1493         $icon = '';
1494         // If object is a category, display expand/contract icon
1495         if ($element['type'] == 'category') {
1496             // Load language strings
1497             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1498             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1499             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1501             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1503             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1504                 $url->param('action', 'switch_plus');
1505                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1507             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1508                 $url->param('action', 'switch_whole');
1509                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1511             } else {
1512                 $url->param('action', 'switch_minus');
1513                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1514             }
1515         }
1516         return $icon;
1517     }
1519     public function process_action($target, $action) {
1520         return self::do_process_action($target, $action);
1521     }
1523     /**
1524      * Processes a single action against a category, grade_item or grade.
1525      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1526      * @param string $action Which action to take (edit, delete etc...)
1527      * @return
1528      */
1529     public static function do_process_action($target, $action) {
1530         // TODO: this code should be in some grade_tree static method
1531         $targettype = substr($target, 0, 1);
1532         $targetid = substr($target, 1);
1533         // TODO: end
1535         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories')) {
1536             $collapsed = unserialize($collapsed);
1537         } else {
1538             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1539         }
1541         switch ($action) {
1542             case 'switch_minus': // Add category to array of aggregatesonly
1543                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1544                     $collapsed['aggregatesonly'][] = $targetid;
1545                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1546                 }
1547                 break;
1549             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1550                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1551                 if ($key !== false) {
1552                     unset($collapsed['aggregatesonly'][$key]);
1553                 }
1554                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1555                     $collapsed['gradesonly'][] = $targetid;
1556                 }
1557                 set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1558                 break;
1559             case 'switch_whole': // Remove the category from the array of collapsed cats
1560                 $key = array_search($targetid, $collapsed['gradesonly']);
1561                 if ($key !== false) {
1562                     unset($collapsed['gradesonly'][$key]);
1563                     set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsed));
1564                 }
1566                 break;
1567             default:
1568                 break;
1569         }
1571         return true;
1572     }
1574     /**
1575      * Returns whether or not to display fixed students column.
1576      * Includes a browser check, because IE6 doesn't support the scrollbar.
1577      *
1578      * @return bool
1579      */
1580     public function is_fixed_students() {
1581         global $USER, $CFG;
1582         return $CFG->grade_report_fixedstudents &&
1583             (check_browser_version('MSIE', '7.0') ||
1584              check_browser_version('Firefox', '2.0') ||
1585              check_browser_version('Gecko', '2006010100') ||
1586              check_browser_version('Camino', '1.0') ||
1587              check_browser_version('Opera', '6.0') ||
1588              check_browser_version('Chrome', '6') ||
1589              check_browser_version('Safari', '300'));
1590     }
1592     /**
1593      * Refactored function for generating HTML of sorting links with matching arrows.
1594      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1595      * to inject into a table header cell.
1596      * @param array $extrafields Array of extra fields being displayed, such as
1597      *   user idnumber
1598      * @return array An associative array of HTML sorting links+arrows
1599      */
1600     public function get_sort_arrows(array $extrafields = array()) {
1601         global $OUTPUT;
1602         $arrows = array();
1604         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1605         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1606         $strfirstname = $this->get_lang_string('firstname');
1607         $strlastname  = $this->get_lang_string('lastname');
1608         $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon'));
1609         $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon'));
1611         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1612         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1614         $arrows['studentname'] = $lastlink;
1616         if ($this->sortitemid === 'lastname') {
1617             if ($this->sortorder == 'ASC') {
1618                 $arrows['studentname'] .= $iconasc;
1619             } else {
1620                 $arrows['studentname'] .= $icondesc;
1621             }
1622         }
1624         $arrows['studentname'] .= ' ' . $firstlink;
1626         if ($this->sortitemid === 'firstname') {
1627             if ($this->sortorder == 'ASC') {
1628                 $arrows['studentname'] .= $iconasc;
1629             } else {
1630                 $arrows['studentname'] .= $icondesc;
1631             }
1632         }
1634         foreach ($extrafields as $field) {
1635             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1636                     array('sortitemid'=>$field)), get_user_field_name($field));
1637             $arrows[$field] = $fieldlink;
1639             if ($field == $this->sortitemid) {
1640                 if ($this->sortorder == 'ASC') {
1641                     $arrows[$field] .= $iconasc;
1642                 } else {
1643                     $arrows[$field] .= $icondesc;
1644                 }
1645             }
1646         }
1648         return $arrows;
1649     }
1651     /**
1652      * Returns the maximum number of students to be displayed on each page
1653      *
1654      * Takes into account the 'studentsperpage' user preference and the 'max_input_vars'
1655      * PHP setting. Too many fields is only a problem when submitting grades but
1656      * we respect 'max_input_vars' even when viewing grades to prevent students disappearing
1657      * when toggling editing on and off.
1658      *
1659      * @return int The maximum number of students to display per page
1660      */
1661     public function get_students_per_page() {
1662         global $USER;
1663         static $studentsperpage = null;
1665         if ($studentsperpage === null) {
1666             $originalstudentsperpage = $studentsperpage = $this->get_pref('studentsperpage');
1668             // Will this number of students result in more fields that we are allowed?
1669             $maxinputvars = ini_get('max_input_vars');
1670             if ($maxinputvars !== false) {
1671                 // We can't do anything about there being more grade items than max_input_vars,
1672                 // but we can decrease number of students per page if there are >= max_input_vars
1673                 $fieldsperstudent = 0; // The number of fields output per student
1675                 if ($this->get_pref('quickgrading') || $this->get_pref('showquickfeedback')) {
1676                     // Each array (grade, feedback) will gain one element
1677                     $fieldsperstudent ++;
1678                 }
1680                 $fieldsrequired = $studentsperpage * $fieldsperstudent;
1681                 if ($fieldsrequired >= $maxinputvars) {
1682                     $studentsperpage = $maxinputvars - 1; // Subtract one to be on the safe side
1683                     if ($studentsperpage<1) {
1684                         // Make sure students per page doesn't fall below 1, though if your
1685                         // max_input_vars is only 1 you've got bigger problems!
1686                         $studentsperpage = 1;
1687                     }
1689                     $a = new stdClass();
1690                     $a->originalstudentsperpage = $originalstudentsperpage;
1691                     $a->studentsperpage = $studentsperpage;
1692                     $a->maxinputvars = $maxinputvars;
1693                     debugging(get_string('studentsperpagereduced', 'grades', $a));
1694                 }
1695             }
1696         }
1698         return $studentsperpage;
1699     }