MDL-54065 gradebook: correctly display module icon
[moodle.git] / grade / 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  * Functions used by gradebook plugins and reports.
19  *
20  * @package   core_grades
21  * @copyright 2009 Petr Skoda and Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once($CFG->libdir . '/gradelib.php');
26 require_once($CFG->dirroot . '/grade/export/lib.php');
28 /**
29  * This class iterates over all users that are graded in a course.
30  * Returns detailed info about users and their grades.
31  *
32  * @author Petr Skoda <skodak@moodle.org>
33  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class graded_users_iterator {
37     /**
38      * The couse whose users we are interested in
39      */
40     protected $course;
42     /**
43      * An array of grade items or null if only user data was requested
44      */
45     protected $grade_items;
47     /**
48      * The group ID we are interested in. 0 means all groups.
49      */
50     protected $groupid;
52     /**
53      * A recordset of graded users
54      */
55     protected $users_rs;
57     /**
58      * A recordset of user grades (grade_grade instances)
59      */
60     protected $grades_rs;
62     /**
63      * Array used when moving to next user while iterating through the grades recordset
64      */
65     protected $gradestack;
67     /**
68      * The first field of the users table by which the array of users will be sorted
69      */
70     protected $sortfield1;
72     /**
73      * Should sortfield1 be ASC or DESC
74      */
75     protected $sortorder1;
77     /**
78      * The second field of the users table by which the array of users will be sorted
79      */
80     protected $sortfield2;
82     /**
83      * Should sortfield2 be ASC or DESC
84      */
85     protected $sortorder2;
87     /**
88      * Should users whose enrolment has been suspended be ignored?
89      */
90     protected $onlyactive = false;
92     /**
93      * Enable user custom fields
94      */
95     protected $allowusercustomfields = false;
97     /**
98      * List of suspended users in course. This includes users whose enrolment status is suspended
99      * or enrolment has expired or not started.
100      */
101     protected $suspendedusers = array();
103     /**
104      * Constructor
105      *
106      * @param object $course A course object
107      * @param array  $grade_items array of grade items, if not specified only user info returned
108      * @param int    $groupid iterate only group users if present
109      * @param string $sortfield1 The first field of the users table by which the array of users will be sorted
110      * @param string $sortorder1 The order in which the first sorting field will be sorted (ASC or DESC)
111      * @param string $sortfield2 The second field of the users table by which the array of users will be sorted
112      * @param string $sortorder2 The order in which the second sorting field will be sorted (ASC or DESC)
113      */
114     public function __construct($course, $grade_items=null, $groupid=0,
115                                           $sortfield1='lastname', $sortorder1='ASC',
116                                           $sortfield2='firstname', $sortorder2='ASC') {
117         $this->course      = $course;
118         $this->grade_items = $grade_items;
119         $this->groupid     = $groupid;
120         $this->sortfield1  = $sortfield1;
121         $this->sortorder1  = $sortorder1;
122         $this->sortfield2  = $sortfield2;
123         $this->sortorder2  = $sortorder2;
125         $this->gradestack  = array();
126     }
128     /**
129      * Initialise the iterator
130      *
131      * @return boolean success
132      */
133     public function init() {
134         global $CFG, $DB;
136         $this->close();
138         export_verify_grades($this->course->id);
139         $course_item = grade_item::fetch_course_item($this->course->id);
140         if ($course_item->needsupdate) {
141             // Can not calculate all final grades - sorry.
142             return false;
143         }
145         $coursecontext = context_course::instance($this->course->id);
147         list($relatedctxsql, $relatedctxparams) = $DB->get_in_or_equal($coursecontext->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'relatedctx');
148         list($gradebookroles_sql, $params) = $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr');
149         list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext, '', 0, $this->onlyactive);
151         $params = array_merge($params, $enrolledparams, $relatedctxparams);
153         if ($this->groupid) {
154             $groupsql = "INNER JOIN {groups_members} gm ON gm.userid = u.id";
155             $groupwheresql = "AND gm.groupid = :groupid";
156             // $params contents: gradebookroles
157             $params['groupid'] = $this->groupid;
158         } else {
159             $groupsql = "";
160             $groupwheresql = "";
161         }
163         if (empty($this->sortfield1)) {
164             // We must do some sorting even if not specified.
165             $ofields = ", u.id AS usrt";
166             $order   = "usrt ASC";
168         } else {
169             $ofields = ", u.$this->sortfield1 AS usrt1";
170             $order   = "usrt1 $this->sortorder1";
171             if (!empty($this->sortfield2)) {
172                 $ofields .= ", u.$this->sortfield2 AS usrt2";
173                 $order   .= ", usrt2 $this->sortorder2";
174             }
175             if ($this->sortfield1 != 'id' and $this->sortfield2 != 'id') {
176                 // User order MUST be the same in both queries,
177                 // must include the only unique user->id if not already present.
178                 $ofields .= ", u.id AS usrt";
179                 $order   .= ", usrt ASC";
180             }
181         }
183         $userfields = 'u.*';
184         $customfieldssql = '';
185         if ($this->allowusercustomfields && !empty($CFG->grade_export_customprofilefields)) {
186             $customfieldscount = 0;
187             $customfieldsarray = grade_helper::get_user_profile_fields($this->course->id, $this->allowusercustomfields);
188             foreach ($customfieldsarray as $field) {
189                 if (!empty($field->customid)) {
190                     $customfieldssql .= "
191                             LEFT JOIN (SELECT * FROM {user_info_data}
192                                 WHERE fieldid = :cf$customfieldscount) cf$customfieldscount
193                             ON u.id = cf$customfieldscount.userid";
194                     $userfields .= ", cf$customfieldscount.data AS customfield_{$field->shortname}";
195                     $params['cf'.$customfieldscount] = $field->customid;
196                     $customfieldscount++;
197                 }
198             }
199         }
201         $users_sql = "SELECT $userfields $ofields
202                         FROM {user} u
203                         JOIN ($enrolledsql) je ON je.id = u.id
204                              $groupsql $customfieldssql
205                         JOIN (
206                                   SELECT DISTINCT ra.userid
207                                     FROM {role_assignments} ra
208                                    WHERE ra.roleid $gradebookroles_sql
209                                      AND ra.contextid $relatedctxsql
210                              ) rainner ON rainner.userid = u.id
211                          WHERE u.deleted = 0
212                              $groupwheresql
213                     ORDER BY $order";
214         $this->users_rs = $DB->get_recordset_sql($users_sql, $params);
216         if (!$this->onlyactive) {
217             $context = context_course::instance($this->course->id);
218             $this->suspendedusers = get_suspended_userids($context);
219         } else {
220             $this->suspendedusers = array();
221         }
223         if (!empty($this->grade_items)) {
224             $itemids = array_keys($this->grade_items);
225             list($itemidsql, $grades_params) = $DB->get_in_or_equal($itemids, SQL_PARAMS_NAMED, 'items');
226             $params = array_merge($params, $grades_params);
228             $grades_sql = "SELECT g.* $ofields
229                              FROM {grade_grades} g
230                              JOIN {user} u ON g.userid = u.id
231                              JOIN ($enrolledsql) je ON je.id = u.id
232                                   $groupsql
233                              JOIN (
234                                       SELECT DISTINCT ra.userid
235                                         FROM {role_assignments} ra
236                                        WHERE ra.roleid $gradebookroles_sql
237                                          AND ra.contextid $relatedctxsql
238                                   ) rainner ON rainner.userid = u.id
239                               WHERE u.deleted = 0
240                               AND g.itemid $itemidsql
241                               $groupwheresql
242                          ORDER BY $order, g.itemid ASC";
243             $this->grades_rs = $DB->get_recordset_sql($grades_sql, $params);
244         } else {
245             $this->grades_rs = false;
246         }
248         return true;
249     }
251     /**
252      * Returns information about the next user
253      * @return mixed array of user info, all grades and feedback or null when no more users found
254      */
255     public function next_user() {
256         if (!$this->users_rs) {
257             return false; // no users present
258         }
260         if (!$this->users_rs->valid()) {
261             if ($current = $this->_pop()) {
262                 // this is not good - user or grades updated between the two reads above :-(
263             }
265             return false; // no more users
266         } else {
267             $user = $this->users_rs->current();
268             $this->users_rs->next();
269         }
271         // find grades of this user
272         $grade_records = array();
273         while (true) {
274             if (!$current = $this->_pop()) {
275                 break; // no more grades
276             }
278             if (empty($current->userid)) {
279                 break;
280             }
282             if ($current->userid != $user->id) {
283                 // grade of the next user, we have all for this user
284                 $this->_push($current);
285                 break;
286             }
288             $grade_records[$current->itemid] = $current;
289         }
291         $grades = array();
292         $feedbacks = array();
294         if (!empty($this->grade_items)) {
295             foreach ($this->grade_items as $grade_item) {
296                 if (!isset($feedbacks[$grade_item->id])) {
297                     $feedbacks[$grade_item->id] = new stdClass();
298                 }
299                 if (array_key_exists($grade_item->id, $grade_records)) {
300                     $feedbacks[$grade_item->id]->feedback       = $grade_records[$grade_item->id]->feedback;
301                     $feedbacks[$grade_item->id]->feedbackformat = $grade_records[$grade_item->id]->feedbackformat;
302                     unset($grade_records[$grade_item->id]->feedback);
303                     unset($grade_records[$grade_item->id]->feedbackformat);
304                     $grades[$grade_item->id] = new grade_grade($grade_records[$grade_item->id], false);
305                 } else {
306                     $feedbacks[$grade_item->id]->feedback       = '';
307                     $feedbacks[$grade_item->id]->feedbackformat = FORMAT_MOODLE;
308                     $grades[$grade_item->id] =
309                         new grade_grade(array('userid'=>$user->id, 'itemid'=>$grade_item->id), false);
310                 }
311                 $grades[$grade_item->id]->grade_item = $grade_item;
312             }
313         }
315         // Set user suspended status.
316         $user->suspendedenrolment = isset($this->suspendedusers[$user->id]);
317         $result = new stdClass();
318         $result->user      = $user;
319         $result->grades    = $grades;
320         $result->feedbacks = $feedbacks;
321         return $result;
322     }
324     /**
325      * Close the iterator, do not forget to call this function
326      */
327     public function close() {
328         if ($this->users_rs) {
329             $this->users_rs->close();
330             $this->users_rs = null;
331         }
332         if ($this->grades_rs) {
333             $this->grades_rs->close();
334             $this->grades_rs = null;
335         }
336         $this->gradestack = array();
337     }
339     /**
340      * Should all enrolled users be exported or just those with an active enrolment?
341      *
342      * @param bool $onlyactive True to limit the export to users with an active enrolment
343      */
344     public function require_active_enrolment($onlyactive = true) {
345         if (!empty($this->users_rs)) {
346             debugging('Calling require_active_enrolment() has no effect unless you call init() again', DEBUG_DEVELOPER);
347         }
348         $this->onlyactive  = $onlyactive;
349     }
351     /**
352      * Allow custom fields to be included
353      *
354      * @param bool $allow Whether to allow custom fields or not
355      * @return void
356      */
357     public function allow_user_custom_fields($allow = true) {
358         if ($allow) {
359             $this->allowusercustomfields = true;
360         } else {
361             $this->allowusercustomfields = false;
362         }
363     }
365     /**
366      * Add a grade_grade instance to the grade stack
367      *
368      * @param grade_grade $grade Grade object
369      *
370      * @return void
371      */
372     private function _push($grade) {
373         array_push($this->gradestack, $grade);
374     }
377     /**
378      * Remove a grade_grade instance from the grade stack
379      *
380      * @return grade_grade current grade object
381      */
382     private function _pop() {
383         global $DB;
384         if (empty($this->gradestack)) {
385             if (empty($this->grades_rs) || !$this->grades_rs->valid()) {
386                 return null; // no grades present
387             }
389             $current = $this->grades_rs->current();
391             $this->grades_rs->next();
393             return $current;
394         } else {
395             return array_pop($this->gradestack);
396         }
397     }
400 /**
401  * Print a selection popup form of the graded users in a course.
402  *
403  * @deprecated since 2.0
404  *
405  * @param int    $course id of the course
406  * @param string $actionpage The page receiving the data from the popoup form
407  * @param int    $userid   id of the currently selected user (or 'all' if they are all selected)
408  * @param int    $groupid id of requested group, 0 means all
409  * @param int    $includeall bool include all option
410  * @param bool   $return If true, will return the HTML, otherwise, will print directly
411  * @return null
412  */
413 function print_graded_users_selector($course, $actionpage, $userid=0, $groupid=0, $includeall=true, $return=false) {
414     global $CFG, $USER, $OUTPUT;
415     return $OUTPUT->render(grade_get_graded_users_select(substr($actionpage, 0, strpos($actionpage, '/')), $course, $userid, $groupid, $includeall));
418 function grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall) {
419     global $USER, $CFG;
421     if (is_null($userid)) {
422         $userid = $USER->id;
423     }
424     $coursecontext = context_course::instance($course->id);
425     $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
426     $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
427     $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $coursecontext);
428     $menu = array(); // Will be a list of userid => user name
429     $menususpendedusers = array(); // Suspended users go to a separate optgroup.
430     $gui = new graded_users_iterator($course, null, $groupid);
431     $gui->require_active_enrolment($showonlyactiveenrol);
432     $gui->init();
433     $label = get_string('selectauser', 'grades');
434     if ($includeall) {
435         $menu[0] = get_string('allusers', 'grades');
436         $label = get_string('selectalloroneuser', 'grades');
437     }
438     while ($userdata = $gui->next_user()) {
439         $user = $userdata->user;
440         $userfullname = fullname($user);
441         if ($user->suspendedenrolment) {
442             $menususpendedusers[$user->id] = $userfullname;
443         } else {
444             $menu[$user->id] = $userfullname;
445         }
446     }
447     $gui->close();
449     if ($includeall) {
450         $menu[0] .= " (" . (count($menu) + count($menususpendedusers) - 1) . ")";
451     }
453     if (!empty($menususpendedusers)) {
454         $menu[] = array(get_string('suspendedusers') => $menususpendedusers);
455     }
456     $select = new single_select(new moodle_url('/grade/report/'.$report.'/index.php', array('id'=>$course->id)), 'userid', $menu, $userid);
457     $select->label = $label;
458     $select->formid = 'choosegradeuser';
459     return $select;
462 /**
463  * Hide warning about changed grades during upgrade to 2.8.
464  *
465  * @param int $courseid The current course id.
466  */
467 function hide_natural_aggregation_upgrade_notice($courseid) {
468     unset_config('show_sumofgrades_upgrade_' . $courseid);
471 /**
472  * Hide warning about changed grades during upgrade from 2.8.0-2.8.6 and 2.9.0.
473  *
474  * @param int $courseid The current course id.
475  */
476 function grade_hide_min_max_grade_upgrade_notice($courseid) {
477     unset_config('show_min_max_grades_changed_' . $courseid);
480 /**
481  * Use the grade min and max from the grade_grade.
482  *
483  * This is reserved for core use after an upgrade.
484  *
485  * @param int $courseid The current course id.
486  */
487 function grade_upgrade_use_min_max_from_grade_grade($courseid) {
488     grade_set_setting($courseid, 'minmaxtouse', GRADE_MIN_MAX_FROM_GRADE_GRADE);
490     grade_force_full_regrading($courseid);
491     // Do this now, because it probably happened to late in the page load to be happen automatically.
492     grade_regrade_final_grades($courseid);
495 /**
496  * Use the grade min and max from the grade_item.
497  *
498  * This is reserved for core use after an upgrade.
499  *
500  * @param int $courseid The current course id.
501  */
502 function grade_upgrade_use_min_max_from_grade_item($courseid) {
503     grade_set_setting($courseid, 'minmaxtouse', GRADE_MIN_MAX_FROM_GRADE_ITEM);
505     grade_force_full_regrading($courseid);
506     // Do this now, because it probably happened to late in the page load to be happen automatically.
507     grade_regrade_final_grades($courseid);
510 /**
511  * Hide warning about changed grades during upgrade to 2.8.
512  *
513  * @param int $courseid The current course id.
514  */
515 function hide_aggregatesubcats_upgrade_notice($courseid) {
516     unset_config('show_aggregatesubcats_upgrade_' . $courseid);
519 /**
520  * Hide warning about changed grades due to bug fixes
521  *
522  * @param int $courseid The current course id.
523  */
524 function hide_gradebook_calculations_freeze_notice($courseid) {
525     unset_config('gradebook_calculations_freeze_' . $courseid);
528 /**
529  * Print warning about changed grades during upgrade to 2.8.
530  *
531  * @param int $courseid The current course id.
532  * @param context $context The course context.
533  * @param string $thispage The relative path for the current page. E.g. /grade/report/user/index.php
534  * @param boolean $return return as string
535  *
536  * @return nothing or string if $return true
537  */
538 function print_natural_aggregation_upgrade_notice($courseid, $context, $thispage, $return=false) {
539     global $CFG, $OUTPUT;
540     $html = '';
542     // Do not do anything if they cannot manage the grades of this course.
543     if (!has_capability('moodle/grade:manage', $context)) {
544         return $html;
545     }
547     $hidesubcatswarning = optional_param('seenaggregatesubcatsupgradedgrades', false, PARAM_BOOL) && confirm_sesskey();
548     $showsubcatswarning = get_config('core', 'show_aggregatesubcats_upgrade_' . $courseid);
549     $hidenaturalwarning = optional_param('seensumofgradesupgradedgrades', false, PARAM_BOOL) && confirm_sesskey();
550     $shownaturalwarning = get_config('core', 'show_sumofgrades_upgrade_' . $courseid);
552     $hideminmaxwarning = optional_param('seenminmaxupgradedgrades', false, PARAM_BOOL) && confirm_sesskey();
553     $showminmaxwarning = get_config('core', 'show_min_max_grades_changed_' . $courseid);
555     $useminmaxfromgradeitem = optional_param('useminmaxfromgradeitem', false, PARAM_BOOL) && confirm_sesskey();
556     $useminmaxfromgradegrade = optional_param('useminmaxfromgradegrade', false, PARAM_BOOL) && confirm_sesskey();
558     $minmaxtouse = grade_get_setting($courseid, 'minmaxtouse', $CFG->grade_minmaxtouse);
560     $gradebookcalculationsfreeze = get_config('core', 'gradebook_calculations_freeze_' . $courseid);
561     $acceptgradebookchanges = optional_param('acceptgradebookchanges', false, PARAM_BOOL) && confirm_sesskey();
563     // Hide the warning if the user told it to go away.
564     if ($hidenaturalwarning) {
565         hide_natural_aggregation_upgrade_notice($courseid);
566     }
567     // Hide the warning if the user told it to go away.
568     if ($hidesubcatswarning) {
569         hide_aggregatesubcats_upgrade_notice($courseid);
570     }
572     // Hide the min/max warning if the user told it to go away.
573     if ($hideminmaxwarning) {
574         grade_hide_min_max_grade_upgrade_notice($courseid);
575         $showminmaxwarning = false;
576     }
578     if ($useminmaxfromgradegrade) {
579         // Revert to the new behaviour, we now use the grade_grade for min/max.
580         grade_upgrade_use_min_max_from_grade_grade($courseid);
581         grade_hide_min_max_grade_upgrade_notice($courseid);
582         $showminmaxwarning = false;
584     } else if ($useminmaxfromgradeitem) {
585         // Apply the new logic, we now use the grade_item for min/max.
586         grade_upgrade_use_min_max_from_grade_item($courseid);
587         grade_hide_min_max_grade_upgrade_notice($courseid);
588         $showminmaxwarning = false;
589     }
592     if (!$hidenaturalwarning && $shownaturalwarning) {
593         $message = get_string('sumofgradesupgradedgrades', 'grades');
594         $hidemessage = get_string('upgradedgradeshidemessage', 'grades');
595         $urlparams = array( 'id' => $courseid,
596                             'seensumofgradesupgradedgrades' => true,
597                             'sesskey' => sesskey());
598         $goawayurl = new moodle_url($thispage, $urlparams);
599         $goawaybutton = $OUTPUT->single_button($goawayurl, $hidemessage, 'get');
600         $html .= $OUTPUT->notification($message, 'notifysuccess');
601         $html .= $goawaybutton;
602     }
604     if (!$hidesubcatswarning && $showsubcatswarning) {
605         $message = get_string('aggregatesubcatsupgradedgrades', 'grades');
606         $hidemessage = get_string('upgradedgradeshidemessage', 'grades');
607         $urlparams = array( 'id' => $courseid,
608                             'seenaggregatesubcatsupgradedgrades' => true,
609                             'sesskey' => sesskey());
610         $goawayurl = new moodle_url($thispage, $urlparams);
611         $goawaybutton = $OUTPUT->single_button($goawayurl, $hidemessage, 'get');
612         $html .= $OUTPUT->notification($message, 'notifysuccess');
613         $html .= $goawaybutton;
614     }
616     if ($showminmaxwarning) {
617         $hidemessage = get_string('upgradedgradeshidemessage', 'grades');
618         $urlparams = array( 'id' => $courseid,
619                             'seenminmaxupgradedgrades' => true,
620                             'sesskey' => sesskey());
622         $goawayurl = new moodle_url($thispage, $urlparams);
623         $hideminmaxbutton = $OUTPUT->single_button($goawayurl, $hidemessage, 'get');
624         $moreinfo = html_writer::link(get_docs_url(get_string('minmaxtouse_link', 'grades')), get_string('moreinfo'),
625             array('target' => '_blank'));
627         if ($minmaxtouse == GRADE_MIN_MAX_FROM_GRADE_ITEM) {
628             // Show the message that there were min/max issues that have been resolved.
629             $message = get_string('minmaxupgradedgrades', 'grades') . ' ' . $moreinfo;
631             $revertmessage = get_string('upgradedminmaxrevertmessage', 'grades');
632             $urlparams = array('id' => $courseid,
633                                'useminmaxfromgradegrade' => true,
634                                'sesskey' => sesskey());
635             $reverturl = new moodle_url($thispage, $urlparams);
636             $revertbutton = $OUTPUT->single_button($reverturl, $revertmessage, 'get');
638             $html .= $OUTPUT->notification($message);
639             $html .= $revertbutton . $hideminmaxbutton;
641         } else if ($minmaxtouse == GRADE_MIN_MAX_FROM_GRADE_GRADE) {
642             // Show the warning that there are min/max issues that have not be resolved.
643             $message = get_string('minmaxupgradewarning', 'grades') . ' ' . $moreinfo;
645             $fixmessage = get_string('minmaxupgradefixbutton', 'grades');
646             $urlparams = array('id' => $courseid,
647                                'useminmaxfromgradeitem' => true,
648                                'sesskey' => sesskey());
649             $fixurl = new moodle_url($thispage, $urlparams);
650             $fixbutton = $OUTPUT->single_button($fixurl, $fixmessage, 'get');
652             $html .= $OUTPUT->notification($message);
653             $html .= $fixbutton . $hideminmaxbutton;
654         }
655     }
657     if ($gradebookcalculationsfreeze) {
658         if ($acceptgradebookchanges) {
659             // Accept potential changes in grades caused by extra credit bug MDL-49257.
660             hide_gradebook_calculations_freeze_notice($courseid);
661             $courseitem = grade_item::fetch_course_item($courseid);
662             $courseitem->force_regrading();
663             grade_regrade_final_grades($courseid);
665             $html .= $OUTPUT->notification(get_string('gradebookcalculationsuptodate', 'grades'), 'notifysuccess');
666         } else {
667             // Show the warning that there may be extra credit weights problems.
668             $a = new stdClass();
669             $a->gradebookversion = $gradebookcalculationsfreeze;
670             if (preg_match('/(\d{8,})/', $CFG->release, $matches)) {
671                 $a->currentversion = $matches[1];
672             } else {
673                 $a->currentversion = $CFG->release;
674             }
675             $a->url = get_docs_url('Gradebook_calculation_changes');
676             $message = get_string('gradebookcalculationswarning', 'grades', $a);
678             $fixmessage = get_string('gradebookcalculationsfixbutton', 'grades');
679             $urlparams = array('id' => $courseid,
680                 'acceptgradebookchanges' => true,
681                 'sesskey' => sesskey());
682             $fixurl = new moodle_url($thispage, $urlparams);
683             $fixbutton = $OUTPUT->single_button($fixurl, $fixmessage, 'get');
685             $html .= $OUTPUT->notification($message);
686             $html .= $fixbutton;
687         }
688     }
690     if (!empty($html)) {
691         $html = html_writer::tag('div', $html, array('class' => 'core_grades_notices'));
692     }
694     if ($return) {
695         return $html;
696     } else {
697         echo $html;
698     }
701 /**
702  * Print grading plugin selection popup form.
703  *
704  * @param array   $plugin_info An array of plugins containing information for the selector
705  * @param boolean $return return as string
706  *
707  * @return nothing or string if $return true
708  */
709 function print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) {
710     global $CFG, $OUTPUT, $PAGE;
712     $menu = array();
713     $count = 0;
714     $active = '';
716     foreach ($plugin_info as $plugin_type => $plugins) {
717         if ($plugin_type == 'strings') {
718             continue;
719         }
721         $first_plugin = reset($plugins);
723         $sectionname = $plugin_info['strings'][$plugin_type];
724         $section = array();
726         foreach ($plugins as $plugin) {
727             $link = $plugin->link->out(false);
728             $section[$link] = $plugin->string;
729             $count++;
730             if ($plugin_type === $active_type and $plugin->id === $active_plugin) {
731                 $active = $link;
732             }
733         }
735         if ($section) {
736             $menu[] = array($sectionname=>$section);
737         }
738     }
740     // finally print/return the popup form
741     if ($count > 1) {
742         $select = new url_select($menu, $active, null, 'choosepluginreport');
743         $select->set_label(get_string('gradereport', 'grades'), array('class' => 'accesshide'));
744         if ($return) {
745             return $OUTPUT->render($select);
746         } else {
747             echo $OUTPUT->render($select);
748         }
749     } else {
750         // only one option - no plugin selector needed
751         return '';
752     }
755 /**
756  * Print grading plugin selection tab-based navigation.
757  *
758  * @param string  $active_type type of plugin on current page - import, export, report or edit
759  * @param string  $active_plugin active plugin type - grader, user, cvs, ...
760  * @param array   $plugin_info Array of plugins
761  * @param boolean $return return as string
762  *
763  * @return nothing or string if $return true
764  */
765 function grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) {
766     global $CFG, $COURSE;
768     if (!isset($currenttab)) { //TODO: this is weird
769         $currenttab = '';
770     }
772     $tabs = array();
773     $top_row  = array();
774     $bottom_row = array();
775     $inactive = array($active_plugin);
776     $activated = array($active_type);
778     $count = 0;
779     $active = '';
781     foreach ($plugin_info as $plugin_type => $plugins) {
782         if ($plugin_type == 'strings') {
783             continue;
784         }
786         // If $plugins is actually the definition of a child-less parent link:
787         if (!empty($plugins->id)) {
788             $string = $plugins->string;
789             if (!empty($plugin_info[$active_type]->parent)) {
790                 $string = $plugin_info[$active_type]->parent->string;
791             }
793             $top_row[] = new tabobject($plugin_type, $plugins->link, $string);
794             continue;
795         }
797         $first_plugin = reset($plugins);
798         $url = $first_plugin->link;
800         if ($plugin_type == 'report') {
801             $url = $CFG->wwwroot.'/grade/report/index.php?id='.$COURSE->id;
802         }
804         $top_row[] = new tabobject($plugin_type, $url, $plugin_info['strings'][$plugin_type]);
806         if ($active_type == $plugin_type) {
807             foreach ($plugins as $plugin) {
808                 $bottom_row[] = new tabobject($plugin->id, $plugin->link, $plugin->string);
809                 if ($plugin->id == $active_plugin) {
810                     $inactive = array($plugin->id);
811                 }
812             }
813         }
814     }
816     $tabs[] = $top_row;
817     $tabs[] = $bottom_row;
819     if ($return) {
820         return print_tabs($tabs, $active_plugin, $inactive, $activated, true);
821     } else {
822         print_tabs($tabs, $active_plugin, $inactive, $activated);
823     }
826 /**
827  * grade_get_plugin_info
828  *
829  * @param int    $courseid The course id
830  * @param string $active_type type of plugin on current page - import, export, report or edit
831  * @param string $active_plugin active plugin type - grader, user, cvs, ...
832  *
833  * @return array
834  */
835 function grade_get_plugin_info($courseid, $active_type, $active_plugin) {
836     global $CFG, $SITE;
838     $context = context_course::instance($courseid);
840     $plugin_info = array();
841     $count = 0;
842     $active = '';
843     $url_prefix = $CFG->wwwroot . '/grade/';
845     // Language strings
846     $plugin_info['strings'] = grade_helper::get_plugin_strings();
848     if ($reports = grade_helper::get_plugins_reports($courseid)) {
849         $plugin_info['report'] = $reports;
850     }
852     if ($settings = grade_helper::get_info_manage_settings($courseid)) {
853         $plugin_info['settings'] = $settings;
854     }
856     if ($scale = grade_helper::get_info_scales($courseid)) {
857         $plugin_info['scale'] = array('view'=>$scale);
858     }
860     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
861         $plugin_info['outcome'] = $outcomes;
862     }
864     if ($letters = grade_helper::get_info_letters($courseid)) {
865         $plugin_info['letter'] = $letters;
866     }
868     if ($imports = grade_helper::get_plugins_import($courseid)) {
869         $plugin_info['import'] = $imports;
870     }
872     if ($exports = grade_helper::get_plugins_export($courseid)) {
873         $plugin_info['export'] = $exports;
874     }
876     foreach ($plugin_info as $plugin_type => $plugins) {
877         if (!empty($plugins->id) && $active_plugin == $plugins->id) {
878             $plugin_info['strings']['active_plugin_str'] = $plugins->string;
879             break;
880         }
881         foreach ($plugins as $plugin) {
882             if (is_a($plugin, 'grade_plugin_info')) {
883                 if ($active_plugin == $plugin->id) {
884                     $plugin_info['strings']['active_plugin_str'] = $plugin->string;
885                 }
886             }
887         }
888     }
890     return $plugin_info;
893 /**
894  * A simple class containing info about grade plugins.
895  * Can be subclassed for special rules
896  *
897  * @package core_grades
898  * @copyright 2009 Nicolas Connault
899  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
900  */
901 class grade_plugin_info {
902     /**
903      * A unique id for this plugin
904      *
905      * @var mixed
906      */
907     public $id;
908     /**
909      * A URL to access this plugin
910      *
911      * @var mixed
912      */
913     public $link;
914     /**
915      * The name of this plugin
916      *
917      * @var mixed
918      */
919     public $string;
920     /**
921      * Another grade_plugin_info object, parent of the current one
922      *
923      * @var mixed
924      */
925     public $parent;
927     /**
928      * Constructor
929      *
930      * @param int $id A unique id for this plugin
931      * @param string $link A URL to access this plugin
932      * @param string $string The name of this plugin
933      * @param object $parent Another grade_plugin_info object, parent of the current one
934      *
935      * @return void
936      */
937     public function __construct($id, $link, $string, $parent=null) {
938         $this->id = $id;
939         $this->link = $link;
940         $this->string = $string;
941         $this->parent = $parent;
942     }
945 /**
946  * Prints the page headers, breadcrumb trail, page heading, (optional) dropdown navigation menu and
947  * (optional) navigation tabs for any gradebook page. All gradebook pages MUST use these functions
948  * in favour of the usual print_header(), print_header_simple(), print_heading() etc.
949  * !IMPORTANT! Use of tabs.php file in gradebook pages is forbidden unless tabs are switched off at
950  * the site level for the gradebook ($CFG->grade_navmethod = GRADE_NAVMETHOD_DROPDOWN).
951  *
952  * @param int     $courseid Course id
953  * @param string  $active_type The type of the current page (report, settings,
954  *                             import, export, scales, outcomes, letters)
955  * @param string  $active_plugin The plugin of the current page (grader, fullview etc...)
956  * @param string  $heading The heading of the page. Tries to guess if none is given
957  * @param boolean $return Whether to return (true) or echo (false) the HTML generated by this function
958  * @param string  $bodytags Additional attributes that will be added to the <body> tag
959  * @param string  $buttons Additional buttons to display on the page
960  * @param boolean $shownavigation should the gradebook navigation drop down (or tabs) be shown?
961  * @param string  $headerhelpidentifier The help string identifier if required.
962  * @param string  $headerhelpcomponent The component for the help string.
963  * @param stdClass $user The user object for use with the user context header.
964  *
965  * @return string HTML code or nothing if $return == false
966  */
967 function print_grade_page_head($courseid, $active_type, $active_plugin=null,
968                                $heading = false, $return=false,
969                                $buttons=false, $shownavigation=true, $headerhelpidentifier = null, $headerhelpcomponent = null,
970                                $user = null) {
971     global $CFG, $OUTPUT, $PAGE;
973     if ($active_type === 'preferences') {
974         // In Moodle 2.8 report preferences were moved under 'settings'. Allow backward compatibility for 3rd party grade reports.
975         $active_type = 'settings';
976     }
978     $plugin_info = grade_get_plugin_info($courseid, $active_type, $active_plugin);
980     // Determine the string of the active plugin
981     $stractive_plugin = ($active_plugin) ? $plugin_info['strings']['active_plugin_str'] : $heading;
982     $stractive_type = $plugin_info['strings'][$active_type];
984     if (empty($plugin_info[$active_type]->id) || !empty($plugin_info[$active_type]->parent)) {
985         $title = $PAGE->course->fullname.': ' . $stractive_type . ': ' . $stractive_plugin;
986     } else {
987         $title = $PAGE->course->fullname.': ' . $stractive_plugin;
988     }
990     if ($active_type == 'report') {
991         $PAGE->set_pagelayout('report');
992     } else {
993         $PAGE->set_pagelayout('admin');
994     }
995     $PAGE->set_title(get_string('grades') . ': ' . $stractive_type);
996     $PAGE->set_heading($title);
997     if ($buttons instanceof single_button) {
998         $buttons = $OUTPUT->render($buttons);
999     }
1000     $PAGE->set_button($buttons);
1001     if ($courseid != SITEID) {
1002         grade_extend_settings($plugin_info, $courseid);
1003     }
1005     // Set the current report as active in the breadcrumbs.
1006     if ($active_plugin !== null && $reportnav = $PAGE->settingsnav->find($active_plugin, navigation_node::TYPE_SETTING)) {
1007         $reportnav->make_active();
1008     }
1010     $returnval = $OUTPUT->header();
1012     if (!$return) {
1013         echo $returnval;
1014     }
1016     // Guess heading if not given explicitly
1017     if (!$heading) {
1018         $heading = $stractive_plugin;
1019     }
1021     if ($shownavigation) {
1022         $navselector = null;
1023         if ($courseid != SITEID &&
1024                 ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_DROPDOWN)) {
1025             // It's absolutely essential that this grade plugin selector is shown after the user header. Just ask Fred.
1026             $navselector = print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, true);
1027             if ($return) {
1028                 $returnval .= $navselector;
1029             } else if (!isset($user)) {
1030                 echo $navselector;
1031             }
1032         }
1034         $output = '';
1035         // Add a help dialogue box if provided.
1036         if (isset($headerhelpidentifier)) {
1037             $output = $OUTPUT->heading_with_help($heading, $headerhelpidentifier, $headerhelpcomponent);
1038         } else {
1039             if (isset($user)) {
1040                 $output = $OUTPUT->context_header(
1041                         array(
1042                             'heading' => fullname($user),
1043                             'user' => $user,
1044                             'usercontext' => context_user::instance($user->id)
1045                         ), 2
1046                     ) . $navselector;
1047             } else {
1048                 $output = $OUTPUT->heading($heading);
1049             }
1050         }
1052         if ($return) {
1053             $returnval .= $output;
1054         } else {
1055             echo $output;
1056         }
1058         if ($courseid != SITEID &&
1059                 ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_TABS)) {
1060             $returnval .= grade_print_tabs($active_type, $active_plugin, $plugin_info, $return);
1061         }
1062     }
1064     $returnval .= print_natural_aggregation_upgrade_notice($courseid,
1065                                                            context_course::instance($courseid),
1066                                                            $PAGE->url,
1067                                                            $return);
1069     if ($return) {
1070         return $returnval;
1071     }
1074 /**
1075  * Utility class used for return tracking when using edit and other forms in grade plugins
1076  *
1077  * @package core_grades
1078  * @copyright 2009 Nicolas Connault
1079  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1080  */
1081 class grade_plugin_return {
1082     public $type;
1083     public $plugin;
1084     public $courseid;
1085     public $userid;
1086     public $page;
1088     /**
1089      * Constructor
1090      *
1091      * @param array $params - associative array with return parameters, if null parameter are taken from _GET or _POST
1092      */
1093     public function __construct($params = null) {
1094         if (empty($params)) {
1095             $this->type     = optional_param('gpr_type', null, PARAM_SAFEDIR);
1096             $this->plugin   = optional_param('gpr_plugin', null, PARAM_PLUGIN);
1097             $this->courseid = optional_param('gpr_courseid', null, PARAM_INT);
1098             $this->userid   = optional_param('gpr_userid', null, PARAM_INT);
1099             $this->page     = optional_param('gpr_page', null, PARAM_INT);
1101         } else {
1102             foreach ($params as $key=>$value) {
1103                 if (property_exists($this, $key)) {
1104                     $this->$key = $value;
1105                 }
1106             }
1107         }
1108     }
1110     /**
1111      * Old syntax of class constructor. Deprecated in PHP7.
1112      *
1113      * @deprecated since Moodle 3.1
1114      */
1115     public function grade_plugin_return($params = null) {
1116         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
1117         self::__construct($params);
1118     }
1120     /**
1121      * Returns return parameters as options array suitable for buttons.
1122      * @return array options
1123      */
1124     public function get_options() {
1125         if (empty($this->type)) {
1126             return array();
1127         }
1129         $params = array();
1131         if (!empty($this->plugin)) {
1132             $params['plugin'] = $this->plugin;
1133         }
1135         if (!empty($this->courseid)) {
1136             $params['id'] = $this->courseid;
1137         }
1139         if (!empty($this->userid)) {
1140             $params['userid'] = $this->userid;
1141         }
1143         if (!empty($this->page)) {
1144             $params['page'] = $this->page;
1145         }
1147         return $params;
1148     }
1150     /**
1151      * Returns return url
1152      *
1153      * @param string $default default url when params not set
1154      * @param array  $extras Extra URL parameters
1155      *
1156      * @return string url
1157      */
1158     public function get_return_url($default, $extras=null) {
1159         global $CFG;
1161         if (empty($this->type) or empty($this->plugin)) {
1162             return $default;
1163         }
1165         $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php';
1166         $glue = '?';
1168         if (!empty($this->courseid)) {
1169             $url .= $glue.'id='.$this->courseid;
1170             $glue = '&amp;';
1171         }
1173         if (!empty($this->userid)) {
1174             $url .= $glue.'userid='.$this->userid;
1175             $glue = '&amp;';
1176         }
1178         if (!empty($this->page)) {
1179             $url .= $glue.'page='.$this->page;
1180             $glue = '&amp;';
1181         }
1183         if (!empty($extras)) {
1184             foreach ($extras as $key=>$value) {
1185                 $url .= $glue.$key.'='.$value;
1186                 $glue = '&amp;';
1187             }
1188         }
1190         return $url;
1191     }
1193     /**
1194      * Returns string with hidden return tracking form elements.
1195      * @return string
1196      */
1197     public function get_form_fields() {
1198         if (empty($this->type)) {
1199             return '';
1200         }
1202         $result  = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />';
1204         if (!empty($this->plugin)) {
1205             $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />';
1206         }
1208         if (!empty($this->courseid)) {
1209             $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />';
1210         }
1212         if (!empty($this->userid)) {
1213             $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />';
1214         }
1216         if (!empty($this->page)) {
1217             $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />';
1218         }
1219     }
1221     /**
1222      * Add hidden elements into mform
1223      *
1224      * @param object &$mform moodle form object
1225      *
1226      * @return void
1227      */
1228     public function add_mform_elements(&$mform) {
1229         if (empty($this->type)) {
1230             return;
1231         }
1233         $mform->addElement('hidden', 'gpr_type', $this->type);
1234         $mform->setType('gpr_type', PARAM_SAFEDIR);
1236         if (!empty($this->plugin)) {
1237             $mform->addElement('hidden', 'gpr_plugin', $this->plugin);
1238             $mform->setType('gpr_plugin', PARAM_PLUGIN);
1239         }
1241         if (!empty($this->courseid)) {
1242             $mform->addElement('hidden', 'gpr_courseid', $this->courseid);
1243             $mform->setType('gpr_courseid', PARAM_INT);
1244         }
1246         if (!empty($this->userid)) {
1247             $mform->addElement('hidden', 'gpr_userid', $this->userid);
1248             $mform->setType('gpr_userid', PARAM_INT);
1249         }
1251         if (!empty($this->page)) {
1252             $mform->addElement('hidden', 'gpr_page', $this->page);
1253             $mform->setType('gpr_page', PARAM_INT);
1254         }
1255     }
1257     /**
1258      * Add return tracking params into url
1259      *
1260      * @param moodle_url $url A URL
1261      *
1262      * @return string $url with return tracking params
1263      */
1264     public function add_url_params(moodle_url $url) {
1265         if (empty($this->type)) {
1266             return $url;
1267         }
1269         $url->param('gpr_type', $this->type);
1271         if (!empty($this->plugin)) {
1272             $url->param('gpr_plugin', $this->plugin);
1273         }
1275         if (!empty($this->courseid)) {
1276             $url->param('gpr_courseid' ,$this->courseid);
1277         }
1279         if (!empty($this->userid)) {
1280             $url->param('gpr_userid', $this->userid);
1281         }
1283         if (!empty($this->page)) {
1284             $url->param('gpr_page', $this->page);
1285         }
1287         return $url;
1288     }
1291 /**
1292  * Function central to gradebook for building and printing the navigation (breadcrumb trail).
1293  *
1294  * @param string $path The path of the calling script (using __FILE__?)
1295  * @param string $pagename The language string to use as the last part of the navigation (non-link)
1296  * @param mixed  $id Either a plain integer (assuming the key is 'id') or
1297  *                   an array of keys and values (e.g courseid => $courseid, itemid...)
1298  *
1299  * @return string
1300  */
1301 function grade_build_nav($path, $pagename=null, $id=null) {
1302     global $CFG, $COURSE, $PAGE;
1304     $strgrades = get_string('grades', 'grades');
1306     // Parse the path and build navlinks from its elements
1307     $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash
1308     $path = substr($path, $dirroot_length);
1309     $path = str_replace('\\', '/', $path);
1311     $path_elements = explode('/', $path);
1313     $path_elements_count = count($path_elements);
1315     // First link is always 'grade'
1316     $PAGE->navbar->add($strgrades, new moodle_url('/grade/index.php', array('id'=>$COURSE->id)));
1318     $link = null;
1319     $numberofelements = 3;
1321     // Prepare URL params string
1322     $linkparams = array();
1323     if (!is_null($id)) {
1324         if (is_array($id)) {
1325             foreach ($id as $idkey => $idvalue) {
1326                 $linkparams[$idkey] = $idvalue;
1327             }
1328         } else {
1329             $linkparams['id'] = $id;
1330         }
1331     }
1333     $navlink4 = null;
1335     // Remove file extensions from filenames
1336     foreach ($path_elements as $key => $filename) {
1337         $path_elements[$key] = str_replace('.php', '', $filename);
1338     }
1340     // Second level links
1341     switch ($path_elements[1]) {
1342         case 'edit': // No link
1343             if ($path_elements[3] != 'index.php') {
1344                 $numberofelements = 4;
1345             }
1346             break;
1347         case 'import': // No link
1348             break;
1349         case 'export': // No link
1350             break;
1351         case 'report':
1352             // $id is required for this link. Do not print it if $id isn't given
1353             if (!is_null($id)) {
1354                 $link = new moodle_url('/grade/report/index.php', $linkparams);
1355             }
1357             if ($path_elements[2] == 'grader') {
1358                 $numberofelements = 4;
1359             }
1360             break;
1362         default:
1363             // If this element isn't among the ones already listed above, it isn't supported, throw an error.
1364             debugging("grade_build_nav() doesn't support ". $path_elements[1] .
1365                     " as the second path element after 'grade'.");
1366             return false;
1367     }
1368     $PAGE->navbar->add(get_string($path_elements[1], 'grades'), $link);
1370     // Third level links
1371     if (empty($pagename)) {
1372         $pagename = get_string($path_elements[2], 'grades');
1373     }
1375     switch ($numberofelements) {
1376         case 3:
1377             $PAGE->navbar->add($pagename, $link);
1378             break;
1379         case 4:
1380             if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') {
1381                 $PAGE->navbar->add(get_string('pluginname', 'gradereport_grader'), new moodle_url('/grade/report/grader/index.php', $linkparams));
1382             }
1383             $PAGE->navbar->add($pagename);
1384             break;
1385     }
1387     return '';
1390 /**
1391  * General structure representing grade items in course
1392  *
1393  * @package core_grades
1394  * @copyright 2009 Nicolas Connault
1395  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1396  */
1397 class grade_structure {
1398     public $context;
1400     public $courseid;
1402     /**
1403     * Reference to modinfo for current course (for performance, to save
1404     * retrieving it from courseid every time). Not actually set except for
1405     * the grade_tree type.
1406     * @var course_modinfo
1407     */
1408     public $modinfo;
1410     /**
1411      * 1D array of grade items only
1412      */
1413     public $items;
1415     /**
1416      * Returns icon of element
1417      *
1418      * @param array &$element An array representing an element in the grade_tree
1419      * @param bool  $spacerifnone return spacer if no icon found
1420      *
1421      * @return string icon or spacer
1422      */
1423     public function get_element_icon(&$element, $spacerifnone=false) {
1424         global $CFG, $OUTPUT;
1425         require_once $CFG->libdir.'/filelib.php';
1427         $outputstr = '';
1429         // Object holding pix_icon information before instantiation.
1430         $icon = new stdClass();
1431         $icon->attributes = array(
1432             'class' => 'icon itemicon'
1433         );
1434         $icon->component = 'moodle';
1436         $none = true;
1437         switch ($element['type']) {
1438             case 'item':
1439             case 'courseitem':
1440             case 'categoryitem':
1441                 $none = false;
1443                 $is_course   = $element['object']->is_course_item();
1444                 $is_category = $element['object']->is_category_item();
1445                 $is_scale    = $element['object']->gradetype == GRADE_TYPE_SCALE;
1446                 $is_value    = $element['object']->gradetype == GRADE_TYPE_VALUE;
1447                 $is_outcome  = !empty($element['object']->outcomeid);
1449                 if ($element['object']->is_calculated()) {
1450                     $icon->pix = 'i/calc';
1451                     $icon->title = s(get_string('calculatedgrade', 'grades'));
1453                 } else if (($is_course or $is_category) and ($is_scale or $is_value)) {
1454                     if ($category = $element['object']->get_item_category()) {
1455                         $aggrstrings = grade_helper::get_aggregation_strings();
1456                         $stragg = $aggrstrings[$category->aggregation];
1458                         $icon->pix = 'i/calc';
1459                         $icon->title = s($stragg);
1461                         switch ($category->aggregation) {
1462                             case GRADE_AGGREGATE_MEAN:
1463                             case GRADE_AGGREGATE_MEDIAN:
1464                             case GRADE_AGGREGATE_WEIGHTED_MEAN:
1465                             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
1466                             case GRADE_AGGREGATE_EXTRACREDIT_MEAN:
1467                                 $icon->pix = 'i/agg_mean';
1468                                 break;
1469                             case GRADE_AGGREGATE_SUM:
1470                                 $icon->pix = 'i/agg_sum';
1471                                 break;
1472                         }
1473                     }
1475                 } else if ($element['object']->itemtype == 'mod') {
1476                     // Prevent outcomes displaying the same icon as the activity they are attached to.
1477                     if ($is_outcome) {
1478                         $icon->pix = 'i/outcomes';
1479                         $icon->title = s(get_string('outcome', 'grades'));
1480                     } else {
1481                         $modinfo = get_fast_modinfo($element['object']->courseid);
1482                         $module = $element['object']->itemmodule;
1483                         $instanceid = $element['object']->iteminstance;
1484                         if (isset($modinfo->instances[$module][$instanceid])) {
1485                             $icon->url = $modinfo->instances[$module][$instanceid]->get_icon_url();
1486                         } else {
1487                             $icon->pix = 'icon';
1488                             $icon->component = $element['object']->itemmodule;
1489                         }
1490                         $icon->title = s(get_string('modulename', $element['object']->itemmodule));
1491                     }
1492                 } else if ($element['object']->itemtype == 'manual') {
1493                     if ($element['object']->is_outcome_item()) {
1494                         $icon->pix = 'i/outcomes';
1495                         $icon->title = s(get_string('outcome', 'grades'));
1496                     } else {
1497                         $icon->pix = 'i/manual_item';
1498                         $icon->title = s(get_string('manualitem', 'grades'));
1499                     }
1500                 }
1501                 break;
1503             case 'category':
1504                 $none = false;
1505                 $icon->pix = 'i/folder';
1506                 $icon->title = s(get_string('category', 'grades'));
1507                 break;
1508         }
1510         if ($none) {
1511             if ($spacerifnone) {
1512                 $outputstr = $OUTPUT->spacer() . ' ';
1513             }
1514         } else if (isset($icon->url)) {
1515             $outputstr = html_writer::img($icon->url, $icon->title, $icon->attributes);
1516         } else {
1517             $outputstr = $OUTPUT->pix_icon($icon->pix, $icon->title, $icon->component, $icon->attributes);
1518         }
1520         return $outputstr;
1521     }
1523     /**
1524      * Returns name of element optionally with icon and link
1525      *
1526      * @param array &$element An array representing an element in the grade_tree
1527      * @param bool  $withlink Whether or not this header has a link
1528      * @param bool  $icon Whether or not to display an icon with this header
1529      * @param bool  $spacerifnone return spacer if no icon found
1530      * @param bool  $withdescription Show description if defined by this item.
1531      * @param bool  $fulltotal If the item is a category total, returns $categoryname."total"
1532      *                         instead of "Category total" or "Course total"
1533      *
1534      * @return string header
1535      */
1536     public function get_element_header(&$element, $withlink = false, $icon = true, $spacerifnone = false,
1537         $withdescription = false, $fulltotal = false) {
1538         $header = '';
1540         if ($icon) {
1541             $header .= $this->get_element_icon($element, $spacerifnone);
1542         }
1544         $header .= $element['object']->get_name($fulltotal);
1546         if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and
1547             $element['type'] != 'courseitem') {
1548             return $header;
1549         }
1551         if ($withlink && $url = $this->get_activity_link($element)) {
1552             $a = new stdClass();
1553             $a->name = get_string('modulename', $element['object']->itemmodule);
1554             $title = get_string('linktoactivity', 'grades', $a);
1556             $header = html_writer::link($url, $header, array('title' => $title));
1557         } else {
1558             $header = html_writer::span($header);
1559         }
1561         if ($withdescription) {
1562             $desc = $element['object']->get_description();
1563             if (!empty($desc)) {
1564                 $header .= '<div class="gradeitemdescription">' . s($desc) . '</div><div class="gradeitemdescriptionfiller"></div>';
1565             }
1566         }
1568         return $header;
1569     }
1571     private function get_activity_link($element) {
1572         global $CFG;
1573         /** @var array static cache of the grade.php file existence flags */
1574         static $hasgradephp = array();
1576         $itemtype = $element['object']->itemtype;
1577         $itemmodule = $element['object']->itemmodule;
1578         $iteminstance = $element['object']->iteminstance;
1579         $itemnumber = $element['object']->itemnumber;
1581         // Links only for module items that have valid instance, module and are
1582         // called from grade_tree with valid modinfo
1583         if ($itemtype != 'mod' || !$iteminstance || !$itemmodule || !$this->modinfo) {
1584             return null;
1585         }
1587         // Get $cm efficiently and with visibility information using modinfo
1588         $instances = $this->modinfo->get_instances();
1589         if (empty($instances[$itemmodule][$iteminstance])) {
1590             return null;
1591         }
1592         $cm = $instances[$itemmodule][$iteminstance];
1594         // Do not add link if activity is not visible to the current user
1595         if (!$cm->uservisible) {
1596             return null;
1597         }
1599         if (!array_key_exists($itemmodule, $hasgradephp)) {
1600             if (file_exists($CFG->dirroot . '/mod/' . $itemmodule . '/grade.php')) {
1601                 $hasgradephp[$itemmodule] = true;
1602             } else {
1603                 $hasgradephp[$itemmodule] = false;
1604             }
1605         }
1607         // If module has grade.php, link to that, otherwise view.php
1608         if ($hasgradephp[$itemmodule]) {
1609             $args = array('id' => $cm->id, 'itemnumber' => $itemnumber);
1610             if (isset($element['userid'])) {
1611                 $args['userid'] = $element['userid'];
1612             }
1613             return new moodle_url('/mod/' . $itemmodule . '/grade.php', $args);
1614         } else {
1615             return new moodle_url('/mod/' . $itemmodule . '/view.php', array('id' => $cm->id));
1616         }
1617     }
1619     /**
1620      * Returns URL of a page that is supposed to contain detailed grade analysis
1621      *
1622      * At the moment, only activity modules are supported. The method generates link
1623      * to the module's file grade.php with the parameters id (cmid), itemid, itemnumber,
1624      * gradeid and userid. If the grade.php does not exist, null is returned.
1625      *
1626      * @return moodle_url|null URL or null if unable to construct it
1627      */
1628     public function get_grade_analysis_url(grade_grade $grade) {
1629         global $CFG;
1630         /** @var array static cache of the grade.php file existence flags */
1631         static $hasgradephp = array();
1633         if (empty($grade->grade_item) or !($grade->grade_item instanceof grade_item)) {
1634             throw new coding_exception('Passed grade without the associated grade item');
1635         }
1636         $item = $grade->grade_item;
1638         if (!$item->is_external_item()) {
1639             // at the moment, only activity modules are supported
1640             return null;
1641         }
1642         if ($item->itemtype !== 'mod') {
1643             throw new coding_exception('Unknown external itemtype: '.$item->itemtype);
1644         }
1645         if (empty($item->iteminstance) or empty($item->itemmodule) or empty($this->modinfo)) {
1646             return null;
1647         }
1649         if (!array_key_exists($item->itemmodule, $hasgradephp)) {
1650             if (file_exists($CFG->dirroot . '/mod/' . $item->itemmodule . '/grade.php')) {
1651                 $hasgradephp[$item->itemmodule] = true;
1652             } else {
1653                 $hasgradephp[$item->itemmodule] = false;
1654             }
1655         }
1657         if (!$hasgradephp[$item->itemmodule]) {
1658             return null;
1659         }
1661         $instances = $this->modinfo->get_instances();
1662         if (empty($instances[$item->itemmodule][$item->iteminstance])) {
1663             return null;
1664         }
1665         $cm = $instances[$item->itemmodule][$item->iteminstance];
1666         if (!$cm->uservisible) {
1667             return null;
1668         }
1670         $url = new moodle_url('/mod/'.$item->itemmodule.'/grade.php', array(
1671             'id'         => $cm->id,
1672             'itemid'     => $item->id,
1673             'itemnumber' => $item->itemnumber,
1674             'gradeid'    => $grade->id,
1675             'userid'     => $grade->userid,
1676         ));
1678         return $url;
1679     }
1681     /**
1682      * Returns an action icon leading to the grade analysis page
1683      *
1684      * @param grade_grade $grade
1685      * @return string
1686      */
1687     public function get_grade_analysis_icon(grade_grade $grade) {
1688         global $OUTPUT;
1690         $url = $this->get_grade_analysis_url($grade);
1691         if (is_null($url)) {
1692             return '';
1693         }
1695         return $OUTPUT->action_icon($url, new pix_icon('t/preview',
1696             get_string('gradeanalysis', 'core_grades')));
1697     }
1699     /**
1700      * Returns the grade eid - the grade may not exist yet.
1701      *
1702      * @param grade_grade $grade_grade A grade_grade object
1703      *
1704      * @return string eid
1705      */
1706     public function get_grade_eid($grade_grade) {
1707         if (empty($grade_grade->id)) {
1708             return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid;
1709         } else {
1710             return 'g'.$grade_grade->id;
1711         }
1712     }
1714     /**
1715      * Returns the grade_item eid
1716      * @param grade_item $grade_item A grade_item object
1717      * @return string eid
1718      */
1719     public function get_item_eid($grade_item) {
1720         return 'ig'.$grade_item->id;
1721     }
1723     /**
1724      * Given a grade_tree element, returns an array of parameters
1725      * used to build an icon for that element.
1726      *
1727      * @param array $element An array representing an element in the grade_tree
1728      *
1729      * @return array
1730      */
1731     public function get_params_for_iconstr($element) {
1732         $strparams = new stdClass();
1733         $strparams->category = '';
1734         $strparams->itemname = '';
1735         $strparams->itemmodule = '';
1737         if (!method_exists($element['object'], 'get_name')) {
1738             return $strparams;
1739         }
1741         $strparams->itemname = html_to_text($element['object']->get_name());
1743         // If element name is categorytotal, get the name of the parent category
1744         if ($strparams->itemname == get_string('categorytotal', 'grades')) {
1745             $parent = $element['object']->get_parent_category();
1746             $strparams->category = $parent->get_name() . ' ';
1747         } else {
1748             $strparams->category = '';
1749         }
1751         $strparams->itemmodule = null;
1752         if (isset($element['object']->itemmodule)) {
1753             $strparams->itemmodule = $element['object']->itemmodule;
1754         }
1755         return $strparams;
1756     }
1758     /**
1759      * Return a reset icon for the given element.
1760      *
1761      * @param array  $element An array representing an element in the grade_tree
1762      * @param object $gpr A grade_plugin_return object
1763      * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1764      * @return string|action_menu_link
1765      */
1766     public function get_reset_icon($element, $gpr, $returnactionmenulink = false) {
1767         global $CFG, $OUTPUT;
1769         // Limit to category items set to use the natural weights aggregation method, and users
1770         // with the capability to manage grades.
1771         if ($element['type'] != 'category' || $element['object']->aggregation != GRADE_AGGREGATE_SUM ||
1772                 !has_capability('moodle/grade:manage', $this->context)) {
1773             return $returnactionmenulink ? null : '';
1774         }
1776         $str = get_string('resetweights', 'grades', $this->get_params_for_iconstr($element));
1777         $url = new moodle_url('/grade/edit/tree/action.php', array(
1778             'id' => $this->courseid,
1779             'action' => 'resetweights',
1780             'eid' => $element['eid'],
1781             'sesskey' => sesskey(),
1782         ));
1784         if ($returnactionmenulink) {
1785             return new action_menu_link_secondary($gpr->add_url_params($url), new pix_icon('t/reset', $str),
1786                 get_string('resetweightsshort', 'grades'));
1787         } else {
1788             return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/reset', $str));
1789         }
1790     }
1792     /**
1793      * Return edit icon for give element
1794      *
1795      * @param array  $element An array representing an element in the grade_tree
1796      * @param object $gpr A grade_plugin_return object
1797      * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1798      * @return string|action_menu_link
1799      */
1800     public function get_edit_icon($element, $gpr, $returnactionmenulink = false) {
1801         global $CFG, $OUTPUT;
1803         if (!has_capability('moodle/grade:manage', $this->context)) {
1804             if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) {
1805                 // oki - let them override grade
1806             } else {
1807                 return $returnactionmenulink ? null : '';
1808             }
1809         }
1811         static $strfeedback   = null;
1812         static $streditgrade = null;
1813         if (is_null($streditgrade)) {
1814             $streditgrade = get_string('editgrade', 'grades');
1815             $strfeedback  = get_string('feedback');
1816         }
1818         $strparams = $this->get_params_for_iconstr($element);
1820         $object = $element['object'];
1822         switch ($element['type']) {
1823             case 'item':
1824             case 'categoryitem':
1825             case 'courseitem':
1826                 $stredit = get_string('editverbose', 'grades', $strparams);
1827                 if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) {
1828                     $url = new moodle_url('/grade/edit/tree/item.php',
1829                             array('courseid' => $this->courseid, 'id' => $object->id));
1830                 } else {
1831                     $url = new moodle_url('/grade/edit/tree/outcomeitem.php',
1832                             array('courseid' => $this->courseid, 'id' => $object->id));
1833                 }
1834                 break;
1836             case 'category':
1837                 $stredit = get_string('editverbose', 'grades', $strparams);
1838                 $url = new moodle_url('/grade/edit/tree/category.php',
1839                         array('courseid' => $this->courseid, 'id' => $object->id));
1840                 break;
1842             case 'grade':
1843                 $stredit = $streditgrade;
1844                 if (empty($object->id)) {
1845                     $url = new moodle_url('/grade/edit/tree/grade.php',
1846                             array('courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid));
1847                 } else {
1848                     $url = new moodle_url('/grade/edit/tree/grade.php',
1849                             array('courseid' => $this->courseid, 'id' => $object->id));
1850                 }
1851                 if (!empty($object->feedback)) {
1852                     $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat)));
1853                 }
1854                 break;
1856             default:
1857                 $url = null;
1858         }
1860         if ($url) {
1861             if ($returnactionmenulink) {
1862                 return new action_menu_link_secondary($gpr->add_url_params($url),
1863                     new pix_icon('t/edit', $stredit),
1864                     get_string('editsettings'));
1865             } else {
1866                 return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/edit', $stredit));
1867             }
1869         } else {
1870             return $returnactionmenulink ? null : '';
1871         }
1872     }
1874     /**
1875      * Return hiding icon for give element
1876      *
1877      * @param array  $element An array representing an element in the grade_tree
1878      * @param object $gpr A grade_plugin_return object
1879      * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1880      * @return string|action_menu_link
1881      */
1882     public function get_hiding_icon($element, $gpr, $returnactionmenulink = false) {
1883         global $CFG, $OUTPUT;
1885         if (!$element['object']->can_control_visibility()) {
1886             return $returnactionmenulink ? null : '';
1887         }
1889         if (!has_capability('moodle/grade:manage', $this->context) and
1890             !has_capability('moodle/grade:hide', $this->context)) {
1891             return $returnactionmenulink ? null : '';
1892         }
1894         $strparams = $this->get_params_for_iconstr($element);
1895         $strshow = get_string('showverbose', 'grades', $strparams);
1896         $strhide = get_string('hideverbose', 'grades', $strparams);
1898         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1899         $url = $gpr->add_url_params($url);
1901         if ($element['object']->is_hidden()) {
1902             $type = 'show';
1903             $tooltip = $strshow;
1905             // Change the icon and add a tooltip showing the date
1906             if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) {
1907                 $type = 'hiddenuntil';
1908                 $tooltip = get_string('hiddenuntildate', 'grades',
1909                         userdate($element['object']->get_hidden()));
1910             }
1912             $url->param('action', 'show');
1914             if ($returnactionmenulink) {
1915                 $hideicon = new action_menu_link_secondary($url, new pix_icon('t/'.$type, $tooltip), get_string('show'));
1916             } else {
1917                 $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strshow, 'class'=>'smallicon')));
1918             }
1920         } else {
1921             $url->param('action', 'hide');
1922             if ($returnactionmenulink) {
1923                 $hideicon = new action_menu_link_secondary($url, new pix_icon('t/hide', $strhide), get_string('hide'));
1924             } else {
1925                 $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/hide', $strhide));
1926             }
1927         }
1929         return $hideicon;
1930     }
1932     /**
1933      * Return locking icon for given element
1934      *
1935      * @param array  $element An array representing an element in the grade_tree
1936      * @param object $gpr A grade_plugin_return object
1937      *
1938      * @return string
1939      */
1940     public function get_locking_icon($element, $gpr) {
1941         global $CFG, $OUTPUT;
1943         $strparams = $this->get_params_for_iconstr($element);
1944         $strunlock = get_string('unlockverbose', 'grades', $strparams);
1945         $strlock = get_string('lockverbose', 'grades', $strparams);
1947         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1948         $url = $gpr->add_url_params($url);
1950         // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon
1951         if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) {
1952             $strparamobj = new stdClass();
1953             $strparamobj->itemname = $element['object']->grade_item->itemname;
1954             $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj);
1956             $action = html_writer::tag('span', $OUTPUT->pix_icon('t/locked', $strnonunlockable),
1957                     array('class' => 'action-icon'));
1959         } else if ($element['object']->is_locked()) {
1960             $type = 'unlock';
1961             $tooltip = $strunlock;
1963             // Change the icon and add a tooltip showing the date
1964             if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) {
1965                 $type = 'locktime';
1966                 $tooltip = get_string('locktimedate', 'grades',
1967                         userdate($element['object']->get_locktime()));
1968             }
1970             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) {
1971                 $action = '';
1972             } else {
1973                 $url->param('action', 'unlock');
1974                 $action = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strunlock, 'class'=>'smallicon')));
1975             }
1977         } else {
1978             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) {
1979                 $action = '';
1980             } else {
1981                 $url->param('action', 'lock');
1982                 $action = $OUTPUT->action_icon($url, new pix_icon('t/lock', $strlock));
1983             }
1984         }
1986         return $action;
1987     }
1989     /**
1990      * Return calculation icon for given element
1991      *
1992      * @param array  $element An array representing an element in the grade_tree
1993      * @param object $gpr A grade_plugin_return object
1994      * @param bool $returnactionmenulink return the instance of action_menu_link instead of string
1995      * @return string|action_menu_link
1996      */
1997     public function get_calculation_icon($element, $gpr, $returnactionmenulink = false) {
1998         global $CFG, $OUTPUT;
1999         if (!has_capability('moodle/grade:manage', $this->context)) {
2000             return $returnactionmenulink ? null : '';
2001         }
2003         $type   = $element['type'];
2004         $object = $element['object'];
2006         if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') {
2007             $strparams = $this->get_params_for_iconstr($element);
2008             $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams);
2010             $is_scale = $object->gradetype == GRADE_TYPE_SCALE;
2011             $is_value = $object->gradetype == GRADE_TYPE_VALUE;
2013             // show calculation icon only when calculation possible
2014             if (!$object->is_external_item() and ($is_scale or $is_value)) {
2015                 if ($object->is_calculated()) {
2016                     $icon = 't/calc';
2017                 } else {
2018                     $icon = 't/calc_off';
2019                 }
2021                 $url = new moodle_url('/grade/edit/tree/calculation.php', array('courseid' => $this->courseid, 'id' => $object->id));
2022                 $url = $gpr->add_url_params($url);
2023                 if ($returnactionmenulink) {
2024                     return new action_menu_link_secondary($url,
2025                         new pix_icon($icon, $streditcalculation),
2026                         get_string('editcalculation', 'grades'));
2027                 } else {
2028                     return $OUTPUT->action_icon($url, new pix_icon($icon, $streditcalculation));
2029                 }
2030             }
2031         }
2033         return $returnactionmenulink ? null : '';
2034     }
2037 /**
2038  * Flat structure similar to grade tree.
2039  *
2040  * @uses grade_structure
2041  * @package core_grades
2042  * @copyright 2009 Nicolas Connault
2043  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2044  */
2045 class grade_seq extends grade_structure {
2047     /**
2048      * 1D array of elements
2049      */
2050     public $elements;
2052     /**
2053      * Constructor, retrieves and stores array of all grade_category and grade_item
2054      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
2055      *
2056      * @param int  $courseid The course id
2057      * @param bool $category_grade_last category grade item is the last child
2058      * @param bool $nooutcomes Whether or not outcomes should be included
2059      */
2060     public function __construct($courseid, $category_grade_last=false, $nooutcomes=false) {
2061         global $USER, $CFG;
2063         $this->courseid   = $courseid;
2064         $this->context    = context_course::instance($courseid);
2066         // get course grade tree
2067         $top_element = grade_category::fetch_course_tree($courseid, true);
2069         $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes);
2071         foreach ($this->elements as $key=>$unused) {
2072             $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object'];
2073         }
2074     }
2076     /**
2077      * Old syntax of class constructor. Deprecated in PHP7.
2078      *
2079      * @deprecated since Moodle 3.1
2080      */
2081     public function grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) {
2082         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
2083         self::__construct($courseid, $category_grade_last, $nooutcomes);
2084     }
2086     /**
2087      * Static recursive helper - makes the grade_item for category the last children
2088      *
2089      * @param array &$element The seed of the recursion
2090      * @param bool $category_grade_last category grade item is the last child
2091      * @param bool $nooutcomes Whether or not outcomes should be included
2092      *
2093      * @return array
2094      */
2095     public function flatten(&$element, $category_grade_last, $nooutcomes) {
2096         if (empty($element['children'])) {
2097             return array();
2098         }
2099         $children = array();
2101         foreach ($element['children'] as $sortorder=>$unused) {
2102             if ($nooutcomes and $element['type'] != 'category' and
2103                 $element['children'][$sortorder]['object']->is_outcome_item()) {
2104                 continue;
2105             }
2106             $children[] = $element['children'][$sortorder];
2107         }
2108         unset($element['children']);
2110         if ($category_grade_last and count($children) > 1) {
2111             $cat_item = array_shift($children);
2112             array_push($children, $cat_item);
2113         }
2115         $result = array();
2116         foreach ($children as $child) {
2117             if ($child['type'] == 'category') {
2118                 $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes);
2119             } else {
2120                 $child['eid'] = 'i'.$child['object']->id;
2121                 $result[$child['object']->id] = $child;
2122             }
2123         }
2125         return $result;
2126     }
2128     /**
2129      * Parses the array in search of a given eid and returns a element object with
2130      * information about the element it has found.
2131      *
2132      * @param int $eid Gradetree Element ID
2133      *
2134      * @return object element
2135      */
2136     public function locate_element($eid) {
2137         // it is a grade - construct a new object
2138         if (strpos($eid, 'n') === 0) {
2139             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
2140                 return null;
2141             }
2143             $itemid = $matches[1];
2144             $userid = $matches[2];
2146             //extra security check - the grade item must be in this tree
2147             if (!$item_el = $this->locate_element('ig'.$itemid)) {
2148                 return null;
2149             }
2151             // $gradea->id may be null - means does not exist yet
2152             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
2154             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2155             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
2157         } else if (strpos($eid, 'g') === 0) {
2158             $id = (int) substr($eid, 1);
2159             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
2160                 return null;
2161             }
2162             //extra security check - the grade item must be in this tree
2163             if (!$item_el = $this->locate_element('ig'.$grade->itemid)) {
2164                 return null;
2165             }
2166             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2167             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
2168         }
2170         // it is a category or item
2171         foreach ($this->elements as $element) {
2172             if ($element['eid'] == $eid) {
2173                 return $element;
2174             }
2175         }
2177         return null;
2178     }
2181 /**
2182  * This class represents a complete tree of categories, grade_items and final grades,
2183  * organises as an array primarily, but which can also be converted to other formats.
2184  * It has simple method calls with complex implementations, allowing for easy insertion,
2185  * deletion and moving of items and categories within the tree.
2186  *
2187  * @uses grade_structure
2188  * @package core_grades
2189  * @copyright 2009 Nicolas Connault
2190  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2191  */
2192 class grade_tree extends grade_structure {
2194     /**
2195      * The basic representation of the tree as a hierarchical, 3-tiered array.
2196      * @var object $top_element
2197      */
2198     public $top_element;
2200     /**
2201      * 2D array of grade items and categories
2202      * @var array $levels
2203      */
2204     public $levels;
2206     /**
2207      * Grade items
2208      * @var array $items
2209      */
2210     public $items;
2212     /**
2213      * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item
2214      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
2215      *
2216      * @param int   $courseid The Course ID
2217      * @param bool  $fillers include fillers and colspans, make the levels var "rectangular"
2218      * @param bool  $category_grade_last category grade item is the last child
2219      * @param array $collapsed array of collapsed categories
2220      * @param bool  $nooutcomes Whether or not outcomes should be included
2221      */
2222     public function __construct($courseid, $fillers=true, $category_grade_last=false,
2223                                $collapsed=null, $nooutcomes=false) {
2224         global $USER, $CFG, $COURSE, $DB;
2226         $this->courseid   = $courseid;
2227         $this->levels     = array();
2228         $this->context    = context_course::instance($courseid);
2230         if (!empty($COURSE->id) && $COURSE->id == $this->courseid) {
2231             $course = $COURSE;
2232         } else {
2233             $course = $DB->get_record('course', array('id' => $this->courseid));
2234         }
2235         $this->modinfo = get_fast_modinfo($course);
2237         // get course grade tree
2238         $this->top_element = grade_category::fetch_course_tree($courseid, true);
2240         // collapse the categories if requested
2241         if (!empty($collapsed)) {
2242             grade_tree::category_collapse($this->top_element, $collapsed);
2243         }
2245         // no otucomes if requested
2246         if (!empty($nooutcomes)) {
2247             grade_tree::no_outcomes($this->top_element);
2248         }
2250         // move category item to last position in category
2251         if ($category_grade_last) {
2252             grade_tree::category_grade_last($this->top_element);
2253         }
2255         if ($fillers) {
2256             // inject fake categories == fillers
2257             grade_tree::inject_fillers($this->top_element, 0);
2258             // add colspans to categories and fillers
2259             grade_tree::inject_colspans($this->top_element);
2260         }
2262         grade_tree::fill_levels($this->levels, $this->top_element, 0);
2264     }
2266     /**
2267      * Old syntax of class constructor. Deprecated in PHP7.
2268      *
2269      * @deprecated since Moodle 3.1
2270      */
2271     public function grade_tree($courseid, $fillers=true, $category_grade_last=false,
2272                                $collapsed=null, $nooutcomes=false) {
2273         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
2274         self::__construct($courseid, $fillers, $category_grade_last, $collapsed, $nooutcomes);
2275     }
2277     /**
2278      * Static recursive helper - removes items from collapsed categories
2279      *
2280      * @param array &$element The seed of the recursion
2281      * @param array $collapsed array of collapsed categories
2282      *
2283      * @return void
2284      */
2285     public function category_collapse(&$element, $collapsed) {
2286         if ($element['type'] != 'category') {
2287             return;
2288         }
2289         if (empty($element['children']) or count($element['children']) < 2) {
2290             return;
2291         }
2293         if (in_array($element['object']->id, $collapsed['aggregatesonly'])) {
2294             $category_item = reset($element['children']); //keep only category item
2295             $element['children'] = array(key($element['children'])=>$category_item);
2297         } else {
2298             if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item
2299                 reset($element['children']);
2300                 $first_key = key($element['children']);
2301                 unset($element['children'][$first_key]);
2302             }
2303             foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children
2304                 grade_tree::category_collapse($element['children'][$sortorder], $collapsed);
2305             }
2306         }
2307     }
2309     /**
2310      * Static recursive helper - removes all outcomes
2311      *
2312      * @param array &$element The seed of the recursion
2313      *
2314      * @return void
2315      */
2316     public function no_outcomes(&$element) {
2317         if ($element['type'] != 'category') {
2318             return;
2319         }
2320         foreach ($element['children'] as $sortorder=>$child) {
2321             if ($element['children'][$sortorder]['type'] == 'item'
2322               and $element['children'][$sortorder]['object']->is_outcome_item()) {
2323                 unset($element['children'][$sortorder]);
2325             } else if ($element['children'][$sortorder]['type'] == 'category') {
2326                 grade_tree::no_outcomes($element['children'][$sortorder]);
2327             }
2328         }
2329     }
2331     /**
2332      * Static recursive helper - makes the grade_item for category the last children
2333      *
2334      * @param array &$element The seed of the recursion
2335      *
2336      * @return void
2337      */
2338     public function category_grade_last(&$element) {
2339         if (empty($element['children'])) {
2340             return;
2341         }
2342         if (count($element['children']) < 2) {
2343             return;
2344         }
2345         $first_item = reset($element['children']);
2346         if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') {
2347             // the category item might have been already removed
2348             $order = key($element['children']);
2349             unset($element['children'][$order]);
2350             $element['children'][$order] =& $first_item;
2351         }
2352         foreach ($element['children'] as $sortorder => $child) {
2353             grade_tree::category_grade_last($element['children'][$sortorder]);
2354         }
2355     }
2357     /**
2358      * Static recursive helper - fills the levels array, useful when accessing tree elements of one level
2359      *
2360      * @param array &$levels The levels of the grade tree through which to recurse
2361      * @param array &$element The seed of the recursion
2362      * @param int   $depth How deep are we?
2363      * @return void
2364      */
2365     public function fill_levels(&$levels, &$element, $depth) {
2366         if (!array_key_exists($depth, $levels)) {
2367             $levels[$depth] = array();
2368         }
2370         // prepare unique identifier
2371         if ($element['type'] == 'category') {
2372             $element['eid'] = 'cg'.$element['object']->id;
2373         } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) {
2374             $element['eid'] = 'ig'.$element['object']->id;
2375             $this->items[$element['object']->id] =& $element['object'];
2376         }
2378         $levels[$depth][] =& $element;
2379         $depth++;
2380         if (empty($element['children'])) {
2381             return;
2382         }
2383         $prev = 0;
2384         foreach ($element['children'] as $sortorder=>$child) {
2385             grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth);
2386             $element['children'][$sortorder]['prev'] = $prev;
2387             $element['children'][$sortorder]['next'] = 0;
2388             if ($prev) {
2389                 $element['children'][$prev]['next'] = $sortorder;
2390             }
2391             $prev = $sortorder;
2392         }
2393     }
2395     /**
2396      * Determines whether the grade tree item can be displayed.
2397      * This is particularly targeted for grade categories that have no total (None) when rendering the grade tree.
2398      * It checks if the grade tree item is of type 'category', and makes sure that the category, or at least one of children,
2399      * can be output.
2400      *
2401      * @param array $element The grade category element.
2402      * @return bool True if the grade tree item can be displayed. False, otherwise.
2403      */
2404     public static function can_output_item($element) {
2405         $canoutput = true;
2407         if ($element['type'] === 'category') {
2408             $object = $element['object'];
2409             $category = grade_category::fetch(array('id' => $object->id));
2410             // Category has total, we can output this.
2411             if ($category->get_grade_item()->gradetype != GRADE_TYPE_NONE) {
2412                 return true;
2413             }
2415             // Category has no total and has no children, no need to output this.
2416             if (empty($element['children'])) {
2417                 return false;
2418             }
2420             $canoutput = false;
2421             // Loop over children and make sure at least one child can be output.
2422             foreach ($element['children'] as $child) {
2423                 $canoutput = self::can_output_item($child);
2424                 if ($canoutput) {
2425                     break;
2426                 }
2427             }
2428         }
2430         return $canoutput;
2431     }
2433     /**
2434      * Static recursive helper - makes full tree (all leafes are at the same level)
2435      *
2436      * @param array &$element The seed of the recursion
2437      * @param int   $depth How deep are we?
2438      *
2439      * @return int
2440      */
2441     public function inject_fillers(&$element, $depth) {
2442         $depth++;
2444         if (empty($element['children'])) {
2445             return $depth;
2446         }
2447         $chdepths = array();
2448         $chids = array_keys($element['children']);
2449         $last_child  = end($chids);
2450         $first_child = reset($chids);
2452         foreach ($chids as $chid) {
2453             $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth);
2454         }
2455         arsort($chdepths);
2457         $maxdepth = reset($chdepths);
2458         foreach ($chdepths as $chid=>$chd) {
2459             if ($chd == $maxdepth) {
2460                 continue;
2461             }
2462             if (!self::can_output_item($element['children'][$chid])) {
2463                 continue;
2464             }
2465             for ($i=0; $i < $maxdepth-$chd; $i++) {
2466                 if ($chid == $first_child) {
2467                     $type = 'fillerfirst';
2468                 } else if ($chid == $last_child) {
2469                     $type = 'fillerlast';
2470                 } else {
2471                     $type = 'filler';
2472                 }
2473                 $oldchild =& $element['children'][$chid];
2474                 $element['children'][$chid] = array('object'=>'filler', 'type'=>$type,
2475                                                     'eid'=>'', 'depth'=>$element['object']->depth,
2476                                                     'children'=>array($oldchild));
2477             }
2478         }
2480         return $maxdepth;
2481     }
2483     /**
2484      * Static recursive helper - add colspan information into categories
2485      *
2486      * @param array &$element The seed of the recursion
2487      *
2488      * @return int
2489      */
2490     public function inject_colspans(&$element) {
2491         if (empty($element['children'])) {
2492             return 1;
2493         }
2494         $count = 0;
2495         foreach ($element['children'] as $key=>$child) {
2496             if (!self::can_output_item($child)) {
2497                 continue;
2498             }
2499             $count += grade_tree::inject_colspans($element['children'][$key]);
2500         }
2501         $element['colspan'] = $count;
2502         return $count;
2503     }
2505     /**
2506      * Parses the array in search of a given eid and returns a element object with
2507      * information about the element it has found.
2508      * @param int $eid Gradetree Element ID
2509      * @return object element
2510      */
2511     public function locate_element($eid) {
2512         // it is a grade - construct a new object
2513         if (strpos($eid, 'n') === 0) {
2514             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
2515                 return null;
2516             }
2518             $itemid = $matches[1];
2519             $userid = $matches[2];
2521             //extra security check - the grade item must be in this tree
2522             if (!$item_el = $this->locate_element('ig'.$itemid)) {
2523                 return null;
2524             }
2526             // $gradea->id may be null - means does not exist yet
2527             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
2529             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2530             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
2532         } else if (strpos($eid, 'g') === 0) {
2533             $id = (int) substr($eid, 1);
2534             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
2535                 return null;
2536             }
2537             //extra security check - the grade item must be in this tree
2538             if (!$item_el = $this->locate_element('ig'.$grade->itemid)) {
2539                 return null;
2540             }
2541             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2542             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
2543         }
2545         // it is a category or item
2546         foreach ($this->levels as $row) {
2547             foreach ($row as $element) {
2548                 if ($element['type'] == 'filler') {
2549                     continue;
2550                 }
2551                 if ($element['eid'] == $eid) {
2552                     return $element;
2553                 }
2554             }
2555         }
2557         return null;
2558     }
2560     /**
2561      * Returns a well-formed XML representation of the grade-tree using recursion.
2562      *
2563      * @param array  $root The current element in the recursion. If null, starts at the top of the tree.
2564      * @param string $tabs The control character to use for tabs
2565      *
2566      * @return string $xml
2567      */
2568     public function exporttoxml($root=null, $tabs="\t") {
2569         $xml = null;
2570         $first = false;
2571         if (is_null($root)) {
2572             $root = $this->top_element;
2573             $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
2574             $xml .= "<gradetree>\n";
2575             $first = true;
2576         }
2578         $type = 'undefined';
2579         if (strpos($root['object']->table, 'grade_categories') !== false) {
2580             $type = 'category';
2581         } else if (strpos($root['object']->table, 'grade_items') !== false) {
2582             $type = 'item';
2583         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
2584             $type = 'outcome';
2585         }
2587         $xml .= "$tabs<element type=\"$type\">\n";
2588         foreach ($root['object'] as $var => $value) {
2589             if (!is_object($value) && !is_array($value) && !empty($value)) {
2590                 $xml .= "$tabs\t<$var>$value</$var>\n";
2591             }
2592         }
2594         if (!empty($root['children'])) {
2595             $xml .= "$tabs\t<children>\n";
2596             foreach ($root['children'] as $sortorder => $child) {
2597                 $xml .= $this->exportToXML($child, $tabs."\t\t");
2598             }
2599             $xml .= "$tabs\t</children>\n";
2600         }
2602         $xml .= "$tabs</element>\n";
2604         if ($first) {
2605             $xml .= "</gradetree>";
2606         }
2608         return $xml;
2609     }
2611     /**
2612      * Returns a JSON representation of the grade-tree using recursion.
2613      *
2614      * @param array $root The current element in the recursion. If null, starts at the top of the tree.
2615      * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy
2616      *
2617      * @return string
2618      */
2619     public function exporttojson($root=null, $tabs="\t") {
2620         $json = null;
2621         $first = false;
2622         if (is_null($root)) {
2623             $root = $this->top_element;
2624             $first = true;
2625         }
2627         $name = '';
2630         if (strpos($root['object']->table, 'grade_categories') !== false) {
2631             $name = $root['object']->fullname;
2632             if ($name == '?') {
2633                 $name = $root['object']->get_name();
2634             }
2635         } else if (strpos($root['object']->table, 'grade_items') !== false) {
2636             $name = $root['object']->itemname;
2637         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
2638             $name = $root['object']->itemname;
2639         }
2641         $json .= "$tabs {\n";
2642         $json .= "$tabs\t \"type\": \"{$root['type']}\",\n";
2643         $json .= "$tabs\t \"name\": \"$name\",\n";
2645         foreach ($root['object'] as $var => $value) {
2646             if (!is_object($value) && !is_array($value) && !empty($value)) {
2647                 $json .= "$tabs\t \"$var\": \"$value\",\n";
2648             }
2649         }
2651         $json = substr($json, 0, strrpos($json, ','));
2653         if (!empty($root['children'])) {
2654             $json .= ",\n$tabs\t\"children\": [\n";
2655             foreach ($root['children'] as $sortorder => $child) {
2656                 $json .= $this->exportToJSON($child, $tabs."\t\t");
2657             }
2658             $json = substr($json, 0, strrpos($json, ','));
2659             $json .= "\n$tabs\t]\n";
2660         }
2662         if ($first) {
2663             $json .= "\n}";
2664         } else {
2665             $json .= "\n$tabs},\n";
2666         }
2668         return $json;
2669     }
2671     /**
2672      * Returns the array of levels
2673      *
2674      * @return array
2675      */
2676     public function get_levels() {
2677         return $this->levels;
2678     }
2680     /**
2681      * Returns the array of grade items
2682      *
2683      * @return array
2684      */
2685     public function get_items() {
2686         return $this->items;
2687     }
2689     /**
2690      * Returns a specific Grade Item
2691      *
2692      * @param int $itemid The ID of the grade_item object
2693      *
2694      * @return grade_item
2695      */
2696     public function get_item($itemid) {
2697         if (array_key_exists($itemid, $this->items)) {
2698             return $this->items[$itemid];
2699         } else {
2700             return false;
2701         }
2702     }
2705 /**
2706  * Local shortcut function for creating an edit/delete button for a grade_* object.
2707  * @param string $type 'edit' or 'delete'
2708  * @param int $courseid The Course ID
2709  * @param grade_* $object The grade_* object
2710  * @return string html
2711  */
2712 function grade_button($type, $courseid, $object) {
2713     global $CFG, $OUTPUT;
2714     if (preg_match('/grade_(.*)/', get_class($object), $matches)) {
2715         $objectidstring = $matches[1] . 'id';
2716     } else {
2717         throw new coding_exception('grade_button() only accepts grade_* objects as third parameter!');
2718     }
2720     $strdelete = get_string('delete');
2721     $stredit   = get_string('edit');
2723     if ($type == 'delete') {
2724         $url = new moodle_url('index.php', array('id' => $courseid, $objectidstring => $object->id, 'action' => 'delete', 'sesskey' => sesskey()));
2725     } else if ($type == 'edit') {
2726         $url = new moodle_url('edit.php', array('courseid' => $courseid, 'id' => $object->id));
2727     }
2729     return $OUTPUT->action_icon($url, new pix_icon('t/'.$type, ${'str'.$type}, '', array('class' => 'iconsmall')));
2733 /**
2734  * This method adds settings to the settings block for the grade system and its
2735  * plugins
2736  *
2737  * @global moodle_page $PAGE
2738  */
2739 function grade_extend_settings($plugininfo, $courseid) {
2740     global $PAGE;
2742     $gradenode = $PAGE->settingsnav->prepend(get_string('gradeadministration', 'grades'), null, navigation_node::TYPE_CONTAINER);
2744     $strings = array_shift($plugininfo);
2746     if ($reports = grade_helper::get_plugins_reports($courseid)) {
2747         foreach ($reports as $report) {
2748             $gradenode->add($report->string, $report->link, navigation_node::TYPE_SETTING, null, $report->id, new pix_icon('i/report', ''));
2749         }
2750     }
2752     if ($settings = grade_helper::get_info_manage_settings($courseid)) {
2753         $settingsnode = $gradenode->add($strings['settings'], null, navigation_node::TYPE_CONTAINER);
2754         foreach ($settings as $setting) {
2755             $settingsnode->add($setting->string, $setting->link, navigation_node::TYPE_SETTING, null, $setting->id, new pix_icon('i/settings', ''));
2756         }
2757     }
2759     if ($imports = grade_helper::get_plugins_import($courseid)) {
2760         $importnode = $gradenode->add($strings['import'], null, navigation_node::TYPE_CONTAINER);
2761         foreach ($imports as $import) {
2762             $importnode->add($import->string, $import->link, navigation_node::TYPE_SETTING, null, $import->id, new pix_icon('i/import', ''));
2763         }
2764     }
2766     if ($exports = grade_helper::get_plugins_export($courseid)) {
2767         $exportnode = $gradenode->add($strings['export'], null, navigation_node::TYPE_CONTAINER);
2768         foreach ($exports as $export) {
2769             $exportnode->add($export->string, $export->link, navigation_node::TYPE_SETTING, null, $export->id, new pix_icon('i/export', ''));
2770         }
2771     }
2773     if ($letters = grade_helper::get_info_letters($courseid)) {
2774         $letters = array_shift($letters);
2775         $gradenode->add($strings['letter'], $letters->link, navigation_node::TYPE_SETTING, null, $letters->id, new pix_icon('i/settings', ''));
2776     }
2778     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
2779         $outcomes = array_shift($outcomes);
2780         $gradenode->add($strings['outcome'], $outcomes->link, navigation_node::TYPE_SETTING, null, $outcomes->id, new pix_icon('i/outcomes', ''));
2781     }
2783     if ($scales = grade_helper::get_info_scales($courseid)) {
2784         $gradenode->add($strings['scale'], $scales->link, navigation_node::TYPE_SETTING, null, $scales->id, new pix_icon('i/scales', ''));
2785     }
2787     if ($gradenode->contains_active_node()) {
2788         // If the gradenode is active include the settings base node (gradeadministration) in
2789         // the navbar, typcially this is ignored.
2790         $PAGE->navbar->includesettingsbase = true;
2792         // If we can get the course admin node make sure it is closed by default
2793         // as in this case the gradenode will be opened
2794         if ($coursenode = $PAGE->settingsnav->get('courseadmin', navigation_node::TYPE_COURSE)){
2795             $coursenode->make_inactive();
2796             $coursenode->forceopen = false;
2797         }
2798     }
2801 /**
2802  * Grade helper class
2803  *
2804  * This class provides several helpful functions that work irrespective of any
2805  * current state.
2806  *
2807  * @copyright 2010 Sam Hemelryk
2808  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2809  */
2810 abstract class grade_helper {
2811     /**
2812      * Cached manage settings info {@see get_info_settings}
2813      * @var grade_plugin_info|false
2814      */
2815     protected static $managesetting = null;
2816     /**
2817      * Cached grade report plugins {@see get_plugins_reports}
2818      * @var array|false
2819      */
2820     protected static $gradereports = null;
2821     /**
2822      * Cached grade report plugins preferences {@see get_info_scales}
2823      * @var array|false
2824      */
2825     protected static $gradereportpreferences = null;
2826     /**
2827      * Cached scale info {@see get_info_scales}
2828      * @var grade_plugin_info|false
2829      */
2830     protected static $scaleinfo = null;
2831     /**
2832      * Cached outcome info {@see get_info_outcomes}
2833      * @var grade_plugin_info|false
2834      */
2835     protected static $outcomeinfo = null;
2836     /**
2837      * Cached leftter info {@see get_info_letters}
2838      * @var grade_plugin_info|false
2839      */
2840     protected static $letterinfo = null;
2841     /**
2842      * Cached grade import plugins {@see get_plugins_import}
2843      * @var array|false
2844      */
2845     protected static $importplugins = null;
2846     /**
2847      * Cached grade export plugins {@see get_plugins_export}
2848      * @var array|false
2849      */
2850     protected static $exportplugins = null;
2851     /**
2852      * Cached grade plugin strings
2853      * @var array
2854      */
2855     protected static $pluginstrings = null;
2856     /**
2857      * Cached grade aggregation strings
2858      * @var array
2859      */
2860     protected static $aggregationstrings = null;
2862     /**
2863      * Gets strings commonly used by the describe plugins
2864      *
2865      * report => get_string('view'),
2866      * scale => get_string('scales'),
2867      * outcome => get_string('outcomes', 'grades'),
2868      * letter => get_string('letters', 'grades'),
2869      * export => get_string('export', 'grades'),
2870      * import => get_string('import'),
2871      * settings => get_string('settings')
2872      *
2873      * @return array
2874      */
2875     public static function get_plugin_strings() {
2876         if (self::$pluginstrings === null) {
2877             self::$pluginstrings = array(
2878                 'report' => get_string('view'),
2879                 'scale' => get_string('scales'),
2880                 'outcome' => get_string('outcomes', 'grades'),
2881                 'letter' => get_string('letters', 'grades'),
2882                 'export' => get_string('export', 'grades'),
2883                 'import' => get_string('import'),
2884                 'settings' => get_string('edittree', 'grades')
2885             );
2886         }
2887         return self::$pluginstrings;
2888     }
2890     /**
2891      * Gets strings describing the available aggregation methods.
2892      *
2893      * @return array
2894      */
2895     public static function get_aggregation_strings() {
2896         if (self::$aggregationstrings === null) {
2897             self::$aggregationstrings = array(
2898                 GRADE_AGGREGATE_MEAN             => get_string('aggregatemean', 'grades'),
2899                 GRADE_AGGREGATE_WEIGHTED_MEAN    => get_string('aggregateweightedmean', 'grades'),
2900                 GRADE_AGGREGATE_WEIGHTED_MEAN2   => get_string('aggregateweightedmean2', 'grades'),
2901                 GRADE_AGGREGATE_EXTRACREDIT_MEAN => get_string('aggregateextracreditmean', 'grades'),
2902                 GRADE_AGGREGATE_MEDIAN           => get_string('aggregatemedian', 'grades'),
2903                 GRADE_AGGREGATE_MIN              => get_string('aggregatemin', 'grades'),
2904                 GRADE_AGGREGATE_MAX              => get_string('aggregatemax', 'grades'),
2905                 GRADE_AGGREGATE_MODE             => get_string('aggregatemode', 'grades'),
2906                 GRADE_AGGREGATE_SUM              => get_string('aggregatesum', 'grades')
2907             );
2908         }
2909         return self::$aggregationstrings;
2910     }
2912     /**
2913      * Get grade_plugin_info object for managing settings if the user can
2914      *
2915      * @param int $courseid
2916      * @return grade_plugin_info[]
2917      */
2918     public static function get_info_manage_settings($courseid) {
2919         if (self::$managesetting !== null) {
2920             return self::$managesetting;
2921         }
2922         $context = context_course::instance($courseid);
2923         self::$managesetting = array();
2924         if ($courseid != SITEID && has_capability('moodle/grade:manage', $context)) {
2925             self::$managesetting['gradebooksetup'] = new grade_plugin_info('setup',
2926                 new moodle_url('/grade/edit/tree/index.php', array('id' => $courseid)),
2927                 get_string('gradebooksetup', 'grades'));
2928             self::$managesetting['coursesettings'] = new grade_plugin_info('coursesettings',
2929                 new moodle_url('/grade/edit/settings/index.php', array('id'=>$courseid)),
2930                 get_string('coursegradesettings', 'grades'));
2931         }
2932         if (self::$gradereportpreferences === null) {
2933             self::get_plugins_reports($courseid);
2934         }
2935         if (self::$gradereportpreferences) {
2936             self::$managesetting = array_merge(self::$managesetting, self::$gradereportpreferences);
2937         }
2938         return self::$managesetting;
2939     }
2940     /**
2941      * Returns an array of plugin reports as grade_plugin_info objects
2942      *
2943      * @param int $courseid
2944      * @return array
2945      */
2946     public static function get_plugins_reports($courseid) {
2947         global $SITE;
2949         if (self::$gradereports !== null) {
2950             return self::$gradereports;
2951         }
2952         $context = context_course::instance($courseid);
2953         $gradereports = array();
2954         $gradepreferences = array();
2955         foreach (core_component::get_plugin_list('gradereport') as $plugin => $plugindir) {
2956             //some reports make no sense if we're not within a course
2957             if ($courseid==$SITE->id && ($plugin=='grader' || $plugin=='user')) {
2958                 continue;
2959             }
2961             // Remove ones we can't see
2962             if (!has_capability('gradereport/'.$plugin.':view', $context)) {
2963                 continue;
2964             }
2966             // Singleview doesn't doesn't accomodate for all cap combos yet, so this is hardcoded..
2967             if ($plugin === 'singleview' && !has_all_capabilities(array('moodle/grade:viewall',
2968                     'moodle/grade:edit'), $context)) {
2969                 continue;
2970             }
2972             $pluginstr = get_string('pluginname', 'gradereport_'.$plugin);
2973             $url = new moodle_url('/grade/report/'.$plugin.'/index.php', array('id'=>$courseid));
2974             $gradereports[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2976             // Add link to preferences tab if such a page exists
2977             if (file_exists($plugindir.'/preferences.php')) {
2978                 $url = new moodle_url('/grade/report/'.$plugin.'/preferences.php', array('id'=>$courseid));
2979                 $gradepreferences[$plugin] = new grade_plugin_info($plugin, $url,
2980                     get_string('preferences', 'grades') . ': ' . $pluginstr);
2981             }
2982         }
2983         if (count($gradereports) == 0) {
2984             $gradereports = false;
2985             $gradepreferences = false;
2986         } else if (count($gradepreferences) == 0) {
2987             $gradepreferences = false;
2988             asort($gradereports);
2989         } else {
2990             asort($gradereports);
2991             asort($gradepreferences);
2992         }
2993         self::$gradereports = $gradereports;
2994         self::$gradereportpreferences = $gradepreferences;
2995         return self::$gradereports;
2996     }
2998     /**
2999      * Get information on scales
3000      * @param int $courseid
3001      * @return grade_plugin_info
3002      */
3003     public static function get_info_scales($courseid) {
3004         if (self::$scaleinfo !== null) {
3005             return self::$scaleinfo;
3006         }
3007         if (has_capability('moodle/course:managescales', context_course::instance($courseid))) {
3008             $url = new moodle_url('/grade/edit/scale/index.php', array('id'=>$courseid));
3009             self::$scaleinfo = new grade_plugin_info('scale', $url, get_string('view'));
3010         } else {
3011             self::$scaleinfo = false;
3012         }
3013         return self::$scaleinfo;
3014     }
3015     /**
3016      * Get information on outcomes
3017      * @param int $courseid
3018      * @return grade_plugin_info
3019      */
3020     public static function get_info_outcomes($courseid) {
3021         global $CFG, $SITE;
3023         if (self::$outcomeinfo !== null) {
3024             return self::$outcomeinfo;
3025         }
3026         $context = context_course::instance($courseid);
3027         $canmanage = has_capability('moodle/grade:manage', $context);
3028         $canupdate = has_capability('moodle/course:update', $context);
3029         if (!empty($CFG->enableoutcomes) && ($canmanage || $canupdate)) {
3030             $outcomes = array();
3031             if ($canupdate) {
3032                 if ($courseid!=$SITE->id) {
3033                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
3034                     $outcomes['course'] = new grade_plugin_info('course', $url, get_string('outcomescourse', 'grades'));
3035                 }
3036                 $url = new moodle_url('/grade/edit/outcome/index.php', array('id'=>$courseid));
3037                 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('editoutcomes', 'grades'));
3038                 $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid'=>$courseid));
3039                 $outcomes['import'] = new grade_plugin_info('import', $url, get_string('importoutcomes', 'grades'));
3040             } else {
3041                 if ($courseid!=$SITE->id) {
3042                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
3043                     $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('outcomescourse', 'grades'));
3044                 }
3045             }
3046             self::$outcomeinfo = $outcomes;
3047         } else {
3048             self::$outcomeinfo = false;
3049         }
3050         return self::$outcomeinfo;
3051     }
3052     /**
3053      * Get information on letters
3054      * @param int $courseid
3055      * @return array
3056      */
3057     public static function get_info_letters($courseid) {
3058         global $SITE;
3059         if (self::$letterinfo !== null) {
3060             return self::$letterinfo;
3061         }
3062         $context = context_course::instance($courseid);
3063         $canmanage = has_capability('moodle/grade:manage', $context);
3064         $canmanageletters = has_capability('moodle/grade:manageletters', $context);
3065         if ($canmanage || $canmanageletters) {
3066             // Redirect to system context when report is accessed from admin settings MDL-31633
3067             if ($context->instanceid == $SITE->id) {
3068                 $param = array('edit' => 1);
3069             } else {
3070                 $param = array('edit' => 1,'id' => $context->id);
3071             }
3072             self::$letterinfo = array(
3073                 'view' => new grade_plugin_info('view', new moodle_url('/grade/edit/letter/index.php', array('id'=>$context->id)), get_string('view')),
3074                 'edit' => new grade_plugin_info('edit', new moodle_url('/grade/edit/letter/index.php', $param), get_string('edit'))
3075             );
3076         } else {
3077             self::$letterinfo = false;
3078         }
3079         return self::$letterinfo;
3080     }
3081     /**
3082      * Get information import plugins
3083      * @param int $courseid
3084      * @return array
3085      */
3086     public static function get_plugins_import($courseid) {
3087         global $CFG;
3089         if (self::$importplugins !== null) {
3090             return self::$importplugins;
3091         }
3092         $importplugins = array();
3093         $context = context_course::instance($courseid);
3095         if (has_capability('moodle/grade:import', $context)) {
3096             foreach (core_component::get_plugin_list('gradeimport') as $plugin => $plugindir) {
3097                 if (!has_capability('gradeimport/'.$plugin.':view', $context)) {
3098                     continue;
3099                 }
3100                 $pluginstr = get_string('pluginname', 'gradeimport_'.$plugin);
3101                 $url = new moodle_url('/grade/import/'.$plugin.'/index.php', array('id'=>$courseid));
3102                 $importplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
3103             }
3105             // Show key manager if grade publishing is enabled and the user has xml publishing capability.
3106             // XML is the only grade import plugin that has publishing feature.
3107             if ($CFG->gradepublishing && has_capability('gradeimport/xml:publish', $context)) {
3108                 $url = new moodle_url('/grade/import/keymanager.php', array('id'=>$courseid));
3109                 $importplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
3110             }
3111         }
3113         if (count($importplugins) > 0) {
3114             asort($importplugins);
3115             self::$importplugins = $importplugins;
3116         } else {
3117             self::$importplugins = false;
3118         }
3119         return self::$importplugins;
3120     }
3121     /**
3122      * Get information export plugins
3123      * @param int $courseid
3124      * @return array
3125      */
3126     public static function get_plugins_export($courseid) {
3127         global $CFG;
3129         if (self::$exportplugins !== null) {
3130             return self::$exportplugins;
3131         }
3132         $context = context_course::instance($courseid);
3133         $exportplugins = array();
3134         $canpublishgrades = 0;
3135         if (has_capability('moodle/grade:export', $context)) {
3136             foreach (core_component::get_plugin_list('gradeexport') as $plugin => $plugindir) {
3137                 if (!has_capability('gradeexport/'.$plugin.':view', $context)) {
3138                     continue;
3139                 }
3140                 // All the grade export plugins has grade publishing capabilities.
3141                 if (has_capability('gradeexport/'.$plugin.':publish', $context)) {
3142                     $canpublishgrades++;
3143                 }
3145                 $pluginstr = get_string('pluginname', 'gradeexport_'.$plugin);
3146                 $url = new moodle_url('/grade/export/'.$plugin.'/index.php', array('id'=>$courseid));
3147                 $exportplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
3148             }
3150             // Show key manager if grade publishing is enabled and the user has at least one grade publishing capability.
3151             if ($CFG->gradepublishing && $canpublishgrades != 0) {
3152                 $url = new moodle_url('/grade/export/keymanager.php', array('id'=>$courseid));
3153                 $exportplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
3154             }
3155         }
3156         if (count($exportplugins) > 0) {
3157             asort($exportplugins);
3158             self::$exportplugins = $exportplugins;
3159         } else {
3160             self::$exportplugins = false;
3161         }
3162         return self::$exportplugins;
3163     }
3165     /**
3166      * Returns the value of a field from a user record
3167      *
3168      * @param stdClass $user object
3169      * @param stdClass $field object
3170      * @return string value of the field
3171      */
3172     public static function get_user_field_value($user, $field) {
3173         if (!empty($field->customid)) {
3174             $fieldname = 'customfield_' . $field->shortname;
3175             if (!empty($user->{$fieldname}) || is_numeric($user->{$fieldname})) {
3176                 $fieldvalue = $user->{$fieldname};
3177             } else {
3178                 $fieldvalue = $field->default;
3179             }
3180         } else {
3181             $fieldvalue = $user->{$field->shortname};
3182         }
3183         return $fieldvalue;
3184     }
3186     /**
3187      * Returns an array of user profile fields to be included in export
3188      *
3189      * @param int $courseid
3190      * @param bool $includecustomfields
3191      * @return array An array of stdClass instances with customid, shortname, datatype, default and fullname fields
3192      */
3193     public static function get_user_profile_fields($courseid, $includecustomfields = false) {
3194         global $CFG, $DB;
3196         // Gets the fields that have to be hidden
3197         $hiddenfields = array_map('trim', explode(',', $CFG->hiddenuserfields));
3198         $context = context_course::instance($courseid);
3199         $canseehiddenfields = has_capability('moodle/course:viewhiddenuserfields', $context);
3200         if ($canseehiddenfields) {
3201             $hiddenfields = array();
3202         }
3204         $fields = array();
3205         require_once($CFG->dirroot.'/user/lib.php');                // Loads user_get_default_fields()
3206         require_once($CFG->dirroot.'/user/profile/lib.php');        // Loads constants, such as PROFILE_VISIBLE_ALL
3207         $userdefaultfields = user_get_default_fields();
3209         // Sets the list of profile fields
3210         $userprofilefields = array_map('trim', explode(',', $CFG->grade_export_userprofilefields));
3211         if (!empty($userprofilefields)) {
3212             foreach ($userprofilefields as $field) {
3213                 $field = trim($field);
3214                 if (in_array($field, $hiddenfields) || !in_array($field, $userdefaultfields)) {
3215                     continue;
3216                 }
3217                 $obj = new stdClass();
3218                 $obj->customid  = 0;
3219                 $obj->shortname = $field;
3220                 $obj->fullname  = get_string($field);
3221                 $fields[] = $obj;
3222             }
3223         }
3225         // Sets the list of custom profile fields
3226         $customprofilefields = array_map('trim', explode(',', $CFG->grade_export_customprofilefields));
3227         if ($includecustomfields && !empty($customprofilefields)) {
3228             list($wherefields, $whereparams) = $DB->get_in_or_equal($customprofilefields);
3229             $customfields = $DB->get_records_sql("SELECT f.*
3230                                                     FROM {user_info_field} f
3231                                                     JOIN {user_info_category} c ON f.categoryid=c.id
3232                                                     WHERE f.shortname $wherefields
3233                                                     ORDER BY c.sortorder ASC, f.sortorder ASC", $whereparams);
3235             foreach ($customfields as $field) {
3236                 // Make sure we can display this custom field
3237                 if (!in_array($field->shortname, $customprofilefields)) {
3238                     continue;
3239                 } else if (in_array($field->shortname, $hiddenfields)) {
3240                     continue;
3241                 } else if ($field->visible != PROFILE_VISIBLE_ALL && !$canseehiddenfields) {
3242                     continue;
3243                 }
3245                 $obj = new stdClass();
3246                 $obj->customid  = $field->id;
3247                 $obj->shortname = $field->shortname;
3248                 $obj->fullname  = format_string($field->name);
3249                 $obj->datatype  = $field->datatype;
3250                 $obj->default   = $field->defaultdata;
3251                 $fields[] = $obj;
3252             }
3253         }
3255         return $fields;
3256     }
3258     /**
3259      * This helper method gets a snapshot of all the weights for a course.
3260      * It is used as a quick method to see if any wieghts have been automatically adjusted.
3261      * @param int $courseid
3262      * @return array of itemid -> aggregationcoef2
3263      */
3264     public static function fetch_all_natural_weights_for_course($courseid) {
3265         global $DB;
3266         $result = array();
3268         $records = $DB->get_records('grade_items', array('courseid'=>$courseid), 'id', 'id, aggregationcoef2');
3269         foreach ($records as $record) {
3270             $result[$record->id] = $record->aggregationcoef2;
3271         }
3272         return $result;
3273     }