MDL-29794 Initial support for re-using a shared grading form
[moodle.git] / grade / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Functions used by gradebook plugins and reports.
20  *
21  * @package   moodlecore
22  * @copyright 2009 Petr Skoda and Nicolas Connault
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require_once $CFG->libdir.'/gradelib.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 {
36     public $course;
37     public $grade_items;
38     public $groupid;
39     public $users_rs;
40     public $grades_rs;
41     public $gradestack;
42     public $sortfield1;
43     public $sortorder1;
44     public $sortfield2;
45     public $sortorder2;
47     /**
48      * Constructor
49      *
50      * @param object $course A course object
51      * @param array  $grade_items array of grade items, if not specified only user info returned
52      * @param int    $groupid iterate only group users if present
53      * @param string $sortfield1 The first field of the users table by which the array of users will be sorted
54      * @param string $sortorder1 The order in which the first sorting field will be sorted (ASC or DESC)
55      * @param string $sortfield2 The second field of the users table by which the array of users will be sorted
56      * @param string $sortorder2 The order in which the second sorting field will be sorted (ASC or DESC)
57      */
58     public function graded_users_iterator($course, $grade_items=null, $groupid=0,
59                                           $sortfield1='lastname', $sortorder1='ASC',
60                                           $sortfield2='firstname', $sortorder2='ASC') {
61         $this->course      = $course;
62         $this->grade_items = $grade_items;
63         $this->groupid     = $groupid;
64         $this->sortfield1  = $sortfield1;
65         $this->sortorder1  = $sortorder1;
66         $this->sortfield2  = $sortfield2;
67         $this->sortorder2  = $sortorder2;
69         $this->gradestack  = array();
70     }
72     /**
73      * Initialise the iterator
74      * @return boolean success
75      */
76     public function init() {
77         global $CFG, $DB;
79         $this->close();
81         grade_regrade_final_grades($this->course->id);
82         $course_item = grade_item::fetch_course_item($this->course->id);
83         if ($course_item->needsupdate) {
84             // can not calculate all final grades - sorry
85             return false;
86         }
88         $coursecontext = get_context_instance(CONTEXT_COURSE, $this->course->id);
89         $relatedcontexts = get_related_contexts_string($coursecontext);
91         list($gradebookroles_sql, $params) =
92             $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr');
94         //limit to users with an active enrolment
95         list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext);
97         $params = array_merge($params, $enrolledparams);
99         if ($this->groupid) {
100             $groupsql = "INNER JOIN {groups_members} gm ON gm.userid = u.id";
101             $groupwheresql = "AND gm.groupid = :groupid";
102             // $params contents: gradebookroles
103             $params['groupid'] = $this->groupid;
104         } else {
105             $groupsql = "";
106             $groupwheresql = "";
107         }
109         if (empty($this->sortfield1)) {
110             // we must do some sorting even if not specified
111             $ofields = ", u.id AS usrt";
112             $order   = "usrt ASC";
114         } else {
115             $ofields = ", u.$this->sortfield1 AS usrt1";
116             $order   = "usrt1 $this->sortorder1";
117             if (!empty($this->sortfield2)) {
118                 $ofields .= ", u.$this->sortfield2 AS usrt2";
119                 $order   .= ", usrt2 $this->sortorder2";
120             }
121             if ($this->sortfield1 != 'id' and $this->sortfield2 != 'id') {
122                 // user order MUST be the same in both queries,
123                 // must include the only unique user->id if not already present
124                 $ofields .= ", u.id AS usrt";
125                 $order   .= ", usrt ASC";
126             }
127         }
129         // $params contents: gradebookroles and groupid (for $groupwheresql)
130         $users_sql = "SELECT u.* $ofields
131                         FROM {user} u
132                         JOIN ($enrolledsql) je ON je.id = u.id
133                              $groupsql
134                         JOIN (
135                                   SELECT DISTINCT ra.userid
136                                     FROM {role_assignments} ra
137                                    WHERE ra.roleid $gradebookroles_sql
138                                      AND ra.contextid $relatedcontexts
139                              ) rainner ON rainner.userid = u.id
140                          WHERE u.deleted = 0
141                              $groupwheresql
142                     ORDER BY $order";
143         $this->users_rs = $DB->get_recordset_sql($users_sql, $params);
145         if (!empty($this->grade_items)) {
146             $itemids = array_keys($this->grade_items);
147             list($itemidsql, $grades_params) = $DB->get_in_or_equal($itemids, SQL_PARAMS_NAMED, 'items');
148             $params = array_merge($params, $grades_params);
149             // $params contents: gradebookroles, enrolledparams, groupid (for $groupwheresql) and itemids
151             $grades_sql = "SELECT g.* $ofields
152                              FROM {grade_grades} g
153                              JOIN {user} u ON g.userid = u.id
154                              JOIN ($enrolledsql) je ON je.id = u.id
155                                   $groupsql
156                              JOIN (
157                                       SELECT DISTINCT ra.userid
158                                         FROM {role_assignments} ra
159                                        WHERE ra.roleid $gradebookroles_sql
160                                          AND ra.contextid $relatedcontexts
161                                   ) rainner ON rainner.userid = u.id
162                               WHERE u.deleted = 0
163                               AND g.itemid $itemidsql
164                               $groupwheresql
165                          ORDER BY $order, g.itemid ASC";
166             $this->grades_rs = $DB->get_recordset_sql($grades_sql, $params);
167         } else {
168             $this->grades_rs = false;
169         }
171         return true;
172     }
174     /**
175      * Returns information about the next user
176      * @return mixed array of user info, all grades and feedback or null when no more users found
177      */
178     function next_user() {
179         if (!$this->users_rs) {
180             return false; // no users present
181         }
183         if (!$this->users_rs->valid()) {
184             if ($current = $this->_pop()) {
185                 // this is not good - user or grades updated between the two reads above :-(
186             }
188             return false; // no more users
189         } else {
190             $user = $this->users_rs->current();
191             $this->users_rs->next();
192         }
194         // find grades of this user
195         $grade_records = array();
196         while (true) {
197             if (!$current = $this->_pop()) {
198                 break; // no more grades
199             }
201             if (empty($current->userid)) {
202                 break;
203             }
205             if ($current->userid != $user->id) {
206                 // grade of the next user, we have all for this user
207                 $this->_push($current);
208                 break;
209             }
211             $grade_records[$current->itemid] = $current;
212         }
214         $grades = array();
215         $feedbacks = array();
217         if (!empty($this->grade_items)) {
218             foreach ($this->grade_items as $grade_item) {
219                 if (array_key_exists($grade_item->id, $grade_records)) {
220                     $feedbacks[$grade_item->id]->feedback       = $grade_records[$grade_item->id]->feedback;
221                     $feedbacks[$grade_item->id]->feedbackformat = $grade_records[$grade_item->id]->feedbackformat;
222                     unset($grade_records[$grade_item->id]->feedback);
223                     unset($grade_records[$grade_item->id]->feedbackformat);
224                     $grades[$grade_item->id] = new grade_grade($grade_records[$grade_item->id], false);
225                 } else {
226                     $feedbacks[$grade_item->id]->feedback       = '';
227                     $feedbacks[$grade_item->id]->feedbackformat = FORMAT_MOODLE;
228                     $grades[$grade_item->id] =
229                         new grade_grade(array('userid'=>$user->id, 'itemid'=>$grade_item->id), false);
230                 }
231             }
232         }
234         $result = new stdClass();
235         $result->user      = $user;
236         $result->grades    = $grades;
237         $result->feedbacks = $feedbacks;
238         return $result;
239     }
241     /**
242      * Close the iterator, do not forget to call this function.
243      * @return void
244      */
245     function close() {
246         if ($this->users_rs) {
247             $this->users_rs->close();
248             $this->users_rs = null;
249         }
250         if ($this->grades_rs) {
251             $this->grades_rs->close();
252             $this->grades_rs = null;
253         }
254         $this->gradestack = array();
255     }
258     /**
259      * _push
260      *
261      * @param grade_grade $grade Grade object
262      *
263      * @return void
264      */
265     function _push($grade) {
266         array_push($this->gradestack, $grade);
267     }
270     /**
271      * _pop
272      *
273      * @return object current grade object
274      */
275     function _pop() {
276         global $DB;
277         if (empty($this->gradestack)) {
278             if (empty($this->grades_rs) || !$this->grades_rs->valid()) {
279                 return null; // no grades present
280             }
282             $current = $this->grades_rs->current();
284             $this->grades_rs->next();
286             return $current;
287         } else {
288             return array_pop($this->gradestack);
289         }
290     }
293 /**
294  * Print a selection popup form of the graded users in a course.
295  *
296  * @deprecated since 2.0
297  *
298  * @param int    $course id of the course
299  * @param string $actionpage The page receiving the data from the popoup form
300  * @param int    $userid   id of the currently selected user (or 'all' if they are all selected)
301  * @param int    $groupid id of requested group, 0 means all
302  * @param int    $includeall bool include all option
303  * @param bool   $return If true, will return the HTML, otherwise, will print directly
304  * @return null
305  */
306 function print_graded_users_selector($course, $actionpage, $userid=0, $groupid=0, $includeall=true, $return=false) {
307     global $CFG, $USER, $OUTPUT;
308     return $OUTPUT->render(grade_get_graded_users_select(substr($actionpage, 0, strpos($actionpage, '/')), $course, $userid, $groupid, $includeall));
311 function grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall) {
312     global $USER;
314     if (is_null($userid)) {
315         $userid = $USER->id;
316     }
318     $menu = array(); // Will be a list of userid => user name
319     $gui = new graded_users_iterator($course, null, $groupid);
320     $gui->init();
321     $label = get_string('selectauser', 'grades');
322     if ($includeall) {
323         $menu[0] = get_string('allusers', 'grades');
324         $label = get_string('selectalloroneuser', 'grades');
325     }
326     while ($userdata = $gui->next_user()) {
327         $user = $userdata->user;
328         $menu[$user->id] = fullname($user);
329     }
330     $gui->close();
332     if ($includeall) {
333         $menu[0] .= " (" . (count($menu) - 1) . ")";
334     }
335     $select = new single_select(new moodle_url('/grade/report/'.$report.'/index.php', array('id'=>$course->id)), 'userid', $menu, $userid);
336     $select->label = $label;
337     $select->formid = 'choosegradeuser';
338     return $select;
341 /**
342  * Print grading plugin selection popup form.
343  *
344  * @param array   $plugin_info An array of plugins containing information for the selector
345  * @param boolean $return return as string
346  *
347  * @return nothing or string if $return true
348  */
349 function print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) {
350     global $CFG, $OUTPUT, $PAGE;
352     $menu = array();
353     $count = 0;
354     $active = '';
356     foreach ($plugin_info as $plugin_type => $plugins) {
357         if ($plugin_type == 'strings') {
358             continue;
359         }
361         $first_plugin = reset($plugins);
363         $sectionname = $plugin_info['strings'][$plugin_type];
364         $section = array();
366         foreach ($plugins as $plugin) {
367             $link = $plugin->link->out(false);
368             $section[$link] = $plugin->string;
369             $count++;
370             if ($plugin_type === $active_type and $plugin->id === $active_plugin) {
371                 $active = $link;
372             }
373         }
375         if ($section) {
376             $menu[] = array($sectionname=>$section);
377         }
378     }
380     // finally print/return the popup form
381     if ($count > 1) {
382         $select = new url_select($menu, $active, null, 'choosepluginreport');
384         if ($return) {
385             return $OUTPUT->render($select);
386         } else {
387             echo $OUTPUT->render($select);
388         }
389     } else {
390         // only one option - no plugin selector needed
391         return '';
392     }
395 /**
396  * Print grading plugin selection tab-based navigation.
397  *
398  * @param string  $active_type type of plugin on current page - import, export, report or edit
399  * @param string  $active_plugin active plugin type - grader, user, cvs, ...
400  * @param array   $plugin_info Array of plugins
401  * @param boolean $return return as string
402  *
403  * @return nothing or string if $return true
404  */
405 function grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) {
406     global $CFG, $COURSE;
408     if (!isset($currenttab)) { //TODO: this is weird
409         $currenttab = '';
410     }
412     $tabs = array();
413     $top_row  = array();
414     $bottom_row = array();
415     $inactive = array($active_plugin);
416     $activated = array();
418     $count = 0;
419     $active = '';
421     foreach ($plugin_info as $plugin_type => $plugins) {
422         if ($plugin_type == 'strings') {
423             continue;
424         }
426         // If $plugins is actually the definition of a child-less parent link:
427         if (!empty($plugins->id)) {
428             $string = $plugins->string;
429             if (!empty($plugin_info[$active_type]->parent)) {
430                 $string = $plugin_info[$active_type]->parent->string;
431             }
433             $top_row[] = new tabobject($plugin_type, $plugins->link, $string);
434             continue;
435         }
437         $first_plugin = reset($plugins);
438         $url = $first_plugin->link;
440         if ($plugin_type == 'report') {
441             $url = $CFG->wwwroot.'/grade/report/index.php?id='.$COURSE->id;
442         }
444         $top_row[] = new tabobject($plugin_type, $url, $plugin_info['strings'][$plugin_type]);
446         if ($active_type == $plugin_type) {
447             foreach ($plugins as $plugin) {
448                 $bottom_row[] = new tabobject($plugin->id, $plugin->link, $plugin->string);
449                 if ($plugin->id == $active_plugin) {
450                     $inactive = array($plugin->id);
451                 }
452             }
453         }
454     }
456     $tabs[] = $top_row;
457     $tabs[] = $bottom_row;
459     if ($return) {
460         return print_tabs($tabs, $active_type, $inactive, $activated, true);
461     } else {
462         print_tabs($tabs, $active_type, $inactive, $activated);
463     }
466 /**
467  * grade_get_plugin_info
468  *
469  * @param int    $courseid The course id
470  * @param string $active_type type of plugin on current page - import, export, report or edit
471  * @param string $active_plugin active plugin type - grader, user, cvs, ...
472  *
473  * @return array
474  */
475 function grade_get_plugin_info($courseid, $active_type, $active_plugin) {
476     global $CFG, $SITE;
478     $context = get_context_instance(CONTEXT_COURSE, $courseid);
480     $plugin_info = array();
481     $count = 0;
482     $active = '';
483     $url_prefix = $CFG->wwwroot . '/grade/';
485     // Language strings
486     $plugin_info['strings'] = grade_helper::get_plugin_strings();
488     if ($reports = grade_helper::get_plugins_reports($courseid)) {
489         $plugin_info['report'] = $reports;
490     }
492     //showing grade categories and items make no sense if we're not within a course
493     if ($courseid!=$SITE->id) {
494         if ($edittree = grade_helper::get_info_edit_structure($courseid)) {
495             $plugin_info['edittree'] = $edittree;
496         }
497     }
499     if ($scale = grade_helper::get_info_scales($courseid)) {
500         $plugin_info['scale'] = array('view'=>$scale);
501     }
503     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
504         $plugin_info['outcome'] = $outcomes;
505     }
507     if ($letters = grade_helper::get_info_letters($courseid)) {
508         $plugin_info['letter'] = $letters;
509     }
511     if ($imports = grade_helper::get_plugins_import($courseid)) {
512         $plugin_info['import'] = $imports;
513     }
515     if ($exports = grade_helper::get_plugins_export($courseid)) {
516         $plugin_info['export'] = $exports;
517     }
519     foreach ($plugin_info as $plugin_type => $plugins) {
520         if (!empty($plugins->id) && $active_plugin == $plugins->id) {
521             $plugin_info['strings']['active_plugin_str'] = $plugins->string;
522             break;
523         }
524         foreach ($plugins as $plugin) {
525             if (is_a($plugin, 'grade_plugin_info')) {
526                 if ($active_plugin == $plugin->id) {
527                     $plugin_info['strings']['active_plugin_str'] = $plugin->string;
528                 }
529             }
530         }
531     }
533     //hide course settings if we're not in a course
534     if ($courseid!=$SITE->id) {
535         if ($setting = grade_helper::get_info_manage_settings($courseid)) {
536             $plugin_info['settings'] = array('course'=>$setting);
537         }
538     }
540     // Put preferences last
541     if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
542         $plugin_info['preferences'] = $preferences;
543     }
545     foreach ($plugin_info as $plugin_type => $plugins) {
546         if (!empty($plugins->id) && $active_plugin == $plugins->id) {
547             $plugin_info['strings']['active_plugin_str'] = $plugins->string;
548             break;
549         }
550         foreach ($plugins as $plugin) {
551             if (is_a($plugin, 'grade_plugin_info')) {
552                 if ($active_plugin == $plugin->id) {
553                     $plugin_info['strings']['active_plugin_str'] = $plugin->string;
554                 }
555             }
556         }
557     }
559     return $plugin_info;
562 /**
563  * A simple class containing info about grade plugins.
564  * Can be subclassed for special rules
565  *
566  * @package moodlecore
567  * @copyright 2009 Nicolas Connault
568  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
569  */
570 class grade_plugin_info {
571     /**
572      * A unique id for this plugin
573      *
574      * @var mixed
575      */
576     public $id;
577     /**
578      * A URL to access this plugin
579      *
580      * @var mixed
581      */
582     public $link;
583     /**
584      * The name of this plugin
585      *
586      * @var mixed
587      */
588     public $string;
589     /**
590      * Another grade_plugin_info object, parent of the current one
591      *
592      * @var mixed
593      */
594     public $parent;
596     /**
597      * Constructor
598      *
599      * @param int $id A unique id for this plugin
600      * @param string $link A URL to access this plugin
601      * @param string $string The name of this plugin
602      * @param object $parent Another grade_plugin_info object, parent of the current one
603      *
604      * @return void
605      */
606     public function __construct($id, $link, $string, $parent=null) {
607         $this->id = $id;
608         $this->link = $link;
609         $this->string = $string;
610         $this->parent = $parent;
611     }
614 /**
615  * Prints the page headers, breadcrumb trail, page heading, (optional) dropdown navigation menu and
616  * (optional) navigation tabs for any gradebook page. All gradebook pages MUST use these functions
617  * in favour of the usual print_header(), print_header_simple(), print_heading() etc.
618  * !IMPORTANT! Use of tabs.php file in gradebook pages is forbidden unless tabs are switched off at
619  * the site level for the gradebook ($CFG->grade_navmethod = GRADE_NAVMETHOD_DROPDOWN).
620  *
621  * @param int     $courseid Course id
622  * @param string  $active_type The type of the current page (report, settings,
623  *                             import, export, scales, outcomes, letters)
624  * @param string  $active_plugin The plugin of the current page (grader, fullview etc...)
625  * @param string  $heading The heading of the page. Tries to guess if none is given
626  * @param boolean $return Whether to return (true) or echo (false) the HTML generated by this function
627  * @param string  $bodytags Additional attributes that will be added to the <body> tag
628  * @param string  $buttons Additional buttons to display on the page
629  *
630  * @return string HTML code or nothing if $return == false
631  */
632 function print_grade_page_head($courseid, $active_type, $active_plugin=null,
633                                $heading = false, $return=false,
634                                $buttons=false, $shownavigation=true) {
635     global $CFG, $OUTPUT, $PAGE;
637     $plugin_info = grade_get_plugin_info($courseid, $active_type, $active_plugin);
639     // Determine the string of the active plugin
640     $stractive_plugin = ($active_plugin) ? $plugin_info['strings']['active_plugin_str'] : $heading;
641     $stractive_type = $plugin_info['strings'][$active_type];
643     if (empty($plugin_info[$active_type]->id) || !empty($plugin_info[$active_type]->parent)) {
644         $title = $PAGE->course->fullname.': ' . $stractive_type . ': ' . $stractive_plugin;
645     } else {
646         $title = $PAGE->course->fullname.': ' . $stractive_plugin;
647     }
649     if ($active_type == 'report') {
650         $PAGE->set_pagelayout('report');
651     } else {
652         $PAGE->set_pagelayout('admin');
653     }
654     $PAGE->set_title(get_string('grades') . ': ' . $stractive_type);
655     $PAGE->set_heading($title);
656     if ($buttons instanceof single_button) {
657         $buttons = $OUTPUT->render($buttons);
658     }
659     $PAGE->set_button($buttons);
660     grade_extend_settings($plugin_info, $courseid);
662     $returnval = $OUTPUT->header();
663     if (!$return) {
664         echo $returnval;
665     }
667     // Guess heading if not given explicitly
668     if (!$heading) {
669         $heading = $stractive_plugin;
670     }
672     if ($shownavigation) {
673         if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_DROPDOWN) {
674             $returnval .= print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return);
675         }
676         $returnval .= $OUTPUT->heading($heading);
677         if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_TABS) {
678             $returnval .= grade_print_tabs($active_type, $active_plugin, $plugin_info, $return);
679         }
680     }
682     if ($return) {
683         return $returnval;
684     }
687 /**
688  * Utility class used for return tracking when using edit and other forms in grade plugins
689  *
690  * @package moodlecore
691  * @copyright 2009 Nicolas Connault
692  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
693  */
694 class grade_plugin_return {
695     public $type;
696     public $plugin;
697     public $courseid;
698     public $userid;
699     public $page;
701     /**
702      * Constructor
703      *
704      * @param array $params - associative array with return parameters, if null parameter are taken from _GET or _POST
705      */
706     public function grade_plugin_return($params = null) {
707         if (empty($params)) {
708             $this->type     = optional_param('gpr_type', null, PARAM_SAFEDIR);
709             $this->plugin   = optional_param('gpr_plugin', null, PARAM_PLUGIN);
710             $this->courseid = optional_param('gpr_courseid', null, PARAM_INT);
711             $this->userid   = optional_param('gpr_userid', null, PARAM_INT);
712             $this->page     = optional_param('gpr_page', null, PARAM_INT);
714         } else {
715             foreach ($params as $key=>$value) {
716                 if (property_exists($this, $key)) {
717                     $this->$key = $value;
718                 }
719             }
720         }
721     }
723     /**
724      * Returns return parameters as options array suitable for buttons.
725      * @return array options
726      */
727     public function get_options() {
728         if (empty($this->type)) {
729             return array();
730         }
732         $params = array();
734         if (!empty($this->plugin)) {
735             $params['plugin'] = $this->plugin;
736         }
738         if (!empty($this->courseid)) {
739             $params['id'] = $this->courseid;
740         }
742         if (!empty($this->userid)) {
743             $params['userid'] = $this->userid;
744         }
746         if (!empty($this->page)) {
747             $params['page'] = $this->page;
748         }
750         return $params;
751     }
753     /**
754      * Returns return url
755      *
756      * @param string $default default url when params not set
757      * @param array  $extras Extra URL parameters
758      *
759      * @return string url
760      */
761     public function get_return_url($default, $extras=null) {
762         global $CFG;
764         if (empty($this->type) or empty($this->plugin)) {
765             return $default;
766         }
768         $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php';
769         $glue = '?';
771         if (!empty($this->courseid)) {
772             $url .= $glue.'id='.$this->courseid;
773             $glue = '&amp;';
774         }
776         if (!empty($this->userid)) {
777             $url .= $glue.'userid='.$this->userid;
778             $glue = '&amp;';
779         }
781         if (!empty($this->page)) {
782             $url .= $glue.'page='.$this->page;
783             $glue = '&amp;';
784         }
786         if (!empty($extras)) {
787             foreach ($extras as $key=>$value) {
788                 $url .= $glue.$key.'='.$value;
789                 $glue = '&amp;';
790             }
791         }
793         return $url;
794     }
796     /**
797      * Returns string with hidden return tracking form elements.
798      * @return string
799      */
800     public function get_form_fields() {
801         if (empty($this->type)) {
802             return '';
803         }
805         $result  = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />';
807         if (!empty($this->plugin)) {
808             $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />';
809         }
811         if (!empty($this->courseid)) {
812             $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />';
813         }
815         if (!empty($this->userid)) {
816             $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />';
817         }
819         if (!empty($this->page)) {
820             $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />';
821         }
822     }
824     /**
825      * Add hidden elements into mform
826      *
827      * @param object &$mform moodle form object
828      *
829      * @return void
830      */
831     public function add_mform_elements(&$mform) {
832         if (empty($this->type)) {
833             return;
834         }
836         $mform->addElement('hidden', 'gpr_type', $this->type);
837         $mform->setType('gpr_type', PARAM_SAFEDIR);
839         if (!empty($this->plugin)) {
840             $mform->addElement('hidden', 'gpr_plugin', $this->plugin);
841             $mform->setType('gpr_plugin', PARAM_PLUGIN);
842         }
844         if (!empty($this->courseid)) {
845             $mform->addElement('hidden', 'gpr_courseid', $this->courseid);
846             $mform->setType('gpr_courseid', PARAM_INT);
847         }
849         if (!empty($this->userid)) {
850             $mform->addElement('hidden', 'gpr_userid', $this->userid);
851             $mform->setType('gpr_userid', PARAM_INT);
852         }
854         if (!empty($this->page)) {
855             $mform->addElement('hidden', 'gpr_page', $this->page);
856             $mform->setType('gpr_page', PARAM_INT);
857         }
858     }
860     /**
861      * Add return tracking params into url
862      *
863      * @param moodle_url $url A URL
864      *
865      * @return string $url with return tracking params
866      */
867     public function add_url_params(moodle_url $url) {
868         if (empty($this->type)) {
869             return $url;
870         }
872         $url->param('gpr_type', $this->type);
874         if (!empty($this->plugin)) {
875             $url->param('gpr_plugin', $this->plugin);
876         }
878         if (!empty($this->courseid)) {
879             $url->param('gpr_courseid' ,$this->courseid);
880         }
882         if (!empty($this->userid)) {
883             $url->param('gpr_userid', $this->userid);
884         }
886         if (!empty($this->page)) {
887             $url->param('gpr_page', $this->page);
888         }
890         return $url;
891     }
894 /**
895  * Function central to gradebook for building and printing the navigation (breadcrumb trail).
896  *
897  * @param string $path The path of the calling script (using __FILE__?)
898  * @param string $pagename The language string to use as the last part of the navigation (non-link)
899  * @param mixed  $id Either a plain integer (assuming the key is 'id') or
900  *                   an array of keys and values (e.g courseid => $courseid, itemid...)
901  *
902  * @return string
903  */
904 function grade_build_nav($path, $pagename=null, $id=null) {
905     global $CFG, $COURSE, $PAGE;
907     $strgrades = get_string('grades', 'grades');
909     // Parse the path and build navlinks from its elements
910     $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash
911     $path = substr($path, $dirroot_length);
912     $path = str_replace('\\', '/', $path);
914     $path_elements = explode('/', $path);
916     $path_elements_count = count($path_elements);
918     // First link is always 'grade'
919     $PAGE->navbar->add($strgrades, new moodle_url('/grade/index.php', array('id'=>$COURSE->id)));
921     $link = null;
922     $numberofelements = 3;
924     // Prepare URL params string
925     $linkparams = array();
926     if (!is_null($id)) {
927         if (is_array($id)) {
928             foreach ($id as $idkey => $idvalue) {
929                 $linkparams[$idkey] = $idvalue;
930             }
931         } else {
932             $linkparams['id'] = $id;
933         }
934     }
936     $navlink4 = null;
938     // Remove file extensions from filenames
939     foreach ($path_elements as $key => $filename) {
940         $path_elements[$key] = str_replace('.php', '', $filename);
941     }
943     // Second level links
944     switch ($path_elements[1]) {
945         case 'edit': // No link
946             if ($path_elements[3] != 'index.php') {
947                 $numberofelements = 4;
948             }
949             break;
950         case 'import': // No link
951             break;
952         case 'export': // No link
953             break;
954         case 'report':
955             // $id is required for this link. Do not print it if $id isn't given
956             if (!is_null($id)) {
957                 $link = new moodle_url('/grade/report/index.php', $linkparams);
958             }
960             if ($path_elements[2] == 'grader') {
961                 $numberofelements = 4;
962             }
963             break;
965         default:
966             // If this element isn't among the ones already listed above, it isn't supported, throw an error.
967             debugging("grade_build_nav() doesn't support ". $path_elements[1] .
968                     " as the second path element after 'grade'.");
969             return false;
970     }
971     $PAGE->navbar->add(get_string($path_elements[1], 'grades'), $link);
973     // Third level links
974     if (empty($pagename)) {
975         $pagename = get_string($path_elements[2], 'grades');
976     }
978     switch ($numberofelements) {
979         case 3:
980             $PAGE->navbar->add($pagename, $link);
981             break;
982         case 4:
983             if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') {
984                 $PAGE->navbar->add(get_string('pluginname', 'gradereport_grader'), new moodle_url('/grade/report/grader/index.php', $linkparams));
985             }
986             $PAGE->navbar->add($pagename);
987             break;
988     }
990     return '';
993 /**
994  * General structure representing grade items in course
995  *
996  * @package moodlecore
997  * @copyright 2009 Nicolas Connault
998  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
999  */
1000 class grade_structure {
1001     public $context;
1003     public $courseid;
1005     /**
1006     * Reference to modinfo for current course (for performance, to save
1007     * retrieving it from courseid every time). Not actually set except for
1008     * the grade_tree type.
1009     * @var course_modinfo
1010     */
1011     public $modinfo;
1013     /**
1014      * 1D array of grade items only
1015      */
1016     public $items;
1018     /**
1019      * Returns icon of element
1020      *
1021      * @param array &$element An array representing an element in the grade_tree
1022      * @param bool  $spacerifnone return spacer if no icon found
1023      *
1024      * @return string icon or spacer
1025      */
1026     public function get_element_icon(&$element, $spacerifnone=false) {
1027         global $CFG, $OUTPUT;
1029         switch ($element['type']) {
1030             case 'item':
1031             case 'courseitem':
1032             case 'categoryitem':
1033                 $is_course   = $element['object']->is_course_item();
1034                 $is_category = $element['object']->is_category_item();
1035                 $is_scale    = $element['object']->gradetype == GRADE_TYPE_SCALE;
1036                 $is_value    = $element['object']->gradetype == GRADE_TYPE_VALUE;
1037                 $is_outcome  = !empty($element['object']->outcomeid);
1039                 if ($element['object']->is_calculated()) {
1040                     $strcalc = get_string('calculatedgrade', 'grades');
1041                     return '<img src="'.$OUTPUT->pix_url('i/calc') . '" class="icon itemicon" title="'.
1042                             s($strcalc).'" alt="'.s($strcalc).'"/>';
1044                 } else if (($is_course or $is_category) and ($is_scale or $is_value)) {
1045                     if ($category = $element['object']->get_item_category()) {
1046                         switch ($category->aggregation) {
1047                             case GRADE_AGGREGATE_MEAN:
1048                             case GRADE_AGGREGATE_MEDIAN:
1049                             case GRADE_AGGREGATE_WEIGHTED_MEAN:
1050                             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
1051                             case GRADE_AGGREGATE_EXTRACREDIT_MEAN:
1052                                 $stragg = get_string('aggregation', 'grades');
1053                                 return '<img src="'.$OUTPUT->pix_url('i/agg_mean') . '" ' .
1054                                         'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
1055                             case GRADE_AGGREGATE_SUM:
1056                                 $stragg = get_string('aggregation', 'grades');
1057                                 return '<img src="'.$OUTPUT->pix_url('i/agg_sum') . '" ' .
1058                                         'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
1059                         }
1060                     }
1062                 } else if ($element['object']->itemtype == 'mod') {
1063                     //prevent outcomes being displaying the same icon as the activity they are attached to
1064                     if ($is_outcome) {
1065                         $stroutcome = s(get_string('outcome', 'grades'));
1066                         return '<img src="'.$OUTPUT->pix_url('i/outcomes') . '" ' .
1067                             'class="icon itemicon" title="'.$stroutcome.
1068                             '" alt="'.$stroutcome.'"/>';
1069                     } else {
1070                         $strmodname = get_string('modulename', $element['object']->itemmodule);
1071                         return '<img src="'.$OUTPUT->pix_url('icon',
1072                             $element['object']->itemmodule) . '" ' .
1073                             'class="icon itemicon" title="' .s($strmodname).
1074                             '" alt="' .s($strmodname).'"/>';
1075                     }
1076                 } else if ($element['object']->itemtype == 'manual') {
1077                     if ($element['object']->is_outcome_item()) {
1078                         $stroutcome = get_string('outcome', 'grades');
1079                         return '<img src="'.$OUTPUT->pix_url('i/outcomes') . '" ' .
1080                                 'class="icon itemicon" title="'.s($stroutcome).
1081                                 '" alt="'.s($stroutcome).'"/>';
1082                     } else {
1083                         $strmanual = get_string('manualitem', 'grades');
1084                         return '<img src="'.$OUTPUT->pix_url('t/manual_item') . '" '.
1085                                 'class="icon itemicon" title="'.s($strmanual).
1086                                 '" alt="'.s($strmanual).'"/>';
1087                     }
1088                 }
1089                 break;
1091             case 'category':
1092                 $strcat = get_string('category', 'grades');
1093                 return '<img src="'.$OUTPUT->pix_url('f/folder') . '" class="icon itemicon" ' .
1094                         'title="'.s($strcat).'" alt="'.s($strcat).'" />';
1095         }
1097         if ($spacerifnone) {
1098             return $OUTPUT->spacer().' ';
1099         } else {
1100             return '';
1101         }
1102     }
1104     /**
1105      * Returns name of element optionally with icon and link
1106      *
1107      * @param array &$element An array representing an element in the grade_tree
1108      * @param bool  $withlink Whether or not this header has a link
1109      * @param bool  $icon Whether or not to display an icon with this header
1110      * @param bool  $spacerifnone return spacer if no icon found
1111      *
1112      * @return string header
1113      */
1114     public function get_element_header(&$element, $withlink=false, $icon=true, $spacerifnone=false) {
1115         $header = '';
1117         if ($icon) {
1118             $header .= $this->get_element_icon($element, $spacerifnone);
1119         }
1121         $header .= $element['object']->get_name();
1123         if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and
1124             $element['type'] != 'courseitem') {
1125             return $header;
1126         }
1128         if ($withlink) {
1129             $url = $this->get_activity_link($element);
1130             if ($url) {
1131                 $a = new stdClass();
1132                 $a->name = get_string('modulename', $element['object']->itemmodule);
1133                 $title = get_string('linktoactivity', 'grades', $a);
1135                 $header = html_writer::link($url, $header, array('title' => $title));
1136             }
1137         }
1139         return $header;
1140     }
1142     private function get_activity_link($element) {
1143         global $CFG;
1145         $itemtype = $element['object']->itemtype;
1146         $itemmodule = $element['object']->itemmodule;
1147         $iteminstance = $element['object']->iteminstance;
1149         // Links only for module items that have valid instance, module and are
1150         // called from grade_tree with valid modinfo
1151         if ($itemtype != 'mod' || !$iteminstance || !$itemmodule || !$this->modinfo) {
1152             return null;
1153         }
1155         // Get $cm efficiently and with visibility information using modinfo
1156         $instances = $this->modinfo->get_instances();
1157         if (empty($instances[$itemmodule][$iteminstance])) {
1158             return null;
1159         }
1160         $cm = $instances[$itemmodule][$iteminstance];
1162         // Do not add link if activity is not visible to the current user
1163         if (!$cm->uservisible) {
1164             return null;
1165         }
1167         // If module has grade.php, link to that, otherwise view.php
1168         $dir = $CFG->dirroot . '/mod/' . $itemmodule;
1169         if (file_exists($dir.'/grade.php')) {
1170             return new moodle_url('/mod/' . $itemmodule . '/grade.php', array('id' => $cm->id));
1171         } else {
1172             return new moodle_url('/mod/' . $itemmodule . '/view.php', array('id' => $cm->id));
1173         }
1174     }
1176     /**
1177      * Returns the grade eid - the grade may not exist yet.
1178      *
1179      * @param grade_grade $grade_grade A grade_grade object
1180      *
1181      * @return string eid
1182      */
1183     public function get_grade_eid($grade_grade) {
1184         if (empty($grade_grade->id)) {
1185             return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid;
1186         } else {
1187             return 'g'.$grade_grade->id;
1188         }
1189     }
1191     /**
1192      * Returns the grade_item eid
1193      * @param grade_item $grade_item A grade_item object
1194      * @return string eid
1195      */
1196     public function get_item_eid($grade_item) {
1197         return 'i'.$grade_item->id;
1198     }
1200     /**
1201      * Given a grade_tree element, returns an array of parameters
1202      * used to build an icon for that element.
1203      *
1204      * @param array $element An array representing an element in the grade_tree
1205      *
1206      * @return array
1207      */
1208     public function get_params_for_iconstr($element) {
1209         $strparams = new stdClass();
1210         $strparams->category = '';
1211         $strparams->itemname = '';
1212         $strparams->itemmodule = '';
1214         if (!method_exists($element['object'], 'get_name')) {
1215             return $strparams;
1216         }
1218         $strparams->itemname = html_to_text($element['object']->get_name());
1220         // If element name is categorytotal, get the name of the parent category
1221         if ($strparams->itemname == get_string('categorytotal', 'grades')) {
1222             $parent = $element['object']->get_parent_category();
1223             $strparams->category = $parent->get_name() . ' ';
1224         } else {
1225             $strparams->category = '';
1226         }
1228         $strparams->itemmodule = null;
1229         if (isset($element['object']->itemmodule)) {
1230             $strparams->itemmodule = $element['object']->itemmodule;
1231         }
1232         return $strparams;
1233     }
1235     /**
1236      * Return edit icon for give element
1237      *
1238      * @param array  $element An array representing an element in the grade_tree
1239      * @param object $gpr A grade_plugin_return object
1240      *
1241      * @return string
1242      */
1243     public function get_edit_icon($element, $gpr) {
1244         global $CFG, $OUTPUT;
1246         if (!has_capability('moodle/grade:manage', $this->context)) {
1247             if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) {
1248                 // oki - let them override grade
1249             } else {
1250                 return '';
1251             }
1252         }
1254         static $strfeedback   = null;
1255         static $streditgrade = null;
1256         if (is_null($streditgrade)) {
1257             $streditgrade = get_string('editgrade', 'grades');
1258             $strfeedback  = get_string('feedback');
1259         }
1261         $strparams = $this->get_params_for_iconstr($element);
1263         $object = $element['object'];
1265         switch ($element['type']) {
1266             case 'item':
1267             case 'categoryitem':
1268             case 'courseitem':
1269                 $stredit = get_string('editverbose', 'grades', $strparams);
1270                 if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) {
1271                     $url = new moodle_url('/grade/edit/tree/item.php',
1272                             array('courseid' => $this->courseid, 'id' => $object->id));
1273                 } else {
1274                     $url = new moodle_url('/grade/edit/tree/outcomeitem.php',
1275                             array('courseid' => $this->courseid, 'id' => $object->id));
1276                 }
1277                 break;
1279             case 'category':
1280                 $stredit = get_string('editverbose', 'grades', $strparams);
1281                 $url = new moodle_url('/grade/edit/tree/category.php',
1282                         array('courseid' => $this->courseid, 'id' => $object->id));
1283                 break;
1285             case 'grade':
1286                 $stredit = $streditgrade;
1287                 if (empty($object->id)) {
1288                     $url = new moodle_url('/grade/edit/tree/grade.php',
1289                             array('courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid));
1290                 } else {
1291                     $url = new moodle_url('/grade/edit/tree/grade.php',
1292                             array('courseid' => $this->courseid, 'id' => $object->id));
1293                 }
1294                 if (!empty($object->feedback)) {
1295                     $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat)));
1296                 }
1297                 break;
1299             default:
1300                 $url = null;
1301         }
1303         if ($url) {
1304             return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/edit', $stredit));
1306         } else {
1307             return '';
1308         }
1309     }
1311     /**
1312      * Return hiding icon for give element
1313      *
1314      * @param array  $element An array representing an element in the grade_tree
1315      * @param object $gpr A grade_plugin_return object
1316      *
1317      * @return string
1318      */
1319     public function get_hiding_icon($element, $gpr) {
1320         global $CFG, $OUTPUT;
1322         if (!has_capability('moodle/grade:manage', $this->context) and
1323             !has_capability('moodle/grade:hide', $this->context)) {
1324             return '';
1325         }
1327         $strparams = $this->get_params_for_iconstr($element);
1328         $strshow = get_string('showverbose', 'grades', $strparams);
1329         $strhide = get_string('hideverbose', 'grades', $strparams);
1331         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1332         $url = $gpr->add_url_params($url);
1334         if ($element['object']->is_hidden()) {
1335             $type = 'show';
1336             $tooltip = $strshow;
1338             // Change the icon and add a tooltip showing the date
1339             if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) {
1340                 $type = 'hiddenuntil';
1341                 $tooltip = get_string('hiddenuntildate', 'grades',
1342                         userdate($element['object']->get_hidden()));
1343             }
1345             $url->param('action', 'show');
1347             $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strshow, 'class'=>'iconsmall')));
1349         } else {
1350             $url->param('action', 'hide');
1351             $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/hide', $strhide));
1352         }
1354         return $hideicon;
1355     }
1357     /**
1358      * Return locking icon for given element
1359      *
1360      * @param array  $element An array representing an element in the grade_tree
1361      * @param object $gpr A grade_plugin_return object
1362      *
1363      * @return string
1364      */
1365     public function get_locking_icon($element, $gpr) {
1366         global $CFG, $OUTPUT;
1368         $strparams = $this->get_params_for_iconstr($element);
1369         $strunlock = get_string('unlockverbose', 'grades', $strparams);
1370         $strlock = get_string('lockverbose', 'grades', $strparams);
1372         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1373         $url = $gpr->add_url_params($url);
1375         // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon
1376         if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) {
1377             $strparamobj = new stdClass();
1378             $strparamobj->itemname = $element['object']->grade_item->itemname;
1379             $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj);
1381             $action = $OUTPUT->pix_icon('t/unlock_gray', $strnonunlockable);
1383         } else if ($element['object']->is_locked()) {
1384             $type = 'unlock';
1385             $tooltip = $strunlock;
1387             // Change the icon and add a tooltip showing the date
1388             if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) {
1389                 $type = 'locktime';
1390                 $tooltip = get_string('locktimedate', 'grades',
1391                         userdate($element['object']->get_locktime()));
1392             }
1394             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) {
1395                 $action = '';
1396             } else {
1397                 $url->param('action', 'unlock');
1398                 $action = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strunlock, 'class'=>'smallicon')));
1399             }
1401         } else {
1402             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) {
1403                 $action = '';
1404             } else {
1405                 $url->param('action', 'lock');
1406                 $action = $OUTPUT->action_icon($url, new pix_icon('t/lock', $strlock));
1407             }
1408         }
1410         return $action;
1411     }
1413     /**
1414      * Return calculation icon for given element
1415      *
1416      * @param array  $element An array representing an element in the grade_tree
1417      * @param object $gpr A grade_plugin_return object
1418      *
1419      * @return string
1420      */
1421     public function get_calculation_icon($element, $gpr) {
1422         global $CFG, $OUTPUT;
1423         if (!has_capability('moodle/grade:manage', $this->context)) {
1424             return '';
1425         }
1427         $type   = $element['type'];
1428         $object = $element['object'];
1430         if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') {
1431             $strparams = $this->get_params_for_iconstr($element);
1432             $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams);
1434             $is_scale = $object->gradetype == GRADE_TYPE_SCALE;
1435             $is_value = $object->gradetype == GRADE_TYPE_VALUE;
1437             // show calculation icon only when calculation possible
1438             if (!$object->is_external_item() and ($is_scale or $is_value)) {
1439                 if ($object->is_calculated()) {
1440                     $icon = 't/calc';
1441                 } else {
1442                     $icon = 't/calc_off';
1443                 }
1445                 $url = new moodle_url('/grade/edit/tree/calculation.php', array('courseid' => $this->courseid, 'id' => $object->id));
1446                 $url = $gpr->add_url_params($url);
1447                 return $OUTPUT->action_icon($url, new pix_icon($icon, $streditcalculation)) . "\n";
1448             }
1449         }
1451         return '';
1452     }
1455 /**
1456  * Flat structure similar to grade tree.
1457  *
1458  * @uses grade_structure
1459  * @package moodlecore
1460  * @copyright 2009 Nicolas Connault
1461  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1462  */
1463 class grade_seq extends grade_structure {
1465     /**
1466      * 1D array of elements
1467      */
1468     public $elements;
1470     /**
1471      * Constructor, retrieves and stores array of all grade_category and grade_item
1472      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1473      *
1474      * @param int  $courseid The course id
1475      * @param bool $category_grade_last category grade item is the last child
1476      * @param bool $nooutcomes Whether or not outcomes should be included
1477      */
1478     public function grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) {
1479         global $USER, $CFG;
1481         $this->courseid   = $courseid;
1482         $this->context    = get_context_instance(CONTEXT_COURSE, $courseid);
1484         // get course grade tree
1485         $top_element = grade_category::fetch_course_tree($courseid, true);
1487         $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes);
1489         foreach ($this->elements as $key=>$unused) {
1490             $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object'];
1491         }
1492     }
1494     /**
1495      * Static recursive helper - makes the grade_item for category the last children
1496      *
1497      * @param array &$element The seed of the recursion
1498      * @param bool $category_grade_last category grade item is the last child
1499      * @param bool $nooutcomes Whether or not outcomes should be included
1500      *
1501      * @return array
1502      */
1503     public function flatten(&$element, $category_grade_last, $nooutcomes) {
1504         if (empty($element['children'])) {
1505             return array();
1506         }
1507         $children = array();
1509         foreach ($element['children'] as $sortorder=>$unused) {
1510             if ($nooutcomes and $element['type'] != 'category' and
1511                 $element['children'][$sortorder]['object']->is_outcome_item()) {
1512                 continue;
1513             }
1514             $children[] = $element['children'][$sortorder];
1515         }
1516         unset($element['children']);
1518         if ($category_grade_last and count($children) > 1) {
1519             $cat_item = array_shift($children);
1520             array_push($children, $cat_item);
1521         }
1523         $result = array();
1524         foreach ($children as $child) {
1525             if ($child['type'] == 'category') {
1526                 $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes);
1527             } else {
1528                 $child['eid'] = 'i'.$child['object']->id;
1529                 $result[$child['object']->id] = $child;
1530             }
1531         }
1533         return $result;
1534     }
1536     /**
1537      * Parses the array in search of a given eid and returns a element object with
1538      * information about the element it has found.
1539      *
1540      * @param int $eid Gradetree Element ID
1541      *
1542      * @return object element
1543      */
1544     public function locate_element($eid) {
1545         // it is a grade - construct a new object
1546         if (strpos($eid, 'n') === 0) {
1547             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1548                 return null;
1549             }
1551             $itemid = $matches[1];
1552             $userid = $matches[2];
1554             //extra security check - the grade item must be in this tree
1555             if (!$item_el = $this->locate_element('i'.$itemid)) {
1556                 return null;
1557             }
1559             // $gradea->id may be null - means does not exist yet
1560             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
1562             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1563             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
1565         } else if (strpos($eid, 'g') === 0) {
1566             $id = (int) substr($eid, 1);
1567             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
1568                 return null;
1569             }
1570             //extra security check - the grade item must be in this tree
1571             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
1572                 return null;
1573             }
1574             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1575             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
1576         }
1578         // it is a category or item
1579         foreach ($this->elements as $element) {
1580             if ($element['eid'] == $eid) {
1581                 return $element;
1582             }
1583         }
1585         return null;
1586     }
1589 /**
1590  * This class represents a complete tree of categories, grade_items and final grades,
1591  * organises as an array primarily, but which can also be converted to other formats.
1592  * It has simple method calls with complex implementations, allowing for easy insertion,
1593  * deletion and moving of items and categories within the tree.
1594  *
1595  * @uses grade_structure
1596  * @package moodlecore
1597  * @copyright 2009 Nicolas Connault
1598  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1599  */
1600 class grade_tree extends grade_structure {
1602     /**
1603      * The basic representation of the tree as a hierarchical, 3-tiered array.
1604      * @var object $top_element
1605      */
1606     public $top_element;
1608     /**
1609      * 2D array of grade items and categories
1610      * @var array $levels
1611      */
1612     public $levels;
1614     /**
1615      * Grade items
1616      * @var array $items
1617      */
1618     public $items;
1620     /**
1621      * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item
1622      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1623      *
1624      * @param int   $courseid The Course ID
1625      * @param bool  $fillers include fillers and colspans, make the levels var "rectangular"
1626      * @param bool  $category_grade_last category grade item is the last child
1627      * @param array $collapsed array of collapsed categories
1628      * @param bool  $nooutcomes Whether or not outcomes should be included
1629      */
1630     public function grade_tree($courseid, $fillers=true, $category_grade_last=false,
1631                                $collapsed=null, $nooutcomes=false) {
1632         global $USER, $CFG, $COURSE, $DB;
1634         $this->courseid   = $courseid;
1635         $this->levels     = array();
1636         $this->context    = get_context_instance(CONTEXT_COURSE, $courseid);
1638         if (!empty($COURSE->id) && $COURSE->id == $this->courseid) {
1639             $course = $COURSE;
1640         } else {
1641             $course = $DB->get_record('course', array('id' => $this->courseid));
1642         }
1643         $this->modinfo = get_fast_modinfo($course);
1645         // get course grade tree
1646         $this->top_element = grade_category::fetch_course_tree($courseid, true);
1648         // collapse the categories if requested
1649         if (!empty($collapsed)) {
1650             grade_tree::category_collapse($this->top_element, $collapsed);
1651         }
1653         // no otucomes if requested
1654         if (!empty($nooutcomes)) {
1655             grade_tree::no_outcomes($this->top_element);
1656         }
1658         // move category item to last position in category
1659         if ($category_grade_last) {
1660             grade_tree::category_grade_last($this->top_element);
1661         }
1663         if ($fillers) {
1664             // inject fake categories == fillers
1665             grade_tree::inject_fillers($this->top_element, 0);
1666             // add colspans to categories and fillers
1667             grade_tree::inject_colspans($this->top_element);
1668         }
1670         grade_tree::fill_levels($this->levels, $this->top_element, 0);
1672     }
1674     /**
1675      * Static recursive helper - removes items from collapsed categories
1676      *
1677      * @param array &$element The seed of the recursion
1678      * @param array $collapsed array of collapsed categories
1679      *
1680      * @return void
1681      */
1682     public function category_collapse(&$element, $collapsed) {
1683         if ($element['type'] != 'category') {
1684             return;
1685         }
1686         if (empty($element['children']) or count($element['children']) < 2) {
1687             return;
1688         }
1690         if (in_array($element['object']->id, $collapsed['aggregatesonly'])) {
1691             $category_item = reset($element['children']); //keep only category item
1692             $element['children'] = array(key($element['children'])=>$category_item);
1694         } else {
1695             if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item
1696                 reset($element['children']);
1697                 $first_key = key($element['children']);
1698                 unset($element['children'][$first_key]);
1699             }
1700             foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children
1701                 grade_tree::category_collapse($element['children'][$sortorder], $collapsed);
1702             }
1703         }
1704     }
1706     /**
1707      * Static recursive helper - removes all outcomes
1708      *
1709      * @param array &$element The seed of the recursion
1710      *
1711      * @return void
1712      */
1713     public function no_outcomes(&$element) {
1714         if ($element['type'] != 'category') {
1715             return;
1716         }
1717         foreach ($element['children'] as $sortorder=>$child) {
1718             if ($element['children'][$sortorder]['type'] == 'item'
1719               and $element['children'][$sortorder]['object']->is_outcome_item()) {
1720                 unset($element['children'][$sortorder]);
1722             } else if ($element['children'][$sortorder]['type'] == 'category') {
1723                 grade_tree::no_outcomes($element['children'][$sortorder]);
1724             }
1725         }
1726     }
1728     /**
1729      * Static recursive helper - makes the grade_item for category the last children
1730      *
1731      * @param array &$element The seed of the recursion
1732      *
1733      * @return void
1734      */
1735     public function category_grade_last(&$element) {
1736         if (empty($element['children'])) {
1737             return;
1738         }
1739         if (count($element['children']) < 2) {
1740             return;
1741         }
1742         $first_item = reset($element['children']);
1743         if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') {
1744             // the category item might have been already removed
1745             $order = key($element['children']);
1746             unset($element['children'][$order]);
1747             $element['children'][$order] =& $first_item;
1748         }
1749         foreach ($element['children'] as $sortorder => $child) {
1750             grade_tree::category_grade_last($element['children'][$sortorder]);
1751         }
1752     }
1754     /**
1755      * Static recursive helper - fills the levels array, useful when accessing tree elements of one level
1756      *
1757      * @param array &$levels The levels of the grade tree through which to recurse
1758      * @param array &$element The seed of the recursion
1759      * @param int   $depth How deep are we?
1760      * @return void
1761      */
1762     public function fill_levels(&$levels, &$element, $depth) {
1763         if (!array_key_exists($depth, $levels)) {
1764             $levels[$depth] = array();
1765         }
1767         // prepare unique identifier
1768         if ($element['type'] == 'category') {
1769             $element['eid'] = 'c'.$element['object']->id;
1770         } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) {
1771             $element['eid'] = 'i'.$element['object']->id;
1772             $this->items[$element['object']->id] =& $element['object'];
1773         }
1775         $levels[$depth][] =& $element;
1776         $depth++;
1777         if (empty($element['children'])) {
1778             return;
1779         }
1780         $prev = 0;
1781         foreach ($element['children'] as $sortorder=>$child) {
1782             grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth);
1783             $element['children'][$sortorder]['prev'] = $prev;
1784             $element['children'][$sortorder]['next'] = 0;
1785             if ($prev) {
1786                 $element['children'][$prev]['next'] = $sortorder;
1787             }
1788             $prev = $sortorder;
1789         }
1790     }
1792     /**
1793      * Static recursive helper - makes full tree (all leafes are at the same level)
1794      *
1795      * @param array &$element The seed of the recursion
1796      * @param int   $depth How deep are we?
1797      *
1798      * @return int
1799      */
1800     public function inject_fillers(&$element, $depth) {
1801         $depth++;
1803         if (empty($element['children'])) {
1804             return $depth;
1805         }
1806         $chdepths = array();
1807         $chids = array_keys($element['children']);
1808         $last_child  = end($chids);
1809         $first_child = reset($chids);
1811         foreach ($chids as $chid) {
1812             $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth);
1813         }
1814         arsort($chdepths);
1816         $maxdepth = reset($chdepths);
1817         foreach ($chdepths as $chid=>$chd) {
1818             if ($chd == $maxdepth) {
1819                 continue;
1820             }
1821             for ($i=0; $i < $maxdepth-$chd; $i++) {
1822                 if ($chid == $first_child) {
1823                     $type = 'fillerfirst';
1824                 } else if ($chid == $last_child) {
1825                     $type = 'fillerlast';
1826                 } else {
1827                     $type = 'filler';
1828                 }
1829                 $oldchild =& $element['children'][$chid];
1830                 $element['children'][$chid] = array('object'=>'filler', 'type'=>$type,
1831                                                     'eid'=>'', 'depth'=>$element['object']->depth,
1832                                                     'children'=>array($oldchild));
1833             }
1834         }
1836         return $maxdepth;
1837     }
1839     /**
1840      * Static recursive helper - add colspan information into categories
1841      *
1842      * @param array &$element The seed of the recursion
1843      *
1844      * @return int
1845      */
1846     public function inject_colspans(&$element) {
1847         if (empty($element['children'])) {
1848             return 1;
1849         }
1850         $count = 0;
1851         foreach ($element['children'] as $key=>$child) {
1852             $count += grade_tree::inject_colspans($element['children'][$key]);
1853         }
1854         $element['colspan'] = $count;
1855         return $count;
1856     }
1858     /**
1859      * Parses the array in search of a given eid and returns a element object with
1860      * information about the element it has found.
1861      * @param int $eid Gradetree Element ID
1862      * @return object element
1863      */
1864     public function locate_element($eid) {
1865         // it is a grade - construct a new object
1866         if (strpos($eid, 'n') === 0) {
1867             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1868                 return null;
1869             }
1871             $itemid = $matches[1];
1872             $userid = $matches[2];
1874             //extra security check - the grade item must be in this tree
1875             if (!$item_el = $this->locate_element('i'.$itemid)) {
1876                 return null;
1877             }
1879             // $gradea->id may be null - means does not exist yet
1880             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
1882             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1883             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
1885         } else if (strpos($eid, 'g') === 0) {
1886             $id = (int) substr($eid, 1);
1887             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
1888                 return null;
1889             }
1890             //extra security check - the grade item must be in this tree
1891             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
1892                 return null;
1893             }
1894             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1895             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
1896         }
1898         // it is a category or item
1899         foreach ($this->levels as $row) {
1900             foreach ($row as $element) {
1901                 if ($element['type'] == 'filler') {
1902                     continue;
1903                 }
1904                 if ($element['eid'] == $eid) {
1905                     return $element;
1906                 }
1907             }
1908         }
1910         return null;
1911     }
1913     /**
1914      * Returns a well-formed XML representation of the grade-tree using recursion.
1915      *
1916      * @param array  $root The current element in the recursion. If null, starts at the top of the tree.
1917      * @param string $tabs The control character to use for tabs
1918      *
1919      * @return string $xml
1920      */
1921     public function exporttoxml($root=null, $tabs="\t") {
1922         $xml = null;
1923         $first = false;
1924         if (is_null($root)) {
1925             $root = $this->top_element;
1926             $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
1927             $xml .= "<gradetree>\n";
1928             $first = true;
1929         }
1931         $type = 'undefined';
1932         if (strpos($root['object']->table, 'grade_categories') !== false) {
1933             $type = 'category';
1934         } else if (strpos($root['object']->table, 'grade_items') !== false) {
1935             $type = 'item';
1936         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
1937             $type = 'outcome';
1938         }
1940         $xml .= "$tabs<element type=\"$type\">\n";
1941         foreach ($root['object'] as $var => $value) {
1942             if (!is_object($value) && !is_array($value) && !empty($value)) {
1943                 $xml .= "$tabs\t<$var>$value</$var>\n";
1944             }
1945         }
1947         if (!empty($root['children'])) {
1948             $xml .= "$tabs\t<children>\n";
1949             foreach ($root['children'] as $sortorder => $child) {
1950                 $xml .= $this->exportToXML($child, $tabs."\t\t");
1951             }
1952             $xml .= "$tabs\t</children>\n";
1953         }
1955         $xml .= "$tabs</element>\n";
1957         if ($first) {
1958             $xml .= "</gradetree>";
1959         }
1961         return $xml;
1962     }
1964     /**
1965      * Returns a JSON representation of the grade-tree using recursion.
1966      *
1967      * @param array $root The current element in the recursion. If null, starts at the top of the tree.
1968      * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy
1969      *
1970      * @return string
1971      */
1972     public function exporttojson($root=null, $tabs="\t") {
1973         $json = null;
1974         $first = false;
1975         if (is_null($root)) {
1976             $root = $this->top_element;
1977             $first = true;
1978         }
1980         $name = '';
1983         if (strpos($root['object']->table, 'grade_categories') !== false) {
1984             $name = $root['object']->fullname;
1985             if ($name == '?') {
1986                 $name = $root['object']->get_name();
1987             }
1988         } else if (strpos($root['object']->table, 'grade_items') !== false) {
1989             $name = $root['object']->itemname;
1990         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
1991             $name = $root['object']->itemname;
1992         }
1994         $json .= "$tabs {\n";
1995         $json .= "$tabs\t \"type\": \"{$root['type']}\",\n";
1996         $json .= "$tabs\t \"name\": \"$name\",\n";
1998         foreach ($root['object'] as $var => $value) {
1999             if (!is_object($value) && !is_array($value) && !empty($value)) {
2000                 $json .= "$tabs\t \"$var\": \"$value\",\n";
2001             }
2002         }
2004         $json = substr($json, 0, strrpos($json, ','));
2006         if (!empty($root['children'])) {
2007             $json .= ",\n$tabs\t\"children\": [\n";
2008             foreach ($root['children'] as $sortorder => $child) {
2009                 $json .= $this->exportToJSON($child, $tabs."\t\t");
2010             }
2011             $json = substr($json, 0, strrpos($json, ','));
2012             $json .= "\n$tabs\t]\n";
2013         }
2015         if ($first) {
2016             $json .= "\n}";
2017         } else {
2018             $json .= "\n$tabs},\n";
2019         }
2021         return $json;
2022     }
2024     /**
2025      * Returns the array of levels
2026      *
2027      * @return array
2028      */
2029     public function get_levels() {
2030         return $this->levels;
2031     }
2033     /**
2034      * Returns the array of grade items
2035      *
2036      * @return array
2037      */
2038     public function get_items() {
2039         return $this->items;
2040     }
2042     /**
2043      * Returns a specific Grade Item
2044      *
2045      * @param int $itemid The ID of the grade_item object
2046      *
2047      * @return grade_item
2048      */
2049     public function get_item($itemid) {
2050         if (array_key_exists($itemid, $this->items)) {
2051             return $this->items[$itemid];
2052         } else {
2053             return false;
2054         }
2055     }
2058 /**
2059  * Local shortcut function for creating an edit/delete button for a grade_* object.
2060  * @param string $type 'edit' or 'delete'
2061  * @param int $courseid The Course ID
2062  * @param grade_* $object The grade_* object
2063  * @return string html
2064  */
2065 function grade_button($type, $courseid, $object) {
2066     global $CFG, $OUTPUT;
2067     if (preg_match('/grade_(.*)/', get_class($object), $matches)) {
2068         $objectidstring = $matches[1] . 'id';
2069     } else {
2070         throw new coding_exception('grade_button() only accepts grade_* objects as third parameter!');
2071     }
2073     $strdelete = get_string('delete');
2074     $stredit   = get_string('edit');
2076     if ($type == 'delete') {
2077         $url = new moodle_url('index.php', array('id' => $courseid, $objectidstring => $object->id, 'action' => 'delete', 'sesskey' => sesskey()));
2078     } else if ($type == 'edit') {
2079         $url = new moodle_url('edit.php', array('courseid' => $courseid, 'id' => $object->id));
2080     }
2082     return $OUTPUT->action_icon($url, new pix_icon('t/'.$type, ${'str'.$type}));
2086 /**
2087  * This method adds settings to the settings block for the grade system and its
2088  * plugins
2089  *
2090  * @global moodle_page $PAGE
2091  */
2092 function grade_extend_settings($plugininfo, $courseid) {
2093     global $PAGE;
2095     $gradenode = $PAGE->settingsnav->prepend(get_string('gradeadministration', 'grades'), null, navigation_node::TYPE_CONTAINER);
2097     $strings = array_shift($plugininfo);
2099     if ($reports = grade_helper::get_plugins_reports($courseid)) {
2100         foreach ($reports as $report) {
2101             $gradenode->add($report->string, $report->link, navigation_node::TYPE_SETTING, null, $report->id, new pix_icon('i/report', ''));
2102         }
2103     }
2105     if ($imports = grade_helper::get_plugins_import($courseid)) {
2106         $importnode = $gradenode->add($strings['import'], null, navigation_node::TYPE_CONTAINER);
2107         foreach ($imports as $import) {
2108             $importnode->add($import->string, $import->link, navigation_node::TYPE_SETTING, null, $import->id, new pix_icon('i/restore', ''));
2109         }
2110     }
2112     if ($exports = grade_helper::get_plugins_export($courseid)) {
2113         $exportnode = $gradenode->add($strings['export'], null, navigation_node::TYPE_CONTAINER);
2114         foreach ($exports as $export) {
2115             $exportnode->add($export->string, $export->link, navigation_node::TYPE_SETTING, null, $export->id, new pix_icon('i/backup', ''));
2116         }
2117     }
2119     if ($setting = grade_helper::get_info_manage_settings($courseid)) {
2120         $gradenode->add(get_string('coursegradesettings', 'grades'), $setting->link, navigation_node::TYPE_SETTING, null, $setting->id, new pix_icon('i/settings', ''));
2121     }
2123     if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
2124         $preferencesnode = $gradenode->add(get_string('myreportpreferences', 'grades'), null, navigation_node::TYPE_CONTAINER);
2125         foreach ($preferences as $preference) {
2126             $preferencesnode->add($preference->string, $preference->link, navigation_node::TYPE_SETTING, null, $preference->id, new pix_icon('i/settings', ''));
2127         }
2128     }
2130     if ($letters = grade_helper::get_info_letters($courseid)) {
2131         $letters = array_shift($letters);
2132         $gradenode->add($strings['letter'], $letters->link, navigation_node::TYPE_SETTING, null, $letters->id, new pix_icon('i/settings', ''));
2133     }
2135     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
2136         $outcomes = array_shift($outcomes);
2137         $gradenode->add($strings['outcome'], $outcomes->link, navigation_node::TYPE_SETTING, null, $outcomes->id, new pix_icon('i/outcomes', ''));
2138     }
2140     if ($scales = grade_helper::get_info_scales($courseid)) {
2141         $gradenode->add($strings['scale'], $scales->link, navigation_node::TYPE_SETTING, null, $scales->id, new pix_icon('i/scales', ''));
2142     }
2144     if ($categories = grade_helper::get_info_edit_structure($courseid)) {
2145         $categoriesnode = $gradenode->add(get_string('categoriesanditems','grades'), null, navigation_node::TYPE_CONTAINER);
2146         foreach ($categories as $category) {
2147             $categoriesnode->add($category->string, $category->link, navigation_node::TYPE_SETTING, null, $category->id, new pix_icon('i/report', ''));
2148         }
2149     }
2151     if ($gradenode->contains_active_node()) {
2152         // If the gradenode is active include the settings base node (gradeadministration) in
2153         // the navbar, typcially this is ignored.
2154         $PAGE->navbar->includesettingsbase = true;
2156         // If we can get the course admin node make sure it is closed by default
2157         // as in this case the gradenode will be opened
2158         if ($coursenode = $PAGE->settingsnav->get('courseadmin', navigation_node::TYPE_COURSE)){
2159             $coursenode->make_inactive();
2160             $coursenode->forceopen = false;
2161         }
2162     }
2165 /**
2166  * Grade helper class
2167  *
2168  * This class provides several helpful functions that work irrespective of any
2169  * current state.
2170  *
2171  * @copyright 2010 Sam Hemelryk
2172  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2173  */
2174 abstract class grade_helper {
2175     /**
2176      * Cached manage settings info {@see get_info_settings}
2177      * @var grade_plugin_info|false
2178      */
2179     protected static $managesetting = null;
2180     /**
2181      * Cached grade report plugins {@see get_plugins_reports}
2182      * @var array|false
2183      */
2184     protected static $gradereports = null;
2185     /**
2186      * Cached grade report plugins preferences {@see get_info_scales}
2187      * @var array|false
2188      */
2189     protected static $gradereportpreferences = null;
2190     /**
2191      * Cached scale info {@see get_info_scales}
2192      * @var grade_plugin_info|false
2193      */
2194     protected static $scaleinfo = null;
2195     /**
2196      * Cached outcome info {@see get_info_outcomes}
2197      * @var grade_plugin_info|false
2198      */
2199     protected static $outcomeinfo = null;
2200     /**
2201      * Cached info on edit structure {@see get_info_edit_structure}
2202      * @var array|false
2203      */
2204     protected static $edittree = null;
2205     /**
2206      * Cached leftter info {@see get_info_letters}
2207      * @var grade_plugin_info|false
2208      */
2209     protected static $letterinfo = null;
2210     /**
2211      * Cached grade import plugins {@see get_plugins_import}
2212      * @var array|false
2213      */
2214     protected static $importplugins = null;
2215     /**
2216      * Cached grade export plugins {@see get_plugins_export}
2217      * @var array|false
2218      */
2219     protected static $exportplugins = null;
2220     /**
2221      * Cached grade plugin strings
2222      * @var array
2223      */
2224     protected static $pluginstrings = null;
2226     /**
2227      * Gets strings commonly used by the describe plugins
2228      *
2229      * report => get_string('view'),
2230      * edittree => get_string('edittree', 'grades'),
2231      * scale => get_string('scales'),
2232      * outcome => get_string('outcomes', 'grades'),
2233      * letter => get_string('letters', 'grades'),
2234      * export => get_string('export', 'grades'),
2235      * import => get_string('import'),
2236      * preferences => get_string('mypreferences', 'grades'),
2237      * settings => get_string('settings')
2238      *
2239      * @return array
2240      */
2241     public static function get_plugin_strings() {
2242         if (self::$pluginstrings === null) {
2243             self::$pluginstrings = array(
2244                 'report' => get_string('view'),
2245                 'edittree' => get_string('edittree', 'grades'),
2246                 'scale' => get_string('scales'),
2247                 'outcome' => get_string('outcomes', 'grades'),
2248                 'letter' => get_string('letters', 'grades'),
2249                 'export' => get_string('export', 'grades'),
2250                 'import' => get_string('import'),
2251                 'preferences' => get_string('mypreferences', 'grades'),
2252                 'settings' => get_string('settings')
2253             );
2254         }
2255         return self::$pluginstrings;
2256     }
2257     /**
2258      * Get grade_plugin_info object for managing settings if the user can
2259      *
2260      * @param int $courseid
2261      * @return grade_plugin_info
2262      */
2263     public static function get_info_manage_settings($courseid) {
2264         if (self::$managesetting !== null) {
2265             return self::$managesetting;
2266         }
2267         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2268         if (has_capability('moodle/course:update', $context)) {
2269             self::$managesetting = new grade_plugin_info('coursesettings', new moodle_url('/grade/edit/settings/index.php', array('id'=>$courseid)), get_string('course'));
2270         } else {
2271             self::$managesetting = false;
2272         }
2273         return self::$managesetting;
2274     }
2275     /**
2276      * Returns an array of plugin reports as grade_plugin_info objects
2277      *
2278      * @param int $courseid
2279      * @return array
2280      */
2281     public static function get_plugins_reports($courseid) {
2282         global $SITE;
2284         if (self::$gradereports !== null) {
2285             return self::$gradereports;
2286         }
2287         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2288         $gradereports = array();
2289         $gradepreferences = array();
2290         foreach (get_plugin_list('gradereport') as $plugin => $plugindir) {
2291             //some reports make no sense if we're not within a course
2292             if ($courseid==$SITE->id && ($plugin=='grader' || $plugin=='user')) {
2293                 continue;
2294             }
2296             // Remove ones we can't see
2297             if (!has_capability('gradereport/'.$plugin.':view', $context)) {
2298                 continue;
2299             }
2301             $pluginstr = get_string('pluginname', 'gradereport_'.$plugin);
2302             $url = new moodle_url('/grade/report/'.$plugin.'/index.php', array('id'=>$courseid));
2303             $gradereports[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2305             // Add link to preferences tab if such a page exists
2306             if (file_exists($plugindir.'/preferences.php')) {
2307                 $url = new moodle_url('/grade/report/'.$plugin.'/preferences.php', array('id'=>$courseid));
2308                 $gradepreferences[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2309             }
2310         }
2311         if (count($gradereports) == 0) {
2312             $gradereports = false;
2313             $gradepreferences = false;
2314         } else if (count($gradepreferences) == 0) {
2315             $gradepreferences = false;
2316             asort($gradereports);
2317         } else {
2318             asort($gradereports);
2319             asort($gradepreferences);
2320         }
2321         self::$gradereports = $gradereports;
2322         self::$gradereportpreferences = $gradepreferences;
2323         return self::$gradereports;
2324     }
2325     /**
2326      * Returns an array of grade plugin report preferences for plugin reports that
2327      * support preferences
2328      * @param int $courseid
2329      * @return array
2330      */
2331     public static function get_plugins_report_preferences($courseid) {
2332         if (self::$gradereportpreferences !== null) {
2333             return self::$gradereportpreferences;
2334         }
2335         self::get_plugins_reports($courseid);
2336         return self::$gradereportpreferences;
2337     }
2338     /**
2339      * Get information on scales
2340      * @param int $courseid
2341      * @return grade_plugin_info
2342      */
2343     public static function get_info_scales($courseid) {
2344         if (self::$scaleinfo !== null) {
2345             return self::$scaleinfo;
2346         }
2347         if (has_capability('moodle/course:managescales', get_context_instance(CONTEXT_COURSE, $courseid))) {
2348             $url = new moodle_url('/grade/edit/scale/index.php', array('id'=>$courseid));
2349             self::$scaleinfo = new grade_plugin_info('scale', $url, get_string('view'));
2350         } else {
2351             self::$scaleinfo = false;
2352         }
2353         return self::$scaleinfo;
2354     }
2355     /**
2356      * Get information on outcomes
2357      * @param int $courseid
2358      * @return grade_plugin_info
2359      */
2360     public static function get_info_outcomes($courseid) {
2361         global $CFG, $SITE;
2363         if (self::$outcomeinfo !== null) {
2364             return self::$outcomeinfo;
2365         }
2366         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2367         $canmanage = has_capability('moodle/grade:manage', $context);
2368         $canupdate = has_capability('moodle/course:update', $context);
2369         if (!empty($CFG->enableoutcomes) && ($canmanage || $canupdate)) {
2370             $outcomes = array();
2371             if ($canupdate) {
2372                 if ($courseid!=$SITE->id) {
2373                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2374                     $outcomes['course'] = new grade_plugin_info('course', $url, get_string('outcomescourse', 'grades'));
2375                 }
2376                 $url = new moodle_url('/grade/edit/outcome/index.php', array('id'=>$courseid));
2377                 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('editoutcomes', 'grades'));
2378                 $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid'=>$courseid));
2379                 $outcomes['import'] = new grade_plugin_info('import', $url, get_string('importoutcomes', 'grades'));
2380             } else {
2381                 if ($courseid!=$SITE->id) {
2382                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2383                     $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('outcomescourse', 'grades'));
2384                 }
2385             }
2386             self::$outcomeinfo = $outcomes;
2387         } else {
2388             self::$outcomeinfo = false;
2389         }
2390         return self::$outcomeinfo;
2391     }
2392     /**
2393      * Get information on editing structures
2394      * @param int $courseid
2395      * @return array
2396      */
2397     public static function get_info_edit_structure($courseid) {
2398         if (self::$edittree !== null) {
2399             return self::$edittree;
2400         }
2401         if (has_capability('moodle/grade:manage', get_context_instance(CONTEXT_COURSE, $courseid))) {
2402             $url = new moodle_url('/grade/edit/tree/index.php', array('sesskey'=>sesskey(), 'showadvanced'=>'0', 'id'=>$courseid));
2403             self::$edittree = array(
2404                 'simpleview' => new grade_plugin_info('simpleview', $url, get_string('simpleview', 'grades')),
2405                 'fullview' => new grade_plugin_info('fullview', new moodle_url($url, array('showadvanced'=>'1')), get_string('fullview', 'grades'))
2406             );
2407         } else {
2408             self::$edittree = false;
2409         }
2410         return self::$edittree;
2411     }
2412     /**
2413      * Get information on letters
2414      * @param int $courseid
2415      * @return array
2416      */
2417     public static function get_info_letters($courseid) {
2418         if (self::$letterinfo !== null) {
2419             return self::$letterinfo;
2420         }
2421         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2422         $canmanage = has_capability('moodle/grade:manage', $context);
2423         $canmanageletters = has_capability('moodle/grade:manageletters', $context);
2424         if ($canmanage || $canmanageletters) {
2425             self::$letterinfo = array(
2426                 'view' => new grade_plugin_info('view', new moodle_url('/grade/edit/letter/index.php', array('id'=>$context->id)), get_string('view')),
2427                 'edit' => new grade_plugin_info('edit', new moodle_url('/grade/edit/letter/index.php', array('edit'=>1,'id'=>$context->id)), get_string('edit'))
2428             );
2429         } else {
2430             self::$letterinfo = false;
2431         }
2432         return self::$letterinfo;
2433     }
2434     /**
2435      * Get information import plugins
2436      * @param int $courseid
2437      * @return array
2438      */
2439     public static function get_plugins_import($courseid) {
2440         global $CFG;
2442         if (self::$importplugins !== null) {
2443             return self::$importplugins;
2444         }
2445         $importplugins = array();
2446         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2448         if (has_capability('moodle/grade:import', $context)) {
2449             foreach (get_plugin_list('gradeimport') as $plugin => $plugindir) {
2450                 if (!has_capability('gradeimport/'.$plugin.':view', $context)) {
2451                     continue;
2452                 }
2453                 $pluginstr = get_string('pluginname', 'gradeimport_'.$plugin);
2454                 $url = new moodle_url('/grade/import/'.$plugin.'/index.php', array('id'=>$courseid));
2455                 $importplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2456             }
2459             if ($CFG->gradepublishing) {
2460                 $url = new moodle_url('/grade/import/keymanager.php', array('id'=>$courseid));
2461                 $importplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2462             }
2463         }
2465         if (count($importplugins) > 0) {
2466             asort($importplugins);
2467             self::$importplugins = $importplugins;
2468         } else {
2469             self::$importplugins = false;
2470         }
2471         return self::$importplugins;
2472     }
2473     /**
2474      * Get information export plugins
2475      * @param int $courseid
2476      * @return array
2477      */
2478     public static function get_plugins_export($courseid) {
2479         global $CFG;
2481         if (self::$exportplugins !== null) {
2482             return self::$exportplugins;
2483         }
2484         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2485         $exportplugins = array();
2486         if (has_capability('moodle/grade:export', $context)) {
2487             foreach (get_plugin_list('gradeexport') as $plugin => $plugindir) {
2488                 if (!has_capability('gradeexport/'.$plugin.':view', $context)) {
2489                     continue;
2490                 }
2491                 $pluginstr = get_string('pluginname', 'gradeexport_'.$plugin);
2492                 $url = new moodle_url('/grade/export/'.$plugin.'/index.php', array('id'=>$courseid));
2493                 $exportplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2494             }
2496             if ($CFG->gradepublishing) {
2497                 $url = new moodle_url('/grade/export/keymanager.php', array('id'=>$courseid));
2498                 $exportplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2499             }
2500         }
2501         if (count($exportplugins) > 0) {
2502             asort($exportplugins);
2503             self::$exportplugins = $exportplugins;
2504         } else {
2505             self::$exportplugins = false;
2506         }
2507         return self::$exportplugins;
2508     }