MDL-63571 grade_report_grader: Use correct context for capability check
[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  * @copyright 2007 Nicolas Connault
32  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class grade_report_grader extends grade_report {
35     /**
36      * The final grades.
37      * @var array $grades
38      */
39     public $grades;
41     /**
42      * Contains all the grades for the course - even the ones not displayed in the grade tree.
43      *
44      * @var array $allgrades
45      */
46     private $allgrades;
48     /**
49      * Contains all grade items expect GRADE_TYPE_NONE.
50      *
51      * @var array $allgradeitems
52      */
53     private $allgradeitems;
55     /**
56      * Array of errors for bulk grades updating.
57      * @var array $gradeserror
58      */
59     public $gradeserror = array();
61     // SQL-RELATED
63     /**
64      * The id of the grade_item by which this report will be sorted.
65      * @var int $sortitemid
66      */
67     public $sortitemid;
69     /**
70      * Sortorder used in the SQL selections.
71      * @var int $sortorder
72      */
73     public $sortorder;
75     /**
76      * An SQL fragment affecting the search for users.
77      * @var string $userselect
78      */
79     public $userselect;
81     /**
82      * The bound params for $userselect
83      * @var array $userselectparams
84      */
85     public $userselectparams = array();
87     /**
88      * List of collapsed categories from user preference
89      * @var array $collapsed
90      */
91     public $collapsed;
93     /**
94      * A count of the rows, used for css classes.
95      * @var int $rowcount
96      */
97     public $rowcount = 0;
99     /**
100      * Capability check caching
101      * @var boolean $canviewhidden
102      */
103     public $canviewhidden;
105     /**
106      * Length at which feedback will be truncated (to the nearest word) and an ellipsis be added.
107      * TODO replace this by a report preference
108      * @var int $feedback_trunc_length
109      */
110     protected $feedback_trunc_length = 50;
112     /**
113      * Allow category grade overriding
114      * @var bool $overridecat
115      */
116     protected $overridecat;
118     /**
119      * Constructor. Sets local copies of user preferences and initialises grade_tree.
120      * @param int $courseid
121      * @param object $gpr grade plugin return tracking object
122      * @param string $context
123      * @param int $page The current page being viewed (when report is paged)
124      * @param int $sortitemid The id of the grade_item by which to sort the table
125      */
126     public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
127         global $CFG;
128         parent::__construct($courseid, $gpr, $context, $page);
130         $this->canviewhidden = has_capability('moodle/grade:viewhidden', context_course::instance($this->course->id));
132         // load collapsed settings for this report
133         $this->collapsed = static::get_collapsed_preferences($this->course->id);
135         if (empty($CFG->enableoutcomes)) {
136             $nooutcomes = false;
137         } else {
138             $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
139         }
141         // if user report preference set or site report setting set use it, otherwise use course or site setting
142         $switch = $this->get_pref('aggregationposition');
143         if ($switch == '') {
144             $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
145         }
147         // Grab the grade_tree for this course
148         $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
150         $this->sortitemid = $sortitemid;
152         // base url for sorting by first/last name
154         $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
156         $studentsperpage = $this->get_students_per_page();
157         if (!empty($this->page) && !empty($studentsperpage)) {
158             $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
159         }
161         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid));
163         $this->setup_groups();
164         $this->setup_users();
165         $this->setup_sortitemid();
167         $this->overridecat = (bool)get_config('moodle', 'grade_overridecat');
168     }
170     /**
171      * Processes the data sent by the form (grades and feedbacks).
172      * Caller is responsible for all access control checks
173      * @param array $data form submission (with magic quotes)
174      * @return array empty array if success, array of warnings if something fails.
175      */
176     public function process_data($data) {
177         global $DB;
178         $warnings = array();
180         $separategroups = false;
181         $mygroups       = array();
182         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
183             $separategroups = true;
184             $mygroups = groups_get_user_groups($this->course->id);
185             $mygroups = $mygroups[0]; // ignore groupings
186             // reorder the groups fro better perf below
187             $current = array_search($this->currentgroup, $mygroups);
188             if ($current !== false) {
189                 unset($mygroups[$current]);
190                 array_unshift($mygroups, $this->currentgroup);
191             }
192         }
193         $viewfullnames = has_capability('moodle/site:viewfullnames', $this->context);
195         // always initialize all arrays
196         $queue = array();
198         $this->load_users();
199         $this->load_final_grades();
201         // Were any changes made?
202         $changedgrades = false;
203         $timepageload = clean_param($data->timepageload, PARAM_INT);
205         foreach ($data as $varname => $students) {
207             $needsupdate = false;
209             // skip, not a grade nor feedback
210             if (strpos($varname, 'grade') === 0) {
211                 $datatype = 'grade';
212             } else if (strpos($varname, 'feedback') === 0) {
213                 $datatype = 'feedback';
214             } else {
215                 continue;
216             }
218             foreach ($students as $userid => $items) {
219                 $userid = clean_param($userid, PARAM_INT);
220                 foreach ($items as $itemid => $postedvalue) {
221                     $itemid = clean_param($itemid, PARAM_INT);
223                     // Was change requested?
224                     $oldvalue = $this->grades[$userid][$itemid];
225                     if ($datatype === 'grade') {
226                         // If there was no grade and there still isn't
227                         if (is_null($oldvalue->finalgrade) && $postedvalue == -1) {
228                             // -1 means no grade
229                             continue;
230                         }
232                         // If the grade item uses a custom scale
233                         if (!empty($oldvalue->grade_item->scaleid)) {
235                             if ((int)$oldvalue->finalgrade === (int)$postedvalue) {
236                                 continue;
237                             }
238                         } else {
239                             // The grade item uses a numeric scale
241                             // Format the finalgrade from the DB so that it matches the grade from the client
242                             if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) {
243                                 continue;
244                             }
245                         }
247                         $changedgrades = true;
249                     } else if ($datatype === 'feedback') {
250                         // If quick grading is on, feedback needs to be compared without line breaks.
251                         if ($this->get_pref('quickgrading')) {
252                             $oldvalue->feedback = preg_replace("/\r\n|\r|\n/", "", $oldvalue->feedback);
253                         }
254                         if (($oldvalue->feedback === $postedvalue) or ($oldvalue->feedback === null and empty($postedvalue))) {
255                             continue;
256                         }
257                     }
259                     if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) {
260                         print_error('invalidgradeitemid');
261                     }
263                     // Pre-process grade
264                     if ($datatype == 'grade') {
265                         $feedback = false;
266                         $feedbackformat = false;
267                         if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
268                             if ($postedvalue == -1) { // -1 means no grade
269                                 $finalgrade = null;
270                             } else {
271                                 $finalgrade = $postedvalue;
272                             }
273                         } else {
274                             $finalgrade = unformat_float($postedvalue);
275                         }
277                         $errorstr = '';
278                         $skip = false;
280                         $dategraded = $oldvalue->get_dategraded();
281                         if (!empty($dategraded) && $timepageload < $dategraded) {
282                             // Warn if the grade was updated while we were editing this form.
283                             $errorstr = 'gradewasmodifiedduringediting';
284                             $skip = true;
285                         } else if (!is_null($finalgrade)) {
286                             // Warn if the grade is out of bounds.
287                             $bounded = $gradeitem->bounded_grade($finalgrade);
288                             if ($bounded > $finalgrade) {
289                                 $errorstr = 'lessthanmin';
290                             } else if ($bounded < $finalgrade) {
291                                 $errorstr = 'morethanmax';
292                             }
293                         }
295                         if ($errorstr) {
296                             $userfields = 'id, ' . get_all_user_name_fields(true);
297                             $user = $DB->get_record('user', array('id' => $userid), $userfields);
298                             $gradestr = new stdClass();
299                             $gradestr->username = fullname($user, $viewfullnames);
300                             $gradestr->itemname = $gradeitem->get_name();
301                             $warnings[] = get_string($errorstr, 'grades', $gradestr);
302                             if ($skip) {
303                                 // Skipping the update of this grade it failed the tests above.
304                                 continue;
305                             }
306                         }
308                     } else if ($datatype == 'feedback') {
309                         $finalgrade = false;
310                         $trimmed = trim($postedvalue);
311                         if (empty($trimmed)) {
312                              $feedback = null;
313                         } else {
314                              $feedback = $postedvalue;
315                         }
316                     }
318                     // group access control
319                     if ($separategroups) {
320                         // note: we can not use $this->currentgroup because it would fail badly
321                         //       when having two browser windows each with different group
322                         $sharinggroup = false;
323                         foreach ($mygroups as $groupid) {
324                             if (groups_is_member($groupid, $userid)) {
325                                 $sharinggroup = true;
326                                 break;
327                             }
328                         }
329                         if (!$sharinggroup) {
330                             // either group membership changed or somebody is hacking grades of other group
331                             $warnings[] = get_string('errorsavegrade', 'grades');
332                             continue;
333                         }
334                     }
336                     $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
338                     // We can update feedback without reloading the grade item as it doesn't affect grade calculations
339                     if ($datatype === 'feedback') {
340                         $this->grades[$userid][$itemid]->feedback = $feedback;
341                     }
342                 }
343             }
344         }
346         if ($changedgrades) {
347             // If a final grade was overriden reload grades so dependent grades like course total will be correct
348             $this->grades = null;
349         }
351         return $warnings;
352     }
355     /**
356      * Setting the sort order, this depends on last state
357      * all this should be in the new table class that we might need to use
358      * for displaying grades.
359      */
360     private function setup_sortitemid() {
362         global $SESSION;
364         if (!isset($SESSION->gradeuserreport)) {
365             $SESSION->gradeuserreport = new stdClass();
366         }
368         if ($this->sortitemid) {
369             if (!isset($SESSION->gradeuserreport->sort)) {
370                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
371                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
372                 } else {
373                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
374                 }
375             } else {
376                 // this is the first sort, i.e. by last name
377                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
378                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
379                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
380                     } else {
381                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
382                     }
383                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
384                     // same as last sort
385                     if ($SESSION->gradeuserreport->sort == 'ASC') {
386                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
387                     } else {
388                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
389                     }
390                 } else {
391                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
392                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
393                     } else {
394                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
395                     }
396                 }
397             }
398             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
399         } else {
400             // not requesting sort, use last setting (for paging)
402             if (isset($SESSION->gradeuserreport->sortitemid)) {
403                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
404             } else {
405                 $this->sortitemid = 'lastname';
406             }
408             if (isset($SESSION->gradeuserreport->sort)) {
409                 $this->sortorder = $SESSION->gradeuserreport->sort;
410             } else {
411                 $this->sortorder = 'ASC';
412             }
413         }
414     }
416     /**
417      * pulls out the userids of the users to be display, and sorts them
418      */
419     public function load_users() {
420         global $CFG, $DB;
422         if (!empty($this->users)) {
423             return;
424         }
425         $this->setup_users();
427         // Limit to users with a gradeable role.
428         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
430         // Check the status of showing only active enrolments.
431         $coursecontext = $this->context->get_course_context(true);
432         $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
433         $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
434         $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
436         // Limit to users with an active enrollment.
437         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol);
439         // Fields we need from the user table.
440         $userfields = user_picture::fields('u', get_extra_user_fields($this->context));
442         // We want to query both the current context and parent contexts.
443         list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
445         // If the user has clicked one of the sort asc/desc arrows.
446         if (is_numeric($this->sortitemid)) {
447             $params = array_merge(array('gitemid' => $this->sortitemid), $gradebookrolesparams, $this->userwheresql_params,
448                     $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
450             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
451             $sort = "g.finalgrade $this->sortorder, u.idnumber, u.lastname, u.firstname, u.email";
452         } else {
453             $sortjoin = '';
454             switch($this->sortitemid) {
455                 case 'lastname':
456                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder, u.idnumber, u.email";
457                     break;
458                 case 'firstname':
459                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder, u.idnumber, u.email";
460                     break;
461                 case 'email':
462                     $sort = "u.email $this->sortorder, u.firstname, u.lastname, u.idnumber";
463                     break;
464                 case 'idnumber':
465                 default:
466                     $sort = "u.idnumber $this->sortorder, u.firstname, u.lastname, u.email";
467                     break;
468             }
470             $params = array_merge($gradebookrolesparams, $this->userwheresql_params, $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
471         }
473         $sql = "SELECT $userfields
474                   FROM {user} u
475                   JOIN ($enrolledsql) je ON je.id = u.id
476                        $this->groupsql
477                        $sortjoin
478                   JOIN (
479                            SELECT DISTINCT ra.userid
480                              FROM {role_assignments} ra
481                             WHERE ra.roleid IN ($this->gradebookroles)
482                               AND ra.contextid $relatedctxsql
483                        ) rainner ON rainner.userid = u.id
484                    AND u.deleted = 0
485                    $this->userwheresql
486                    $this->groupwheresql
487               ORDER BY $sort";
488         $studentsperpage = $this->get_students_per_page();
489         $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage);
491         if (empty($this->users)) {
492             $this->userselect = '';
493             $this->users = array();
494             $this->userselect_params = array();
495         } else {
496             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
497             $this->userselect = "AND g.userid $usql";
498             $this->userselect_params = $uparams;
500             // First flag everyone as not suspended.
501             foreach ($this->users as $user) {
502                 $this->users[$user->id]->suspendedenrolment = false;
503             }
505             // If we want to mix both suspended and not suspended users, let's find out who is suspended.
506             if (!$showonlyactiveenrol) {
507                 $sql = "SELECT ue.userid
508                           FROM {user_enrolments} ue
509                           JOIN {enrol} e ON e.id = ue.enrolid
510                          WHERE ue.userid $usql
511                                AND ue.status = :uestatus
512                                AND e.status = :estatus
513                                AND e.courseid = :courseid
514                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)
515                       GROUP BY ue.userid";
517                 $time = time();
518                 $params = array_merge($uparams, array('estatus' => ENROL_INSTANCE_ENABLED, 'uestatus' => ENROL_USER_ACTIVE,
519                         'courseid' => $coursecontext->instanceid, 'now1' => $time, 'now2' => $time));
520                 $useractiveenrolments = $DB->get_records_sql($sql, $params);
522                 foreach ($this->users as $user) {
523                     $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
524                 }
525             }
526         }
527         return $this->users;
528     }
530     /**
531      * Load all grade items.
532      */
533     protected function get_allgradeitems() {
534         if (!empty($this->allgradeitems)) {
535             return $this->allgradeitems;
536         }
537         $allgradeitems = grade_item::fetch_all(array('courseid' => $this->courseid));
538         // But hang on - don't include ones which are set to not show the grade at all.
539         $this->allgradeitems = array_filter($allgradeitems, function($item) {
540             return $item->gradetype != GRADE_TYPE_NONE;
541         });
543         return $this->allgradeitems;
544     }
546     /**
547      * we supply the userids in this query, and get all the grades
548      * pulls out all the grades, this does not need to worry about paging
549      */
550     public function load_final_grades() {
551         global $CFG, $DB;
553         if (!empty($this->grades)) {
554             return;
555         }
557         if (empty($this->users)) {
558             return;
559         }
561         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
562         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
563         $sql = "SELECT g.*
564                   FROM {grade_items} gi,
565                        {grade_grades} g
566                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
568         $userids = array_keys($this->users);
569         $allgradeitems = $this->get_allgradeitems();
571         if ($grades = $DB->get_records_sql($sql, $params)) {
572             foreach ($grades as $graderec) {
573                 $grade = new grade_grade($graderec, false);
574                 if (!empty($allgradeitems[$graderec->itemid])) {
575                     // Note: Filter out grades which have a grade type of GRADE_TYPE_NONE.
576                     // Only grades without this type are present in $allgradeitems.
577                     $this->allgrades[$graderec->userid][$graderec->itemid] = $grade;
578                 }
579                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
580                     $this->grades[$graderec->userid][$graderec->itemid] = $grade;
581                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
582                 }
583             }
584         }
586         // prefil grades that do not exist yet
587         foreach ($userids as $userid) {
588             foreach ($this->gtree->get_items() as $itemid => $unused) {
589                 if (!isset($this->grades[$userid][$itemid])) {
590                     $this->grades[$userid][$itemid] = new grade_grade();
591                     $this->grades[$userid][$itemid]->itemid = $itemid;
592                     $this->grades[$userid][$itemid]->userid = $userid;
593                     $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
595                     $this->allgrades[$userid][$itemid] = $this->grades[$userid][$itemid];
596                 }
597             }
598         }
600         // Pre fill grades for any remaining items which might be collapsed.
601         foreach ($userids as $userid) {
602             foreach ($allgradeitems as $itemid => $gradeitem) {
603                 if (!isset($this->allgrades[$userid][$itemid])) {
604                     $this->allgrades[$userid][$itemid] = new grade_grade();
605                     $this->allgrades[$userid][$itemid]->itemid = $itemid;
606                     $this->allgrades[$userid][$itemid]->userid = $userid;
607                     $this->allgrades[$userid][$itemid]->grade_item = $gradeitem;
608                 }
609             }
610         }
611     }
613     /**
614      * Gets html toggle
615      * @deprecated since Moodle 2.4 as it appears not to be used any more.
616      */
617     public function get_toggles_html() {
618         throw new coding_exception('get_toggles_html() can not be used any more');
619     }
621     /**
622      * Prints html toggle
623      * @deprecated since 2.4 as it appears not to be used any more.
624      * @param unknown $type
625      */
626     public function print_toggle($type) {
627         throw new coding_exception('print_toggle() can not be used any more');
628     }
630     /**
631      * Builds and returns the rows that will make up the left part of the grader report
632      * This consists of student names and icons, links to user reports and id numbers, as well
633      * as header cells for these columns. It also includes the fillers required for the
634      * categories displayed on the right side of the report.
635      * @param boolean $displayaverages whether to display average rows in the table
636      * @return array Array of html_table_row objects
637      */
638     public function get_left_rows($displayaverages) {
639         global $CFG, $USER, $OUTPUT;
641         $rows = array();
643         $showuserimage = $this->get_pref('showuserimage');
644         // FIXME: MDL-52678 This get_capability_info is hacky and we should have an API for inserting grade row links instead.
645         $canseeuserreport = false;
646         $canseesingleview = false;
647         if (get_capability_info('gradereport/'.$CFG->grade_profilereport.':view')) {
648             $canseeuserreport = has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context);
649         }
650         if (get_capability_info('gradereport/singleview:view')) {
651             $canseesingleview = has_all_capabilities(array('gradereport/singleview:view', 'moodle/grade:viewall',
652             'moodle/grade:edit'), $this->context);
653         }
654         $hasuserreportcell = $canseeuserreport || $canseesingleview;
655         $viewfullnames = has_capability('moodle/site:viewfullnames', $this->context);
657         $strfeedback  = $this->get_lang_string("feedback");
658         $strgrade     = $this->get_lang_string('grade');
660         $extrafields = get_extra_user_fields($this->context);
662         $arrows = $this->get_sort_arrows($extrafields);
664         $colspan = 1 + $hasuserreportcell + count($extrafields);
666         $levels = count($this->gtree->levels) - 1;
668         $fillercell = new html_table_cell();
669         $fillercell->header = true;
670         $fillercell->attributes['scope'] = 'col';
671         $fillercell->attributes['class'] = 'cell topleft';
672         $fillercell->text = html_writer::span(get_string('participants'), 'accesshide');
673         $fillercell->colspan = $colspan;
674         $fillercell->rowspan = $levels;
675         $row = new html_table_row(array($fillercell));
676         $rows[] = $row;
678         for ($i = 1; $i < $levels; $i++) {
679             $row = new html_table_row();
680             $rows[] = $row;
681         }
683         $headerrow = new html_table_row();
684         $headerrow->attributes['class'] = 'heading';
686         $studentheader = new html_table_cell();
687         $studentheader->attributes['class'] = 'header';
688         $studentheader->scope = 'col';
689         $studentheader->header = true;
690         $studentheader->id = 'studentheader';
691         if ($hasuserreportcell) {
692             $studentheader->colspan = 2;
693         }
694         $studentheader->text = $arrows['studentname'];
696         $headerrow->cells[] = $studentheader;
698         foreach ($extrafields as $field) {
699             $fieldheader = new html_table_cell();
700             $fieldheader->attributes['class'] = 'header userfield user' . $field;
701             $fieldheader->scope = 'col';
702             $fieldheader->header = true;
703             $fieldheader->text = $arrows[$field];
705             $headerrow->cells[] = $fieldheader;
706         }
708         $rows[] = $headerrow;
710         $rows = $this->get_left_icons_row($rows, $colspan);
712         $suspendedstring = null;
713         foreach ($this->users as $userid => $user) {
714             $userrow = new html_table_row();
715             $userrow->id = 'fixed_user_'.$userid;
717             $usercell = new html_table_cell();
718             $usercell->attributes['class'] = 'header user';
720             $usercell->header = true;
721             $usercell->scope = 'row';
723             if ($showuserimage) {
724                 $usercell->text = $OUTPUT->user_picture($user, array('visibletoscreenreaders' => false));
725             }
727             $fullname = fullname($user, $viewfullnames);
728             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), $fullname, array(
729                 'class' => 'username',
730             ));
732             if (!empty($user->suspendedenrolment)) {
733                 $usercell->attributes['class'] .= ' usersuspended';
735                 //may be lots of suspended users so only get the string once
736                 if (empty($suspendedstring)) {
737                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
738                 }
739                 $icon = $OUTPUT->pix_icon('i/enrolmentsuspended', $suspendedstring);
740                 $usercell->text .= html_writer::tag('span', $icon, array('class'=>'usersuspendedicon'));
741             }
743             $userrow->cells[] = $usercell;
745             $userreportcell = new html_table_cell();
746             $userreportcell->attributes['class'] = 'userreport';
747             $userreportcell->header = false;
748             if ($canseeuserreport) {
749                 $a = new stdClass();
750                 $a->user = $fullname;
751                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
752                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
753                 $userreportcell->text .= $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
754             }
756             if ($canseesingleview) {
757                 $url = new moodle_url('/grade/report/singleview/index.php', array('id' => $this->course->id, 'itemid' => $user->id, 'item' => 'user'));
758                 $singleview = $OUTPUT->action_icon($url, new pix_icon('t/editstring', get_string('singleview', 'grades', $fullname)));
759                 $userreportcell->text .= $singleview;
760             }
762             if ($userreportcell->text) {
763                 $userrow->cells[] = $userreportcell;
764             }
766             foreach ($extrafields as $field) {
767                 $fieldcell = new html_table_cell();
768                 $fieldcell->attributes['class'] = 'userfield user' . $field;
769                 $fieldcell->header = false;
770                 $fieldcell->text = $user->{$field};
771                 $userrow->cells[] = $fieldcell;
772             }
774             $userrow->attributes['data-uid'] = $userid;
775             $rows[] = $userrow;
776         }
778         $rows = $this->get_left_range_row($rows, $colspan);
779         if ($displayaverages) {
780             $rows = $this->get_left_avg_row($rows, $colspan, true);
781             $rows = $this->get_left_avg_row($rows, $colspan);
782         }
784         return $rows;
785     }
787     /**
788      * Builds and returns the rows that will make up the right part of the grader report
789      * @param boolean $displayaverages whether to display average rows in the table
790      * @return array Array of html_table_row objects
791      */
792     public function get_right_rows($displayaverages) {
793         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
795         $rows = array();
796         $this->rowcount = 0;
797         $numrows = count($this->gtree->get_levels());
798         $numusers = count($this->users);
799         $gradetabindex = 1;
800         $columnstounset = array();
801         $strgrade = $this->get_lang_string('grade');
802         $strfeedback  = $this->get_lang_string("feedback");
803         $arrows = $this->get_sort_arrows();
805         $jsarguments = array(
806             'cfg'       => array('ajaxenabled'=>false),
807             'items'     => array(),
808             'users'     => array(),
809             'feedback'  => array(),
810             'grades'    => array()
811         );
812         $jsscales = array();
814         // Get preferences once.
815         $showactivityicons = $this->get_pref('showactivityicons');
816         $quickgrading = $this->get_pref('quickgrading');
817         $showquickfeedback = $this->get_pref('showquickfeedback');
818         $enableajax = $this->get_pref('enableajax');
819         $showanalysisicon = $this->get_pref('showanalysisicon');
821         // Get strings which are re-used inside the loop.
822         $strftimedatetimeshort = get_string('strftimedatetimeshort');
823         $strexcludedgrades = get_string('excluded', 'grades');
824         $strerror = get_string('error');
826         $viewfullnames = has_capability('moodle/site:viewfullnames', $this->context);
828         foreach ($this->gtree->get_levels() as $key => $row) {
829             $headingrow = new html_table_row();
830             $headingrow->attributes['class'] = 'heading_name_row';
832             foreach ($row as $columnkey => $element) {
833                 $sortlink = clone($this->baseurl);
834                 if (isset($element['object']->id)) {
835                     $sortlink->param('sortitemid', $element['object']->id);
836                 }
838                 $eid    = $element['eid'];
839                 $object = $element['object'];
840                 $type   = $element['type'];
841                 $categorystate = @$element['categorystate'];
843                 if (!empty($element['colspan'])) {
844                     $colspan = $element['colspan'];
845                 } else {
846                     $colspan = 1;
847                 }
849                 if (!empty($element['depth'])) {
850                     $catlevel = 'catlevel'.$element['depth'];
851                 } else {
852                     $catlevel = '';
853                 }
855                 // Element is a filler
856                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
857                     $fillercell = new html_table_cell();
858                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
859                     $fillercell->colspan = $colspan;
860                     $fillercell->text = '&nbsp;';
862                     // This is a filler cell; don't use a <th>, it'll confuse screen readers.
863                     $fillercell->header = false;
864                     $headingrow->cells[] = $fillercell;
865                 } else if ($type == 'category') {
866                     // Make sure the grade category has a grade total or at least has child grade items.
867                     if (grade_tree::can_output_item($element)) {
868                         // Element is a category.
869                         $categorycell = new html_table_cell();
870                         $categorycell->attributes['class'] = 'category ' . $catlevel;
871                         $categorycell->colspan = $colspan;
872                         $categorycell->text = $this->get_course_header($element);
873                         $categorycell->header = true;
874                         $categorycell->scope = 'col';
876                         // Print icons.
877                         if ($USER->gradeediting[$this->courseid]) {
878                             $categorycell->text .= $this->get_icons($element);
879                         }
881                         $headingrow->cells[] = $categorycell;
882                     }
883                 } else {
884                     // Element is a grade_item
885                     if ($element['object']->id == $this->sortitemid) {
886                         if ($this->sortorder == 'ASC') {
887                             $arrow = $this->get_sort_arrow('up', $sortlink);
888                         } else {
889                             $arrow = $this->get_sort_arrow('down', $sortlink);
890                         }
891                     } else {
892                         $arrow = $this->get_sort_arrow('move', $sortlink);
893                     }
895                     $headerlink = $this->gtree->get_element_header($element, true, $showactivityicons, false, false, true);
897                     $itemcell = new html_table_cell();
898                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable'. ' i'. $element['object']->id;
899                     $itemcell->attributes['data-itemid'] = $element['object']->id;
901                     if ($element['object']->is_hidden()) {
902                         $itemcell->attributes['class'] .= ' dimmed_text';
903                     }
905                     $singleview = '';
907                     // FIXME: MDL-52678 This is extremely hacky we should have an API for inserting grade column links.
908                     if (get_capability_info('gradereport/singleview:view')) {
909                         if (has_all_capabilities(array('gradereport/singleview:view', 'moodle/grade:viewall',
910                             'moodle/grade:edit'), $this->context)) {
912                             $url = new moodle_url('/grade/report/singleview/index.php', array(
913                                 'id' => $this->course->id,
914                                 'item' => 'grade',
915                                 'itemid' => $element['object']->id));
916                             $singleview = $OUTPUT->action_icon(
917                                 $url,
918                                 new pix_icon('t/editstring', get_string('singleview', 'grades', $element['object']->get_name()))
919                             );
920                         }
921                     }
923                     $itemcell->colspan = $colspan;
924                     $itemcell->text = $headerlink . $arrow . $singleview;
925                     $itemcell->header = true;
926                     $itemcell->scope = 'col';
928                     $headingrow->cells[] = $itemcell;
929                 }
930             }
931             $rows[] = $headingrow;
932         }
934         $rows = $this->get_right_icons_row($rows);
936         // Preload scale objects for items with a scaleid and initialize tab indices
937         $scaleslist = array();
938         $tabindices = array();
940         foreach ($this->gtree->get_items() as $itemid => $item) {
941             $scale = null;
942             if (!empty($item->scaleid)) {
943                 $scaleslist[] = $item->scaleid;
944                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
945             } else {
946                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
947             }
948             $tabindices[$item->id]['grade'] = $gradetabindex;
949             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
950             $gradetabindex += $numusers * 2;
951         }
952         $scalesarray = array();
954         if (!empty($scaleslist)) {
955             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
956         }
957         $jsscales = $scalesarray;
959         // Get all the grade items if the user can not view hidden grade items.
960         // It is possible that the user is simply viewing the 'Course total' by switching to the 'Aggregates only' view
961         // and that this user does not have the ability to view hidden items. In this case we still need to pass all the
962         // grade items (in case one has been hidden) as the course total shown needs to be adjusted for this particular
963         // user.
964         if (!$this->canviewhidden) {
965             $allgradeitems = $this->get_allgradeitems();
966         }
968         foreach ($this->users as $userid => $user) {
970             if ($this->canviewhidden) {
971                 $altered = array();
972                 $unknown = array();
973             } else {
974                 $usergrades = $this->allgrades[$userid];
975                 $hidingaffected = grade_grade::get_hiding_affected($usergrades, $allgradeitems);
976                 $altered = $hidingaffected['altered'];
977                 $unknown = $hidingaffected['unknowngrades'];
978                 unset($hidingaffected);
979             }
981             $itemrow = new html_table_row();
982             $itemrow->id = 'user_'.$userid;
984             $fullname = fullname($user, $viewfullnames);
985             $jsarguments['users'][$userid] = $fullname;
987             foreach ($this->gtree->items as $itemid => $unused) {
988                 $item =& $this->gtree->items[$itemid];
989                 $grade = $this->grades[$userid][$item->id];
991                 $itemcell = new html_table_cell();
993                 $itemcell->id = 'u'.$userid.'i'.$itemid;
994                 $itemcell->attributes['data-itemid'] = $itemid;
996                 // Get the decimal points preference for this item
997                 $decimalpoints = $item->get_decimals();
999                 if (array_key_exists($itemid, $unknown)) {
1000                     $gradeval = null;
1001                 } else if (array_key_exists($itemid, $altered)) {
1002                     $gradeval = $altered[$itemid];
1003                 } else {
1004                     $gradeval = $grade->finalgrade;
1005                 }
1006                 if (!empty($grade->finalgrade)) {
1007                     $gradevalforjs = null;
1008                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1009                         $gradevalforjs = (int)$gradeval;
1010                     } else {
1011                         $gradevalforjs = format_float($gradeval, $decimalpoints);
1012                     }
1013                     $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforjs);
1014                 }
1016                 // MDL-11274
1017                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
1018                 if (!$this->canviewhidden and $grade->is_hidden()) {
1019                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
1020                         // 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
1021                         $itemcell->text = "<span class='datesubmitted'>" .
1022                                 userdate($grade->get_datesubmitted(), $strftimedatetimeshort) . "</span>";
1023                     } else {
1024                         $itemcell->text = '-';
1025                     }
1026                     $itemrow->cells[] = $itemcell;
1027                     continue;
1028                 }
1030                 // emulate grade element
1031                 $eid = $this->gtree->get_grade_eid($grade);
1032                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
1034                 $itemcell->attributes['class'] .= ' grade i'.$itemid;
1035                 if ($item->is_category_item()) {
1036                     $itemcell->attributes['class'] .= ' cat';
1037                 }
1038                 if ($item->is_course_item()) {
1039                     $itemcell->attributes['class'] .= ' course';
1040                 }
1041                 if ($grade->is_overridden()) {
1042                     $itemcell->attributes['class'] .= ' overridden';
1043                     $itemcell->attributes['aria-label'] = get_string('overriddengrade', 'gradereport_grader');
1044                 }
1046                 if (!empty($grade->feedback)) {
1047                     $feedback = wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)), 34, '<br>');
1048                     $itemcell->attributes['data-feedback'] = $feedback;
1049                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content' => $feedback);
1050                 }
1052                 if ($grade->is_excluded()) {
1053                     // Adding white spaces before and after to prevent a screenreader from
1054                     // thinking that the words are attached to the next/previous <span> or text.
1055                     $itemcell->text .= " <span class='excludedfloater'>" . $strexcludedgrades . "</span> ";
1056                 }
1058                 // Do not show any icons if no grade (no record in DB to match)
1059                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
1060                     $itemcell->text .= $this->get_icons($element);
1061                 }
1063                 $hidden = '';
1064                 if ($grade->is_hidden()) {
1065                     $hidden = ' dimmed_text ';
1066                 }
1068                 $gradepass = ' gradefail ';
1069                 if ($grade->is_passed($item)) {
1070                     $gradepass = ' gradepass ';
1071                 } else if (is_null($grade->is_passed($item))) {
1072                     $gradepass = '';
1073                 }
1075                 // if in editing mode, we need to print either a text box
1076                 // or a drop down (for scales)
1077                 // grades in item of type grade category or course are not directly editable
1078                 if ($item->needsupdate) {
1079                     $itemcell->text .= "<span class='gradingerror{$hidden}'>" . $strerror . "</span>";
1081                 } else if ($USER->gradeediting[$this->courseid]) {
1083                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1084                         $itemcell->attributes['class'] .= ' grade_type_scale';
1085                     } else if ($item->gradetype == GRADE_TYPE_VALUE) {
1086                         $itemcell->attributes['class'] .= ' grade_type_value';
1087                     } else if ($item->gradetype == GRADE_TYPE_TEXT) {
1088                         $itemcell->attributes['class'] .= ' grade_type_text';
1089                     }
1091                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1092                         $scale = $scalesarray[$item->scaleid];
1093                         $gradeval = (int)$gradeval; // scales use only integers
1094                         $scales = explode(",", $scale->scale);
1095                         // reindex because scale is off 1
1097                         // MDL-12104 some previous scales might have taken up part of the array
1098                         // so this needs to be reset
1099                         $scaleopt = array();
1100                         $i = 0;
1101                         foreach ($scales as $scaleoption) {
1102                             $i++;
1103                             $scaleopt[$i] = $scaleoption;
1104                         }
1106                         if ($quickgrading and $grade->is_editable()) {
1107                             $oldval = empty($gradeval) ? -1 : $gradeval;
1108                             if (empty($item->outcomeid)) {
1109                                 $nogradestr = $this->get_lang_string('nograde');
1110                             } else {
1111                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
1112                             }
1113                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
1114                             $gradelabel = $fullname . ' ' . $item->get_name(true);
1115                             $itemcell->text .= html_writer::label(
1116                                 get_string('useractivitygrade', 'gradereport_grader', $gradelabel), $attributes['id'], false,
1117                                     array('class' => 'accesshide'));
1118                             $itemcell->text .= html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, array(-1=>$nogradestr), $attributes);
1119                         } else if (!empty($scale)) {
1120                             $scales = explode(",", $scale->scale);
1122                             // invalid grade if gradeval < 1
1123                             if ($gradeval < 1) {
1124                                 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>-</span>";
1125                             } else {
1126                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
1127                                 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>{$scales[$gradeval - 1]}</span>";
1128                             }
1129                         }
1131                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
1132                         if ($quickgrading and $grade->is_editable()) {
1133                             $value = format_float($gradeval, $decimalpoints);
1134                             $gradelabel = $fullname . ' ' . $item->get_name(true);
1135                             $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">'
1136                                           .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>';
1137                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
1138                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade['
1139                                           .$userid.'][' .$item->id.']" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
1140                         } else {
1141                             $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1142                                     format_float($gradeval, $decimalpoints) . "</span>";
1143                         }
1144                     }
1146                     // If quickfeedback is on, print an input element
1147                     if ($showquickfeedback and $grade->is_editable()) {
1148                         $feedbacklabel = $fullname . ' ' . $item->get_name(true);
1149                         $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">'
1150                                       .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>';
1151                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
1152                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback['.$userid.']['.$item->id.']" value="' . s($grade->feedback) . '" />';
1153                     }
1155                 } else { // Not editing
1156                     $gradedisplaytype = $item->get_displaytype();
1158                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1159                         $itemcell->attributes['class'] .= ' grade_type_scale';
1160                     } else if ($item->gradetype == GRADE_TYPE_VALUE) {
1161                         $itemcell->attributes['class'] .= ' grade_type_value';
1162                     } else if ($item->gradetype == GRADE_TYPE_TEXT) {
1163                         $itemcell->attributes['class'] .= ' grade_type_text';
1164                     }
1166                     // Only allow edting if the grade is editable (not locked, not in a unoverridable category, etc).
1167                     if ($enableajax && $grade->is_editable()) {
1168                         // If a grade item is type text, and we don't have show quick feedback on, it can't be edited.
1169                         if ($item->gradetype != GRADE_TYPE_TEXT || $showquickfeedback) {
1170                             $itemcell->attributes['class'] .= ' clickable';
1171                         }
1172                     }
1174                     if ($item->needsupdate) {
1175                         $itemcell->text .= "<span class='gradingerror{$hidden}{$gradepass}'>" . $error . "</span>";
1176                     } else {
1177                         // The max and min for an aggregation may be different to the grade_item.
1178                         if (!is_null($gradeval)) {
1179                             $item->grademax = $grade->get_grade_max();
1180                             $item->grademin = $grade->get_grade_min();
1181                         }
1183                         $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1184                                 grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null) . "</span>";
1185                         if ($showanalysisicon) {
1186                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1187                         }
1188                     }
1189                 }
1191                 // Enable keyboard navigation if the grade is editable (not locked, not in a unoverridable category, etc).
1192                 if ($enableajax && $grade->is_editable()) {
1193                     // If a grade item is type text, and we don't have show quick feedback on, it can't be edited.
1194                     if ($item->gradetype != GRADE_TYPE_TEXT || $showquickfeedback) {
1195                         $itemcell->attributes['class'] .= ' gbnavigable';
1196                     }
1197                 }
1199                 if (!empty($this->gradeserror[$item->id][$userid])) {
1200                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1201                 }
1203                 $itemrow->cells[] = $itemcell;
1204             }
1205             $rows[] = $itemrow;
1206         }
1208         if ($enableajax) {
1209             $jsarguments['cfg']['ajaxenabled'] = true;
1210             $jsarguments['cfg']['scales'] = array();
1211             foreach ($jsscales as $scale) {
1212                 // Trim the scale values, as they may have a space that is ommitted from values later.
1213                 $jsarguments['cfg']['scales'][$scale->id] = array_map('trim', explode(',', $scale->scale));
1214             }
1215             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1217             // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades']
1218         }
1219         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1220         $jsarguments['cfg']['courseid'] = $this->courseid;
1221         $jsarguments['cfg']['studentsperpage'] = $this->get_students_per_page();
1222         $jsarguments['cfg']['showquickfeedback'] = (bool) $showquickfeedback;
1224         $module = array(
1225             'name'      => 'gradereport_grader',
1226             'fullpath'  => '/grade/report/grader/module.js',
1227             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1228         );
1229         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1230         $PAGE->requires->strings_for_js(array('addfeedback', 'feedback', 'grade'), 'grades');
1231         $PAGE->requires->strings_for_js(array('ajaxchoosescale', 'ajaxclicktoclose', 'ajaxerror', 'ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1232         if (!$enableajax && $USER->gradeediting[$this->courseid]) {
1233             $PAGE->requires->yui_module('moodle-core-formchangechecker',
1234                     'M.core_formchangechecker.init',
1235                     array(array(
1236                         'formid' => 'gradereport_grader'
1237                     ))
1238             );
1239             $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
1240         }
1242         $rows = $this->get_right_range_row($rows);
1243         if ($displayaverages) {
1244             $rows = $this->get_right_avg_row($rows, true);
1245             $rows = $this->get_right_avg_row($rows);
1246         }
1248         return $rows;
1249     }
1251     /**
1252      * Depending on the style of report (fixedstudents vs traditional one-table),
1253      * arranges the rows of data in one or two tables, and returns the output of
1254      * these tables in HTML
1255      * @param boolean $displayaverages whether to display average rows in the table
1256      * @return string HTML
1257      */
1258     public function get_grade_table($displayaverages = false) {
1259         global $OUTPUT;
1260         $leftrows = $this->get_left_rows($displayaverages);
1261         $rightrows = $this->get_right_rows($displayaverages);
1263         $html = '';
1265         $fulltable = new html_table();
1266         $fulltable->attributes['class'] = 'gradereport-grader-table';
1267         $fulltable->id = 'user-grades';
1268         $fulltable->summary = get_string('summarygrader', 'gradereport_grader');
1270         // Extract rows from each side (left and right) and collate them into one row each
1271         foreach ($leftrows as $key => $row) {
1272             $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1273             $fulltable->data[] = $row;
1274         }
1275         $html .= html_writer::table($fulltable);
1276         return $OUTPUT->container($html, 'gradeparent');
1277     }
1279     /**
1280      * Builds and return the row of icons for the left side of the report.
1281      * It only has one cell that says "Controls"
1282      * @param array $rows The Array of rows for the left part of the report
1283      * @param int $colspan The number of columns this cell has to span
1284      * @return array Array of rows for the left part of the report
1285      */
1286     public function get_left_icons_row($rows=array(), $colspan=1) {
1287         global $USER;
1289         if ($USER->gradeediting[$this->courseid]) {
1290             $controlsrow = new html_table_row();
1291             $controlsrow->attributes['class'] = 'controls';
1292             $controlscell = new html_table_cell();
1293             $controlscell->attributes['class'] = 'header controls';
1294             $controlscell->colspan = $colspan;
1295             $controlscell->text = $this->get_lang_string('controls', 'grades');
1297             $controlsrow->cells[] = $controlscell;
1298             $rows[] = $controlsrow;
1299         }
1300         return $rows;
1301     }
1303     /**
1304      * Builds and return the header for the row of ranges, for the left part of the grader report.
1305      * @param array $rows The Array of rows for the left part of the report
1306      * @param int $colspan The number of columns this cell has to span
1307      * @return array Array of rows for the left part of the report
1308      */
1309     public function get_left_range_row($rows=array(), $colspan=1) {
1310         global $CFG, $USER;
1312         if ($this->get_pref('showranges')) {
1313             $rangerow = new html_table_row();
1314             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1315             $rangecell = new html_table_cell();
1316             $rangecell->attributes['class'] = 'header range';
1317             $rangecell->colspan = $colspan;
1318             $rangecell->header = true;
1319             $rangecell->scope = 'row';
1320             $rangecell->text = $this->get_lang_string('range', 'grades');
1321             $rangerow->cells[] = $rangecell;
1322             $rows[] = $rangerow;
1323         }
1325         return $rows;
1326     }
1328     /**
1329      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1330      * @param array $rows The Array of rows for the left part of the report
1331      * @param int $colspan The number of columns this cell has to span
1332      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1333      * @return array Array of rows for the left part of the report
1334      */
1335     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1336         if (!$this->canviewhidden) {
1337             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1338             // better not show them at all if user can not see all hideen grades
1339             return $rows;
1340         }
1342         $showaverages = $this->get_pref('showaverages');
1343         $showaveragesgroup = $this->currentgroup && $showaverages;
1344         $straveragegroup = get_string('groupavg', 'grades');
1346         if ($groupavg) {
1347             if ($showaveragesgroup) {
1348                 $groupavgrow = new html_table_row();
1349                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1350                 $groupavgcell = new html_table_cell();
1351                 $groupavgcell->attributes['class'] = 'header range';
1352                 $groupavgcell->colspan = $colspan;
1353                 $groupavgcell->header = true;
1354                 $groupavgcell->scope = 'row';
1355                 $groupavgcell->text = $straveragegroup;
1356                 $groupavgrow->cells[] = $groupavgcell;
1357                 $rows[] = $groupavgrow;
1358             }
1359         } else {
1360             $straverage = get_string('overallaverage', 'grades');
1362             if ($showaverages) {
1363                 $avgrow = new html_table_row();
1364                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1365                 $avgcell = new html_table_cell();
1366                 $avgcell->attributes['class'] = 'header range';
1367                 $avgcell->colspan = $colspan;
1368                 $avgcell->header = true;
1369                 $avgcell->scope = 'row';
1370                 $avgcell->text = $straverage;
1371                 $avgrow->cells[] = $avgcell;
1372                 $rows[] = $avgrow;
1373             }
1374         }
1376         return $rows;
1377     }
1379     /**
1380      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1381      * @param array $rows The Array of rows for the right part of the report
1382      * @return array Array of rows for the right part of the report
1383      */
1384     public function get_right_icons_row($rows=array()) {
1385         global $USER;
1386         if ($USER->gradeediting[$this->courseid]) {
1387             $iconsrow = new html_table_row();
1388             $iconsrow->attributes['class'] = 'controls';
1390             foreach ($this->gtree->items as $itemid => $unused) {
1391                 // emulate grade element
1392                 $item = $this->gtree->get_item($itemid);
1394                 $eid = $this->gtree->get_item_eid($item);
1395                 $element = $this->gtree->locate_element($eid);
1396                 $itemcell = new html_table_cell();
1397                 $itemcell->attributes['class'] = 'controls icons i'.$itemid;
1398                 $itemcell->text = $this->get_icons($element);
1399                 $iconsrow->cells[] = $itemcell;
1400             }
1401             $rows[] = $iconsrow;
1402         }
1403         return $rows;
1404     }
1406     /**
1407      * Builds and return the row of ranges for the right part of the grader report.
1408      * @param array $rows The Array of rows for the right part of the report
1409      * @return array Array of rows for the right part of the report
1410      */
1411     public function get_right_range_row($rows=array()) {
1412         global $OUTPUT;
1414         if ($this->get_pref('showranges')) {
1415             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1416             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1417             $rangerow = new html_table_row();
1418             $rangerow->attributes['class'] = 'heading range';
1420             foreach ($this->gtree->items as $itemid => $unused) {
1421                 $item =& $this->gtree->items[$itemid];
1422                 $itemcell = new html_table_cell();
1423                 $itemcell->attributes['class'] .= ' range i'. $itemid;
1425                 $hidden = '';
1426                 if ($item->is_hidden()) {
1427                     $hidden = ' dimmed_text ';
1428                 }
1430                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1432                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1433                 $rangerow->cells[] = $itemcell;
1434             }
1435             $rows[] = $rangerow;
1436         }
1437         return $rows;
1438     }
1440     /**
1441      * Builds and return the row of averages for the right part of the grader report.
1442      * @param array $rows Whether to return only group averages or all averages.
1443      * @param bool $grouponly Whether to return only group averages or all averages.
1444      * @return array Array of rows for the right part of the report
1445      */
1446     public function get_right_avg_row($rows=array(), $grouponly=false) {
1447         global $USER, $DB, $OUTPUT, $CFG;
1449         if (!$this->canviewhidden) {
1450             // Totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1451             // better not show them at all if user can not see all hidden grades.
1452             return $rows;
1453         }
1455         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1456         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1457         $meanselection         = $this->get_pref('meanselection');
1458         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1460         if ($grouponly) {
1461             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1462             $groupsql = $this->groupsql;
1463             $groupwheresql = $this->groupwheresql;
1464             $groupwheresqlparams = $this->groupwheresql_params;
1465         } else {
1466             $showaverages = $this->get_pref('showaverages');
1467             $groupsql = "";
1468             $groupwheresql = "";
1469             $groupwheresqlparams = array();
1470         }
1472         if ($showaverages) {
1473             $totalcount = $this->get_numusers($grouponly);
1475             // Limit to users with a gradeable role.
1476             list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1478             // Limit to users with an active enrollment.
1479             $coursecontext = $this->context->get_course_context(true);
1480             $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
1481             $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
1482             $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
1483             list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context, '', 0, $showonlyactiveenrol);
1485             // We want to query both the current context and parent contexts.
1486             list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
1488             $params = array_merge(array('courseid' => $this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams, $relatedctxparams);
1490             // Find sums of all grade items in course.
1491             $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1492                       FROM {grade_items} gi
1493                       JOIN {grade_grades} g ON g.itemid = gi.id
1494                       JOIN {user} u ON u.id = g.userid
1495                       JOIN ($enrolledsql) je ON je.id = u.id
1496                       JOIN (
1497                                SELECT DISTINCT ra.userid
1498                                  FROM {role_assignments} ra
1499                                 WHERE ra.roleid $gradebookrolessql
1500                                   AND ra.contextid $relatedctxsql
1501                            ) rainner ON rainner.userid = u.id
1502                       $groupsql
1503                      WHERE gi.courseid = :courseid
1504                        AND u.deleted = 0
1505                        AND g.finalgrade IS NOT NULL
1506                        $groupwheresql
1507                      GROUP BY g.itemid";
1508             $sumarray = array();
1509             if ($sums = $DB->get_records_sql($sql, $params)) {
1510                 foreach ($sums as $itemid => $csum) {
1511                     $sumarray[$itemid] = $csum->sum;
1512                 }
1513             }
1515             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1516             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1517             $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1518                       FROM {grade_items} gi
1519                       CROSS JOIN {user} u
1520                       JOIN ($enrolledsql) je
1521                            ON je.id = u.id
1522                       JOIN {role_assignments} ra
1523                            ON ra.userid = u.id
1524                       LEFT OUTER JOIN {grade_grades} g
1525                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1526                       $groupsql
1527                      WHERE gi.courseid = :courseid
1528                            AND ra.roleid $gradebookrolessql
1529                            AND ra.contextid $relatedctxsql
1530                            AND u.deleted = 0
1531                            AND g.id IS NULL
1532                            $groupwheresql
1533                   GROUP BY gi.id";
1535             $ungradedcounts = $DB->get_records_sql($sql, $params);
1537             $avgrow = new html_table_row();
1538             $avgrow->attributes['class'] = 'avg';
1540             foreach ($this->gtree->items as $itemid => $unused) {
1541                 $item =& $this->gtree->items[$itemid];
1543                 if ($item->needsupdate) {
1544                     $avgcell = new html_table_cell();
1545                     $avgcell->attributes['class'] = 'i'. $itemid;
1546                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1547                     $avgrow->cells[] = $avgcell;
1548                     continue;
1549                 }
1551                 if (!isset($sumarray[$item->id])) {
1552                     $sumarray[$item->id] = 0;
1553                 }
1555                 if (empty($ungradedcounts[$itemid])) {
1556                     $ungradedcount = 0;
1557                 } else {
1558                     $ungradedcount = $ungradedcounts[$itemid]->count;
1559                 }
1561                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1562                     $meancount = $totalcount - $ungradedcount;
1563                 } else { // Bump up the sum by the number of ungraded items * grademin
1564                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1565                     $meancount = $totalcount;
1566                 }
1568                 // Determine which display type to use for this average
1569                 if ($USER->gradeediting[$this->courseid]) {
1570                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1572                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1573                     $displaytype = $item->get_displaytype();
1575                 } else {
1576                     $displaytype = $averagesdisplaytype;
1577                 }
1579                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1580                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1581                     $decimalpoints = $item->get_decimals();
1583                 } else {
1584                     $decimalpoints = $averagesdecimalpoints;
1585                 }
1587                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1588                     $avgcell = new html_table_cell();
1589                     $avgcell->attributes['class'] = 'i'. $itemid;
1590                     $avgcell->text = '-';
1591                     $avgrow->cells[] = $avgcell;
1593                 } else {
1594                     $sum = $sumarray[$item->id];
1595                     $avgradeval = $sum/$meancount;
1596                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1598                     $numberofgrades = '';
1599                     if ($shownumberofgrades) {
1600                         $numberofgrades = " ($meancount)";
1601                     }
1603                     $avgcell = new html_table_cell();
1604                     $avgcell->attributes['class'] = 'i'. $itemid;
1605                     $avgcell->text = $gradehtml.$numberofgrades;
1606                     $avgrow->cells[] = $avgcell;
1607                 }
1608             }
1609             $rows[] = $avgrow;
1610         }
1611         return $rows;
1612     }
1614     /**
1615      * Given element category, create a collapsible icon and
1616      * course header.
1617      *
1618      * @param array $element
1619      * @return string HTML
1620      */
1621     protected function get_course_header($element) {
1622         global $OUTPUT;
1624         $icon = '';
1625         // If object is a category, display expand/contract icon.
1626         if ($element['type'] == 'category') {
1627             // Load language strings.
1628             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1629             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1630             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1632             $url = new moodle_url($this->gpr->get_return_url(null, array('target' => $element['eid'], 'sesskey' => sesskey())));
1634             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1635                 $url->param('action', 'switch_plus');
1636                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus), null, null);
1637                 $showing = get_string('showingaggregatesonly', 'grades');
1638             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1639                 $url->param('action', 'switch_whole');
1640                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole), null, null);
1641                 $showing = get_string('showinggradesonly', 'grades');
1642             } else {
1643                 $url->param('action', 'switch_minus');
1644                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus), null, null);
1645                 $showing = get_string('showingfullmode', 'grades');
1646             }
1647         }
1649         $name = $element['object']->get_name();
1650         $courseheaderid = 'courseheader_' . clean_param($name, PARAM_ALPHANUMEXT);
1651         $courseheader = html_writer::tag('span', $name, array('id' => $courseheaderid,
1652                 'title' => $name, 'class' => 'gradeitemheader'));
1653         $courseheader .= html_writer::label($showing, $courseheaderid, false, array('class' => 'accesshide'));
1654         $courseheader .= $icon;
1656         return $courseheader;
1657     }
1659     /**
1660      * Given a grade_category, grade_item or grade_grade, this function
1661      * figures out the state of the object and builds then returns a div
1662      * with the icons needed for the grader report.
1663      *
1664      * @param array $element
1665      * @return string HTML
1666      */
1667     protected function get_icons($element) {
1668         global $CFG, $USER, $OUTPUT;
1670         if (!$USER->gradeediting[$this->courseid]) {
1671             return '<div class="grade_icons" />';
1672         }
1674         // Init all icons
1675         $editicon = '';
1677         $editable = true;
1679         if ($element['type'] == 'grade') {
1680             $item = $element['object']->grade_item;
1681             if ($item->is_course_item() or $item->is_category_item()) {
1682                 $editable = $this->overridecat;
1683             }
1684         }
1686         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem' && $editable) {
1687             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1688         }
1690         $editcalculationicon = '';
1691         $showhideicon        = '';
1692         $lockunlockicon      = '';
1694         if (has_capability('moodle/grade:manage', $this->context)) {
1695             if ($this->get_pref('showcalculations')) {
1696                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1697             }
1699             if ($this->get_pref('showeyecons')) {
1700                 $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1701             }
1703             if ($this->get_pref('showlocks')) {
1704                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1705             }
1707         }
1709         $gradeanalysisicon   = '';
1710         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1711             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1712         }
1714         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1715     }
1717     /**
1718      * Given a category element returns collapsing +/- icon if available
1719      *
1720      * @deprecated since Moodle 2.9 MDL-46662 - please do not use this function any more.
1721      */
1722     protected function get_collapsing_icon($element) {
1723         throw new coding_exception('get_collapsing_icon() can not be used any more, please use get_course_header() instead.');
1724     }
1726     /**
1727      * Processes a single action against a category, grade_item or grade.
1728      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1729      * @param string $action Which action to take (edit, delete etc...)
1730      * @return
1731      */
1732     public function process_action($target, $action) {
1733         return self::do_process_action($target, $action, $this->course->id);
1734     }
1736     /**
1737      * From the list of categories that this user prefers to collapse choose ones that belong to the current course.
1738      *
1739      * This function serves two purposes.
1740      * Mainly it helps migrating from user preference style when all courses were stored in one preference.
1741      * Also it helps to remove the settings for categories that were removed if the array for one course grows too big.
1742      *
1743      * @param int $courseid
1744      * @param array $collapsed
1745      * @return array
1746      */
1747     protected static function filter_collapsed_categories($courseid, $collapsed) {
1748         global $DB;
1749         if (empty($collapsed)) {
1750             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1751         }
1752         if (empty($collapsed['aggregatesonly']) && empty($collapsed['gradesonly'])) {
1753             return $collapsed;
1754         }
1755         $cats = $DB->get_fieldset_select('grade_categories', 'id', 'courseid = ?', array($courseid));
1756         $collapsed['aggregatesonly'] = array_values(array_intersect($collapsed['aggregatesonly'], $cats));
1757         $collapsed['gradesonly'] = array_values(array_intersect($collapsed['gradesonly'], $cats));
1758         return $collapsed;
1759     }
1761     /**
1762      * Returns the list of categories that this user wants to collapse or display aggregatesonly
1763      *
1764      * This method also migrates on request from the old format of storing user preferences when they were stored
1765      * in one preference for all courses causing DB error when trying to insert very big value.
1766      *
1767      * @param int $courseid
1768      * @return array
1769      */
1770     protected static function get_collapsed_preferences($courseid) {
1771         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories'.$courseid)) {
1772             return json_decode($collapsed, true);
1773         }
1775         // Try looking for old location of user setting that used to store all courses in one serialized user preference.
1776         if (($oldcollapsedpref = get_user_preferences('grade_report_grader_collapsed_categories')) !== null) {
1777             if ($collapsedall = unserialize_array($oldcollapsedpref)) {
1778                 // We found the old-style preference, filter out only categories that belong to this course and update the prefs.
1779                 $collapsed = static::filter_collapsed_categories($courseid, $collapsedall);
1780                 if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1781                     static::set_collapsed_preferences($courseid, $collapsed);
1782                     $collapsedall['aggregatesonly'] = array_diff($collapsedall['aggregatesonly'], $collapsed['aggregatesonly']);
1783                     $collapsedall['gradesonly'] = array_diff($collapsedall['gradesonly'], $collapsed['gradesonly']);
1784                     if (!empty($collapsedall['aggregatesonly']) || !empty($collapsedall['gradesonly'])) {
1785                         set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsedall));
1786                     } else {
1787                         unset_user_preference('grade_report_grader_collapsed_categories');
1788                     }
1789                 }
1790             } else {
1791                 // We found the old-style preference, but it is unreadable, discard it.
1792                 unset_user_preference('grade_report_grader_collapsed_categories');
1793             }
1794         } else {
1795             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1796         }
1797         return $collapsed;
1798     }
1800     /**
1801      * Sets the list of categories that user wants to see collapsed in user preferences
1802      *
1803      * This method may filter or even trim the list if it does not fit in DB field.
1804      *
1805      * @param int $courseid
1806      * @param array $collapsed
1807      */
1808     protected static function set_collapsed_preferences($courseid, $collapsed) {
1809         global $DB;
1810         // In an unlikely case that the list of collapsed categories for one course is too big for the user preference size,
1811         // try to filter the list of categories since array may contain categories that were deleted.
1812         if (strlen(json_encode($collapsed)) >= 1333) {
1813             $collapsed = static::filter_collapsed_categories($courseid, $collapsed);
1814         }
1816         // If this did not help, "forget" about some of the collapsed categories. Still better than to loose all information.
1817         while (strlen(json_encode($collapsed)) >= 1333) {
1818             if (count($collapsed['aggregatesonly'])) {
1819                 array_pop($collapsed['aggregatesonly']);
1820             }
1821             if (count($collapsed['gradesonly'])) {
1822                 array_pop($collapsed['gradesonly']);
1823             }
1824         }
1826         if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1827             set_user_preference('grade_report_grader_collapsed_categories'.$courseid, json_encode($collapsed));
1828         } else {
1829             unset_user_preference('grade_report_grader_collapsed_categories'.$courseid);
1830         }
1831     }
1833     /**
1834      * Processes a single action against a category, grade_item or grade.
1835      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1836      * @param string $action Which action to take (edit, delete etc...)
1837      * @param int $courseid affected course.
1838      * @return
1839      */
1840     public static function do_process_action($target, $action, $courseid = null) {
1841         global $DB;
1842         // TODO: this code should be in some grade_tree static method
1843         $targettype = substr($target, 0, 2);
1844         $targetid = substr($target, 2);
1845         // TODO: end
1847         if ($targettype !== 'cg') {
1848             // The following code only works with categories.
1849             return true;
1850         }
1852         if (!$courseid) {
1853             debugging('Function grade_report_grader::do_process_action() now requires additional argument courseid',
1854                 DEBUG_DEVELOPER);
1855             if (!$courseid = $DB->get_field('grade_categories', 'courseid', array('id' => $targetid), IGNORE_MISSING)) {
1856                 return true;
1857             }
1858         }
1860         $collapsed = static::get_collapsed_preferences($courseid);
1862         switch ($action) {
1863             case 'switch_minus': // Add category to array of aggregatesonly
1864                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1865                     $collapsed['aggregatesonly'][] = $targetid;
1866                     static::set_collapsed_preferences($courseid, $collapsed);
1867                 }
1868                 break;
1870             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1871                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1872                 if ($key !== false) {
1873                     unset($collapsed['aggregatesonly'][$key]);
1874                 }
1875                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1876                     $collapsed['gradesonly'][] = $targetid;
1877                 }
1878                 static::set_collapsed_preferences($courseid, $collapsed);
1879                 break;
1880             case 'switch_whole': // Remove the category from the array of collapsed cats
1881                 $key = array_search($targetid, $collapsed['gradesonly']);
1882                 if ($key !== false) {
1883                     unset($collapsed['gradesonly'][$key]);
1884                     static::set_collapsed_preferences($courseid, $collapsed);
1885                 }
1887                 break;
1888             default:
1889                 break;
1890         }
1892         return true;
1893     }
1895     /**
1896      * Refactored function for generating HTML of sorting links with matching arrows.
1897      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1898      * to inject into a table header cell.
1899      * @param array $extrafields Array of extra fields being displayed, such as
1900      *   user idnumber
1901      * @return array An associative array of HTML sorting links+arrows
1902      */
1903     public function get_sort_arrows(array $extrafields = array()) {
1904         global $OUTPUT, $CFG;
1905         $arrows = array();
1907         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1908         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1909         $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon'));
1910         $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon'));
1912         // Sourced from tablelib.php
1913         // Check the full name display for sortable fields.
1914         if (has_capability('moodle/site:viewfullnames', $this->context)) {
1915             $nameformat = $CFG->alternativefullnameformat;
1916         } else {
1917             $nameformat = $CFG->fullnamedisplay;
1918         }
1920         if ($nameformat == 'language') {
1921             $nameformat = get_string('fullnamedisplay');
1922         }
1924         $arrows['studentname'] = '';
1925         $requirednames = order_in_string(get_all_user_name_fields(), $nameformat);
1926         if (!empty($requirednames)) {
1927             foreach ($requirednames as $name) {
1928                 $arrows['studentname'] .= html_writer::link(
1929                     new moodle_url($this->baseurl, array('sortitemid' => $name)), $this->get_lang_string($name)
1930                 );
1931                 if ($this->sortitemid == $name) {
1932                     $arrows['studentname'] .= $this->sortorder == 'ASC' ? $iconasc : $icondesc;
1933                 }
1934                 $arrows['studentname'] .= ' / ';
1935             }
1937             $arrows['studentname'] = substr($arrows['studentname'], 0, -3);
1938         }
1940         foreach ($extrafields as $field) {
1941             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1942                     array('sortitemid'=>$field)), get_user_field_name($field));
1943             $arrows[$field] = $fieldlink;
1945             if ($field == $this->sortitemid) {
1946                 if ($this->sortorder == 'ASC') {
1947                     $arrows[$field] .= $iconasc;
1948                 } else {
1949                     $arrows[$field] .= $icondesc;
1950                 }
1951             }
1952         }
1954         return $arrows;
1955     }
1957     /**
1958      * Returns the maximum number of students to be displayed on each page
1959      *
1960      * @return int The maximum number of students to display per page
1961      */
1962     public function get_students_per_page() {
1963         return $this->get_pref('studentsperpage');
1964     }