6aabf4c1a7133142617fdca37f233f903cb54760
[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      * Array of errors for bulk grades updating.
43      * @var array $gradeserror
44      */
45     public $gradeserror = array();
47     // SQL-RELATED
49     /**
50      * The id of the grade_item by which this report will be sorted.
51      * @var int $sortitemid
52      */
53     public $sortitemid;
55     /**
56      * Sortorder used in the SQL selections.
57      * @var int $sortorder
58      */
59     public $sortorder;
61     /**
62      * An SQL fragment affecting the search for users.
63      * @var string $userselect
64      */
65     public $userselect;
67     /**
68      * The bound params for $userselect
69      * @var array $userselectparams
70      */
71     public $userselectparams = array();
73     /**
74      * List of collapsed categories from user preference
75      * @var array $collapsed
76      */
77     public $collapsed;
79     /**
80      * A count of the rows, used for css classes.
81      * @var int $rowcount
82      */
83     public $rowcount = 0;
85     /**
86      * Capability check caching
87      * @var boolean $canviewhidden
88      */
89     public $canviewhidden;
91     /**
92      * Length at which feedback will be truncated (to the nearest word) and an ellipsis be added.
93      * TODO replace this by a report preference
94      * @var int $feedback_trunc_length
95      */
96     protected $feedback_trunc_length = 50;
98     /**
99      * Allow category grade overriding
100      * @var bool $overridecat
101      */
102     protected $overridecat;
104     /**
105      * Constructor. Sets local copies of user preferences and initialises grade_tree.
106      * @param int $courseid
107      * @param object $gpr grade plugin return tracking object
108      * @param string $context
109      * @param int $page The current page being viewed (when report is paged)
110      * @param int $sortitemid The id of the grade_item by which to sort the table
111      */
112     public function __construct($courseid, $gpr, $context, $page=null, $sortitemid=null) {
113         global $CFG;
114         parent::__construct($courseid, $gpr, $context, $page);
116         $this->canviewhidden = has_capability('moodle/grade:viewhidden', context_course::instance($this->course->id));
118         // load collapsed settings for this report
119         $this->collapsed = static::get_collapsed_preferences($this->course->id);
121         if (empty($CFG->enableoutcomes)) {
122             $nooutcomes = false;
123         } else {
124             $nooutcomes = get_user_preferences('grade_report_shownooutcomes');
125         }
127         // if user report preference set or site report setting set use it, otherwise use course or site setting
128         $switch = $this->get_pref('aggregationposition');
129         if ($switch == '') {
130             $switch = grade_get_setting($this->courseid, 'aggregationposition', $CFG->grade_aggregationposition);
131         }
133         // Grab the grade_tree for this course
134         $this->gtree = new grade_tree($this->courseid, true, $switch, $this->collapsed, $nooutcomes);
136         $this->sortitemid = $sortitemid;
138         // base url for sorting by first/last name
140         $this->baseurl = new moodle_url('index.php', array('id' => $this->courseid));
142         $studentsperpage = $this->get_students_per_page();
143         if (!empty($this->page) && !empty($studentsperpage)) {
144             $this->baseurl->params(array('perpage' => $studentsperpage, 'page' => $this->page));
145         }
147         $this->pbarurl = new moodle_url('/grade/report/grader/index.php', array('id' => $this->courseid));
149         $this->setup_groups();
150         $this->setup_users();
151         $this->setup_sortitemid();
153         $this->overridecat = (bool)get_config('moodle', 'grade_overridecat');
154     }
156     /**
157      * Processes the data sent by the form (grades and feedbacks).
158      * Caller is responsible for all access control checks
159      * @param array $data form submission (with magic quotes)
160      * @return array empty array if success, array of warnings if something fails.
161      */
162     public function process_data($data) {
163         global $DB;
164         $warnings = array();
166         $separategroups = false;
167         $mygroups       = array();
168         if ($this->groupmode == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $this->context)) {
169             $separategroups = true;
170             $mygroups = groups_get_user_groups($this->course->id);
171             $mygroups = $mygroups[0]; // ignore groupings
172             // reorder the groups fro better perf below
173             $current = array_search($this->currentgroup, $mygroups);
174             if ($current !== false) {
175                 unset($mygroups[$current]);
176                 array_unshift($mygroups, $this->currentgroup);
177             }
178         }
180         // always initialize all arrays
181         $queue = array();
183         $this->load_users();
184         $this->load_final_grades();
186         // Were any changes made?
187         $changedgrades = false;
189         foreach ($data as $varname => $students) {
191             $needsupdate = false;
193             // skip, not a grade nor feedback
194             if (strpos($varname, 'grade') === 0) {
195                 $datatype = 'grade';
196             } else if (strpos($varname, 'feedback') === 0) {
197                 $datatype = 'feedback';
198             } else {
199                 continue;
200             }
202             foreach ($students as $userid => $items) {
203                 $userid = clean_param($userid, PARAM_INT);
204                 foreach ($items as $itemid => $postedvalue) {
205                     $itemid = clean_param($itemid, PARAM_INT);
207                     // Was change requested?
208                     $oldvalue = $this->grades[$userid][$itemid];
209                     if ($datatype === 'grade') {
210                         // If there was no grade and there still isn't
211                         if (is_null($oldvalue->finalgrade) && $postedvalue == -1) {
212                             // -1 means no grade
213                             continue;
214                         }
216                         // If the grade item uses a custom scale
217                         if (!empty($oldvalue->grade_item->scaleid)) {
219                             if ((int)$oldvalue->finalgrade === (int)$postedvalue) {
220                                 continue;
221                             }
222                         } else {
223                             // The grade item uses a numeric scale
225                             // Format the finalgrade from the DB so that it matches the grade from the client
226                             if ($postedvalue === format_float($oldvalue->finalgrade, $oldvalue->grade_item->get_decimals())) {
227                                 continue;
228                             }
229                         }
231                         $changedgrades = true;
233                     } else if ($datatype === 'feedback') {
234                         // If quick grading is on, feedback needs to be compared without line breaks.
235                         if ($this->get_pref('quickgrading')) {
236                             $oldvalue->feedback = preg_replace("/\r\n|\r|\n/", "", $oldvalue->feedback);
237                         }
238                         if (($oldvalue->feedback === $postedvalue) or ($oldvalue->feedback === null and empty($postedvalue))) {
239                             continue;
240                         }
241                     }
243                     if (!$gradeitem = grade_item::fetch(array('id'=>$itemid, 'courseid'=>$this->courseid))) {
244                         print_error('invalidgradeitemid');
245                     }
247                     // Pre-process grade
248                     if ($datatype == 'grade') {
249                         $feedback = false;
250                         $feedbackformat = false;
251                         if ($gradeitem->gradetype == GRADE_TYPE_SCALE) {
252                             if ($postedvalue == -1) { // -1 means no grade
253                                 $finalgrade = null;
254                             } else {
255                                 $finalgrade = $postedvalue;
256                             }
257                         } else {
258                             $finalgrade = unformat_float($postedvalue);
259                         }
261                         $errorstr = '';
262                         // Warn if the grade is out of bounds.
263                         if (!is_null($finalgrade)) {
264                             $bounded = $gradeitem->bounded_grade($finalgrade);
265                             if ($bounded > $finalgrade) {
266                                 $errorstr = 'lessthanmin';
267                             } else if ($bounded < $finalgrade) {
268                                 $errorstr = 'morethanmax';
269                             }
270                         }
271                         if ($errorstr) {
272                             $userfields = 'id, ' . get_all_user_name_fields(true);
273                             $user = $DB->get_record('user', array('id' => $userid), $userfields);
274                             $gradestr = new stdClass();
275                             $gradestr->username = fullname($user);
276                             $gradestr->itemname = $gradeitem->get_name();
277                             $warnings[] = get_string($errorstr, 'grades', $gradestr);
278                         }
280                     } else if ($datatype == 'feedback') {
281                         $finalgrade = false;
282                         $trimmed = trim($postedvalue);
283                         if (empty($trimmed)) {
284                              $feedback = null;
285                         } else {
286                              $feedback = $postedvalue;
287                         }
288                     }
290                     // group access control
291                     if ($separategroups) {
292                         // note: we can not use $this->currentgroup because it would fail badly
293                         //       when having two browser windows each with different group
294                         $sharinggroup = false;
295                         foreach ($mygroups as $groupid) {
296                             if (groups_is_member($groupid, $userid)) {
297                                 $sharinggroup = true;
298                                 break;
299                             }
300                         }
301                         if (!$sharinggroup) {
302                             // either group membership changed or somebody is hacking grades of other group
303                             $warnings[] = get_string('errorsavegrade', 'grades');
304                             continue;
305                         }
306                     }
308                     $oldgradegrade = new grade_grade(array('userid' => $userid, 'itemid' => $gradeitem->id), true);
310                     $gradeitem->update_final_grade($userid, $finalgrade, 'gradebook', $feedback, FORMAT_MOODLE);
312                     $gradegrade = new grade_grade(array('userid' => $userid, 'itemid' => $gradeitem->id), true);
314                     if ($oldgradegrade->finalgrade != $gradegrade->finalgrade
315                         or empty($oldgradegrade->overridden) != empty($gradegrade->overridden)
316                     ) {
317                         $gradegrade->grade_item = $gradeitem;
318                         \core\event\user_graded::create_from_grade($gradegrade)->trigger();
319                     }
321                     // We can update feedback without reloading the grade item as it doesn't affect grade calculations
322                     if ($datatype === 'feedback') {
323                         $this->grades[$userid][$itemid]->feedback = $feedback;
324                     }
325                 }
326             }
327         }
329         if ($changedgrades) {
330             // If a final grade was overriden reload grades so dependent grades like course total will be correct
331             $this->grades = null;
332         }
334         return $warnings;
335     }
338     /**
339      * Setting the sort order, this depends on last state
340      * all this should be in the new table class that we might need to use
341      * for displaying grades.
342      */
343     private function setup_sortitemid() {
345         global $SESSION;
347         if (!isset($SESSION->gradeuserreport)) {
348             $SESSION->gradeuserreport = new stdClass();
349         }
351         if ($this->sortitemid) {
352             if (!isset($SESSION->gradeuserreport->sort)) {
353                 if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
354                     $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
355                 } else {
356                     $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
357                 }
358             } else {
359                 // this is the first sort, i.e. by last name
360                 if (!isset($SESSION->gradeuserreport->sortitemid)) {
361                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
362                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
363                     } else {
364                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
365                     }
366                 } else if ($SESSION->gradeuserreport->sortitemid == $this->sortitemid) {
367                     // same as last sort
368                     if ($SESSION->gradeuserreport->sort == 'ASC') {
369                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
370                     } else {
371                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
372                     }
373                 } else {
374                     if ($this->sortitemid == 'firstname' || $this->sortitemid == 'lastname') {
375                         $this->sortorder = $SESSION->gradeuserreport->sort = 'ASC';
376                     } else {
377                         $this->sortorder = $SESSION->gradeuserreport->sort = 'DESC';
378                     }
379                 }
380             }
381             $SESSION->gradeuserreport->sortitemid = $this->sortitemid;
382         } else {
383             // not requesting sort, use last setting (for paging)
385             if (isset($SESSION->gradeuserreport->sortitemid)) {
386                 $this->sortitemid = $SESSION->gradeuserreport->sortitemid;
387             } else {
388                 $this->sortitemid = 'lastname';
389             }
391             if (isset($SESSION->gradeuserreport->sort)) {
392                 $this->sortorder = $SESSION->gradeuserreport->sort;
393             } else {
394                 $this->sortorder = 'ASC';
395             }
396         }
397     }
399     /**
400      * pulls out the userids of the users to be display, and sorts them
401      */
402     public function load_users() {
403         global $CFG, $DB;
405         if (!empty($this->users)) {
406             return;
407         }
408         $this->setup_users();
410         // Limit to users with a gradeable role.
411         list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
413         // Limit to users with an active enrollment.
414         list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
416         // Fields we need from the user table.
417         $userfields = user_picture::fields('u', get_extra_user_fields($this->context));
419         // We want to query both the current context and parent contexts.
420         list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
422         // If the user has clicked one of the sort asc/desc arrows.
423         if (is_numeric($this->sortitemid)) {
424             $params = array_merge(array('gitemid' => $this->sortitemid), $gradebookrolesparams, $this->userwheresql_params,
425                     $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
427             $sortjoin = "LEFT JOIN {grade_grades} g ON g.userid = u.id AND g.itemid = $this->sortitemid";
428             $sort = "g.finalgrade $this->sortorder";
429         } else {
430             $sortjoin = '';
431             switch($this->sortitemid) {
432                 case 'lastname':
433                     $sort = "u.lastname $this->sortorder, u.firstname $this->sortorder";
434                     break;
435                 case 'firstname':
436                     $sort = "u.firstname $this->sortorder, u.lastname $this->sortorder";
437                     break;
438                 case 'email':
439                     $sort = "u.email $this->sortorder";
440                     break;
441                 case 'idnumber':
442                 default:
443                     $sort = "u.idnumber $this->sortorder";
444                     break;
445             }
447             $params = array_merge($gradebookrolesparams, $this->userwheresql_params, $this->groupwheresql_params, $enrolledparams, $relatedctxparams);
448         }
450         $sql = "SELECT $userfields
451                   FROM {user} u
452                   JOIN ($enrolledsql) je ON je.id = u.id
453                        $this->groupsql
454                        $sortjoin
455                   JOIN (
456                            SELECT DISTINCT ra.userid
457                              FROM {role_assignments} ra
458                             WHERE ra.roleid IN ($this->gradebookroles)
459                               AND ra.contextid $relatedctxsql
460                        ) rainner ON rainner.userid = u.id
461                    AND u.deleted = 0
462                    $this->userwheresql
463                    $this->groupwheresql
464               ORDER BY $sort";
465         $studentsperpage = $this->get_students_per_page();
466         $this->users = $DB->get_records_sql($sql, $params, $studentsperpage * $this->page, $studentsperpage);
468         if (empty($this->users)) {
469             $this->userselect = '';
470             $this->users = array();
471             $this->userselect_params = array();
472         } else {
473             list($usql, $uparams) = $DB->get_in_or_equal(array_keys($this->users), SQL_PARAMS_NAMED, 'usid0');
474             $this->userselect = "AND g.userid $usql";
475             $this->userselect_params = $uparams;
477             // Add a flag to each user indicating whether their enrolment is active.
478             $sql = "SELECT ue.userid
479                       FROM {user_enrolments} ue
480                       JOIN {enrol} e ON e.id = ue.enrolid
481                      WHERE ue.userid $usql
482                            AND ue.status = :uestatus
483                            AND e.status = :estatus
484                            AND e.courseid = :courseid
485                            AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)
486                   GROUP BY ue.userid";
487             $coursecontext = $this->context->get_course_context(true);
488             $time = time();
489             $params = array_merge($uparams, array('estatus' => ENROL_INSTANCE_ENABLED, 'uestatus' => ENROL_USER_ACTIVE,
490                     'courseid' => $coursecontext->instanceid, 'now1' => $time, 'now2' => $time));
491             $useractiveenrolments = $DB->get_records_sql($sql, $params);
493             $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
494             $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
495             $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
496             foreach ($this->users as $user) {
497                 // If we are showing only active enrolments, then remove suspended users from list.
498                 if ($showonlyactiveenrol && !array_key_exists($user->id, $useractiveenrolments)) {
499                     unset($this->users[$user->id]);
500                 } else {
501                     $this->users[$user->id]->suspendedenrolment = !array_key_exists($user->id, $useractiveenrolments);
502                 }
503             }
504         }
505         return $this->users;
506     }
508     /**
509      * we supply the userids in this query, and get all the grades
510      * pulls out all the grades, this does not need to worry about paging
511      */
512     public function load_final_grades() {
513         global $CFG, $DB;
515         if (!empty($this->grades)) {
516             return;
517         }
519         if (empty($this->users)) {
520             return;
521         }
523         // please note that we must fetch all grade_grades fields if we want to construct grade_grade object from it!
524         $params = array_merge(array('courseid'=>$this->courseid), $this->userselect_params);
525         $sql = "SELECT g.*
526                   FROM {grade_items} gi,
527                        {grade_grades} g
528                  WHERE g.itemid = gi.id AND gi.courseid = :courseid {$this->userselect}";
530         $userids = array_keys($this->users);
532         if ($grades = $DB->get_records_sql($sql, $params)) {
533             foreach ($grades as $graderec) {
534                 if (in_array($graderec->userid, $userids) and array_key_exists($graderec->itemid, $this->gtree->get_items())) { // some items may not be present!!
535                     $this->grades[$graderec->userid][$graderec->itemid] = new grade_grade($graderec, false);
536                     $this->grades[$graderec->userid][$graderec->itemid]->grade_item = $this->gtree->get_item($graderec->itemid); // db caching
537                 }
538             }
539         }
541         // prefil grades that do not exist yet
542         foreach ($userids as $userid) {
543             foreach ($this->gtree->get_items() as $itemid => $unused) {
544                 if (!isset($this->grades[$userid][$itemid])) {
545                     $this->grades[$userid][$itemid] = new grade_grade();
546                     $this->grades[$userid][$itemid]->itemid = $itemid;
547                     $this->grades[$userid][$itemid]->userid = $userid;
548                     $this->grades[$userid][$itemid]->grade_item = $this->gtree->get_item($itemid); // db caching
549                 }
550             }
551         }
552     }
554     /**
555      * Gets html toggle
556      * @deprecated since Moodle 2.4 as it appears not to be used any more.
557      */
558     public function get_toggles_html() {
559         throw new coding_exception('get_toggles_html() can not be used any more');
560     }
562     /**
563      * Prints html toggle
564      * @deprecated since 2.4 as it appears not to be used any more.
565      * @param unknown $type
566      */
567     public function print_toggle($type) {
568         throw new coding_exception('print_toggle() can not be used any more');
569     }
571     /**
572      * Builds and returns the rows that will make up the left part of the grader report
573      * This consists of student names and icons, links to user reports and id numbers, as well
574      * as header cells for these columns. It also includes the fillers required for the
575      * categories displayed on the right side of the report.
576      * @param boolean $displayaverages whether to display average rows in the table
577      * @return array Array of html_table_row objects
578      */
579     public function get_left_rows($displayaverages) {
580         global $CFG, $USER, $OUTPUT;
582         $rows = array();
584         $showuserimage = $this->get_pref('showuserimage');
586         $strfeedback  = $this->get_lang_string("feedback");
587         $strgrade     = $this->get_lang_string('grade');
589         $extrafields = get_extra_user_fields($this->context);
591         $arrows = $this->get_sort_arrows($extrafields);
593         $colspan = 1;
594         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
595             $colspan++;
596         }
597         $colspan += count($extrafields);
599         $levels = count($this->gtree->levels) - 1;
601         for ($i = 0; $i < $levels; $i++) {
602             $fillercell = new html_table_cell();
603             $fillercell->attributes['class'] = 'fixedcolumn cell topleft';
604             $fillercell->text = ' ';
605             $fillercell->colspan = $colspan;
606             $row = new html_table_row(array($fillercell));
607             $rows[] = $row;
608         }
610         $headerrow = new html_table_row();
611         $headerrow->attributes['class'] = 'heading';
613         $studentheader = new html_table_cell();
614         $studentheader->attributes['class'] = 'header';
615         $studentheader->scope = 'col';
616         $studentheader->header = true;
617         $studentheader->id = 'studentheader';
618         if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
619             $studentheader->colspan = 2;
620         }
621         $studentheader->text = $arrows['studentname'];
623         $headerrow->cells[] = $studentheader;
625         foreach ($extrafields as $field) {
626             $fieldheader = new html_table_cell();
627             $fieldheader->attributes['class'] = 'header userfield user' . $field;
628             $fieldheader->scope = 'col';
629             $fieldheader->header = true;
630             $fieldheader->text = $arrows[$field];
632             $headerrow->cells[] = $fieldheader;
633         }
635         $rows[] = $headerrow;
637         $rows = $this->get_left_icons_row($rows, $colspan);
639         $rowclasses = array('even', 'odd');
641         $suspendedstring = null;
642         foreach ($this->users as $userid => $user) {
643             $userrow = new html_table_row();
644             $userrow->id = 'fixed_user_'.$userid;
645             $userrow->attributes['class'] = 'r'.$this->rowcount++.' '.$rowclasses[$this->rowcount % 2];
647             $usercell = new html_table_cell();
648             $usercell->attributes['class'] = 'user';
650             $usercell->header = true;
651             $usercell->scope = 'row';
653             if ($showuserimage) {
654                 $usercell->text = $OUTPUT->user_picture($user);
655             }
657             $fullname = fullname($user);
658             $usercell->text .= html_writer::link(new moodle_url('/user/view.php', array('id' => $user->id, 'course' => $this->course->id)), $fullname);
660             if (!empty($user->suspendedenrolment)) {
661                 $usercell->attributes['class'] .= ' usersuspended';
663                 //may be lots of suspended users so only get the string once
664                 if (empty($suspendedstring)) {
665                     $suspendedstring = get_string('userenrolmentsuspended', 'grades');
666                 }
667                 $usercell->text .= html_writer::empty_tag('img', array('src'=>$OUTPUT->pix_url('i/enrolmentsuspended'), 'title'=>$suspendedstring,
668                         'alt'=>$suspendedstring, 'class'=>'usersuspendedicon'));
669             }
671             $userrow->cells[] = $usercell;
673             if (has_capability('gradereport/'.$CFG->grade_profilereport.':view', $this->context)) {
674                 $userreportcell = new html_table_cell();
675                 $userreportcell->attributes['class'] = 'userreport';
676                 $userreportcell->header = true;
677                 $a = new stdClass();
678                 $a->user = $fullname;
679                 $strgradesforuser = get_string('gradesforuser', 'grades', $a);
680                 $url = new moodle_url('/grade/report/'.$CFG->grade_profilereport.'/index.php', array('userid' => $user->id, 'id' => $this->course->id));
681                 $userreportcell->text = $OUTPUT->action_icon($url, new pix_icon('t/grades', $strgradesforuser));
682                 $userrow->cells[] = $userreportcell;
683             }
685             foreach ($extrafields as $field) {
686                 $fieldcell = new html_table_cell();
687                 $fieldcell->attributes['class'] = 'header userfield user' . $field;
688                 $fieldcell->header = true;
689                 $fieldcell->scope = 'row';
690                 $fieldcell->text = $user->{$field};
691                 $userrow->cells[] = $fieldcell;
692             }
694             $rows[] = $userrow;
695         }
697         $rows = $this->get_left_range_row($rows, $colspan);
698         if ($displayaverages) {
699             $rows = $this->get_left_avg_row($rows, $colspan, true);
700             $rows = $this->get_left_avg_row($rows, $colspan);
701         }
703         return $rows;
704     }
706     /**
707      * Builds and returns the rows that will make up the right part of the grader report
708      * @param boolean $displayaverages whether to display average rows in the table
709      * @return array Array of html_table_row objects
710      */
711     public function get_right_rows($displayaverages) {
712         global $CFG, $USER, $OUTPUT, $DB, $PAGE;
714         $rows = array();
715         $this->rowcount = 0;
716         $numrows = count($this->gtree->get_levels());
717         $numusers = count($this->users);
718         $gradetabindex = 1;
719         $columnstounset = array();
720         $strgrade = $this->get_lang_string('grade');
721         $strfeedback  = $this->get_lang_string("feedback");
722         $arrows = $this->get_sort_arrows();
724         $jsarguments = array(
725             'id'        => '#fixed_column',
726             'cfg'       => array('ajaxenabled'=>false),
727             'items'     => array(),
728             'users'     => array(),
729             'feedback'  => array()
730         );
731         $jsscales = array();
733         // Get preferences once.
734         $showactivityicons = $this->get_pref('showactivityicons');
735         $quickgrading = $this->get_pref('quickgrading');
736         $showquickfeedback = $this->get_pref('showquickfeedback');
737         $enableajax = $this->get_pref('enableajax');
738         $showanalysisicon = $this->get_pref('showanalysisicon');
740         // Get strings which are re-used inside the loop.
741         $strftimedatetimeshort = get_string('strftimedatetimeshort');
742         $strexcludedgrades = get_string('excluded', 'grades');
743         $strerror = get_string('error');
744         $strtypescale = get_string('typescale', 'grades');
746         foreach ($this->gtree->get_levels() as $key => $row) {
747             $headingrow = new html_table_row();
748             $headingrow->attributes['class'] = 'heading_name_row';
750             foreach ($row as $columnkey => $element) {
751                 $sortlink = clone($this->baseurl);
752                 if (isset($element['object']->id)) {
753                     $sortlink->param('sortitemid', $element['object']->id);
754                 }
756                 $eid    = $element['eid'];
757                 $object = $element['object'];
758                 $type   = $element['type'];
759                 $categorystate = @$element['categorystate'];
761                 if (!empty($element['colspan'])) {
762                     $colspan = $element['colspan'];
763                 } else {
764                     $colspan = 1;
765                 }
767                 if (!empty($element['depth'])) {
768                     $catlevel = 'catlevel'.$element['depth'];
769                 } else {
770                     $catlevel = '';
771                 }
773                 // Element is a filler
774                 if ($type == 'filler' or $type == 'fillerfirst' or $type == 'fillerlast') {
775                     $fillercell = new html_table_cell();
776                     $fillercell->attributes['class'] = $type . ' ' . $catlevel;
777                     $fillercell->colspan = $colspan;
778                     $fillercell->text = '&nbsp;';
779                     $fillercell->header = true;
780                     $fillercell->scope = 'col';
781                     $headingrow->cells[] = $fillercell;
782                 } else if ($type == 'category') {
783                     // Element is a category
784                     $categorycell = new html_table_cell();
785                     $categorycell->attributes['class'] = 'category ' . $catlevel;
786                     $categorycell->colspan = $colspan;
787                     $categorycell->text = shorten_text($element['object']->get_name());
788                     $categorycell->text .= $this->get_collapsing_icon($element);
789                     $categorycell->header = true;
790                     $categorycell->scope = 'col';
792                     // Print icons
793                     if ($USER->gradeediting[$this->courseid]) {
794                         $categorycell->text .= $this->get_icons($element);
795                     }
797                     $headingrow->cells[] = $categorycell;
798                 } else {
799                     // Element is a grade_item
800                     if ($element['object']->id == $this->sortitemid) {
801                         if ($this->sortorder == 'ASC') {
802                             $arrow = $this->get_sort_arrow('up', $sortlink);
803                         } else {
804                             $arrow = $this->get_sort_arrow('down', $sortlink);
805                         }
806                     } else {
807                         $arrow = $this->get_sort_arrow('move', $sortlink);
808                     }
810                     $headerlink = $this->gtree->get_element_header($element, true, $showactivityicons, false);
812                     $itemcell = new html_table_cell();
813                     $itemcell->attributes['class'] = $type . ' ' . $catlevel . ' highlightable'. ' i'. $element['object']->id;
815                     if ($element['object']->is_hidden()) {
816                         $itemcell->attributes['class'] .= ' dimmed_text';
817                     }
819                     $itemcell->colspan = $colspan;
820                     $itemcell->text = shorten_text($headerlink) . $arrow;
821                     $itemcell->header = true;
822                     $itemcell->scope = 'col';
824                     $headingrow->cells[] = $itemcell;
825                 }
826             }
827             $rows[] = $headingrow;
828         }
830         $rows = $this->get_right_icons_row($rows);
832         // Preload scale objects for items with a scaleid and initialize tab indices
833         $scaleslist = array();
834         $tabindices = array();
836         foreach ($this->gtree->get_items() as $itemid => $item) {
837             $scale = null;
838             if (!empty($item->scaleid)) {
839                 $scaleslist[] = $item->scaleid;
840                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'scale', 'scale'=>$item->scaleid, 'decimals'=>$item->get_decimals());
841             } else {
842                 $jsarguments['items'][$itemid] = array('id'=>$itemid, 'name'=>$item->get_name(true), 'type'=>'value', 'scale'=>false, 'decimals'=>$item->get_decimals());
843             }
844             $tabindices[$item->id]['grade'] = $gradetabindex;
845             $tabindices[$item->id]['feedback'] = $gradetabindex + $numusers;
846             $gradetabindex += $numusers * 2;
847         }
848         $scalesarray = array();
850         if (!empty($scaleslist)) {
851             $scalesarray = $DB->get_records_list('scale', 'id', $scaleslist);
852         }
853         $jsscales = $scalesarray;
855         $rowclasses = array('even', 'odd');
857         foreach ($this->users as $userid => $user) {
859             if ($this->canviewhidden) {
860                 $altered = array();
861                 $unknown = array();
862             } else {
863                 $hidingaffected = grade_grade::get_hiding_affected($this->grades[$userid], $this->gtree->get_items());
864                 $altered = $hidingaffected['altered'];
865                 $unknown = $hidingaffected['unknown'];
866                 unset($hidingaffected);
867             }
869             $itemrow = new html_table_row();
870             $itemrow->id = 'user_'.$userid;
871             $itemrow->attributes['class'] = $rowclasses[$this->rowcount % 2];
873             $fullname = fullname($user);
874             $jsarguments['users'][$userid] = $fullname;
876             foreach ($this->gtree->items as $itemid => $unused) {
877                 $item =& $this->gtree->items[$itemid];
878                 $grade = $this->grades[$userid][$item->id];
880                 $itemcell = new html_table_cell();
882                 $itemcell->id = 'u'.$userid.'i'.$itemid;
884                 // Get the decimal points preference for this item
885                 $decimalpoints = $item->get_decimals();
887                 if (in_array($itemid, $unknown)) {
888                     $gradeval = null;
889                 } else if (array_key_exists($itemid, $altered)) {
890                     $gradeval = $altered[$itemid];
891                 } else {
892                     $gradeval = $grade->finalgrade;
893                 }
894                 if (!empty($grade->finalgrade)) {
895                     $gradevalforjs = null;
896                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
897                         $gradevalforjs = (int)$gradeval;
898                     } else {
899                         $gradevalforjs = format_float($gradeval, $decimalpoints);
900                     }
901                     $jsarguments['grades'][] = array('user'=>$userid, 'item'=>$itemid, 'grade'=>$gradevalforjs);
902                 }
904                 // MDL-11274
905                 // Hide grades in the grader report if the current grader doesn't have 'moodle/grade:viewhidden'
906                 if (!$this->canviewhidden and $grade->is_hidden()) {
907                     if (!empty($CFG->grade_hiddenasdate) and $grade->get_datesubmitted() and !$item->is_category_item() and !$item->is_course_item()) {
908                         // 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
909                         $itemcell->text = "<span class='datesubmitted'>" .
910                                 userdate($grade->get_datesubmitted(), $strftimedatetimeshort) . "</span>";
911                     } else {
912                         $itemcell->text = '-';
913                     }
914                     $itemrow->cells[] = $itemcell;
915                     continue;
916                 }
918                 // emulate grade element
919                 $eid = $this->gtree->get_grade_eid($grade);
920                 $element = array('eid'=>$eid, 'object'=>$grade, 'type'=>'grade');
922                 $itemcell->attributes['class'] .= ' grade i'.$itemid;
923                 if ($item->is_category_item()) {
924                     $itemcell->attributes['class'] .= ' cat';
925                 }
926                 if ($item->is_course_item()) {
927                     $itemcell->attributes['class'] .= ' course';
928                 }
929                 if ($grade->is_overridden()) {
930                     $itemcell->attributes['class'] .= ' overridden';
931                 }
933                 if (!empty($grade->feedback)) {
934                     //should we be truncating feedback? ie $short_feedback = shorten_text($feedback, $this->feedback_trunc_length);
935                     $jsarguments['feedback'][] = array('user'=>$userid, 'item'=>$itemid, 'content'=>wordwrap(trim(format_string($grade->feedback, $grade->feedbackformat)),
936                             34, '<br/ >'));
937                 }
939                 if ($grade->is_excluded()) {
940                     $itemcell->text .= "<span class='excludedfloater'>" . $strexcludedgrades . "</span>";
941                 }
943                 // Do not show any icons if no grade (no record in DB to match)
944                 if (!$item->needsupdate and $USER->gradeediting[$this->courseid]) {
945                     $itemcell->text .= $this->get_icons($element);
946                 }
948                 $hidden = '';
949                 if ($grade->is_hidden()) {
950                     $hidden = ' dimmed_text ';
951                 }
953                 $gradepass = ' gradefail ';
954                 if ($grade->is_passed($item)) {
955                     $gradepass = ' gradepass ';
956                 } else if (is_null($grade->is_passed($item))) {
957                     $gradepass = '';
958                 }
960                 // if in editing mode, we need to print either a text box
961                 // or a drop down (for scales)
962                 // grades in item of type grade category or course are not directly editable
963                 if ($item->needsupdate) {
964                     $itemcell->text .= "<span class='gradingerror{$hidden}'>" . $strerror . "</span>";
966                 } else if ($USER->gradeediting[$this->courseid]) {
968                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
969                         $scale = $scalesarray[$item->scaleid];
970                         $gradeval = (int)$gradeval; // scales use only integers
971                         $scales = explode(",", $scale->scale);
972                         // reindex because scale is off 1
974                         // MDL-12104 some previous scales might have taken up part of the array
975                         // so this needs to be reset
976                         $scaleopt = array();
977                         $i = 0;
978                         foreach ($scales as $scaleoption) {
979                             $i++;
980                             $scaleopt[$i] = $scaleoption;
981                         }
983                         if ($quickgrading and $grade->is_editable()) {
984                             $oldval = empty($gradeval) ? -1 : $gradeval;
985                             if (empty($item->outcomeid)) {
986                                 $nogradestr = $this->get_lang_string('nograde');
987                             } else {
988                                 $nogradestr = $this->get_lang_string('nooutcome', 'grades');
989                             }
990                             $attributes = array('tabindex' => $tabindices[$item->id]['grade'], 'id'=>'grade_'.$userid.'_'.$item->id);
991                             $itemcell->text .= html_writer::label($strtypescale, $attributes['id'], false,
992                                     array('class' => 'accesshide'));
993                             $itemcell->text .= html_writer::select($scaleopt, 'grade['.$userid.']['.$item->id.']', $gradeval, array(-1=>$nogradestr), $attributes);
994                         } else if (!empty($scale)) {
995                             $scales = explode(",", $scale->scale);
997                             // invalid grade if gradeval < 1
998                             if ($gradeval < 1) {
999                                 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>-</span>";
1000                             } else {
1001                                 $gradeval = $grade->grade_item->bounded_grade($gradeval); //just in case somebody changes scale
1002                                 $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>{$scales[$gradeval - 1]}</span>";
1003                             }
1004                         }
1006                     } else if ($item->gradetype != GRADE_TYPE_TEXT) { // Value type
1007                         if ($quickgrading and $grade->is_editable()) {
1008                             $value = format_float($gradeval, $decimalpoints);
1009                             $gradelabel = $fullname . ' ' . $item->itemname;
1010                             $itemcell->text .= '<label class="accesshide" for="grade_'.$userid.'_'.$item->id.'">'
1011                                           .get_string('useractivitygrade', 'gradereport_grader', $gradelabel).'</label>';
1012                             $itemcell->text .= '<input size="6" tabindex="' . $tabindices[$item->id]['grade']
1013                                           . '" type="text" class="text" title="'. $strgrade .'" name="grade['
1014                                           .$userid.'][' .$item->id.']" id="grade_'.$userid.'_'.$item->id.'" value="'.$value.'" />';
1015                         } else {
1016                             $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1017                                     format_float($gradeval, $decimalpoints) . "</span>";
1018                         }
1019                     }
1021                     // If quickfeedback is on, print an input element
1022                     if ($showquickfeedback and $grade->is_editable()) {
1023                         $feedbacklabel = $fullname . ' ' . $item->itemname;
1024                         $itemcell->text .= '<label class="accesshide" for="feedback_'.$userid.'_'.$item->id.'">'
1025                                       .get_string('useractivityfeedback', 'gradereport_grader', $feedbacklabel).'</label>';
1026                         $itemcell->text .= '<input class="quickfeedback" tabindex="' . $tabindices[$item->id]['feedback'].'" id="feedback_'.$userid.'_'.$item->id
1027                                       . '" size="6" title="' . $strfeedback . '" type="text" name="feedback['.$userid.']['.$item->id.']" value="' . s($grade->feedback) . '" />';
1028                     }
1030                 } else { // Not editing
1031                     $gradedisplaytype = $item->get_displaytype();
1033                     if ($item->scaleid && !empty($scalesarray[$item->scaleid])) {
1034                         $itemcell->attributes['class'] .= ' grade_type_scale';
1035                     } else if ($item->gradetype != GRADE_TYPE_TEXT) {
1036                         $itemcell->attributes['class'] .= ' grade_type_text';
1037                     }
1039                     if ($enableajax) {
1040                         $canoverride = true;
1041                         if ($item->is_category_item() || $item->is_course_item()) {
1042                             $canoverride = (bool) get_config('moodle', 'grade_overridecat');
1043                         }
1044                         if ($canoverride) {
1045                             $itemcell->attributes['class'] .= ' clickable';
1046                         }
1047                     }
1049                     if ($item->needsupdate) {
1050                         $itemcell->text .= "<span class='gradingerror{$hidden}{$gradepass}'>" . $error . "</span>";
1051                     } else {
1052                         // The max and min for an aggregation may be different to the grade_item.
1053                         if (!is_null($gradeval)) {
1054                             $item->grademax = $grade->rawgrademax;
1055                             $item->grademin = $grade->rawgrademin;
1056                         }
1058                         $itemcell->text .= "<span class='gradevalue{$hidden}{$gradepass}'>" .
1059                                 grade_format_gradevalue($gradeval, $item, true, $gradedisplaytype, null) . "</span>";
1060                         if ($showanalysisicon) {
1061                             $itemcell->text .= $this->gtree->get_grade_analysis_icon($grade);
1062                         }
1063                     }
1064                 }
1066                 if (!empty($this->gradeserror[$item->id][$userid])) {
1067                     $itemcell->text .= $this->gradeserror[$item->id][$userid];
1068                 }
1070                 $itemrow->cells[] = $itemcell;
1071             }
1072             $rows[] = $itemrow;
1073         }
1075         if ($enableajax) {
1076             $jsarguments['cfg']['ajaxenabled'] = true;
1077             $jsarguments['cfg']['scales'] = array();
1078             foreach ($jsscales as $scale) {
1079                 $jsarguments['cfg']['scales'][$scale->id] = explode(',', $scale->scale);
1080             }
1081             $jsarguments['cfg']['feedbacktrunclength'] =  $this->feedback_trunc_length;
1083             // Student grades and feedback are already at $jsarguments['feedback'] and $jsarguments['grades']
1084         }
1085         $jsarguments['cfg']['isediting'] = (bool)$USER->gradeediting[$this->courseid];
1086         $jsarguments['cfg']['courseid'] = $this->courseid;
1087         $jsarguments['cfg']['studentsperpage'] = $this->get_students_per_page();
1088         $jsarguments['cfg']['showquickfeedback'] = (bool) $showquickfeedback;
1090         $module = array(
1091             'name'      => 'gradereport_grader',
1092             'fullpath'  => '/grade/report/grader/module.js',
1093             'requires'  => array('base', 'dom', 'event', 'event-mouseenter', 'event-key', 'io-queue', 'json-parse', 'overlay')
1094         );
1095         $PAGE->requires->js_init_call('M.gradereport_grader.init_report', $jsarguments, false, $module);
1096         $PAGE->requires->strings_for_js(array('addfeedback', 'feedback', 'grade'), 'grades');
1097         $PAGE->requires->strings_for_js(array('ajaxchoosescale', 'ajaxclicktoclose', 'ajaxerror', 'ajaxfailedupdate', 'ajaxfieldchanged'), 'gradereport_grader');
1098         if (!$enableajax && $USER->gradeediting[$this->courseid]) {
1099             $PAGE->requires->yui_module('moodle-core-formchangechecker',
1100                     'M.core_formchangechecker.init',
1101                     array(array(
1102                         'formid' => 'gradereport_grader'
1103                     ))
1104             );
1105             $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
1106         }
1108         $rows = $this->get_right_range_row($rows);
1109         if ($displayaverages) {
1110             $rows = $this->get_right_avg_row($rows, true);
1111             $rows = $this->get_right_avg_row($rows);
1112         }
1114         return $rows;
1115     }
1117     /**
1118      * Depending on the style of report (fixedstudents vs traditional one-table),
1119      * arranges the rows of data in one or two tables, and returns the output of
1120      * these tables in HTML
1121      * @param boolean $displayaverages whether to display average rows in the table
1122      * @return string HTML
1123      */
1124     public function get_grade_table($displayaverages = false) {
1125         global $OUTPUT;
1126         $fixedstudents = $this->is_fixed_students();
1128         $leftrows = $this->get_left_rows($displayaverages);
1129         $rightrows = $this->get_right_rows($displayaverages);
1131         $html = '';
1133         if ($fixedstudents) {
1134             $fixedcolumntable = new html_table();
1135             $fixedcolumntable->id = 'fixed_column';
1136             $fixedcolumntable->data = $leftrows;
1137             $html .= $OUTPUT->container(html_writer::table($fixedcolumntable), 'left_scroller');
1139             $righttable = new html_table();
1140             $righttable->id = 'user-grades';
1141             $righttable->data = $rightrows;
1143             $html .= $OUTPUT->container(html_writer::table($righttable), 'right_scroller');
1144         } else {
1145             $fulltable = new html_table();
1146             $fulltable->attributes['class'] = 'gradestable flexible boxaligncenter generaltable';
1147             $fulltable->id = 'user-grades';
1149             // Extract rows from each side (left and right) and collate them into one row each
1150             foreach ($leftrows as $key => $row) {
1151                 $row->cells = array_merge($row->cells, $rightrows[$key]->cells);
1152                 $fulltable->data[] = $row;
1153             }
1154             $html .= html_writer::table($fulltable);
1155         }
1156         return $OUTPUT->container($html, 'gradeparent');
1157     }
1159     /**
1160      * Builds and return the row of icons for the left side of the report.
1161      * It only has one cell that says "Controls"
1162      * @param array $rows The Array of rows for the left part of the report
1163      * @param int $colspan The number of columns this cell has to span
1164      * @return array Array of rows for the left part of the report
1165      */
1166     public function get_left_icons_row($rows=array(), $colspan=1) {
1167         global $USER;
1169         if ($USER->gradeediting[$this->courseid]) {
1170             $controlsrow = new html_table_row();
1171             $controlsrow->attributes['class'] = 'controls';
1172             $controlscell = new html_table_cell();
1173             $controlscell->attributes['class'] = 'header controls';
1174             $controlscell->colspan = $colspan;
1175             $controlscell->text = $this->get_lang_string('controls', 'grades');
1177             $controlsrow->cells[] = $controlscell;
1178             $rows[] = $controlsrow;
1179         }
1180         return $rows;
1181     }
1183     /**
1184      * Builds and return the header for the row of ranges, for the left part of the grader report.
1185      * @param array $rows The Array of rows for the left part of the report
1186      * @param int $colspan The number of columns this cell has to span
1187      * @return array Array of rows for the left part of the report
1188      */
1189     public function get_left_range_row($rows=array(), $colspan=1) {
1190         global $CFG, $USER;
1192         if ($this->get_pref('showranges')) {
1193             $rangerow = new html_table_row();
1194             $rangerow->attributes['class'] = 'range r'.$this->rowcount++;
1195             $rangecell = new html_table_cell();
1196             $rangecell->attributes['class'] = 'header range';
1197             $rangecell->colspan = $colspan;
1198             $rangecell->header = true;
1199             $rangecell->scope = 'row';
1200             $rangecell->text = $this->get_lang_string('range', 'grades');
1201             $rangerow->cells[] = $rangecell;
1202             $rows[] = $rangerow;
1203         }
1205         return $rows;
1206     }
1208     /**
1209      * Builds and return the headers for the rows of averages, for the left part of the grader report.
1210      * @param array $rows The Array of rows for the left part of the report
1211      * @param int $colspan The number of columns this cell has to span
1212      * @param bool $groupavg If true, returns the row for group averages, otherwise for overall averages
1213      * @return array Array of rows for the left part of the report
1214      */
1215     public function get_left_avg_row($rows=array(), $colspan=1, $groupavg=false) {
1216         if (!$this->canviewhidden) {
1217             // totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1218             // better not show them at all if user can not see all hideen grades
1219             return $rows;
1220         }
1222         $showaverages = $this->get_pref('showaverages');
1223         $showaveragesgroup = $this->currentgroup && $showaverages;
1224         $straveragegroup = get_string('groupavg', 'grades');
1226         if ($groupavg) {
1227             if ($showaveragesgroup) {
1228                 $groupavgrow = new html_table_row();
1229                 $groupavgrow->attributes['class'] = 'groupavg r'.$this->rowcount++;
1230                 $groupavgcell = new html_table_cell();
1231                 $groupavgcell->attributes['class'] = 'header range';
1232                 $groupavgcell->colspan = $colspan;
1233                 $groupavgcell->header = true;
1234                 $groupavgcell->scope = 'row';
1235                 $groupavgcell->text = $straveragegroup;
1236                 $groupavgrow->cells[] = $groupavgcell;
1237                 $rows[] = $groupavgrow;
1238             }
1239         } else {
1240             $straverage = get_string('overallaverage', 'grades');
1242             if ($showaverages) {
1243                 $avgrow = new html_table_row();
1244                 $avgrow->attributes['class'] = 'avg r'.$this->rowcount++;
1245                 $avgcell = new html_table_cell();
1246                 $avgcell->attributes['class'] = 'header range';
1247                 $avgcell->colspan = $colspan;
1248                 $avgcell->header = true;
1249                 $avgcell->scope = 'row';
1250                 $avgcell->text = $straverage;
1251                 $avgrow->cells[] = $avgcell;
1252                 $rows[] = $avgrow;
1253             }
1254         }
1256         return $rows;
1257     }
1259     /**
1260      * Builds and return the row of icons when editing is on, for the right part of the grader report.
1261      * @param array $rows The Array of rows for the right part of the report
1262      * @return array Array of rows for the right part of the report
1263      */
1264     public function get_right_icons_row($rows=array()) {
1265         global $USER;
1266         if ($USER->gradeediting[$this->courseid]) {
1267             $iconsrow = new html_table_row();
1268             $iconsrow->attributes['class'] = 'controls';
1270             foreach ($this->gtree->items as $itemid => $unused) {
1271                 // emulate grade element
1272                 $item = $this->gtree->get_item($itemid);
1274                 $eid = $this->gtree->get_item_eid($item);
1275                 $element = $this->gtree->locate_element($eid);
1276                 $itemcell = new html_table_cell();
1277                 $itemcell->attributes['class'] = 'controls icons i'.$itemid;
1278                 $itemcell->text = $this->get_icons($element);
1279                 $iconsrow->cells[] = $itemcell;
1280             }
1281             $rows[] = $iconsrow;
1282         }
1283         return $rows;
1284     }
1286     /**
1287      * Builds and return the row of ranges for the right part of the grader report.
1288      * @param array $rows The Array of rows for the right part of the report
1289      * @return array Array of rows for the right part of the report
1290      */
1291     public function get_right_range_row($rows=array()) {
1292         global $OUTPUT;
1294         if ($this->get_pref('showranges')) {
1295             $rangesdisplaytype   = $this->get_pref('rangesdisplaytype');
1296             $rangesdecimalpoints = $this->get_pref('rangesdecimalpoints');
1297             $rangerow = new html_table_row();
1298             $rangerow->attributes['class'] = 'heading range';
1300             foreach ($this->gtree->items as $itemid => $unused) {
1301                 $item =& $this->gtree->items[$itemid];
1302                 $itemcell = new html_table_cell();
1303                 $itemcell->attributes['class'] .= ' range i'. $itemid;
1305                 $hidden = '';
1306                 if ($item->is_hidden()) {
1307                     $hidden = ' dimmed_text ';
1308                 }
1310                 $formattedrange = $item->get_formatted_range($rangesdisplaytype, $rangesdecimalpoints);
1312                 $itemcell->text = $OUTPUT->container($formattedrange, 'rangevalues'.$hidden);
1313                 $rangerow->cells[] = $itemcell;
1314             }
1315             $rows[] = $rangerow;
1316         }
1317         return $rows;
1318     }
1320     /**
1321      * Builds and return the row of averages for the right part of the grader report.
1322      * @param array $rows Whether to return only group averages or all averages.
1323      * @param bool $grouponly Whether to return only group averages or all averages.
1324      * @return array Array of rows for the right part of the report
1325      */
1326     public function get_right_avg_row($rows=array(), $grouponly=false) {
1327         global $USER, $DB, $OUTPUT;
1329         if (!$this->canviewhidden) {
1330             // Totals might be affected by hiding, if user can not see hidden grades the aggregations might be altered
1331             // better not show them at all if user can not see all hidden grades.
1332             return $rows;
1333         }
1335         $averagesdisplaytype   = $this->get_pref('averagesdisplaytype');
1336         $averagesdecimalpoints = $this->get_pref('averagesdecimalpoints');
1337         $meanselection         = $this->get_pref('meanselection');
1338         $shownumberofgrades    = $this->get_pref('shownumberofgrades');
1340         if ($grouponly) {
1341             $showaverages = $this->currentgroup && $this->get_pref('showaverages');
1342             $groupsql = $this->groupsql;
1343             $groupwheresql = $this->groupwheresql;
1344             $groupwheresqlparams = $this->groupwheresql_params;
1345         } else {
1346             $showaverages = $this->get_pref('showaverages');
1347             $groupsql = "";
1348             $groupwheresql = "";
1349             $groupwheresqlparams = array();
1350         }
1352         if ($showaverages) {
1353             $totalcount = $this->get_numusers($grouponly);
1355             // Limit to users with a gradeable role.
1356             list($gradebookrolessql, $gradebookrolesparams) = $DB->get_in_or_equal(explode(',', $this->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
1358             // Limit to users with an active enrollment.
1359             list($enrolledsql, $enrolledparams) = get_enrolled_sql($this->context);
1361             // We want to query both the current context and parent contexts.
1362             list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($this->context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
1364             $params = array_merge(array('courseid' => $this->courseid), $gradebookrolesparams, $enrolledparams, $groupwheresqlparams, $relatedctxparams);
1366             // Find sums of all grade items in course.
1367             $sql = "SELECT g.itemid, SUM(g.finalgrade) AS sum
1368                       FROM {grade_items} gi
1369                       JOIN {grade_grades} g ON g.itemid = gi.id
1370                       JOIN {user} u ON u.id = g.userid
1371                       JOIN ($enrolledsql) je ON je.id = u.id
1372                       JOIN (
1373                                SELECT DISTINCT ra.userid
1374                                  FROM {role_assignments} ra
1375                                 WHERE ra.roleid $gradebookrolessql
1376                                   AND ra.contextid $relatedctxsql
1377                            ) rainner ON rainner.userid = u.id
1378                       $groupsql
1379                      WHERE gi.courseid = :courseid
1380                        AND u.deleted = 0
1381                        AND g.finalgrade IS NOT NULL
1382                        $groupwheresql
1383                      GROUP BY g.itemid";
1384             $sumarray = array();
1385             if ($sums = $DB->get_records_sql($sql, $params)) {
1386                 foreach ($sums as $itemid => $csum) {
1387                     $sumarray[$itemid] = $csum->sum;
1388                 }
1389             }
1391             // MDL-10875 Empty grades must be evaluated as grademin, NOT always 0
1392             // This query returns a count of ungraded grades (NULL finalgrade OR no matching record in grade_grades table)
1393             $sql = "SELECT gi.id, COUNT(DISTINCT u.id) AS count
1394                       FROM {grade_items} gi
1395                       CROSS JOIN {user} u
1396                       JOIN ($enrolledsql) je
1397                            ON je.id = u.id
1398                       JOIN {role_assignments} ra
1399                            ON ra.userid = u.id
1400                       LEFT OUTER JOIN {grade_grades} g
1401                            ON (g.itemid = gi.id AND g.userid = u.id AND g.finalgrade IS NOT NULL)
1402                       $groupsql
1403                      WHERE gi.courseid = :courseid
1404                            AND ra.roleid $gradebookrolessql
1405                            AND ra.contextid $relatedctxsql
1406                            AND u.deleted = 0
1407                            AND g.id IS NULL
1408                            $groupwheresql
1409                   GROUP BY gi.id";
1411             $ungradedcounts = $DB->get_records_sql($sql, $params);
1413             $avgrow = new html_table_row();
1414             $avgrow->attributes['class'] = 'avg';
1416             foreach ($this->gtree->items as $itemid => $unused) {
1417                 $item =& $this->gtree->items[$itemid];
1419                 if ($item->needsupdate) {
1420                     $avgcell = new html_table_cell();
1421                     $avgcell->attributes['class'] = 'i'. $itemid;
1422                     $avgcell->text = $OUTPUT->container(get_string('error'), 'gradingerror');
1423                     $avgrow->cells[] = $avgcell;
1424                     continue;
1425                 }
1427                 if (!isset($sumarray[$item->id])) {
1428                     $sumarray[$item->id] = 0;
1429                 }
1431                 if (empty($ungradedcounts[$itemid])) {
1432                     $ungradedcount = 0;
1433                 } else {
1434                     $ungradedcount = $ungradedcounts[$itemid]->count;
1435                 }
1437                 if ($meanselection == GRADE_REPORT_MEAN_GRADED) {
1438                     $meancount = $totalcount - $ungradedcount;
1439                 } else { // Bump up the sum by the number of ungraded items * grademin
1440                     $sumarray[$item->id] += $ungradedcount * $item->grademin;
1441                     $meancount = $totalcount;
1442                 }
1444                 // Determine which display type to use for this average
1445                 if ($USER->gradeediting[$this->courseid]) {
1446                     $displaytype = GRADE_DISPLAY_TYPE_REAL;
1448                 } else if ($averagesdisplaytype == GRADE_REPORT_PREFERENCE_INHERIT) { // no ==0 here, please resave the report and user preferences
1449                     $displaytype = $item->get_displaytype();
1451                 } else {
1452                     $displaytype = $averagesdisplaytype;
1453                 }
1455                 // Override grade_item setting if a display preference (not inherit) was set for the averages
1456                 if ($averagesdecimalpoints == GRADE_REPORT_PREFERENCE_INHERIT) {
1457                     $decimalpoints = $item->get_decimals();
1459                 } else {
1460                     $decimalpoints = $averagesdecimalpoints;
1461                 }
1463                 if (!isset($sumarray[$item->id]) || $meancount == 0) {
1464                     $avgcell = new html_table_cell();
1465                     $avgcell->attributes['class'] = 'i'. $itemid;
1466                     $avgcell->text = '-';
1467                     $avgrow->cells[] = $avgcell;
1469                 } else {
1470                     $sum = $sumarray[$item->id];
1471                     $avgradeval = $sum/$meancount;
1472                     $gradehtml = grade_format_gradevalue($avgradeval, $item, true, $displaytype, $decimalpoints);
1474                     $numberofgrades = '';
1475                     if ($shownumberofgrades) {
1476                         $numberofgrades = " ($meancount)";
1477                     }
1479                     $avgcell = new html_table_cell();
1480                     $avgcell->attributes['class'] = 'i'. $itemid;
1481                     $avgcell->text = $gradehtml.$numberofgrades;
1482                     $avgrow->cells[] = $avgcell;
1483                 }
1484             }
1485             $rows[] = $avgrow;
1486         }
1487         return $rows;
1488     }
1490     /**
1491      * Given a grade_category, grade_item or grade_grade, this function
1492      * figures out the state of the object and builds then returns a div
1493      * with the icons needed for the grader report.
1494      *
1495      * @param array $element
1496      * @return string HTML
1497      */
1498     protected function get_icons($element) {
1499         global $CFG, $USER, $OUTPUT;
1501         if (!$USER->gradeediting[$this->courseid]) {
1502             return '<div class="grade_icons" />';
1503         }
1505         // Init all icons
1506         $editicon = '';
1508         $editable = true;
1510         if ($element['type'] == 'grade') {
1511             $item = $element['object']->grade_item;
1512             if ($item->is_course_item() or $item->is_category_item()) {
1513                 $editable = $this->overridecat;
1514             }
1515         }
1517         if ($element['type'] != 'categoryitem' && $element['type'] != 'courseitem' && $editable) {
1518             $editicon = $this->gtree->get_edit_icon($element, $this->gpr);
1519         }
1521         $editcalculationicon = '';
1522         $showhideicon        = '';
1523         $lockunlockicon      = '';
1525         if (has_capability('moodle/grade:manage', $this->context)) {
1526             if ($this->get_pref('showcalculations')) {
1527                 $editcalculationicon = $this->gtree->get_calculation_icon($element, $this->gpr);
1528             }
1530             if ($this->get_pref('showeyecons')) {
1531                 $showhideicon = $this->gtree->get_hiding_icon($element, $this->gpr);
1532             }
1534             if ($this->get_pref('showlocks')) {
1535                 $lockunlockicon = $this->gtree->get_locking_icon($element, $this->gpr);
1536             }
1538         }
1540         $gradeanalysisicon   = '';
1541         if ($this->get_pref('showanalysisicon') && $element['type'] == 'grade') {
1542             $gradeanalysisicon .= $this->gtree->get_grade_analysis_icon($element['object']);
1543         }
1545         return $OUTPUT->container($editicon.$editcalculationicon.$showhideicon.$lockunlockicon.$gradeanalysisicon, 'grade_icons');
1546     }
1548     /**
1549      * Given a category element returns collapsing +/- icon if available
1550      * @param object $element
1551      * @return string HTML
1552      */
1553     protected function get_collapsing_icon($element) {
1554         global $OUTPUT;
1556         $icon = '';
1557         // If object is a category, display expand/contract icon
1558         if ($element['type'] == 'category') {
1559             // Load language strings
1560             $strswitchminus = $this->get_lang_string('aggregatesonly', 'grades');
1561             $strswitchplus  = $this->get_lang_string('gradesonly', 'grades');
1562             $strswitchwhole = $this->get_lang_string('fullmode', 'grades');
1564             $url = new moodle_url($this->gpr->get_return_url(null, array('target'=>$element['eid'], 'sesskey'=>sesskey())));
1566             if (in_array($element['object']->id, $this->collapsed['aggregatesonly'])) {
1567                 $url->param('action', 'switch_plus');
1568                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_plus', $strswitchplus));
1570             } else if (in_array($element['object']->id, $this->collapsed['gradesonly'])) {
1571                 $url->param('action', 'switch_whole');
1572                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_whole', $strswitchwhole));
1574             } else {
1575                 $url->param('action', 'switch_minus');
1576                 $icon = $OUTPUT->action_icon($url, new pix_icon('t/switch_minus', $strswitchminus));
1577             }
1578         }
1579         return $icon;
1580     }
1582     /**
1583      * Processes a single action against a category, grade_item or grade.
1584      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1585      * @param string $action Which action to take (edit, delete etc...)
1586      * @return
1587      */
1588     public function process_action($target, $action) {
1589         return self::do_process_action($target, $action, $this->course->id);
1590     }
1592     /**
1593      * From the list of categories that this user prefers to collapse choose ones that belong to the current course.
1594      *
1595      * This function serves two purposes.
1596      * Mainly it helps migrating from user preference style when all courses were stored in one preference.
1597      * Also it helps to remove the settings for categories that were removed if the array for one course grows too big.
1598      *
1599      * @param int $courseid
1600      * @param array $collapsed
1601      * @return array
1602      */
1603     protected static function filter_collapsed_categories($courseid, $collapsed) {
1604         global $DB;
1605         if (empty($collapsed)) {
1606             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1607         }
1608         if (empty($collapsed['aggregatesonly']) && empty($collapsed['gradesonly'])) {
1609             return $collapsed;
1610         }
1611         $cats = $DB->get_fieldset_select('grade_categories', 'id', 'courseid = ?', array($courseid));
1612         $collapsed['aggregatesonly'] = array_values(array_intersect($collapsed['aggregatesonly'], $cats));
1613         $collapsed['gradesonly'] = array_values(array_intersect($collapsed['gradesonly'], $cats));
1614         return $collapsed;
1615     }
1617     /**
1618      * Returns the list of categories that this user wants to collapse or display aggregatesonly
1619      *
1620      * This method also migrates on request from the old format of storing user preferences when they were stored
1621      * in one preference for all courses causing DB error when trying to insert very big value.
1622      *
1623      * @param int $courseid
1624      * @return array
1625      */
1626     protected static function get_collapsed_preferences($courseid) {
1627         if ($collapsed = get_user_preferences('grade_report_grader_collapsed_categories'.$courseid)) {
1628             return json_decode($collapsed, true);
1629         }
1631         // Try looking for old location of user setting that used to store all courses in one serialized user preference.
1632         if (($oldcollapsedpref = get_user_preferences('grade_report_grader_collapsed_categories')) !== null) {
1633             if ($collapsedall = @unserialize($oldcollapsedpref)) {
1634                 // We found the old-style preference, filter out only categories that belong to this course and update the prefs.
1635                 $collapsed = static::filter_collapsed_categories($courseid, $collapsedall);
1636                 if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1637                     static::set_collapsed_preferences($courseid, $collapsed);
1638                     $collapsedall['aggregatesonly'] = array_diff($collapsedall['aggregatesonly'], $collapsed['aggregatesonly']);
1639                     $collapsedall['gradesonly'] = array_diff($collapsedall['gradesonly'], $collapsed['gradesonly']);
1640                     if (!empty($collapsedall['aggregatesonly']) || !empty($collapsedall['gradesonly'])) {
1641                         set_user_preference('grade_report_grader_collapsed_categories', serialize($collapsedall));
1642                     } else {
1643                         unset_user_preference('grade_report_grader_collapsed_categories');
1644                     }
1645                 }
1646             } else {
1647                 // We found the old-style preference, but it is unreadable, discard it.
1648                 unset_user_preference('grade_report_grader_collapsed_categories');
1649             }
1650         } else {
1651             $collapsed = array('aggregatesonly' => array(), 'gradesonly' => array());
1652         }
1653         return $collapsed;
1654     }
1656     /**
1657      * Sets the list of categories that user wants to see collapsed in user preferences
1658      *
1659      * This method may filter or even trim the list if it does not fit in DB field.
1660      *
1661      * @param int $courseid
1662      * @param array $collapsed
1663      */
1664     protected static function set_collapsed_preferences($courseid, $collapsed) {
1665         global $DB;
1666         // In an unlikely case that the list of collapsed categories for one course is too big for the user preference size,
1667         // try to filter the list of categories since array may contain categories that were deleted.
1668         if (strlen(json_encode($collapsed)) >= 1333) {
1669             $collapsed = static::filter_collapsed_categories($courseid, $collapsed);
1670         }
1672         // If this did not help, "forget" about some of the collapsed categories. Still better than to loose all information.
1673         while (strlen(json_encode($collapsed)) >= 1333) {
1674             if (count($collapsed['aggregatesonly'])) {
1675                 array_pop($collapsed['aggregatesonly']);
1676             }
1677             if (count($collapsed['gradesonly'])) {
1678                 array_pop($collapsed['gradesonly']);
1679             }
1680         }
1682         if (!empty($collapsed['aggregatesonly']) || !empty($collapsed['gradesonly'])) {
1683             set_user_preference('grade_report_grader_collapsed_categories'.$courseid, json_encode($collapsed));
1684         } else {
1685             unset_user_preference('grade_report_grader_collapsed_categories'.$courseid);
1686         }
1687     }
1689     /**
1690      * Processes a single action against a category, grade_item or grade.
1691      * @param string $target eid ({type}{id}, e.g. c4 for category4)
1692      * @param string $action Which action to take (edit, delete etc...)
1693      * @param int $courseid affected course.
1694      * @return
1695      */
1696     public static function do_process_action($target, $action, $courseid = null) {
1697         global $DB;
1698         // TODO: this code should be in some grade_tree static method
1699         $targettype = substr($target, 0, 2);
1700         $targetid = substr($target, 2);
1701         // TODO: end
1703         if ($targettype !== 'cg') {
1704             // The following code only works with categories.
1705             return true;
1706         }
1708         if (!$courseid) {
1709             debugging('Function grade_report_grader::do_process_action() now requires additional argument courseid',
1710                 DEBUG_DEVELOPER);
1711             if (!$courseid = $DB->get_field('grade_categories', 'courseid', array('id' => $targetid), IGNORE_MISSING)) {
1712                 return true;
1713             }
1714         }
1716         $collapsed = static::get_collapsed_preferences($courseid);
1718         switch ($action) {
1719             case 'switch_minus': // Add category to array of aggregatesonly
1720                 if (!in_array($targetid, $collapsed['aggregatesonly'])) {
1721                     $collapsed['aggregatesonly'][] = $targetid;
1722                     static::set_collapsed_preferences($courseid, $collapsed);
1723                 }
1724                 break;
1726             case 'switch_plus': // Remove category from array of aggregatesonly, and add it to array of gradesonly
1727                 $key = array_search($targetid, $collapsed['aggregatesonly']);
1728                 if ($key !== false) {
1729                     unset($collapsed['aggregatesonly'][$key]);
1730                 }
1731                 if (!in_array($targetid, $collapsed['gradesonly'])) {
1732                     $collapsed['gradesonly'][] = $targetid;
1733                 }
1734                 static::set_collapsed_preferences($courseid, $collapsed);
1735                 break;
1736             case 'switch_whole': // Remove the category from the array of collapsed cats
1737                 $key = array_search($targetid, $collapsed['gradesonly']);
1738                 if ($key !== false) {
1739                     unset($collapsed['gradesonly'][$key]);
1740                     static::set_collapsed_preferences($courseid, $collapsed);
1741                 }
1743                 break;
1744             default:
1745                 break;
1746         }
1748         return true;
1749     }
1751     /**
1752      * Returns whether or not to display fixed students column.
1753      * Includes a browser check, because IE6 doesn't support the scrollbar.
1754      *
1755      * @return bool
1756      */
1757     public function is_fixed_students() {
1758         global $CFG;
1760         return $CFG->grade_report_fixedstudents;
1761     }
1763     /**
1764      * Refactored function for generating HTML of sorting links with matching arrows.
1765      * Returns an array with 'studentname' and 'idnumber' as keys, with HTML ready
1766      * to inject into a table header cell.
1767      * @param array $extrafields Array of extra fields being displayed, such as
1768      *   user idnumber
1769      * @return array An associative array of HTML sorting links+arrows
1770      */
1771     public function get_sort_arrows(array $extrafields = array()) {
1772         global $OUTPUT;
1773         $arrows = array();
1775         $strsortasc   = $this->get_lang_string('sortasc', 'grades');
1776         $strsortdesc  = $this->get_lang_string('sortdesc', 'grades');
1777         $strfirstname = $this->get_lang_string('firstname');
1778         $strlastname  = $this->get_lang_string('lastname');
1779         $iconasc = $OUTPUT->pix_icon('t/sort_asc', $strsortasc, '', array('class' => 'iconsmall sorticon'));
1780         $icondesc = $OUTPUT->pix_icon('t/sort_desc', $strsortdesc, '', array('class' => 'iconsmall sorticon'));
1782         $firstlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'firstname')), $strfirstname);
1783         $lastlink = html_writer::link(new moodle_url($this->baseurl, array('sortitemid'=>'lastname')), $strlastname);
1785         $arrows['studentname'] = $lastlink;
1787         if ($this->sortitemid === 'lastname') {
1788             if ($this->sortorder == 'ASC') {
1789                 $arrows['studentname'] .= $iconasc;
1790             } else {
1791                 $arrows['studentname'] .= $icondesc;
1792             }
1793         }
1795         $arrows['studentname'] .= ' ' . $firstlink;
1797         if ($this->sortitemid === 'firstname') {
1798             if ($this->sortorder == 'ASC') {
1799                 $arrows['studentname'] .= $iconasc;
1800             } else {
1801                 $arrows['studentname'] .= $icondesc;
1802             }
1803         }
1805         foreach ($extrafields as $field) {
1806             $fieldlink = html_writer::link(new moodle_url($this->baseurl,
1807                     array('sortitemid'=>$field)), get_user_field_name($field));
1808             $arrows[$field] = $fieldlink;
1810             if ($field == $this->sortitemid) {
1811                 if ($this->sortorder == 'ASC') {
1812                     $arrows[$field] .= $iconasc;
1813                 } else {
1814                     $arrows[$field] .= $icondesc;
1815                 }
1816             }
1817         }
1819         return $arrows;
1820     }
1822     /**
1823      * Returns the maximum number of students to be displayed on each page
1824      *
1825      * @return int The maximum number of students to display per page
1826      */
1827     public function get_students_per_page() {
1828         return $this->get_pref('studentsperpage');
1829     }