gradebook MDL-24867 now hiding some items from the gradebook nav box if youre not...
[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         list($gradebookroles_sql, $params) =
89             $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
91         $relatedcontexts = get_related_contexts_string(get_context_instance(CONTEXT_COURSE, $this->course->id));
93         if ($this->groupid) {
94             $groupsql = "INNER JOIN {groups_members} gm ON gm.userid = u.id";
95             $groupwheresql = "AND gm.groupid = :groupid";
96             // $params contents: gradebookroles
97             $params['groupid'] = $this->groupid;
98         } else {
99             $groupsql = "";
100             $groupwheresql = "";
101         }
103         if (empty($this->sortfield1)) {
104             // we must do some sorting even if not specified
105             $ofields = ", u.id AS usrt";
106             $order   = "usrt ASC";
108         } else {
109             $ofields = ", u.$this->sortfield1 AS usrt1";
110             $order   = "usrt1 $this->sortorder1";
111             if (!empty($this->sortfield2)) {
112                 $ofields .= ", u.$this->sortfield2 AS usrt2";
113                 $order   .= ", usrt2 $this->sortorder2";
114             }
115             if ($this->sortfield1 != 'id' and $this->sortfield2 != 'id') {
116                 // user order MUST be the same in both queries,
117                 // must include the only unique user->id if not already present
118                 $ofields .= ", u.id AS usrt";
119                 $order   .= ", usrt ASC";
120             }
121         }
123         // $params contents: gradebookroles and groupid (for $groupwheresql)
124         $users_sql = "SELECT u.* $ofields
125                         FROM {user} u
126                              INNER JOIN {role_assignments} ra ON u.id = ra.userid
127                              $groupsql
128                        WHERE u.deleted=0
129                              AND ra.roleid $gradebookroles_sql
130                              AND ra.contextid $relatedcontexts
131                              $groupwheresql
132                     ORDER BY $order";
134         $this->users_rs = $DB->get_recordset_sql($users_sql, $params);
136         if (!empty($this->grade_items)) {
137             $itemids = array_keys($this->grade_items);
138             list($itemidsql, $grades_params) = $DB->get_in_or_equal($itemids, SQL_PARAMS_NAMED, 'items0');
139             $params = array_merge($params, $grades_params);
141             // $params contents: gradebookroles, groupid (for $groupwheresql) and itemids
142             $grades_sql = "SELECT g.* $ofields
143                              FROM {grade_grades} g
144                                   INNER JOIN {user} u ON g.userid = u.id
145                                   INNER JOIN {role_assignments} ra ON u.id = ra.userid
146                                   $groupsql
147                             WHERE ra.roleid $gradebookroles_sql
148                                   AND ra.contextid $relatedcontexts
149                                   $groupwheresql
150                                   AND g.itemid $itemidsql
151                          ORDER BY $order, g.itemid ASC";
152             $this->grades_rs = $DB->get_recordset_sql($grades_sql, $params);
153         } else {
154             $this->grades_rs = false;
155         }
157         return true;
158     }
160     /**
161      * Returns information about the next user
162      * @return mixed array of user info, all grades and feedback or null when no more users found
163      */
164     function next_user() {
165         if (!$this->users_rs) {
166             return false; // no users present
167         }
169         if (!$this->users_rs->valid()) {
170             if ($current = $this->_pop()) {
171                 // this is not good - user or grades updated between the two reads above :-(
172             }
174             return false; // no more users
175         } else {
176             $user = $this->users_rs->current();
177             $this->users_rs->next();
178         }
180         // find grades of this user
181         $grade_records = array();
182         while (true) {
183             if (!$current = $this->_pop()) {
184                 break; // no more grades
185             }
187             if (empty($current->userid)) {
188                 break;
189             }
191             if ($current->userid != $user->id) {
192                 // grade of the next user, we have all for this user
193                 $this->_push($current);
194                 break;
195             }
197             $grade_records[$current->itemid] = $current;
198         }
200         $grades = array();
201         $feedbacks = array();
203         if (!empty($this->grade_items)) {
204             foreach ($this->grade_items as $grade_item) {
205                 if (array_key_exists($grade_item->id, $grade_records)) {
206                     $feedbacks[$grade_item->id]->feedback       = $grade_records[$grade_item->id]->feedback;
207                     $feedbacks[$grade_item->id]->feedbackformat = $grade_records[$grade_item->id]->feedbackformat;
208                     unset($grade_records[$grade_item->id]->feedback);
209                     unset($grade_records[$grade_item->id]->feedbackformat);
210                     $grades[$grade_item->id] = new grade_grade($grade_records[$grade_item->id], false);
211                 } else {
212                     $feedbacks[$grade_item->id]->feedback       = '';
213                     $feedbacks[$grade_item->id]->feedbackformat = FORMAT_MOODLE;
214                     $grades[$grade_item->id] =
215                         new grade_grade(array('userid'=>$user->id, 'itemid'=>$grade_item->id), false);
216                 }
217             }
218         }
220         $result = new stdClass();
221         $result->user      = $user;
222         $result->grades    = $grades;
223         $result->feedbacks = $feedbacks;
225         return $result;
226     }
228     /**
229      * Close the iterator, do not forget to call this function.
230      * @return void
231      */
232     function close() {
233         if ($this->users_rs) {
234             $this->users_rs->close();
235             $this->users_rs = null;
236         }
237         if ($this->grades_rs) {
238             $this->grades_rs->close();
239             $this->grades_rs = null;
240         }
241         $this->gradestack = array();
242     }
245     /**
246      * _push
247      *
248      * @param grade_grade $grade Grade object
249      *
250      * @return void
251      */
252     function _push($grade) {
253         array_push($this->gradestack, $grade);
254     }
257     /**
258      * _pop
259      *
260      * @return void
261      */
262     function _pop() {
263         global $DB;
264         if (empty($this->gradestack)) {
265             if (!$this->grades_rs) {
266                 return null; // no grades present
267             }
269             if ($this->grades_rs->next()) {
270                 return null; // no more grades
271             }
273             return $this->grades_rs->current();
274         } else {
275             return array_pop($this->gradestack);
276         }
277     }
280 /**
281  * Print a selection popup form of the graded users in a course.
282  *
283  * @deprecated since 2.0
284  *
285  * @param int    $course id of the course
286  * @param string $actionpage The page receiving the data from the popoup form
287  * @param int    $userid   id of the currently selected user (or 'all' if they are all selected)
288  * @param int    $groupid id of requested group, 0 means all
289  * @param int    $includeall bool include all option
290  * @param bool   $return If true, will return the HTML, otherwise, will print directly
291  * @return null
292  */
293 function print_graded_users_selector($course, $actionpage, $userid=0, $groupid=0, $includeall=true, $return=false) {
294     global $CFG, $USER, $OUTPUT;
295     return $OUTPUT->render(grade_get_graded_users_select(substr($actionpage, 0, strpos($actionpage, '/')), $course, $userid, $groupid, $includeall));
298 function grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall) {
299     global $USER;
301     if (is_null($userid)) {
302         $userid = $USER->id;
303     }
305     $menu = array(); // Will be a list of userid => user name
306     $gui = new graded_users_iterator($course, null, $groupid);
307     $gui->init();
308     $label = get_string('selectauser', 'grades');
309     if ($includeall) {
310         $menu[0] = get_string('allusers', 'grades');
311         $label = get_string('selectalloroneuser', 'grades');
312     }
313     while ($userdata = $gui->next_user()) {
314         $user = $userdata->user;
315         $menu[$user->id] = fullname($user);
316     }
317     $gui->close();
319     if ($includeall) {
320         $menu[0] .= " (" . (count($menu) - 1) . ")";
321     }
322     $select = new single_select(new moodle_url('/grade/report/'.$report.'/index.php', array('id'=>$course->id)), 'userid', $menu, $userid);
323     $select->label = $label;
324     $select->formid = 'choosegradeuser';
325     return $select;
328 /**
329  * Print grading plugin selection popup form.
330  *
331  * @param array   $plugin_info An array of plugins containing information for the selector
332  * @param boolean $return return as string
333  *
334  * @return nothing or string if $return true
335  */
336 function print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) {
337     global $CFG, $OUTPUT, $PAGE;
339     $menu = array();
340     $count = 0;
341     $active = '';
343     foreach ($plugin_info as $plugin_type => $plugins) {
344         if ($plugin_type == 'strings') {
345             continue;
346         }
348         $first_plugin = reset($plugins);
350         $sectionname = $plugin_info['strings'][$plugin_type];
351         $section = array();
353         foreach ($plugins as $plugin) {
354             $link = $plugin->link->out(false);
355             $section[$link] = $plugin->string;
356             $count++;
357             if ($plugin_type === $active_type and $plugin->id === $active_plugin) {
358                 $active = $link;
359             }
360         }
362         if ($section) {
363             $menu[] = array($sectionname=>$section);
364         }
365     }
367     // finally print/return the popup form
368     if ($count > 1) {
369         $select = new url_select($menu, $active, null, 'choosepluginreport');
371         if ($return) {
372             return $OUTPUT->render($select);
373         } else {
374             echo $OUTPUT->render($select);
375         }
376     } else {
377         // only one option - no plugin selector needed
378         return '';
379     }
382 /**
383  * Print grading plugin selection tab-based navigation.
384  *
385  * @param string  $active_type type of plugin on current page - import, export, report or edit
386  * @param string  $active_plugin active plugin type - grader, user, cvs, ...
387  * @param array   $plugin_info Array of plugins
388  * @param boolean $return return as string
389  *
390  * @return nothing or string if $return true
391  */
392 function grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) {
393     global $CFG, $COURSE;
395     if (!isset($currenttab)) { //TODO: this is weird
396         $currenttab = '';
397     }
399     $tabs = array();
400     $top_row  = array();
401     $bottom_row = array();
402     $inactive = array($active_plugin);
403     $activated = array();
405     $count = 0;
406     $active = '';
408     foreach ($plugin_info as $plugin_type => $plugins) {
409         if ($plugin_type == 'strings') {
410             continue;
411         }
413         // If $plugins is actually the definition of a child-less parent link:
414         if (!empty($plugins->id)) {
415             $string = $plugins->string;
416             if (!empty($plugin_info[$active_type]->parent)) {
417                 $string = $plugin_info[$active_type]->parent->string;
418             }
420             $top_row[] = new tabobject($plugin_type, $plugins->link, $string);
421             continue;
422         }
424         $first_plugin = reset($plugins);
425         $url = $first_plugin->link;
427         if ($plugin_type == 'report') {
428             $url = $CFG->wwwroot.'/grade/report/index.php?id='.$COURSE->id;
429         }
431         $top_row[] = new tabobject($plugin_type, $url, $plugin_info['strings'][$plugin_type]);
433         if ($active_type == $plugin_type) {
434             foreach ($plugins as $plugin) {
435                 $bottom_row[] = new tabobject($plugin->id, $plugin->link, $plugin->string);
436                 if ($plugin->id == $active_plugin) {
437                     $inactive = array($plugin->id);
438                 }
439             }
440         }
441     }
443     $tabs[] = $top_row;
444     $tabs[] = $bottom_row;
446     if ($return) {
447         return print_tabs($tabs, $active_type, $inactive, $activated, true);
448     } else {
449         print_tabs($tabs, $active_type, $inactive, $activated);
450     }
453 /**
454  * grade_get_plugin_info
455  *
456  * @param int    $courseid The course id
457  * @param string $active_type type of plugin on current page - import, export, report or edit
458  * @param string $active_plugin active plugin type - grader, user, cvs, ...
459  *
460  * @return array
461  */
462 function grade_get_plugin_info($courseid, $active_type, $active_plugin) {
463     global $CFG, $SITE;
465     $context = get_context_instance(CONTEXT_COURSE, $courseid);
467     $plugin_info = array();
468     $count = 0;
469     $active = '';
470     $url_prefix = $CFG->wwwroot . '/grade/';
472     // Language strings
473     $plugin_info['strings'] = grade_helper::get_plugin_strings();
475     if ($reports = grade_helper::get_plugins_reports($courseid)) {
476         $plugin_info['report'] = $reports;
477     }
479     //showing grade categories and items make no sense if we're not within a course
480     if ($courseid!=$SITE->id) {
481         if ($edittree = grade_helper::get_info_edit_structure($courseid)) {
482             $plugin_info['edittree'] = $edittree;
483         }
484     }
486     if ($scale = grade_helper::get_info_scales($courseid)) {
487         $plugin_info['scale'] = array('view'=>$scale);
488     }
490     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
491         $plugin_info['outcome'] = $outcomes;
492     }
494     if ($letters = grade_helper::get_info_letters($courseid)) {
495         $plugin_info['letter'] = $letters;
496     }
498     if ($imports = grade_helper::get_plugins_import($courseid)) {
499         $plugin_info['import'] = $imports;
500     }
502     if ($exports = grade_helper::get_plugins_export($courseid)) {
503         $plugin_info['export'] = $exports;
504     }
506     foreach ($plugin_info as $plugin_type => $plugins) {
507         if (!empty($plugins->id) && $active_plugin == $plugins->id) {
508             $plugin_info['strings']['active_plugin_str'] = $plugins->string;
509             break;
510         }
511         foreach ($plugins as $plugin) {
512             if (is_a($plugin, 'grade_plugin_info')) {
513                 if ($active_plugin == $plugin->id) {
514                     $plugin_info['strings']['active_plugin_str'] = $plugin->string;
515                 }
516             }
517         }
518     }
520     //hide course settings if we're not in a course
521     if ($courseid!=$SITE->id) {
522         if ($setting = grade_helper::get_info_manage_settings($courseid)) {
523             $plugin_info['settings'] = array('course'=>$setting);
524         }
525     }
527     // Put preferences last
528     if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
529         $plugin_info['preferences'] = $preferences;
530     }
532     foreach ($plugin_info as $plugin_type => $plugins) {
533         if (!empty($plugins->id) && $active_plugin == $plugins->id) {
534             $plugin_info['strings']['active_plugin_str'] = $plugins->string;
535             break;
536         }
537         foreach ($plugins as $plugin) {
538             if (is_a($plugin, 'grade_plugin_info')) {
539                 if ($active_plugin == $plugin->id) {
540                     $plugin_info['strings']['active_plugin_str'] = $plugin->string;
541                 }
542             }
543         }
544     }
546     return $plugin_info;
549 /**
550  * A simple class containing info about grade plugins.
551  * Can be subclassed for special rules
552  *
553  * @package moodlecore
554  * @copyright 2009 Nicolas Connault
555  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
556  */
557 class grade_plugin_info {
558     /**
559      * A unique id for this plugin
560      *
561      * @var mixed
562      */
563     public $id;
564     /**
565      * A URL to access this plugin
566      *
567      * @var mixed
568      */
569     public $link;
570     /**
571      * The name of this plugin
572      *
573      * @var mixed
574      */
575     public $string;
576     /**
577      * Another grade_plugin_info object, parent of the current one
578      *
579      * @var mixed
580      */
581     public $parent;
583     /**
584      * Constructor
585      *
586      * @param int $id A unique id for this plugin
587      * @param string $link A URL to access this plugin
588      * @param string $string The name of this plugin
589      * @param object $parent Another grade_plugin_info object, parent of the current one
590      *
591      * @return void
592      */
593     public function __construct($id, $link, $string, $parent=null) {
594         $this->id = $id;
595         $this->link = $link;
596         $this->string = $string;
597         $this->parent = $parent;
598     }
601 /**
602  * Prints the page headers, breadcrumb trail, page heading, (optional) dropdown navigation menu and
603  * (optional) navigation tabs for any gradebook page. All gradebook pages MUST use these functions
604  * in favour of the usual print_header(), print_header_simple(), print_heading() etc.
605  * !IMPORTANT! Use of tabs.php file in gradebook pages is forbidden unless tabs are switched off at
606  * the site level for the gradebook ($CFG->grade_navmethod = GRADE_NAVMETHOD_DROPDOWN).
607  *
608  * @param int     $courseid Course id
609  * @param string  $active_type The type of the current page (report, settings,
610  *                             import, export, scales, outcomes, letters)
611  * @param string  $active_plugin The plugin of the current page (grader, fullview etc...)
612  * @param string  $heading The heading of the page. Tries to guess if none is given
613  * @param boolean $return Whether to return (true) or echo (false) the HTML generated by this function
614  * @param string  $bodytags Additional attributes that will be added to the <body> tag
615  * @param string  $buttons Additional buttons to display on the page
616  *
617  * @return string HTML code or nothing if $return == false
618  */
619 function print_grade_page_head($courseid, $active_type, $active_plugin=null,
620                                $heading = false, $return=false,
621                                $buttons=false, $shownavigation=true) {
622     global $CFG, $OUTPUT, $PAGE;
624     $plugin_info = grade_get_plugin_info($courseid, $active_type, $active_plugin);
626     // Determine the string of the active plugin
627     $stractive_plugin = ($active_plugin) ? $plugin_info['strings']['active_plugin_str'] : $heading;
628     $stractive_type = $plugin_info['strings'][$active_type];
630     if (empty($plugin_info[$active_type]->id) || !empty($plugin_info[$active_type]->parent)) {
631         $title = $PAGE->course->fullname.': ' . $stractive_type . ': ' . $stractive_plugin;
632     } else {
633         $title = $PAGE->course->fullname.': ' . $stractive_plugin;
634     }
636     if ($active_type == 'report') {
637         $PAGE->set_pagelayout('report');
638     } else {
639         $PAGE->set_pagelayout('admin');
640     }
641     $PAGE->set_title(get_string('grades') . ': ' . $stractive_type);
642     $PAGE->set_heading($title);
643     if ($buttons instanceof single_button) {
644         $buttons = $OUTPUT->render($buttons);
645     }
646     $PAGE->set_button($buttons);
647     grade_extend_settings($plugin_info, $courseid);
649     $returnval = $OUTPUT->header();
650     if (!$return) {
651         echo $returnval;
652     }
654     // Guess heading if not given explicitly
655     if (!$heading) {
656         $heading = $stractive_plugin;
657     }
659     if ($shownavigation) {
660         if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_DROPDOWN) {
661             $returnval .= print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return);
662         }
663         $returnval .= $OUTPUT->heading($heading);
664         if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_TABS) {
665             $returnval .= grade_print_tabs($active_type, $active_plugin, $plugin_info, $return);
666         }
667     }
669     if ($return) {
670         return $returnval;
671     }
674 /**
675  * Utility class used for return tracking when using edit and other forms in grade plugins
676  *
677  * @package moodlecore
678  * @copyright 2009 Nicolas Connault
679  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
680  */
681 class grade_plugin_return {
682     public $type;
683     public $plugin;
684     public $courseid;
685     public $userid;
686     public $page;
688     /**
689      * Constructor
690      *
691      * @param array $params - associative array with return parameters, if null parameter are taken from _GET or _POST
692      */
693     public function grade_plugin_return($params = null) {
694         if (empty($params)) {
695             $this->type     = optional_param('gpr_type', null, PARAM_SAFEDIR);
696             $this->plugin   = optional_param('gpr_plugin', null, PARAM_SAFEDIR);
697             $this->courseid = optional_param('gpr_courseid', null, PARAM_INT);
698             $this->userid   = optional_param('gpr_userid', null, PARAM_INT);
699             $this->page     = optional_param('gpr_page', null, PARAM_INT);
701         } else {
702             foreach ($params as $key=>$value) {
703                 if (property_exists($this, $key)) {
704                     $this->$key = $value;
705                 }
706             }
707         }
708     }
710     /**
711      * Returns return parameters as options array suitable for buttons.
712      * @return array options
713      */
714     public function get_options() {
715         if (empty($this->type)) {
716             return array();
717         }
719         $params = array();
721         if (!empty($this->plugin)) {
722             $params['plugin'] = $this->plugin;
723         }
725         if (!empty($this->courseid)) {
726             $params['id'] = $this->courseid;
727         }
729         if (!empty($this->userid)) {
730             $params['userid'] = $this->userid;
731         }
733         if (!empty($this->page)) {
734             $params['page'] = $this->page;
735         }
737         return $params;
738     }
740     /**
741      * Returns return url
742      *
743      * @param string $default default url when params not set
744      * @param array  $extras Extra URL parameters
745      *
746      * @return string url
747      */
748     public function get_return_url($default, $extras=null) {
749         global $CFG;
751         if (empty($this->type) or empty($this->plugin)) {
752             return $default;
753         }
755         $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php';
756         $glue = '?';
758         if (!empty($this->courseid)) {
759             $url .= $glue.'id='.$this->courseid;
760             $glue = '&amp;';
761         }
763         if (!empty($this->userid)) {
764             $url .= $glue.'userid='.$this->userid;
765             $glue = '&amp;';
766         }
768         if (!empty($this->page)) {
769             $url .= $glue.'page='.$this->page;
770             $glue = '&amp;';
771         }
773         if (!empty($extras)) {
774             foreach ($extras as $key=>$value) {
775                 $url .= $glue.$key.'='.$value;
776                 $glue = '&amp;';
777             }
778         }
780         return $url;
781     }
783     /**
784      * Returns string with hidden return tracking form elements.
785      * @return string
786      */
787     public function get_form_fields() {
788         if (empty($this->type)) {
789             return '';
790         }
792         $result  = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />';
794         if (!empty($this->plugin)) {
795             $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />';
796         }
798         if (!empty($this->courseid)) {
799             $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />';
800         }
802         if (!empty($this->userid)) {
803             $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />';
804         }
806         if (!empty($this->page)) {
807             $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />';
808         }
809     }
811     /**
812      * Add hidden elements into mform
813      *
814      * @param object &$mform moodle form object
815      *
816      * @return void
817      */
818     public function add_mform_elements(&$mform) {
819         if (empty($this->type)) {
820             return;
821         }
823         $mform->addElement('hidden', 'gpr_type', $this->type);
824         $mform->setType('gpr_type', PARAM_SAFEDIR);
826         if (!empty($this->plugin)) {
827             $mform->addElement('hidden', 'gpr_plugin', $this->plugin);
828             $mform->setType('gpr_plugin', PARAM_SAFEDIR);
829         }
831         if (!empty($this->courseid)) {
832             $mform->addElement('hidden', 'gpr_courseid', $this->courseid);
833             $mform->setType('gpr_courseid', PARAM_INT);
834         }
836         if (!empty($this->userid)) {
837             $mform->addElement('hidden', 'gpr_userid', $this->userid);
838             $mform->setType('gpr_userid', PARAM_INT);
839         }
841         if (!empty($this->page)) {
842             $mform->addElement('hidden', 'gpr_page', $this->page);
843             $mform->setType('gpr_page', PARAM_INT);
844         }
845     }
847     /**
848      * Add return tracking params into url
849      *
850      * @param moodle_url $url A URL
851      *
852      * @return string $url with return tracking params
853      */
854     public function add_url_params(moodle_url $url) {
855         if (empty($this->type)) {
856             return $url;
857         }
859         $url->param('gpr_type', $this->type);
861         if (!empty($this->plugin)) {
862             $url->param('gpr_plugin', $this->plugin);
863         }
865         if (!empty($this->courseid)) {
866             $url->param('gpr_courseid' ,$this->courseid);
867         }
869         if (!empty($this->userid)) {
870             $url->param('gpr_userid', $this->userid);
871         }
873         if (!empty($this->page)) {
874             $url->param('gpr_page', $this->page);
875         }
877         return $url;
878     }
881 /**
882  * Function central to gradebook for building and printing the navigation (breadcrumb trail).
883  *
884  * @param string $path The path of the calling script (using __FILE__?)
885  * @param string $pagename The language string to use as the last part of the navigation (non-link)
886  * @param mixed  $id Either a plain integer (assuming the key is 'id') or
887  *                   an array of keys and values (e.g courseid => $courseid, itemid...)
888  *
889  * @return string
890  */
891 function grade_build_nav($path, $pagename=null, $id=null) {
892     global $CFG, $COURSE, $PAGE;
894     $strgrades = get_string('grades', 'grades');
896     // Parse the path and build navlinks from its elements
897     $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash
898     $path = substr($path, $dirroot_length);
899     $path = str_replace('\\', '/', $path);
901     $path_elements = explode('/', $path);
903     $path_elements_count = count($path_elements);
905     // First link is always 'grade'
906     $PAGE->navbar->add($strgrades, new moodle_url('/grade/index.php', array('id'=>$COURSE->id)));
908     $link = null;
909     $numberofelements = 3;
911     // Prepare URL params string
912     $linkparams = array();
913     if (!is_null($id)) {
914         if (is_array($id)) {
915             foreach ($id as $idkey => $idvalue) {
916                 $linkparams[$idkey] = $idvalue;
917             }
918         } else {
919             $linkparams['id'] = $id;
920         }
921     }
923     $navlink4 = null;
925     // Remove file extensions from filenames
926     foreach ($path_elements as $key => $filename) {
927         $path_elements[$key] = str_replace('.php', '', $filename);
928     }
930     // Second level links
931     switch ($path_elements[1]) {
932         case 'edit': // No link
933             if ($path_elements[3] != 'index.php') {
934                 $numberofelements = 4;
935             }
936             break;
937         case 'import': // No link
938             break;
939         case 'export': // No link
940             break;
941         case 'report':
942             // $id is required for this link. Do not print it if $id isn't given
943             if (!is_null($id)) {
944                 $link = new moodle_url('/grade/report/index.php', $linkparams);
945             }
947             if ($path_elements[2] == 'grader') {
948                 $numberofelements = 4;
949             }
950             break;
952         default:
953             // If this element isn't among the ones already listed above, it isn't supported, throw an error.
954             debugging("grade_build_nav() doesn't support ". $path_elements[1] .
955                     " as the second path element after 'grade'.");
956             return false;
957     }
958     $PAGE->navbar->add(get_string($path_elements[1], 'grades'), $link);
960     // Third level links
961     if (empty($pagename)) {
962         $pagename = get_string($path_elements[2], 'grades');
963     }
965     switch ($numberofelements) {
966         case 3:
967             $PAGE->navbar->add($pagename, $link);
968             break;
969         case 4:
970             if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') {
971                 $PAGE->navbar->add(get_string('pluginname', 'gradereport_grader'), new moodle_url('/grade/report/grader/index.php', $linkparams));
972             }
973             $PAGE->navbar->add($pagename);
974             break;
975     }
977     return '';
980 /**
981  * General structure representing grade items in course
982  *
983  * @package moodlecore
984  * @copyright 2009 Nicolas Connault
985  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
986  */
987 class grade_structure {
988     public $context;
990     public $courseid;
992     /**
993      * 1D array of grade items only
994      */
995     public $items;
997     /**
998      * Returns icon of element
999      *
1000      * @param array &$element An array representing an element in the grade_tree
1001      * @param bool  $spacerifnone return spacer if no icon found
1002      *
1003      * @return string icon or spacer
1004      */
1005     public function get_element_icon(&$element, $spacerifnone=false) {
1006         global $CFG, $OUTPUT;
1008         switch ($element['type']) {
1009             case 'item':
1010             case 'courseitem':
1011             case 'categoryitem':
1012                 $is_course   = $element['object']->is_course_item();
1013                 $is_category = $element['object']->is_category_item();
1014                 $is_scale    = $element['object']->gradetype == GRADE_TYPE_SCALE;
1015                 $is_value    = $element['object']->gradetype == GRADE_TYPE_VALUE;
1017                 if ($element['object']->is_calculated()) {
1018                     $strcalc = get_string('calculatedgrade', 'grades');
1019                     return '<img src="'.$OUTPUT->pix_url('i/calc') . '" class="icon itemicon" title="'.
1020                             s($strcalc).'" alt="'.s($strcalc).'"/>';
1022                 } else if (($is_course or $is_category) and ($is_scale or $is_value)) {
1023                     if ($category = $element['object']->get_item_category()) {
1024                         switch ($category->aggregation) {
1025                             case GRADE_AGGREGATE_MEAN:
1026                             case GRADE_AGGREGATE_MEDIAN:
1027                             case GRADE_AGGREGATE_WEIGHTED_MEAN:
1028                             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
1029                             case GRADE_AGGREGATE_EXTRACREDIT_MEAN:
1030                                 $stragg = get_string('aggregation', 'grades');
1031                                 return '<img src="'.$OUTPUT->pix_url('i/agg_mean') . '" ' .
1032                                         'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
1033                             case GRADE_AGGREGATE_SUM:
1034                                 $stragg = get_string('aggregation', 'grades');
1035                                 return '<img src="'.$OUTPUT->pix_url('i/agg_sum') . '" ' .
1036                                         'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
1037                         }
1038                     }
1040                 } else if ($element['object']->itemtype == 'mod') {
1041                     $strmodname = get_string('modulename', $element['object']->itemmodule);
1042                     return '<img src="'.$OUTPUT->pix_url('icon',
1043                             $element['object']->itemmodule) . '" ' .
1044                             'class="icon itemicon" title="' .s($strmodname).
1045                             '" alt="' .s($strmodname).'"/>';
1047                 } else if ($element['object']->itemtype == 'manual') {
1048                     if ($element['object']->is_outcome_item()) {
1049                         $stroutcome = get_string('outcome', 'grades');
1050                         return '<img src="'.$OUTPUT->pix_url('i/outcomes') . '" ' .
1051                                 'class="icon itemicon" title="'.s($stroutcome).
1052                                 '" alt="'.s($stroutcome).'"/>';
1053                     } else {
1054                         $strmanual = get_string('manualitem', 'grades');
1055                         return '<img src="'.$OUTPUT->pix_url('t/manual_item') . '" '.
1056                                 'class="icon itemicon" title="'.s($strmanual).
1057                                 '" alt="'.s($strmanual).'"/>';
1058                     }
1059                 }
1060                 break;
1062             case 'category':
1063                 $strcat = get_string('category', 'grades');
1064                 return '<img src="'.$OUTPUT->pix_url('f/folder') . '" class="icon itemicon" ' .
1065                         'title="'.s($strcat).'" alt="'.s($strcat).'" />';
1066         }
1068         if ($spacerifnone) {
1069             return $OUTPUT->spacer().' ';
1070         } else {
1071             return '';
1072         }
1073     }
1075     /**
1076      * Returns name of element optionally with icon and link
1077      *
1078      * @param array &$element An array representing an element in the grade_tree
1079      * @param bool  $withlink Whether or not this header has a link
1080      * @param bool  $icon Whether or not to display an icon with this header
1081      * @param bool  $spacerifnone return spacer if no icon found
1082      *
1083      * @return string header
1084      */
1085     public function get_element_header(&$element, $withlink=false, $icon=true, $spacerifnone=false) {
1086         global $CFG;
1088         $header = '';
1090         if ($icon) {
1091             $header .= $this->get_element_icon($element, $spacerifnone);
1092         }
1094         $header .= $element['object']->get_name();
1096         if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and
1097             $element['type'] != 'courseitem') {
1098             return $header;
1099         }
1101         $itemtype     = $element['object']->itemtype;
1102         $itemmodule   = $element['object']->itemmodule;
1103         $iteminstance = $element['object']->iteminstance;
1105         if ($withlink and $itemtype=='mod' and $iteminstance and $itemmodule) {
1106             if ($cm = get_coursemodule_from_instance($itemmodule, $iteminstance, $this->courseid)) {
1108                 $a = new stdClass();
1109                 $a->name = get_string('modulename', $element['object']->itemmodule);
1110                 $title = get_string('linktoactivity', 'grades', $a);
1111                 $dir = $CFG->dirroot.'/mod/'.$itemmodule;
1113                 if (file_exists($dir.'/grade.php')) {
1114                     $url = $CFG->wwwroot.'/mod/'.$itemmodule.'/grade.php?id='.$cm->id;
1115                 } else {
1116                     $url = $CFG->wwwroot.'/mod/'.$itemmodule.'/view.php?id='.$cm->id;
1117                 }
1119                 $header = '<a href="'.$url.'" title="'.s($title).'">'.$header.'</a>';
1120             }
1121         }
1123         return $header;
1124     }
1126     /**
1127      * Returns the grade eid - the grade may not exist yet.
1128      *
1129      * @param grade_grade $grade_grade A grade_grade object
1130      *
1131      * @return string eid
1132      */
1133     public function get_grade_eid($grade_grade) {
1134         if (empty($grade_grade->id)) {
1135             return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid;
1136         } else {
1137             return 'g'.$grade_grade->id;
1138         }
1139     }
1141     /**
1142      * Returns the grade_item eid
1143      * @param grade_item $grade_item A grade_item object
1144      * @return string eid
1145      */
1146     public function get_item_eid($grade_item) {
1147         return 'i'.$grade_item->id;
1148     }
1150     /**
1151      * Given a grade_tree element, returns an array of parameters
1152      * used to build an icon for that element.
1153      *
1154      * @param array $element An array representing an element in the grade_tree
1155      *
1156      * @return array
1157      */
1158     public function get_params_for_iconstr($element) {
1159         $strparams = new stdClass();
1160         $strparams->category = '';
1161         $strparams->itemname = '';
1162         $strparams->itemmodule = '';
1164         if (!method_exists($element['object'], 'get_name')) {
1165             return $strparams;
1166         }
1168         $strparams->itemname = html_to_text($element['object']->get_name());
1170         // If element name is categorytotal, get the name of the parent category
1171         if ($strparams->itemname == get_string('categorytotal', 'grades')) {
1172             $parent = $element['object']->get_parent_category();
1173             $strparams->category = $parent->get_name() . ' ';
1174         } else {
1175             $strparams->category = '';
1176         }
1178         $strparams->itemmodule = null;
1179         if (isset($element['object']->itemmodule)) {
1180             $strparams->itemmodule = $element['object']->itemmodule;
1181         }
1182         return $strparams;
1183     }
1185     /**
1186      * Return edit icon for give element
1187      *
1188      * @param array  $element An array representing an element in the grade_tree
1189      * @param object $gpr A grade_plugin_return object
1190      *
1191      * @return string
1192      */
1193     public function get_edit_icon($element, $gpr) {
1194         global $CFG, $OUTPUT;
1196         if (!has_capability('moodle/grade:manage', $this->context)) {
1197             if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) {
1198                 // oki - let them override grade
1199             } else {
1200                 return '';
1201             }
1202         }
1204         static $strfeedback   = null;
1205         static $streditgrade = null;
1206         if (is_null($streditgrade)) {
1207             $streditgrade = get_string('editgrade', 'grades');
1208             $strfeedback  = get_string('feedback');
1209         }
1211         $strparams = $this->get_params_for_iconstr($element);
1213         $object = $element['object'];
1215         switch ($element['type']) {
1216             case 'item':
1217             case 'categoryitem':
1218             case 'courseitem':
1219                 $stredit = get_string('editverbose', 'grades', $strparams);
1220                 if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) {
1221                     $url = new moodle_url('/grade/edit/tree/item.php',
1222                             array('courseid' => $this->courseid, 'id' => $object->id));
1223                 } else {
1224                     $url = new moodle_url('/grade/edit/tree/outcomeitem.php',
1225                             array('courseid' => $this->courseid, 'id' => $object->id));
1226                 }
1227                 break;
1229             case 'category':
1230                 $stredit = get_string('editverbose', 'grades', $strparams);
1231                 $url = new moodle_url('/grade/edit/tree/category.php',
1232                         array('courseid' => $this->courseid, 'id' => $object->id));
1233                 break;
1235             case 'grade':
1236                 $stredit = $streditgrade;
1237                 if (empty($object->id)) {
1238                     $url = new moodle_url('/grade/edit/tree/grade.php',
1239                             array('courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid));
1240                 } else {
1241                     $url = new moodle_url('/grade/edit/tree/grade.php',
1242                             array('courseid' => $this->courseid, 'id' => $object->id));
1243                 }
1244                 if (!empty($object->feedback)) {
1245                     $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat)));
1246                 }
1247                 break;
1249             default:
1250                 $url = null;
1251         }
1253         if ($url) {
1254             return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/edit', $stredit));
1256         } else {
1257             return '';
1258         }
1259     }
1261     /**
1262      * Return hiding icon for give element
1263      *
1264      * @param array  $element An array representing an element in the grade_tree
1265      * @param object $gpr A grade_plugin_return object
1266      *
1267      * @return string
1268      */
1269     public function get_hiding_icon($element, $gpr) {
1270         global $CFG, $OUTPUT;
1272         if (!has_capability('moodle/grade:manage', $this->context) and
1273             !has_capability('moodle/grade:hide', $this->context)) {
1274             return '';
1275         }
1277         $strparams = $this->get_params_for_iconstr($element);
1278         $strshow = get_string('showverbose', 'grades', $strparams);
1279         $strhide = get_string('hideverbose', 'grades', $strparams);
1281         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1282         $url = $gpr->add_url_params($url);
1284         if ($element['object']->is_hidden()) {
1285             $type = 'show';
1286             $tooltip = $strshow;
1288             // Change the icon and add a tooltip showing the date
1289             if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) {
1290                 $type = 'hiddenuntil';
1291                 $tooltip = get_string('hiddenuntildate', 'grades',
1292                         userdate($element['object']->get_hidden()));
1293             }
1295             $url->param('action', 'show');
1297             $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strshow, 'class'=>'iconsmall')));
1299         } else {
1300             $url->param('action', 'hide');
1301             $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/hide', $strhide));
1302         }
1304         return $hideicon;
1305     }
1307     /**
1308      * Return locking icon for given element
1309      *
1310      * @param array  $element An array representing an element in the grade_tree
1311      * @param object $gpr A grade_plugin_return object
1312      *
1313      * @return string
1314      */
1315     public function get_locking_icon($element, $gpr) {
1316         global $CFG, $OUTPUT;
1318         $strparams = $this->get_params_for_iconstr($element);
1319         $strunlock = get_string('unlockverbose', 'grades', $strparams);
1320         $strlock = get_string('lockverbose', 'grades', $strparams);
1322         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1323         $url = $gpr->add_url_params($url);
1325         // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon
1326         if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) {
1327             $strparamobj = new stdClass();
1328             $strparamobj->itemname = $element['object']->grade_item->itemname;
1329             $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj);
1331             $action = $OUTPUT->pix_icon('t/unlock_gray', $strnonunlockable);
1333         } else if ($element['object']->is_locked()) {
1334             $type = 'unlock';
1335             $tooltip = $strunlock;
1337             // Change the icon and add a tooltip showing the date
1338             if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) {
1339                 $type = 'locktime';
1340                 $tooltip = get_string('locktimedate', 'grades',
1341                         userdate($element['object']->get_locktime()));
1342             }
1344             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) {
1345                 $action = '';
1346             } else {
1347                 $url->param('action', 'unlock');
1348                 $action = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strunlock, 'class'=>'smallicon')));
1349             }
1351         } else {
1352             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) {
1353                 $action = '';
1354             } else {
1355                 $url->param('action', 'lock');
1356                 $action = $OUTPUT->action_icon($url, new pix_icon('t/lock', $strlock));
1357             }
1358         }
1360         return $action;
1361     }
1363     /**
1364      * Return calculation icon for given element
1365      *
1366      * @param array  $element An array representing an element in the grade_tree
1367      * @param object $gpr A grade_plugin_return object
1368      *
1369      * @return string
1370      */
1371     public function get_calculation_icon($element, $gpr) {
1372         global $CFG, $OUTPUT;
1373         if (!has_capability('moodle/grade:manage', $this->context)) {
1374             return '';
1375         }
1377         $type   = $element['type'];
1378         $object = $element['object'];
1380         if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') {
1381             $strparams = $this->get_params_for_iconstr($element);
1382             $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams);
1384             $is_scale = $object->gradetype == GRADE_TYPE_SCALE;
1385             $is_value = $object->gradetype == GRADE_TYPE_VALUE;
1387             // show calculation icon only when calculation possible
1388             if (!$object->is_external_item() and ($is_scale or $is_value)) {
1389                 if ($object->is_calculated()) {
1390                     $icon = 't/calc';
1391                 } else {
1392                     $icon = 't/calc_off';
1393                 }
1395                 $url = new moodle_url('/grade/edit/tree/calculation.php', array('courseid' => $this->courseid, 'id' => $object->id));
1396                 $url = $gpr->add_url_params($url);
1397                 return $OUTPUT->action_icon($url, new pix_icon($icon, $streditcalculation)) . "\n";
1398             }
1399         }
1401         return '';
1402     }
1405 /**
1406  * Flat structure similar to grade tree.
1407  *
1408  * @uses grade_structure
1409  * @package moodlecore
1410  * @copyright 2009 Nicolas Connault
1411  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1412  */
1413 class grade_seq extends grade_structure {
1415     /**
1416      * 1D array of elements
1417      */
1418     public $elements;
1420     /**
1421      * Constructor, retrieves and stores array of all grade_category and grade_item
1422      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1423      *
1424      * @param int  $courseid The course id
1425      * @param bool $category_grade_last category grade item is the last child
1426      * @param bool $nooutcomes Whether or not outcomes should be included
1427      */
1428     public function grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) {
1429         global $USER, $CFG;
1431         $this->courseid   = $courseid;
1432         $this->context    = get_context_instance(CONTEXT_COURSE, $courseid);
1434         // get course grade tree
1435         $top_element = grade_category::fetch_course_tree($courseid, true);
1437         $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes);
1439         foreach ($this->elements as $key=>$unused) {
1440             $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object'];
1441         }
1442     }
1444     /**
1445      * Static recursive helper - makes the grade_item for category the last children
1446      *
1447      * @param array &$element The seed of the recursion
1448      * @param bool $category_grade_last category grade item is the last child
1449      * @param bool $nooutcomes Whether or not outcomes should be included
1450      *
1451      * @return array
1452      */
1453     public function flatten(&$element, $category_grade_last, $nooutcomes) {
1454         if (empty($element['children'])) {
1455             return array();
1456         }
1457         $children = array();
1459         foreach ($element['children'] as $sortorder=>$unused) {
1460             if ($nooutcomes and $element['type'] != 'category' and
1461                 $element['children'][$sortorder]['object']->is_outcome_item()) {
1462                 continue;
1463             }
1464             $children[] = $element['children'][$sortorder];
1465         }
1466         unset($element['children']);
1468         if ($category_grade_last and count($children) > 1) {
1469             $cat_item = array_shift($children);
1470             array_push($children, $cat_item);
1471         }
1473         $result = array();
1474         foreach ($children as $child) {
1475             if ($child['type'] == 'category') {
1476                 $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes);
1477             } else {
1478                 $child['eid'] = 'i'.$child['object']->id;
1479                 $result[$child['object']->id] = $child;
1480             }
1481         }
1483         return $result;
1484     }
1486     /**
1487      * Parses the array in search of a given eid and returns a element object with
1488      * information about the element it has found.
1489      *
1490      * @param int $eid Gradetree Element ID
1491      *
1492      * @return object element
1493      */
1494     public function locate_element($eid) {
1495         // it is a grade - construct a new object
1496         if (strpos($eid, 'n') === 0) {
1497             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1498                 return null;
1499             }
1501             $itemid = $matches[1];
1502             $userid = $matches[2];
1504             //extra security check - the grade item must be in this tree
1505             if (!$item_el = $this->locate_element('i'.$itemid)) {
1506                 return null;
1507             }
1509             // $gradea->id may be null - means does not exist yet
1510             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
1512             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1513             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
1515         } else if (strpos($eid, 'g') === 0) {
1516             $id = (int) substr($eid, 1);
1517             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
1518                 return null;
1519             }
1520             //extra security check - the grade item must be in this tree
1521             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
1522                 return null;
1523             }
1524             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1525             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
1526         }
1528         // it is a category or item
1529         foreach ($this->elements as $element) {
1530             if ($element['eid'] == $eid) {
1531                 return $element;
1532             }
1533         }
1535         return null;
1536     }
1539 /**
1540  * This class represents a complete tree of categories, grade_items and final grades,
1541  * organises as an array primarily, but which can also be converted to other formats.
1542  * It has simple method calls with complex implementations, allowing for easy insertion,
1543  * deletion and moving of items and categories within the tree.
1544  *
1545  * @uses grade_structure
1546  * @package moodlecore
1547  * @copyright 2009 Nicolas Connault
1548  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1549  */
1550 class grade_tree extends grade_structure {
1552     /**
1553      * The basic representation of the tree as a hierarchical, 3-tiered array.
1554      * @var object $top_element
1555      */
1556     public $top_element;
1558     /**
1559      * 2D array of grade items and categories
1560      * @var array $levels
1561      */
1562     public $levels;
1564     /**
1565      * Grade items
1566      * @var array $items
1567      */
1568     public $items;
1570     /**
1571      * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item
1572      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1573      *
1574      * @param int   $courseid The Course ID
1575      * @param bool  $fillers include fillers and colspans, make the levels var "rectangular"
1576      * @param bool  $category_grade_last category grade item is the last child
1577      * @param array $collapsed array of collapsed categories
1578      * @param bool  $nooutcomes Whether or not outcomes should be included
1579      */
1580     public function grade_tree($courseid, $fillers=true, $category_grade_last=false,
1581                                $collapsed=null, $nooutcomes=false) {
1582         global $USER, $CFG;
1584         $this->courseid   = $courseid;
1585         $this->levels     = array();
1586         $this->context    = get_context_instance(CONTEXT_COURSE, $courseid);
1588         // get course grade tree
1589         $this->top_element = grade_category::fetch_course_tree($courseid, true);
1591         // collapse the categories if requested
1592         if (!empty($collapsed)) {
1593             grade_tree::category_collapse($this->top_element, $collapsed);
1594         }
1596         // no otucomes if requested
1597         if (!empty($nooutcomes)) {
1598             grade_tree::no_outcomes($this->top_element);
1599         }
1601         // move category item to last position in category
1602         if ($category_grade_last) {
1603             grade_tree::category_grade_last($this->top_element);
1604         }
1606         if ($fillers) {
1607             // inject fake categories == fillers
1608             grade_tree::inject_fillers($this->top_element, 0);
1609             // add colspans to categories and fillers
1610             grade_tree::inject_colspans($this->top_element);
1611         }
1613         grade_tree::fill_levels($this->levels, $this->top_element, 0);
1615     }
1617     /**
1618      * Static recursive helper - removes items from collapsed categories
1619      *
1620      * @param array &$element The seed of the recursion
1621      * @param array $collapsed array of collapsed categories
1622      *
1623      * @return void
1624      */
1625     public function category_collapse(&$element, $collapsed) {
1626         if ($element['type'] != 'category') {
1627             return;
1628         }
1629         if (empty($element['children']) or count($element['children']) < 2) {
1630             return;
1631         }
1633         if (in_array($element['object']->id, $collapsed['aggregatesonly'])) {
1634             $category_item = reset($element['children']); //keep only category item
1635             $element['children'] = array(key($element['children'])=>$category_item);
1637         } else {
1638             if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item
1639                 reset($element['children']);
1640                 $first_key = key($element['children']);
1641                 unset($element['children'][$first_key]);
1642             }
1643             foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children
1644                 grade_tree::category_collapse($element['children'][$sortorder], $collapsed);
1645             }
1646         }
1647     }
1649     /**
1650      * Static recursive helper - removes all outcomes
1651      *
1652      * @param array &$element The seed of the recursion
1653      *
1654      * @return void
1655      */
1656     public function no_outcomes(&$element) {
1657         if ($element['type'] != 'category') {
1658             return;
1659         }
1660         foreach ($element['children'] as $sortorder=>$child) {
1661             if ($element['children'][$sortorder]['type'] == 'item'
1662               and $element['children'][$sortorder]['object']->is_outcome_item()) {
1663                 unset($element['children'][$sortorder]);
1665             } else if ($element['children'][$sortorder]['type'] == 'category') {
1666                 grade_tree::no_outcomes($element['children'][$sortorder]);
1667             }
1668         }
1669     }
1671     /**
1672      * Static recursive helper - makes the grade_item for category the last children
1673      *
1674      * @param array &$element The seed of the recursion
1675      *
1676      * @return void
1677      */
1678     public function category_grade_last(&$element) {
1679         if (empty($element['children'])) {
1680             return;
1681         }
1682         if (count($element['children']) < 2) {
1683             return;
1684         }
1685         $first_item = reset($element['children']);
1686         if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') {
1687             // the category item might have been already removed
1688             $order = key($element['children']);
1689             unset($element['children'][$order]);
1690             $element['children'][$order] =& $first_item;
1691         }
1692         foreach ($element['children'] as $sortorder => $child) {
1693             grade_tree::category_grade_last($element['children'][$sortorder]);
1694         }
1695     }
1697     /**
1698      * Static recursive helper - fills the levels array, useful when accessing tree elements of one level
1699      *
1700      * @param array &$levels The levels of the grade tree through which to recurse
1701      * @param array &$element The seed of the recursion
1702      * @param int   $depth How deep are we?
1703      * @return void
1704      */
1705     public function fill_levels(&$levels, &$element, $depth) {
1706         if (!array_key_exists($depth, $levels)) {
1707             $levels[$depth] = array();
1708         }
1710         // prepare unique identifier
1711         if ($element['type'] == 'category') {
1712             $element['eid'] = 'c'.$element['object']->id;
1713         } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) {
1714             $element['eid'] = 'i'.$element['object']->id;
1715             $this->items[$element['object']->id] =& $element['object'];
1716         }
1718         $levels[$depth][] =& $element;
1719         $depth++;
1720         if (empty($element['children'])) {
1721             return;
1722         }
1723         $prev = 0;
1724         foreach ($element['children'] as $sortorder=>$child) {
1725             grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth);
1726             $element['children'][$sortorder]['prev'] = $prev;
1727             $element['children'][$sortorder]['next'] = 0;
1728             if ($prev) {
1729                 $element['children'][$prev]['next'] = $sortorder;
1730             }
1731             $prev = $sortorder;
1732         }
1733     }
1735     /**
1736      * Static recursive helper - makes full tree (all leafes are at the same level)
1737      *
1738      * @param array &$element The seed of the recursion
1739      * @param int   $depth How deep are we?
1740      *
1741      * @return int
1742      */
1743     public function inject_fillers(&$element, $depth) {
1744         $depth++;
1746         if (empty($element['children'])) {
1747             return $depth;
1748         }
1749         $chdepths = array();
1750         $chids = array_keys($element['children']);
1751         $last_child  = end($chids);
1752         $first_child = reset($chids);
1754         foreach ($chids as $chid) {
1755             $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth);
1756         }
1757         arsort($chdepths);
1759         $maxdepth = reset($chdepths);
1760         foreach ($chdepths as $chid=>$chd) {
1761             if ($chd == $maxdepth) {
1762                 continue;
1763             }
1764             for ($i=0; $i < $maxdepth-$chd; $i++) {
1765                 if ($chid == $first_child) {
1766                     $type = 'fillerfirst';
1767                 } else if ($chid == $last_child) {
1768                     $type = 'fillerlast';
1769                 } else {
1770                     $type = 'filler';
1771                 }
1772                 $oldchild =& $element['children'][$chid];
1773                 $element['children'][$chid] = array('object'=>'filler', 'type'=>$type,
1774                                                     'eid'=>'', 'depth'=>$element['object']->depth,
1775                                                     'children'=>array($oldchild));
1776             }
1777         }
1779         return $maxdepth;
1780     }
1782     /**
1783      * Static recursive helper - add colspan information into categories
1784      *
1785      * @param array &$element The seed of the recursion
1786      *
1787      * @return int
1788      */
1789     public function inject_colspans(&$element) {
1790         if (empty($element['children'])) {
1791             return 1;
1792         }
1793         $count = 0;
1794         foreach ($element['children'] as $key=>$child) {
1795             $count += grade_tree::inject_colspans($element['children'][$key]);
1796         }
1797         $element['colspan'] = $count;
1798         return $count;
1799     }
1801     /**
1802      * Parses the array in search of a given eid and returns a element object with
1803      * information about the element it has found.
1804      * @param int $eid Gradetree Element ID
1805      * @return object element
1806      */
1807     public function locate_element($eid) {
1808         // it is a grade - construct a new object
1809         if (strpos($eid, 'n') === 0) {
1810             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1811                 return null;
1812             }
1814             $itemid = $matches[1];
1815             $userid = $matches[2];
1817             //extra security check - the grade item must be in this tree
1818             if (!$item_el = $this->locate_element('i'.$itemid)) {
1819                 return null;
1820             }
1822             // $gradea->id may be null - means does not exist yet
1823             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
1825             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1826             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
1828         } else if (strpos($eid, 'g') === 0) {
1829             $id = (int) substr($eid, 1);
1830             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
1831                 return null;
1832             }
1833             //extra security check - the grade item must be in this tree
1834             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
1835                 return null;
1836             }
1837             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1838             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
1839         }
1841         // it is a category or item
1842         foreach ($this->levels as $row) {
1843             foreach ($row as $element) {
1844                 if ($element['type'] == 'filler') {
1845                     continue;
1846                 }
1847                 if ($element['eid'] == $eid) {
1848                     return $element;
1849                 }
1850             }
1851         }
1853         return null;
1854     }
1856     /**
1857      * Returns a well-formed XML representation of the grade-tree using recursion.
1858      *
1859      * @param array  $root The current element in the recursion. If null, starts at the top of the tree.
1860      * @param string $tabs The control character to use for tabs
1861      *
1862      * @return string $xml
1863      */
1864     public function exporttoxml($root=null, $tabs="\t") {
1865         $xml = null;
1866         $first = false;
1867         if (is_null($root)) {
1868             $root = $this->top_element;
1869             $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
1870             $xml .= "<gradetree>\n";
1871             $first = true;
1872         }
1874         $type = 'undefined';
1875         if (strpos($root['object']->table, 'grade_categories') !== false) {
1876             $type = 'category';
1877         } else if (strpos($root['object']->table, 'grade_items') !== false) {
1878             $type = 'item';
1879         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
1880             $type = 'outcome';
1881         }
1883         $xml .= "$tabs<element type=\"$type\">\n";
1884         foreach ($root['object'] as $var => $value) {
1885             if (!is_object($value) && !is_array($value) && !empty($value)) {
1886                 $xml .= "$tabs\t<$var>$value</$var>\n";
1887             }
1888         }
1890         if (!empty($root['children'])) {
1891             $xml .= "$tabs\t<children>\n";
1892             foreach ($root['children'] as $sortorder => $child) {
1893                 $xml .= $this->exportToXML($child, $tabs."\t\t");
1894             }
1895             $xml .= "$tabs\t</children>\n";
1896         }
1898         $xml .= "$tabs</element>\n";
1900         if ($first) {
1901             $xml .= "</gradetree>";
1902         }
1904         return $xml;
1905     }
1907     /**
1908      * Returns a JSON representation of the grade-tree using recursion.
1909      *
1910      * @param array $root The current element in the recursion. If null, starts at the top of the tree.
1911      * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy
1912      *
1913      * @return string
1914      */
1915     public function exporttojson($root=null, $tabs="\t") {
1916         $json = null;
1917         $first = false;
1918         if (is_null($root)) {
1919             $root = $this->top_element;
1920             $first = true;
1921         }
1923         $name = '';
1926         if (strpos($root['object']->table, 'grade_categories') !== false) {
1927             $name = $root['object']->fullname;
1928             if ($name == '?') {
1929                 $name = $root['object']->get_name();
1930             }
1931         } else if (strpos($root['object']->table, 'grade_items') !== false) {
1932             $name = $root['object']->itemname;
1933         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
1934             $name = $root['object']->itemname;
1935         }
1937         $json .= "$tabs {\n";
1938         $json .= "$tabs\t \"type\": \"{$root['type']}\",\n";
1939         $json .= "$tabs\t \"name\": \"$name\",\n";
1941         foreach ($root['object'] as $var => $value) {
1942             if (!is_object($value) && !is_array($value) && !empty($value)) {
1943                 $json .= "$tabs\t \"$var\": \"$value\",\n";
1944             }
1945         }
1947         $json = substr($json, 0, strrpos($json, ','));
1949         if (!empty($root['children'])) {
1950             $json .= ",\n$tabs\t\"children\": [\n";
1951             foreach ($root['children'] as $sortorder => $child) {
1952                 $json .= $this->exportToJSON($child, $tabs."\t\t");
1953             }
1954             $json = substr($json, 0, strrpos($json, ','));
1955             $json .= "\n$tabs\t]\n";
1956         }
1958         if ($first) {
1959             $json .= "\n}";
1960         } else {
1961             $json .= "\n$tabs},\n";
1962         }
1964         return $json;
1965     }
1967     /**
1968      * Returns the array of levels
1969      *
1970      * @return array
1971      */
1972     public function get_levels() {
1973         return $this->levels;
1974     }
1976     /**
1977      * Returns the array of grade items
1978      *
1979      * @return array
1980      */
1981     public function get_items() {
1982         return $this->items;
1983     }
1985     /**
1986      * Returns a specific Grade Item
1987      *
1988      * @param int $itemid The ID of the grade_item object
1989      *
1990      * @return grade_item
1991      */
1992     public function get_item($itemid) {
1993         if (array_key_exists($itemid, $this->items)) {
1994             return $this->items[$itemid];
1995         } else {
1996             return false;
1997         }
1998     }
2001 /**
2002  * Local shortcut function for creating an edit/delete button for a grade_* object.
2003  * @param string $type 'edit' or 'delete'
2004  * @param int $courseid The Course ID
2005  * @param grade_* $object The grade_* object
2006  * @return string html
2007  */
2008 function grade_button($type, $courseid, $object) {
2009     global $CFG, $OUTPUT;
2010     if (preg_match('/grade_(.*)/', get_class($object), $matches)) {
2011         $objectidstring = $matches[1] . 'id';
2012     } else {
2013         throw new coding_exception('grade_button() only accepts grade_* objects as third parameter!');
2014     }
2016     $strdelete = get_string('delete');
2017     $stredit   = get_string('edit');
2019     if ($type == 'delete') {
2020         $url = new moodle_url('index.php', array('id' => $courseid, $objectidstring => $object->id, 'action' => 'delete', 'sesskey' => sesskey()));
2021     } else if ($type == 'edit') {
2022         $url = new moodle_url('edit.php', array('courseid' => $courseid, 'id' => $object->id));
2023     }
2025     return $OUTPUT->action_icon($url, new pix_icon('t/'.$type, ${'str'.$type}));
2029 /**
2030  * This method adds settings to the settings block for the grade system and its
2031  * plugins
2032  *
2033  * @global moodle_page $PAGE
2034  */
2035 function grade_extend_settings($plugininfo, $courseid) {
2036     global $PAGE;
2038     $gradenode = $PAGE->settingsnav->prepend(get_string('gradeadministration', 'grades'), null, navigation_node::TYPE_CONTAINER);
2040     $strings = array_shift($plugininfo);
2042     if ($reports = grade_helper::get_plugins_reports($courseid)) {
2043         foreach ($reports as $report) {
2044             $gradenode->add($report->string, $report->link, navigation_node::TYPE_SETTING, null, $report->id, new pix_icon('i/report', ''));
2045         }
2046     }
2048     if ($imports = grade_helper::get_plugins_import($courseid)) {
2049         $importnode = $gradenode->add($strings['import'], null, navigation_node::TYPE_CONTAINER);
2050         foreach ($imports as $import) {
2051             $importnode->add($import->string, $import->link, navigation_node::TYPE_SETTING, null, $import->id, new pix_icon('i/restore', ''));
2052         }
2053     }
2055     if ($exports = grade_helper::get_plugins_export($courseid)) {
2056         $exportnode = $gradenode->add($strings['export'], null, navigation_node::TYPE_CONTAINER);
2057         foreach ($exports as $export) {
2058             $exportnode->add($export->string, $export->link, navigation_node::TYPE_SETTING, null, $export->id, new pix_icon('i/backup', ''));
2059         }
2060     }
2062     if ($setting = grade_helper::get_info_manage_settings($courseid)) {
2063         $gradenode->add(get_string('coursegradesettings', 'grades'), $setting->link, navigation_node::TYPE_SETTING, null, $setting->id, new pix_icon('i/settings', ''));
2064     }
2066     if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
2067         $preferencesnode = $gradenode->add(get_string('myreportpreferences', 'grades'), null, navigation_node::TYPE_CONTAINER);
2068         foreach ($preferences as $preference) {
2069             $preferencesnode->add($preference->string, $preference->link, navigation_node::TYPE_SETTING, null, $preference->id, new pix_icon('i/settings', ''));
2070         }
2071     }
2073     if ($letters = grade_helper::get_info_letters($courseid)) {
2074         $letters = array_shift($letters);
2075         $gradenode->add($strings['letter'], $letters->link, navigation_node::TYPE_SETTING, null, $letters->id, new pix_icon('i/settings', ''));
2076     }
2078     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
2079         $outcomes = array_shift($outcomes);
2080         $gradenode->add($strings['outcome'], $outcomes->link, navigation_node::TYPE_SETTING, null, $outcomes->id, new pix_icon('i/outcomes', ''));
2081     }
2083     if ($scales = grade_helper::get_info_scales($courseid)) {
2084         $gradenode->add($strings['scale'], $scales->link, navigation_node::TYPE_SETTING, null, $scales->id, new pix_icon('i/scales', ''));
2085     }
2087     if ($categories = grade_helper::get_info_edit_structure($courseid)) {
2088         $categoriesnode = $gradenode->add(get_string('categoriesanditems','grades'), null, navigation_node::TYPE_CONTAINER);
2089         foreach ($categories as $category) {
2090             $categoriesnode->add($category->string, $category->link, navigation_node::TYPE_SETTING, null, $category->id, new pix_icon('i/report', ''));
2091         }
2092     }
2094     if ($gradenode->contains_active_node()) {
2095         // If the gradenode is active include the settings base node (gradeadministration) in
2096         // the navbar, typcially this is ignored.
2097         $PAGE->navbar->includesettingsbase = true;
2099         // If we can get the course admin node make sure it is closed by default
2100         // as in this case the gradenode will be opened
2101         if ($coursenode = $PAGE->settingsnav->get('courseadmin', navigation_node::TYPE_COURSE)){
2102             $coursenode->make_inactive();
2103             $coursenode->forceopen = false;
2104         }
2105     }
2108 /**
2109  * Grade helper class
2110  *
2111  * This class provides several helpful functions that work irrespective of any
2112  * current state.
2113  *
2114  * @copyright 2010 Sam Hemelryk
2115  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2116  */
2117 abstract class grade_helper {
2118     /**
2119      * Cached manage settings info {@see get_info_settings}
2120      * @var grade_plugin_info|false
2121      */
2122     protected static $managesetting = null;
2123     /**
2124      * Cached grade report plugins {@see get_plugins_reports}
2125      * @var array|false
2126      */
2127     protected static $gradereports = null;
2128     /**
2129      * Cached grade report plugins preferences {@see get_info_scales}
2130      * @var array|false
2131      */
2132     protected static $gradereportpreferences = null;
2133     /**
2134      * Cached scale info {@see get_info_scales}
2135      * @var grade_plugin_info|false
2136      */
2137     protected static $scaleinfo = null;
2138     /**
2139      * Cached outcome info {@see get_info_outcomes}
2140      * @var grade_plugin_info|false
2141      */
2142     protected static $outcomeinfo = null;
2143     /**
2144      * Cached info on edit structure {@see get_info_edit_structure}
2145      * @var array|false
2146      */
2147     protected static $edittree = null;
2148     /**
2149      * Cached leftter info {@see get_info_letters}
2150      * @var grade_plugin_info|false
2151      */
2152     protected static $letterinfo = null;
2153     /**
2154      * Cached grade import plugins {@see get_plugins_import}
2155      * @var array|false
2156      */
2157     protected static $importplugins = null;
2158     /**
2159      * Cached grade export plugins {@see get_plugins_export}
2160      * @var array|false
2161      */
2162     protected static $exportplugins = null;
2163     /**
2164      * Cached grade plugin strings
2165      * @var array
2166      */
2167     protected static $pluginstrings = null;
2169     /**
2170      * Gets strings commonly used by the describe plugins
2171      *
2172      * report => get_string('view'),
2173      * edittree => get_string('edittree', 'grades'),
2174      * scale => get_string('scales'),
2175      * outcome => get_string('outcomes', 'grades'),
2176      * letter => get_string('letters', 'grades'),
2177      * export => get_string('export', 'grades'),
2178      * import => get_string('import'),
2179      * preferences => get_string('mypreferences', 'grades'),
2180      * settings => get_string('settings')
2181      *
2182      * @return array
2183      */
2184     public static function get_plugin_strings() {
2185         if (self::$pluginstrings === null) {
2186             self::$pluginstrings = array(
2187                 'report' => get_string('view'),
2188                 'edittree' => get_string('edittree', 'grades'),
2189                 'scale' => get_string('scales'),
2190                 'outcome' => get_string('outcomes', 'grades'),
2191                 'letter' => get_string('letters', 'grades'),
2192                 'export' => get_string('export', 'grades'),
2193                 'import' => get_string('import'),
2194                 'preferences' => get_string('mypreferences', 'grades'),
2195                 'settings' => get_string('settings')
2196             );
2197         }
2198         return self::$pluginstrings;
2199     }
2200     /**
2201      * Get grade_plugin_info object for managing settings if the user can
2202      *
2203      * @param int $courseid
2204      * @return grade_plugin_info
2205      */
2206     public static function get_info_manage_settings($courseid) {
2207         if (self::$managesetting !== null) {
2208             return self::$managesetting;
2209         }
2210         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2211         if (has_capability('moodle/course:update', $context)) {
2212             self::$managesetting = new grade_plugin_info('coursesettings', new moodle_url('/grade/edit/settings/index.php', array('id'=>$courseid)), get_string('course'));
2213         } else {
2214             self::$managesetting = false;
2215         }
2216         return self::$managesetting;
2217     }
2218     /**
2219      * Returns an array of plugin reports as grade_plugin_info objects
2220      *
2221      * @param int $courseid
2222      * @return array
2223      */
2224     public static function get_plugins_reports($courseid) {
2225         global $SITE;
2226         
2227         if (self::$gradereports !== null) {
2228             return self::$gradereports;
2229         }
2230         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2231         $gradereports = array();
2232         $gradepreferences = array();
2233         foreach (get_plugin_list('gradereport') as $plugin => $plugindir) {
2234             //some reports make no sense if we're not within a course
2235             if ($courseid==$SITE->id && ($plugin=='grader' || $plugin=='user')) {
2236                 continue;
2237             }
2239             // Remove ones we can't see
2240             if (!has_capability('gradereport/'.$plugin.':view', $context)) {
2241                 continue;
2242             }
2244             $pluginstr = get_string('pluginname', 'gradereport_'.$plugin);
2245             $url = new moodle_url('/grade/report/'.$plugin.'/index.php', array('id'=>$courseid));
2246             $gradereports[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2248             // Add link to preferences tab if such a page exists
2249             if (file_exists($plugindir.'/preferences.php')) {
2250                 $url = new moodle_url('/grade/report/'.$plugin.'/preferences.php', array('id'=>$courseid));
2251                 $gradepreferences[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2252             }
2253         }
2254         if (count($gradereports) == 0) {
2255             $gradereports = false;
2256             $gradepreferences = false;
2257         } else if (count($gradepreferences) == 0) {
2258             $gradepreferences = false;
2259             asort($gradereports);
2260         } else {
2261             asort($gradereports);
2262             asort($gradepreferences);
2263         }
2264         self::$gradereports = $gradereports;
2265         self::$gradereportpreferences = $gradepreferences;
2266         return self::$gradereports;
2267     }
2268     /**
2269      * Returns an array of grade plugin report preferences for plugin reports that
2270      * support preferences
2271      * @param int $courseid
2272      * @return array
2273      */
2274     public static function get_plugins_report_preferences($courseid) {
2275         if (self::$gradereportpreferences !== null) {
2276             return self::$gradereportpreferences;
2277         }
2278         self::get_plugins_reports($courseid);
2279         return self::$gradereportpreferences;
2280     }
2281     /**
2282      * Get information on scales
2283      * @param int $courseid
2284      * @return grade_plugin_info
2285      */
2286     public static function get_info_scales($courseid) {
2287         if (self::$scaleinfo !== null) {
2288             return self::$scaleinfo;
2289         }
2290         if (has_capability('moodle/course:managescales', get_context_instance(CONTEXT_COURSE, $courseid))) {
2291             $url = new moodle_url('/grade/edit/scale/index.php', array('id'=>$courseid));
2292             self::$scaleinfo = new grade_plugin_info('scale', $url, get_string('view'));
2293         } else {
2294             self::$scaleinfo = false;
2295         }
2296         return self::$scaleinfo;
2297     }
2298     /**
2299      * Get information on outcomes
2300      * @param int $courseid
2301      * @return grade_plugin_info
2302      */
2303     public static function get_info_outcomes($courseid) {
2304         global $CFG, $SITE;
2306         if (self::$outcomeinfo !== null) {
2307             return self::$outcomeinfo;
2308         }
2309         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2310         $canmanage = has_capability('moodle/grade:manage', $context);
2311         $canupdate = has_capability('moodle/course:update', $context);
2312         if (!empty($CFG->enableoutcomes) && ($canmanage || $canupdate)) {
2313             $outcomes = array();
2314             if ($canupdate) {
2315                 if ($courseid!=$SITE->id) {
2316                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2317                     $outcomes['course'] = new grade_plugin_info('course', $url, get_string('outcomescourse', 'grades'));
2318                 }
2319                 $url = new moodle_url('/grade/edit/outcome/index.php', array('id'=>$courseid));
2320                 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('editoutcomes', 'grades'));
2321                 $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid'=>$courseid));
2322                 $outcomes['import'] = new grade_plugin_info('import', $url, get_string('importoutcomes', 'grades'));
2323             } else {
2324                 if ($courseid!=$SITE->id) {
2325                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2326                     $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('outcomescourse', 'grades'));
2327                 }
2328             }
2329             self::$outcomeinfo = $outcomes;
2330         } else {
2331             self::$outcomeinfo = false;
2332         }
2333         return self::$outcomeinfo;
2334     }
2335     /**
2336      * Get information on editing structures
2337      * @param int $courseid
2338      * @return array
2339      */
2340     public static function get_info_edit_structure($courseid) {
2341         if (self::$edittree !== null) {
2342             return self::$edittree;
2343         }
2344         if (has_capability('moodle/grade:manage', get_context_instance(CONTEXT_COURSE, $courseid))) {
2345             $url = new moodle_url('/grade/edit/tree/index.php', array('sesskey'=>sesskey(), 'showadvanced'=>'0', 'id'=>$courseid));
2346             self::$edittree = array(
2347                 'simpleview' => new grade_plugin_info('simpleview', $url, get_string('simpleview', 'grades')),
2348                 'fullview' => new grade_plugin_info('fullview', new moodle_url($url, array('showadvanced'=>'1')), get_string('fullview', 'grades'))
2349             );
2350         } else {
2351             self::$edittree = false;
2352         }
2353         return self::$edittree;
2354     }
2355     /**
2356      * Get information on letters
2357      * @param int $courseid
2358      * @return array
2359      */
2360     public static function get_info_letters($courseid) {
2361         if (self::$letterinfo !== null) {
2362             return self::$letterinfo;
2363         }
2364         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2365         $canmanage = has_capability('moodle/grade:manage', $context);
2366         $canmanageletters = has_capability('moodle/grade:manageletters', $context);
2367         if ($canmanage || $canmanageletters) {
2368             self::$letterinfo = array(
2369                 'view' => new grade_plugin_info('view', new moodle_url('/grade/edit/letter/index.php', array('id'=>$context->id)), get_string('view')),
2370                 'edit' => new grade_plugin_info('edit', new moodle_url('/grade/edit/letter/index.php', array('edit'=>1,'id'=>$context->id)), get_string('edit'))
2371             );
2372         } else {
2373             self::$letterinfo = false;
2374         }
2375         return self::$letterinfo;
2376     }
2377     /**
2378      * Get information import plugins
2379      * @param int $courseid
2380      * @return array
2381      */
2382     public static function get_plugins_import($courseid) {
2383         global $CFG;
2385         if (self::$importplugins !== null) {
2386             return self::$importplugins;
2387         }
2388         $importplugins = array();
2389         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2391         if (has_capability('moodle/grade:import', $context)) {
2392             foreach (get_plugin_list('gradeimport') as $plugin => $plugindir) {
2393                 if (!has_capability('gradeimport/'.$plugin.':view', $context)) {
2394                     continue;
2395                 }
2396                 $pluginstr = get_string('pluginname', 'gradeimport_'.$plugin);
2397                 $url = new moodle_url('/grade/import/'.$plugin.'/index.php', array('id'=>$courseid));
2398                 $importplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2399             }
2402             if ($CFG->gradepublishing) {
2403                 $url = new moodle_url('/grade/import/keymanager.php', array('id'=>$courseid));
2404                 $importplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2405             }
2406         }
2408         if (count($importplugins) > 0) {
2409             asort($importplugins);
2410             self::$importplugins = $importplugins;
2411         } else {
2412             self::$importplugins = false;
2413         }
2414         return self::$importplugins;
2415     }
2416     /**
2417      * Get information export plugins
2418      * @param int $courseid
2419      * @return array
2420      */
2421     public static function get_plugins_export($courseid) {
2422         global $CFG;
2424         if (self::$exportplugins !== null) {
2425             return self::$exportplugins;
2426         }
2427         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2428         $exportplugins = array();
2429         if (has_capability('moodle/grade:export', $context)) {
2430             foreach (get_plugin_list('gradeexport') as $plugin => $plugindir) {
2431                 if (!has_capability('gradeexport/'.$plugin.':view', $context)) {
2432                     continue;
2433                 }
2434                 $pluginstr = get_string('pluginname', 'gradeexport_'.$plugin);
2435                 $url = new moodle_url('/grade/export/'.$plugin.'/index.php', array('id'=>$courseid));
2436                 $exportplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2437             }
2439             if ($CFG->gradepublishing) {
2440                 $url = new moodle_url('/grade/export/keymanager.php', array('id'=>$courseid));
2441                 $exportplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2442             }
2443         }
2444         if (count($exportplugins) > 0) {
2445             asort($exportplugins);
2446             self::$exportplugins = $exportplugins;
2447         } else {
2448             self::$exportplugins = false;
2449         }
2450         return self::$exportplugins;
2451     }