Merge branch 'MDL-33110_master' of git://github.com/lazydaisy/moodle
[moodle.git] / grade / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Functions used by gradebook plugins and reports.
19  *
20  * @package   core_grades
21  * @copyright 2009 Petr Skoda and Nicolas Connault
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once $CFG->libdir.'/gradelib.php';
27 /**
28  * This class iterates over all users that are graded in a course.
29  * Returns detailed info about users and their grades.
30  *
31  * @author Petr Skoda <skodak@moodle.org>
32  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class graded_users_iterator {
35     public $course;
36     public $grade_items;
37     public $groupid;
38     public $users_rs;
39     public $grades_rs;
40     public $gradestack;
41     public $sortfield1;
42     public $sortorder1;
43     public $sortfield2;
44     public $sortorder2;
46     /**
47      * Should users whose enrolment has been suspended be ignored?
48      */
49     protected $onlyactive = false;
51     /**
52      * Constructor
53      *
54      * @param object $course A course object
55      * @param array  $grade_items array of grade items, if not specified only user info returned
56      * @param int    $groupid iterate only group users if present
57      * @param string $sortfield1 The first field of the users table by which the array of users will be sorted
58      * @param string $sortorder1 The order in which the first sorting field will be sorted (ASC or DESC)
59      * @param string $sortfield2 The second field of the users table by which the array of users will be sorted
60      * @param string $sortorder2 The order in which the second sorting field will be sorted (ASC or DESC)
61      */
62     public function graded_users_iterator($course, $grade_items=null, $groupid=0,
63                                           $sortfield1='lastname', $sortorder1='ASC',
64                                           $sortfield2='firstname', $sortorder2='ASC') {
65         $this->course      = $course;
66         $this->grade_items = $grade_items;
67         $this->groupid     = $groupid;
68         $this->sortfield1  = $sortfield1;
69         $this->sortorder1  = $sortorder1;
70         $this->sortfield2  = $sortfield2;
71         $this->sortorder2  = $sortorder2;
73         $this->gradestack  = array();
74     }
76     /**
77      * Initialise the iterator
78      * @return boolean success
79      */
80     public function init() {
81         global $CFG, $DB;
83         $this->close();
85         grade_regrade_final_grades($this->course->id);
86         $course_item = grade_item::fetch_course_item($this->course->id);
87         if ($course_item->needsupdate) {
88             // can not calculate all final grades - sorry
89             return false;
90         }
92         $coursecontext = get_context_instance(CONTEXT_COURSE, $this->course->id);
93         $relatedcontexts = get_related_contexts_string($coursecontext);
95         list($gradebookroles_sql, $params) =
96             $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr');
97         list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext, '', 0, $this->onlyactive);
99         $params = array_merge($params, $enrolledparams);
101         if ($this->groupid) {
102             $groupsql = "INNER JOIN {groups_members} gm ON gm.userid = u.id";
103             $groupwheresql = "AND gm.groupid = :groupid";
104             // $params contents: gradebookroles
105             $params['groupid'] = $this->groupid;
106         } else {
107             $groupsql = "";
108             $groupwheresql = "";
109         }
111         if (empty($this->sortfield1)) {
112             // we must do some sorting even if not specified
113             $ofields = ", u.id AS usrt";
114             $order   = "usrt ASC";
116         } else {
117             $ofields = ", u.$this->sortfield1 AS usrt1";
118             $order   = "usrt1 $this->sortorder1";
119             if (!empty($this->sortfield2)) {
120                 $ofields .= ", u.$this->sortfield2 AS usrt2";
121                 $order   .= ", usrt2 $this->sortorder2";
122             }
123             if ($this->sortfield1 != 'id' and $this->sortfield2 != 'id') {
124                 // user order MUST be the same in both queries,
125                 // must include the only unique user->id if not already present
126                 $ofields .= ", u.id AS usrt";
127                 $order   .= ", usrt ASC";
128             }
129         }
131         // $params contents: gradebookroles and groupid (for $groupwheresql)
132         $users_sql = "SELECT u.* $ofields
133                         FROM {user} u
134                         JOIN ($enrolledsql) je ON je.id = u.id
135                              $groupsql
136                         JOIN (
137                                   SELECT DISTINCT ra.userid
138                                     FROM {role_assignments} ra
139                                    WHERE ra.roleid $gradebookroles_sql
140                                      AND ra.contextid $relatedcontexts
141                              ) rainner ON rainner.userid = u.id
142                          WHERE u.deleted = 0
143                              $groupwheresql
144                     ORDER BY $order";
145         $this->users_rs = $DB->get_recordset_sql($users_sql, $params);
147         if (!empty($this->grade_items)) {
148             $itemids = array_keys($this->grade_items);
149             list($itemidsql, $grades_params) = $DB->get_in_or_equal($itemids, SQL_PARAMS_NAMED, 'items');
150             $params = array_merge($params, $grades_params);
151             // $params contents: gradebookroles, enrolledparams, groupid (for $groupwheresql) and itemids
153             $grades_sql = "SELECT g.* $ofields
154                              FROM {grade_grades} g
155                              JOIN {user} u ON g.userid = u.id
156                              JOIN ($enrolledsql) je ON je.id = u.id
157                                   $groupsql
158                              JOIN (
159                                       SELECT DISTINCT ra.userid
160                                         FROM {role_assignments} ra
161                                        WHERE ra.roleid $gradebookroles_sql
162                                          AND ra.contextid $relatedcontexts
163                                   ) rainner ON rainner.userid = u.id
164                               WHERE u.deleted = 0
165                               AND g.itemid $itemidsql
166                               $groupwheresql
167                          ORDER BY $order, g.itemid ASC";
168             $this->grades_rs = $DB->get_recordset_sql($grades_sql, $params);
169         } else {
170             $this->grades_rs = false;
171         }
173         return true;
174     }
176     /**
177      * Returns information about the next user
178      * @return mixed array of user info, all grades and feedback or null when no more users found
179      */
180     function next_user() {
181         if (!$this->users_rs) {
182             return false; // no users present
183         }
185         if (!$this->users_rs->valid()) {
186             if ($current = $this->_pop()) {
187                 // this is not good - user or grades updated between the two reads above :-(
188             }
190             return false; // no more users
191         } else {
192             $user = $this->users_rs->current();
193             $this->users_rs->next();
194         }
196         // find grades of this user
197         $grade_records = array();
198         while (true) {
199             if (!$current = $this->_pop()) {
200                 break; // no more grades
201             }
203             if (empty($current->userid)) {
204                 break;
205             }
207             if ($current->userid != $user->id) {
208                 // grade of the next user, we have all for this user
209                 $this->_push($current);
210                 break;
211             }
213             $grade_records[$current->itemid] = $current;
214         }
216         $grades = array();
217         $feedbacks = array();
219         if (!empty($this->grade_items)) {
220             foreach ($this->grade_items as $grade_item) {
221                 if (!isset($feedbacks[$grade_item->id])) {
222                     $feedbacks[$grade_item->id] = new stdClass();
223                 }
224                 if (array_key_exists($grade_item->id, $grade_records)) {
225                     $feedbacks[$grade_item->id]->feedback       = $grade_records[$grade_item->id]->feedback;
226                     $feedbacks[$grade_item->id]->feedbackformat = $grade_records[$grade_item->id]->feedbackformat;
227                     unset($grade_records[$grade_item->id]->feedback);
228                     unset($grade_records[$grade_item->id]->feedbackformat);
229                     $grades[$grade_item->id] = new grade_grade($grade_records[$grade_item->id], false);
230                 } else {
231                     $feedbacks[$grade_item->id]->feedback       = '';
232                     $feedbacks[$grade_item->id]->feedbackformat = FORMAT_MOODLE;
233                     $grades[$grade_item->id] =
234                         new grade_grade(array('userid'=>$user->id, 'itemid'=>$grade_item->id), false);
235                 }
236             }
237         }
239         $result = new stdClass();
240         $result->user      = $user;
241         $result->grades    = $grades;
242         $result->feedbacks = $feedbacks;
243         return $result;
244     }
246     /**
247      * Close the iterator, do not forget to call this function.
248      * @return void
249      */
250     function close() {
251         if ($this->users_rs) {
252             $this->users_rs->close();
253             $this->users_rs = null;
254         }
255         if ($this->grades_rs) {
256             $this->grades_rs->close();
257             $this->grades_rs = null;
258         }
259         $this->gradestack = array();
260     }
262     /**
263      * Should all enrolled users be exported or just those with an active enrolment?
264      *
265      * @param bool $onlyactive True to limit the export to users with an active enrolment
266      */
267     public function require_active_enrolment($onlyactive = true) {
268         if (!empty($this->users_rs)) {
269             debugging('Calling require_active_enrolment() has no effect unless you call init() again', DEBUG_DEVELOPER);
270         }
271         $this->onlyactive  = $onlyactive;
272     }
275     /**
276      * _push
277      *
278      * @param grade_grade $grade Grade object
279      *
280      * @return void
281      */
282     function _push($grade) {
283         array_push($this->gradestack, $grade);
284     }
287     /**
288      * _pop
289      *
290      * @return object current grade object
291      */
292     function _pop() {
293         global $DB;
294         if (empty($this->gradestack)) {
295             if (empty($this->grades_rs) || !$this->grades_rs->valid()) {
296                 return null; // no grades present
297             }
299             $current = $this->grades_rs->current();
301             $this->grades_rs->next();
303             return $current;
304         } else {
305             return array_pop($this->gradestack);
306         }
307     }
310 /**
311  * Print a selection popup form of the graded users in a course.
312  *
313  * @deprecated since 2.0
314  *
315  * @param int    $course id of the course
316  * @param string $actionpage The page receiving the data from the popoup form
317  * @param int    $userid   id of the currently selected user (or 'all' if they are all selected)
318  * @param int    $groupid id of requested group, 0 means all
319  * @param int    $includeall bool include all option
320  * @param bool   $return If true, will return the HTML, otherwise, will print directly
321  * @return null
322  */
323 function print_graded_users_selector($course, $actionpage, $userid=0, $groupid=0, $includeall=true, $return=false) {
324     global $CFG, $USER, $OUTPUT;
325     return $OUTPUT->render(grade_get_graded_users_select(substr($actionpage, 0, strpos($actionpage, '/')), $course, $userid, $groupid, $includeall));
328 function grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall) {
329     global $USER;
331     if (is_null($userid)) {
332         $userid = $USER->id;
333     }
335     $menu = array(); // Will be a list of userid => user name
336     $gui = new graded_users_iterator($course, null, $groupid);
337     $gui->init();
338     $label = get_string('selectauser', 'grades');
339     if ($includeall) {
340         $menu[0] = get_string('allusers', 'grades');
341         $label = get_string('selectalloroneuser', 'grades');
342     }
343     while ($userdata = $gui->next_user()) {
344         $user = $userdata->user;
345         $menu[$user->id] = fullname($user);
346     }
347     $gui->close();
349     if ($includeall) {
350         $menu[0] .= " (" . (count($menu) - 1) . ")";
351     }
352     $select = new single_select(new moodle_url('/grade/report/'.$report.'/index.php', array('id'=>$course->id)), 'userid', $menu, $userid);
353     $select->label = $label;
354     $select->formid = 'choosegradeuser';
355     return $select;
358 /**
359  * Print grading plugin selection popup form.
360  *
361  * @param array   $plugin_info An array of plugins containing information for the selector
362  * @param boolean $return return as string
363  *
364  * @return nothing or string if $return true
365  */
366 function print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) {
367     global $CFG, $OUTPUT, $PAGE;
369     $menu = array();
370     $count = 0;
371     $active = '';
373     foreach ($plugin_info as $plugin_type => $plugins) {
374         if ($plugin_type == 'strings') {
375             continue;
376         }
378         $first_plugin = reset($plugins);
380         $sectionname = $plugin_info['strings'][$plugin_type];
381         $section = array();
383         foreach ($plugins as $plugin) {
384             $link = $plugin->link->out(false);
385             $section[$link] = $plugin->string;
386             $count++;
387             if ($plugin_type === $active_type and $plugin->id === $active_plugin) {
388                 $active = $link;
389             }
390         }
392         if ($section) {
393             $menu[] = array($sectionname=>$section);
394         }
395     }
397     // finally print/return the popup form
398     if ($count > 1) {
399         $select = new url_select($menu, $active, null, 'choosepluginreport');
401         if ($return) {
402             return $OUTPUT->render($select);
403         } else {
404             echo $OUTPUT->render($select);
405         }
406     } else {
407         // only one option - no plugin selector needed
408         return '';
409     }
412 /**
413  * Print grading plugin selection tab-based navigation.
414  *
415  * @param string  $active_type type of plugin on current page - import, export, report or edit
416  * @param string  $active_plugin active plugin type - grader, user, cvs, ...
417  * @param array   $plugin_info Array of plugins
418  * @param boolean $return return as string
419  *
420  * @return nothing or string if $return true
421  */
422 function grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) {
423     global $CFG, $COURSE;
425     if (!isset($currenttab)) { //TODO: this is weird
426         $currenttab = '';
427     }
429     $tabs = array();
430     $top_row  = array();
431     $bottom_row = array();
432     $inactive = array($active_plugin);
433     $activated = array();
435     $count = 0;
436     $active = '';
438     foreach ($plugin_info as $plugin_type => $plugins) {
439         if ($plugin_type == 'strings') {
440             continue;
441         }
443         // If $plugins is actually the definition of a child-less parent link:
444         if (!empty($plugins->id)) {
445             $string = $plugins->string;
446             if (!empty($plugin_info[$active_type]->parent)) {
447                 $string = $plugin_info[$active_type]->parent->string;
448             }
450             $top_row[] = new tabobject($plugin_type, $plugins->link, $string);
451             continue;
452         }
454         $first_plugin = reset($plugins);
455         $url = $first_plugin->link;
457         if ($plugin_type == 'report') {
458             $url = $CFG->wwwroot.'/grade/report/index.php?id='.$COURSE->id;
459         }
461         $top_row[] = new tabobject($plugin_type, $url, $plugin_info['strings'][$plugin_type]);
463         if ($active_type == $plugin_type) {
464             foreach ($plugins as $plugin) {
465                 $bottom_row[] = new tabobject($plugin->id, $plugin->link, $plugin->string);
466                 if ($plugin->id == $active_plugin) {
467                     $inactive = array($plugin->id);
468                 }
469             }
470         }
471     }
473     $tabs[] = $top_row;
474     $tabs[] = $bottom_row;
476     if ($return) {
477         return print_tabs($tabs, $active_type, $inactive, $activated, true);
478     } else {
479         print_tabs($tabs, $active_type, $inactive, $activated);
480     }
483 /**
484  * grade_get_plugin_info
485  *
486  * @param int    $courseid The course id
487  * @param string $active_type type of plugin on current page - import, export, report or edit
488  * @param string $active_plugin active plugin type - grader, user, cvs, ...
489  *
490  * @return array
491  */
492 function grade_get_plugin_info($courseid, $active_type, $active_plugin) {
493     global $CFG, $SITE;
495     $context = get_context_instance(CONTEXT_COURSE, $courseid);
497     $plugin_info = array();
498     $count = 0;
499     $active = '';
500     $url_prefix = $CFG->wwwroot . '/grade/';
502     // Language strings
503     $plugin_info['strings'] = grade_helper::get_plugin_strings();
505     if ($reports = grade_helper::get_plugins_reports($courseid)) {
506         $plugin_info['report'] = $reports;
507     }
509     //showing grade categories and items make no sense if we're not within a course
510     if ($courseid!=$SITE->id) {
511         if ($edittree = grade_helper::get_info_edit_structure($courseid)) {
512             $plugin_info['edittree'] = $edittree;
513         }
514     }
516     if ($scale = grade_helper::get_info_scales($courseid)) {
517         $plugin_info['scale'] = array('view'=>$scale);
518     }
520     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
521         $plugin_info['outcome'] = $outcomes;
522     }
524     if ($letters = grade_helper::get_info_letters($courseid)) {
525         $plugin_info['letter'] = $letters;
526     }
528     if ($imports = grade_helper::get_plugins_import($courseid)) {
529         $plugin_info['import'] = $imports;
530     }
532     if ($exports = grade_helper::get_plugins_export($courseid)) {
533         $plugin_info['export'] = $exports;
534     }
536     foreach ($plugin_info as $plugin_type => $plugins) {
537         if (!empty($plugins->id) && $active_plugin == $plugins->id) {
538             $plugin_info['strings']['active_plugin_str'] = $plugins->string;
539             break;
540         }
541         foreach ($plugins as $plugin) {
542             if (is_a($plugin, 'grade_plugin_info')) {
543                 if ($active_plugin == $plugin->id) {
544                     $plugin_info['strings']['active_plugin_str'] = $plugin->string;
545                 }
546             }
547         }
548     }
550     //hide course settings if we're not in a course
551     if ($courseid!=$SITE->id) {
552         if ($setting = grade_helper::get_info_manage_settings($courseid)) {
553             $plugin_info['settings'] = array('course'=>$setting);
554         }
555     }
557     // Put preferences last
558     if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
559         $plugin_info['preferences'] = $preferences;
560     }
562     foreach ($plugin_info as $plugin_type => $plugins) {
563         if (!empty($plugins->id) && $active_plugin == $plugins->id) {
564             $plugin_info['strings']['active_plugin_str'] = $plugins->string;
565             break;
566         }
567         foreach ($plugins as $plugin) {
568             if (is_a($plugin, 'grade_plugin_info')) {
569                 if ($active_plugin == $plugin->id) {
570                     $plugin_info['strings']['active_plugin_str'] = $plugin->string;
571                 }
572             }
573         }
574     }
576     return $plugin_info;
579 /**
580  * A simple class containing info about grade plugins.
581  * Can be subclassed for special rules
582  *
583  * @package core_grades
584  * @copyright 2009 Nicolas Connault
585  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
586  */
587 class grade_plugin_info {
588     /**
589      * A unique id for this plugin
590      *
591      * @var mixed
592      */
593     public $id;
594     /**
595      * A URL to access this plugin
596      *
597      * @var mixed
598      */
599     public $link;
600     /**
601      * The name of this plugin
602      *
603      * @var mixed
604      */
605     public $string;
606     /**
607      * Another grade_plugin_info object, parent of the current one
608      *
609      * @var mixed
610      */
611     public $parent;
613     /**
614      * Constructor
615      *
616      * @param int $id A unique id for this plugin
617      * @param string $link A URL to access this plugin
618      * @param string $string The name of this plugin
619      * @param object $parent Another grade_plugin_info object, parent of the current one
620      *
621      * @return void
622      */
623     public function __construct($id, $link, $string, $parent=null) {
624         $this->id = $id;
625         $this->link = $link;
626         $this->string = $string;
627         $this->parent = $parent;
628     }
631 /**
632  * Prints the page headers, breadcrumb trail, page heading, (optional) dropdown navigation menu and
633  * (optional) navigation tabs for any gradebook page. All gradebook pages MUST use these functions
634  * in favour of the usual print_header(), print_header_simple(), print_heading() etc.
635  * !IMPORTANT! Use of tabs.php file in gradebook pages is forbidden unless tabs are switched off at
636  * the site level for the gradebook ($CFG->grade_navmethod = GRADE_NAVMETHOD_DROPDOWN).
637  *
638  * @param int     $courseid Course id
639  * @param string  $active_type The type of the current page (report, settings,
640  *                             import, export, scales, outcomes, letters)
641  * @param string  $active_plugin The plugin of the current page (grader, fullview etc...)
642  * @param string  $heading The heading of the page. Tries to guess if none is given
643  * @param boolean $return Whether to return (true) or echo (false) the HTML generated by this function
644  * @param string  $bodytags Additional attributes that will be added to the <body> tag
645  * @param string  $buttons Additional buttons to display on the page
646  * @param boolean $shownavigation should the gradebook navigation drop down (or tabs) be shown?
647  *
648  * @return string HTML code or nothing if $return == false
649  */
650 function print_grade_page_head($courseid, $active_type, $active_plugin=null,
651                                $heading = false, $return=false,
652                                $buttons=false, $shownavigation=true) {
653     global $CFG, $OUTPUT, $PAGE;
655     $plugin_info = grade_get_plugin_info($courseid, $active_type, $active_plugin);
657     // Determine the string of the active plugin
658     $stractive_plugin = ($active_plugin) ? $plugin_info['strings']['active_plugin_str'] : $heading;
659     $stractive_type = $plugin_info['strings'][$active_type];
661     if (empty($plugin_info[$active_type]->id) || !empty($plugin_info[$active_type]->parent)) {
662         $title = $PAGE->course->fullname.': ' . $stractive_type . ': ' . $stractive_plugin;
663     } else {
664         $title = $PAGE->course->fullname.': ' . $stractive_plugin;
665     }
667     if ($active_type == 'report') {
668         $PAGE->set_pagelayout('report');
669     } else {
670         $PAGE->set_pagelayout('admin');
671     }
672     $PAGE->set_title(get_string('grades') . ': ' . $stractive_type);
673     $PAGE->set_heading($title);
674     if ($buttons instanceof single_button) {
675         $buttons = $OUTPUT->render($buttons);
676     }
677     $PAGE->set_button($buttons);
678     grade_extend_settings($plugin_info, $courseid);
680     $returnval = $OUTPUT->header();
681     if (!$return) {
682         echo $returnval;
683     }
685     // Guess heading if not given explicitly
686     if (!$heading) {
687         $heading = $stractive_plugin;
688     }
690     if ($shownavigation) {
691         if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_DROPDOWN) {
692             $returnval .= print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return);
693         }
695         if ($return) {
696             $returnval .= $OUTPUT->heading($heading);
697         } else {
698             echo $OUTPUT->heading($heading);
699         }
701         if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_TABS) {
702             $returnval .= grade_print_tabs($active_type, $active_plugin, $plugin_info, $return);
703         }
704     }
706     if ($return) {
707         return $returnval;
708     }
711 /**
712  * Utility class used for return tracking when using edit and other forms in grade plugins
713  *
714  * @package core_grades
715  * @copyright 2009 Nicolas Connault
716  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
717  */
718 class grade_plugin_return {
719     public $type;
720     public $plugin;
721     public $courseid;
722     public $userid;
723     public $page;
725     /**
726      * Constructor
727      *
728      * @param array $params - associative array with return parameters, if null parameter are taken from _GET or _POST
729      */
730     public function grade_plugin_return($params = null) {
731         if (empty($params)) {
732             $this->type     = optional_param('gpr_type', null, PARAM_SAFEDIR);
733             $this->plugin   = optional_param('gpr_plugin', null, PARAM_PLUGIN);
734             $this->courseid = optional_param('gpr_courseid', null, PARAM_INT);
735             $this->userid   = optional_param('gpr_userid', null, PARAM_INT);
736             $this->page     = optional_param('gpr_page', null, PARAM_INT);
738         } else {
739             foreach ($params as $key=>$value) {
740                 if (property_exists($this, $key)) {
741                     $this->$key = $value;
742                 }
743             }
744         }
745     }
747     /**
748      * Returns return parameters as options array suitable for buttons.
749      * @return array options
750      */
751     public function get_options() {
752         if (empty($this->type)) {
753             return array();
754         }
756         $params = array();
758         if (!empty($this->plugin)) {
759             $params['plugin'] = $this->plugin;
760         }
762         if (!empty($this->courseid)) {
763             $params['id'] = $this->courseid;
764         }
766         if (!empty($this->userid)) {
767             $params['userid'] = $this->userid;
768         }
770         if (!empty($this->page)) {
771             $params['page'] = $this->page;
772         }
774         return $params;
775     }
777     /**
778      * Returns return url
779      *
780      * @param string $default default url when params not set
781      * @param array  $extras Extra URL parameters
782      *
783      * @return string url
784      */
785     public function get_return_url($default, $extras=null) {
786         global $CFG;
788         if (empty($this->type) or empty($this->plugin)) {
789             return $default;
790         }
792         $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php';
793         $glue = '?';
795         if (!empty($this->courseid)) {
796             $url .= $glue.'id='.$this->courseid;
797             $glue = '&amp;';
798         }
800         if (!empty($this->userid)) {
801             $url .= $glue.'userid='.$this->userid;
802             $glue = '&amp;';
803         }
805         if (!empty($this->page)) {
806             $url .= $glue.'page='.$this->page;
807             $glue = '&amp;';
808         }
810         if (!empty($extras)) {
811             foreach ($extras as $key=>$value) {
812                 $url .= $glue.$key.'='.$value;
813                 $glue = '&amp;';
814             }
815         }
817         return $url;
818     }
820     /**
821      * Returns string with hidden return tracking form elements.
822      * @return string
823      */
824     public function get_form_fields() {
825         if (empty($this->type)) {
826             return '';
827         }
829         $result  = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />';
831         if (!empty($this->plugin)) {
832             $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />';
833         }
835         if (!empty($this->courseid)) {
836             $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />';
837         }
839         if (!empty($this->userid)) {
840             $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />';
841         }
843         if (!empty($this->page)) {
844             $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />';
845         }
846     }
848     /**
849      * Add hidden elements into mform
850      *
851      * @param object &$mform moodle form object
852      *
853      * @return void
854      */
855     public function add_mform_elements(&$mform) {
856         if (empty($this->type)) {
857             return;
858         }
860         $mform->addElement('hidden', 'gpr_type', $this->type);
861         $mform->setType('gpr_type', PARAM_SAFEDIR);
863         if (!empty($this->plugin)) {
864             $mform->addElement('hidden', 'gpr_plugin', $this->plugin);
865             $mform->setType('gpr_plugin', PARAM_PLUGIN);
866         }
868         if (!empty($this->courseid)) {
869             $mform->addElement('hidden', 'gpr_courseid', $this->courseid);
870             $mform->setType('gpr_courseid', PARAM_INT);
871         }
873         if (!empty($this->userid)) {
874             $mform->addElement('hidden', 'gpr_userid', $this->userid);
875             $mform->setType('gpr_userid', PARAM_INT);
876         }
878         if (!empty($this->page)) {
879             $mform->addElement('hidden', 'gpr_page', $this->page);
880             $mform->setType('gpr_page', PARAM_INT);
881         }
882     }
884     /**
885      * Add return tracking params into url
886      *
887      * @param moodle_url $url A URL
888      *
889      * @return string $url with return tracking params
890      */
891     public function add_url_params(moodle_url $url) {
892         if (empty($this->type)) {
893             return $url;
894         }
896         $url->param('gpr_type', $this->type);
898         if (!empty($this->plugin)) {
899             $url->param('gpr_plugin', $this->plugin);
900         }
902         if (!empty($this->courseid)) {
903             $url->param('gpr_courseid' ,$this->courseid);
904         }
906         if (!empty($this->userid)) {
907             $url->param('gpr_userid', $this->userid);
908         }
910         if (!empty($this->page)) {
911             $url->param('gpr_page', $this->page);
912         }
914         return $url;
915     }
918 /**
919  * Function central to gradebook for building and printing the navigation (breadcrumb trail).
920  *
921  * @param string $path The path of the calling script (using __FILE__?)
922  * @param string $pagename The language string to use as the last part of the navigation (non-link)
923  * @param mixed  $id Either a plain integer (assuming the key is 'id') or
924  *                   an array of keys and values (e.g courseid => $courseid, itemid...)
925  *
926  * @return string
927  */
928 function grade_build_nav($path, $pagename=null, $id=null) {
929     global $CFG, $COURSE, $PAGE;
931     $strgrades = get_string('grades', 'grades');
933     // Parse the path and build navlinks from its elements
934     $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash
935     $path = substr($path, $dirroot_length);
936     $path = str_replace('\\', '/', $path);
938     $path_elements = explode('/', $path);
940     $path_elements_count = count($path_elements);
942     // First link is always 'grade'
943     $PAGE->navbar->add($strgrades, new moodle_url('/grade/index.php', array('id'=>$COURSE->id)));
945     $link = null;
946     $numberofelements = 3;
948     // Prepare URL params string
949     $linkparams = array();
950     if (!is_null($id)) {
951         if (is_array($id)) {
952             foreach ($id as $idkey => $idvalue) {
953                 $linkparams[$idkey] = $idvalue;
954             }
955         } else {
956             $linkparams['id'] = $id;
957         }
958     }
960     $navlink4 = null;
962     // Remove file extensions from filenames
963     foreach ($path_elements as $key => $filename) {
964         $path_elements[$key] = str_replace('.php', '', $filename);
965     }
967     // Second level links
968     switch ($path_elements[1]) {
969         case 'edit': // No link
970             if ($path_elements[3] != 'index.php') {
971                 $numberofelements = 4;
972             }
973             break;
974         case 'import': // No link
975             break;
976         case 'export': // No link
977             break;
978         case 'report':
979             // $id is required for this link. Do not print it if $id isn't given
980             if (!is_null($id)) {
981                 $link = new moodle_url('/grade/report/index.php', $linkparams);
982             }
984             if ($path_elements[2] == 'grader') {
985                 $numberofelements = 4;
986             }
987             break;
989         default:
990             // If this element isn't among the ones already listed above, it isn't supported, throw an error.
991             debugging("grade_build_nav() doesn't support ". $path_elements[1] .
992                     " as the second path element after 'grade'.");
993             return false;
994     }
995     $PAGE->navbar->add(get_string($path_elements[1], 'grades'), $link);
997     // Third level links
998     if (empty($pagename)) {
999         $pagename = get_string($path_elements[2], 'grades');
1000     }
1002     switch ($numberofelements) {
1003         case 3:
1004             $PAGE->navbar->add($pagename, $link);
1005             break;
1006         case 4:
1007             if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') {
1008                 $PAGE->navbar->add(get_string('pluginname', 'gradereport_grader'), new moodle_url('/grade/report/grader/index.php', $linkparams));
1009             }
1010             $PAGE->navbar->add($pagename);
1011             break;
1012     }
1014     return '';
1017 /**
1018  * General structure representing grade items in course
1019  *
1020  * @package core_grades
1021  * @copyright 2009 Nicolas Connault
1022  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1023  */
1024 class grade_structure {
1025     public $context;
1027     public $courseid;
1029     /**
1030     * Reference to modinfo for current course (for performance, to save
1031     * retrieving it from courseid every time). Not actually set except for
1032     * the grade_tree type.
1033     * @var course_modinfo
1034     */
1035     public $modinfo;
1037     /**
1038      * 1D array of grade items only
1039      */
1040     public $items;
1042     /**
1043      * Returns icon of element
1044      *
1045      * @param array &$element An array representing an element in the grade_tree
1046      * @param bool  $spacerifnone return spacer if no icon found
1047      *
1048      * @return string icon or spacer
1049      */
1050     public function get_element_icon(&$element, $spacerifnone=false) {
1051         global $CFG, $OUTPUT;
1052         require_once $CFG->libdir.'/filelib.php';
1054         switch ($element['type']) {
1055             case 'item':
1056             case 'courseitem':
1057             case 'categoryitem':
1058                 $is_course   = $element['object']->is_course_item();
1059                 $is_category = $element['object']->is_category_item();
1060                 $is_scale    = $element['object']->gradetype == GRADE_TYPE_SCALE;
1061                 $is_value    = $element['object']->gradetype == GRADE_TYPE_VALUE;
1062                 $is_outcome  = !empty($element['object']->outcomeid);
1064                 if ($element['object']->is_calculated()) {
1065                     $strcalc = get_string('calculatedgrade', 'grades');
1066                     return '<img src="'.$OUTPUT->pix_url('i/calc') . '" class="icon itemicon" title="'.
1067                             s($strcalc).'" alt="'.s($strcalc).'"/>';
1069                 } else if (($is_course or $is_category) and ($is_scale or $is_value)) {
1070                     if ($category = $element['object']->get_item_category()) {
1071                         switch ($category->aggregation) {
1072                             case GRADE_AGGREGATE_MEAN:
1073                             case GRADE_AGGREGATE_MEDIAN:
1074                             case GRADE_AGGREGATE_WEIGHTED_MEAN:
1075                             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
1076                             case GRADE_AGGREGATE_EXTRACREDIT_MEAN:
1077                                 $stragg = get_string('aggregation', 'grades');
1078                                 return '<img src="'.$OUTPUT->pix_url('i/agg_mean') . '" ' .
1079                                         'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
1080                             case GRADE_AGGREGATE_SUM:
1081                                 $stragg = get_string('aggregation', 'grades');
1082                                 return '<img src="'.$OUTPUT->pix_url('i/agg_sum') . '" ' .
1083                                         'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
1084                         }
1085                     }
1087                 } else if ($element['object']->itemtype == 'mod') {
1088                     //prevent outcomes being displaying the same icon as the activity they are attached to
1089                     if ($is_outcome) {
1090                         $stroutcome = s(get_string('outcome', 'grades'));
1091                         return '<img src="'.$OUTPUT->pix_url('i/outcomes') . '" ' .
1092                             'class="icon itemicon" title="'.$stroutcome.
1093                             '" alt="'.$stroutcome.'"/>';
1094                     } else {
1095                         $strmodname = get_string('modulename', $element['object']->itemmodule);
1096                         return '<img src="'.$OUTPUT->pix_url('icon',
1097                             $element['object']->itemmodule) . '" ' .
1098                             'class="icon itemicon" title="' .s($strmodname).
1099                             '" alt="' .s($strmodname).'"/>';
1100                     }
1101                 } else if ($element['object']->itemtype == 'manual') {
1102                     if ($element['object']->is_outcome_item()) {
1103                         $stroutcome = get_string('outcome', 'grades');
1104                         return '<img src="'.$OUTPUT->pix_url('i/outcomes') . '" ' .
1105                                 'class="icon itemicon" title="'.s($stroutcome).
1106                                 '" alt="'.s($stroutcome).'"/>';
1107                     } else {
1108                         $strmanual = get_string('manualitem', 'grades');
1109                         return '<img src="'.$OUTPUT->pix_url('t/manual_item') . '" '.
1110                                 'class="icon itemicon" title="'.s($strmanual).
1111                                 '" alt="'.s($strmanual).'"/>';
1112                     }
1113                 }
1114                 break;
1116             case 'category':
1117                 $strcat = get_string('category', 'grades');
1118                 return '<img src="'.$OUTPUT->pix_url(file_folder_icon()) . '" class="icon itemicon" ' .
1119                         'title="'.s($strcat).'" alt="'.s($strcat).'" />';
1120         }
1122         if ($spacerifnone) {
1123             return $OUTPUT->spacer().' ';
1124         } else {
1125             return '';
1126         }
1127     }
1129     /**
1130      * Returns name of element optionally with icon and link
1131      *
1132      * @param array &$element An array representing an element in the grade_tree
1133      * @param bool  $withlink Whether or not this header has a link
1134      * @param bool  $icon Whether or not to display an icon with this header
1135      * @param bool  $spacerifnone return spacer if no icon found
1136      *
1137      * @return string header
1138      */
1139     public function get_element_header(&$element, $withlink=false, $icon=true, $spacerifnone=false) {
1140         $header = '';
1142         if ($icon) {
1143             $header .= $this->get_element_icon($element, $spacerifnone);
1144         }
1146         $header .= $element['object']->get_name();
1148         if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and
1149             $element['type'] != 'courseitem') {
1150             return $header;
1151         }
1153         if ($withlink) {
1154             $url = $this->get_activity_link($element);
1155             if ($url) {
1156                 $a = new stdClass();
1157                 $a->name = get_string('modulename', $element['object']->itemmodule);
1158                 $title = get_string('linktoactivity', 'grades', $a);
1160                 $header = html_writer::link($url, $header, array('title' => $title));
1161             }
1162         }
1164         return $header;
1165     }
1167     private function get_activity_link($element) {
1168         global $CFG;
1169         /** @var array static cache of the grade.php file existence flags */
1170         static $hasgradephp = array();
1172         $itemtype = $element['object']->itemtype;
1173         $itemmodule = $element['object']->itemmodule;
1174         $iteminstance = $element['object']->iteminstance;
1175         $itemnumber = $element['object']->itemnumber;
1177         // Links only for module items that have valid instance, module and are
1178         // called from grade_tree with valid modinfo
1179         if ($itemtype != 'mod' || !$iteminstance || !$itemmodule || !$this->modinfo) {
1180             return null;
1181         }
1183         // Get $cm efficiently and with visibility information using modinfo
1184         $instances = $this->modinfo->get_instances();
1185         if (empty($instances[$itemmodule][$iteminstance])) {
1186             return null;
1187         }
1188         $cm = $instances[$itemmodule][$iteminstance];
1190         // Do not add link if activity is not visible to the current user
1191         if (!$cm->uservisible) {
1192             return null;
1193         }
1195         if (!array_key_exists($itemmodule, $hasgradephp)) {
1196             if (file_exists($CFG->dirroot . '/mod/' . $itemmodule . '/grade.php')) {
1197                 $hasgradephp[$itemmodule] = true;
1198             } else {
1199                 $hasgradephp[$itemmodule] = false;
1200             }
1201         }
1203         // If module has grade.php, link to that, otherwise view.php
1204         if ($hasgradephp[$itemmodule]) {
1205             $args = array('id' => $cm->id, 'itemnumber' => $itemnumber);
1206             if (isset($element['userid'])) {
1207                 $args['userid'] = $element['userid'];
1208             }
1209             return new moodle_url('/mod/' . $itemmodule . '/grade.php', $args);
1210         } else {
1211             return new moodle_url('/mod/' . $itemmodule . '/view.php', array('id' => $cm->id));
1212         }
1213     }
1215     /**
1216      * Returns URL of a page that is supposed to contain detailed grade analysis
1217      *
1218      * At the moment, only activity modules are supported. The method generates link
1219      * to the module's file grade.php with the parameters id (cmid), itemid, itemnumber,
1220      * gradeid and userid. If the grade.php does not exist, null is returned.
1221      *
1222      * @return moodle_url|null URL or null if unable to construct it
1223      */
1224     public function get_grade_analysis_url(grade_grade $grade) {
1225         global $CFG;
1226         /** @var array static cache of the grade.php file existence flags */
1227         static $hasgradephp = array();
1229         if (empty($grade->grade_item) or !($grade->grade_item instanceof grade_item)) {
1230             throw new coding_exception('Passed grade without the associated grade item');
1231         }
1232         $item = $grade->grade_item;
1234         if (!$item->is_external_item()) {
1235             // at the moment, only activity modules are supported
1236             return null;
1237         }
1238         if ($item->itemtype !== 'mod') {
1239             throw new coding_exception('Unknown external itemtype: '.$item->itemtype);
1240         }
1241         if (empty($item->iteminstance) or empty($item->itemmodule) or empty($this->modinfo)) {
1242             return null;
1243         }
1245         if (!array_key_exists($item->itemmodule, $hasgradephp)) {
1246             if (file_exists($CFG->dirroot . '/mod/' . $item->itemmodule . '/grade.php')) {
1247                 $hasgradephp[$item->itemmodule] = true;
1248             } else {
1249                 $hasgradephp[$item->itemmodule] = false;
1250             }
1251         }
1253         if (!$hasgradephp[$item->itemmodule]) {
1254             return null;
1255         }
1257         $instances = $this->modinfo->get_instances();
1258         if (empty($instances[$item->itemmodule][$item->iteminstance])) {
1259             return null;
1260         }
1261         $cm = $instances[$item->itemmodule][$item->iteminstance];
1262         if (!$cm->uservisible) {
1263             return null;
1264         }
1266         $url = new moodle_url('/mod/'.$item->itemmodule.'/grade.php', array(
1267             'id'         => $cm->id,
1268             'itemid'     => $item->id,
1269             'itemnumber' => $item->itemnumber,
1270             'gradeid'    => $grade->id,
1271             'userid'     => $grade->userid,
1272         ));
1274         return $url;
1275     }
1277     /**
1278      * Returns an action icon leading to the grade analysis page
1279      *
1280      * @param grade_grade $grade
1281      * @return string
1282      */
1283     public function get_grade_analysis_icon(grade_grade $grade) {
1284         global $OUTPUT;
1286         $url = $this->get_grade_analysis_url($grade);
1287         if (is_null($url)) {
1288             return '';
1289         }
1291         return $OUTPUT->action_icon($url, new pix_icon('t/preview',
1292             get_string('gradeanalysis', 'core_grades')));
1293     }
1295     /**
1296      * Returns the grade eid - the grade may not exist yet.
1297      *
1298      * @param grade_grade $grade_grade A grade_grade object
1299      *
1300      * @return string eid
1301      */
1302     public function get_grade_eid($grade_grade) {
1303         if (empty($grade_grade->id)) {
1304             return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid;
1305         } else {
1306             return 'g'.$grade_grade->id;
1307         }
1308     }
1310     /**
1311      * Returns the grade_item eid
1312      * @param grade_item $grade_item A grade_item object
1313      * @return string eid
1314      */
1315     public function get_item_eid($grade_item) {
1316         return 'i'.$grade_item->id;
1317     }
1319     /**
1320      * Given a grade_tree element, returns an array of parameters
1321      * used to build an icon for that element.
1322      *
1323      * @param array $element An array representing an element in the grade_tree
1324      *
1325      * @return array
1326      */
1327     public function get_params_for_iconstr($element) {
1328         $strparams = new stdClass();
1329         $strparams->category = '';
1330         $strparams->itemname = '';
1331         $strparams->itemmodule = '';
1333         if (!method_exists($element['object'], 'get_name')) {
1334             return $strparams;
1335         }
1337         $strparams->itemname = html_to_text($element['object']->get_name());
1339         // If element name is categorytotal, get the name of the parent category
1340         if ($strparams->itemname == get_string('categorytotal', 'grades')) {
1341             $parent = $element['object']->get_parent_category();
1342             $strparams->category = $parent->get_name() . ' ';
1343         } else {
1344             $strparams->category = '';
1345         }
1347         $strparams->itemmodule = null;
1348         if (isset($element['object']->itemmodule)) {
1349             $strparams->itemmodule = $element['object']->itemmodule;
1350         }
1351         return $strparams;
1352     }
1354     /**
1355      * Return edit icon for give element
1356      *
1357      * @param array  $element An array representing an element in the grade_tree
1358      * @param object $gpr A grade_plugin_return object
1359      *
1360      * @return string
1361      */
1362     public function get_edit_icon($element, $gpr) {
1363         global $CFG, $OUTPUT;
1365         if (!has_capability('moodle/grade:manage', $this->context)) {
1366             if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) {
1367                 // oki - let them override grade
1368             } else {
1369                 return '';
1370             }
1371         }
1373         static $strfeedback   = null;
1374         static $streditgrade = null;
1375         if (is_null($streditgrade)) {
1376             $streditgrade = get_string('editgrade', 'grades');
1377             $strfeedback  = get_string('feedback');
1378         }
1380         $strparams = $this->get_params_for_iconstr($element);
1382         $object = $element['object'];
1384         switch ($element['type']) {
1385             case 'item':
1386             case 'categoryitem':
1387             case 'courseitem':
1388                 $stredit = get_string('editverbose', 'grades', $strparams);
1389                 if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) {
1390                     $url = new moodle_url('/grade/edit/tree/item.php',
1391                             array('courseid' => $this->courseid, 'id' => $object->id));
1392                 } else {
1393                     $url = new moodle_url('/grade/edit/tree/outcomeitem.php',
1394                             array('courseid' => $this->courseid, 'id' => $object->id));
1395                 }
1396                 break;
1398             case 'category':
1399                 $stredit = get_string('editverbose', 'grades', $strparams);
1400                 $url = new moodle_url('/grade/edit/tree/category.php',
1401                         array('courseid' => $this->courseid, 'id' => $object->id));
1402                 break;
1404             case 'grade':
1405                 $stredit = $streditgrade;
1406                 if (empty($object->id)) {
1407                     $url = new moodle_url('/grade/edit/tree/grade.php',
1408                             array('courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid));
1409                 } else {
1410                     $url = new moodle_url('/grade/edit/tree/grade.php',
1411                             array('courseid' => $this->courseid, 'id' => $object->id));
1412                 }
1413                 if (!empty($object->feedback)) {
1414                     $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat)));
1415                 }
1416                 break;
1418             default:
1419                 $url = null;
1420         }
1422         if ($url) {
1423             return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/edit', $stredit));
1425         } else {
1426             return '';
1427         }
1428     }
1430     /**
1431      * Return hiding icon for give element
1432      *
1433      * @param array  $element An array representing an element in the grade_tree
1434      * @param object $gpr A grade_plugin_return object
1435      *
1436      * @return string
1437      */
1438     public function get_hiding_icon($element, $gpr) {
1439         global $CFG, $OUTPUT;
1441         if (!has_capability('moodle/grade:manage', $this->context) and
1442             !has_capability('moodle/grade:hide', $this->context)) {
1443             return '';
1444         }
1446         $strparams = $this->get_params_for_iconstr($element);
1447         $strshow = get_string('showverbose', 'grades', $strparams);
1448         $strhide = get_string('hideverbose', 'grades', $strparams);
1450         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1451         $url = $gpr->add_url_params($url);
1453         if ($element['object']->is_hidden()) {
1454             $type = 'show';
1455             $tooltip = $strshow;
1457             // Change the icon and add a tooltip showing the date
1458             if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) {
1459                 $type = 'hiddenuntil';
1460                 $tooltip = get_string('hiddenuntildate', 'grades',
1461                         userdate($element['object']->get_hidden()));
1462             }
1464             $url->param('action', 'show');
1466             $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strshow, 'class'=>'iconsmall')));
1468         } else {
1469             $url->param('action', 'hide');
1470             $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/hide', $strhide));
1471         }
1473         return $hideicon;
1474     }
1476     /**
1477      * Return locking icon for given element
1478      *
1479      * @param array  $element An array representing an element in the grade_tree
1480      * @param object $gpr A grade_plugin_return object
1481      *
1482      * @return string
1483      */
1484     public function get_locking_icon($element, $gpr) {
1485         global $CFG, $OUTPUT;
1487         $strparams = $this->get_params_for_iconstr($element);
1488         $strunlock = get_string('unlockverbose', 'grades', $strparams);
1489         $strlock = get_string('lockverbose', 'grades', $strparams);
1491         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1492         $url = $gpr->add_url_params($url);
1494         // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon
1495         if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) {
1496             $strparamobj = new stdClass();
1497             $strparamobj->itemname = $element['object']->grade_item->itemname;
1498             $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj);
1500             $action = $OUTPUT->pix_icon('t/unlock_gray', $strnonunlockable);
1502         } else if ($element['object']->is_locked()) {
1503             $type = 'unlock';
1504             $tooltip = $strunlock;
1506             // Change the icon and add a tooltip showing the date
1507             if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) {
1508                 $type = 'locktime';
1509                 $tooltip = get_string('locktimedate', 'grades',
1510                         userdate($element['object']->get_locktime()));
1511             }
1513             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) {
1514                 $action = '';
1515             } else {
1516                 $url->param('action', 'unlock');
1517                 $action = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strunlock, 'class'=>'smallicon')));
1518             }
1520         } else {
1521             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) {
1522                 $action = '';
1523             } else {
1524                 $url->param('action', 'lock');
1525                 $action = $OUTPUT->action_icon($url, new pix_icon('t/lock', $strlock));
1526             }
1527         }
1529         return $action;
1530     }
1532     /**
1533      * Return calculation icon for given element
1534      *
1535      * @param array  $element An array representing an element in the grade_tree
1536      * @param object $gpr A grade_plugin_return object
1537      *
1538      * @return string
1539      */
1540     public function get_calculation_icon($element, $gpr) {
1541         global $CFG, $OUTPUT;
1542         if (!has_capability('moodle/grade:manage', $this->context)) {
1543             return '';
1544         }
1546         $type   = $element['type'];
1547         $object = $element['object'];
1549         if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') {
1550             $strparams = $this->get_params_for_iconstr($element);
1551             $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams);
1553             $is_scale = $object->gradetype == GRADE_TYPE_SCALE;
1554             $is_value = $object->gradetype == GRADE_TYPE_VALUE;
1556             // show calculation icon only when calculation possible
1557             if (!$object->is_external_item() and ($is_scale or $is_value)) {
1558                 if ($object->is_calculated()) {
1559                     $icon = 't/calc';
1560                 } else {
1561                     $icon = 't/calc_off';
1562                 }
1564                 $url = new moodle_url('/grade/edit/tree/calculation.php', array('courseid' => $this->courseid, 'id' => $object->id));
1565                 $url = $gpr->add_url_params($url);
1566                 return $OUTPUT->action_icon($url, new pix_icon($icon, $streditcalculation)) . "\n";
1567             }
1568         }
1570         return '';
1571     }
1574 /**
1575  * Flat structure similar to grade tree.
1576  *
1577  * @uses grade_structure
1578  * @package core_grades
1579  * @copyright 2009 Nicolas Connault
1580  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1581  */
1582 class grade_seq extends grade_structure {
1584     /**
1585      * 1D array of elements
1586      */
1587     public $elements;
1589     /**
1590      * Constructor, retrieves and stores array of all grade_category and grade_item
1591      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1592      *
1593      * @param int  $courseid The course id
1594      * @param bool $category_grade_last category grade item is the last child
1595      * @param bool $nooutcomes Whether or not outcomes should be included
1596      */
1597     public function grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) {
1598         global $USER, $CFG;
1600         $this->courseid   = $courseid;
1601         $this->context    = get_context_instance(CONTEXT_COURSE, $courseid);
1603         // get course grade tree
1604         $top_element = grade_category::fetch_course_tree($courseid, true);
1606         $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes);
1608         foreach ($this->elements as $key=>$unused) {
1609             $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object'];
1610         }
1611     }
1613     /**
1614      * Static recursive helper - makes the grade_item for category the last children
1615      *
1616      * @param array &$element The seed of the recursion
1617      * @param bool $category_grade_last category grade item is the last child
1618      * @param bool $nooutcomes Whether or not outcomes should be included
1619      *
1620      * @return array
1621      */
1622     public function flatten(&$element, $category_grade_last, $nooutcomes) {
1623         if (empty($element['children'])) {
1624             return array();
1625         }
1626         $children = array();
1628         foreach ($element['children'] as $sortorder=>$unused) {
1629             if ($nooutcomes and $element['type'] != 'category' and
1630                 $element['children'][$sortorder]['object']->is_outcome_item()) {
1631                 continue;
1632             }
1633             $children[] = $element['children'][$sortorder];
1634         }
1635         unset($element['children']);
1637         if ($category_grade_last and count($children) > 1) {
1638             $cat_item = array_shift($children);
1639             array_push($children, $cat_item);
1640         }
1642         $result = array();
1643         foreach ($children as $child) {
1644             if ($child['type'] == 'category') {
1645                 $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes);
1646             } else {
1647                 $child['eid'] = 'i'.$child['object']->id;
1648                 $result[$child['object']->id] = $child;
1649             }
1650         }
1652         return $result;
1653     }
1655     /**
1656      * Parses the array in search of a given eid and returns a element object with
1657      * information about the element it has found.
1658      *
1659      * @param int $eid Gradetree Element ID
1660      *
1661      * @return object element
1662      */
1663     public function locate_element($eid) {
1664         // it is a grade - construct a new object
1665         if (strpos($eid, 'n') === 0) {
1666             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1667                 return null;
1668             }
1670             $itemid = $matches[1];
1671             $userid = $matches[2];
1673             //extra security check - the grade item must be in this tree
1674             if (!$item_el = $this->locate_element('i'.$itemid)) {
1675                 return null;
1676             }
1678             // $gradea->id may be null - means does not exist yet
1679             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
1681             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1682             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
1684         } else if (strpos($eid, 'g') === 0) {
1685             $id = (int) substr($eid, 1);
1686             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
1687                 return null;
1688             }
1689             //extra security check - the grade item must be in this tree
1690             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
1691                 return null;
1692             }
1693             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1694             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
1695         }
1697         // it is a category or item
1698         foreach ($this->elements as $element) {
1699             if ($element['eid'] == $eid) {
1700                 return $element;
1701             }
1702         }
1704         return null;
1705     }
1708 /**
1709  * This class represents a complete tree of categories, grade_items and final grades,
1710  * organises as an array primarily, but which can also be converted to other formats.
1711  * It has simple method calls with complex implementations, allowing for easy insertion,
1712  * deletion and moving of items and categories within the tree.
1713  *
1714  * @uses grade_structure
1715  * @package core_grades
1716  * @copyright 2009 Nicolas Connault
1717  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1718  */
1719 class grade_tree extends grade_structure {
1721     /**
1722      * The basic representation of the tree as a hierarchical, 3-tiered array.
1723      * @var object $top_element
1724      */
1725     public $top_element;
1727     /**
1728      * 2D array of grade items and categories
1729      * @var array $levels
1730      */
1731     public $levels;
1733     /**
1734      * Grade items
1735      * @var array $items
1736      */
1737     public $items;
1739     /**
1740      * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item
1741      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1742      *
1743      * @param int   $courseid The Course ID
1744      * @param bool  $fillers include fillers and colspans, make the levels var "rectangular"
1745      * @param bool  $category_grade_last category grade item is the last child
1746      * @param array $collapsed array of collapsed categories
1747      * @param bool  $nooutcomes Whether or not outcomes should be included
1748      */
1749     public function grade_tree($courseid, $fillers=true, $category_grade_last=false,
1750                                $collapsed=null, $nooutcomes=false) {
1751         global $USER, $CFG, $COURSE, $DB;
1753         $this->courseid   = $courseid;
1754         $this->levels     = array();
1755         $this->context    = get_context_instance(CONTEXT_COURSE, $courseid);
1757         if (!empty($COURSE->id) && $COURSE->id == $this->courseid) {
1758             $course = $COURSE;
1759         } else {
1760             $course = $DB->get_record('course', array('id' => $this->courseid));
1761         }
1762         $this->modinfo = get_fast_modinfo($course);
1764         // get course grade tree
1765         $this->top_element = grade_category::fetch_course_tree($courseid, true);
1767         // collapse the categories if requested
1768         if (!empty($collapsed)) {
1769             grade_tree::category_collapse($this->top_element, $collapsed);
1770         }
1772         // no otucomes if requested
1773         if (!empty($nooutcomes)) {
1774             grade_tree::no_outcomes($this->top_element);
1775         }
1777         // move category item to last position in category
1778         if ($category_grade_last) {
1779             grade_tree::category_grade_last($this->top_element);
1780         }
1782         if ($fillers) {
1783             // inject fake categories == fillers
1784             grade_tree::inject_fillers($this->top_element, 0);
1785             // add colspans to categories and fillers
1786             grade_tree::inject_colspans($this->top_element);
1787         }
1789         grade_tree::fill_levels($this->levels, $this->top_element, 0);
1791     }
1793     /**
1794      * Static recursive helper - removes items from collapsed categories
1795      *
1796      * @param array &$element The seed of the recursion
1797      * @param array $collapsed array of collapsed categories
1798      *
1799      * @return void
1800      */
1801     public function category_collapse(&$element, $collapsed) {
1802         if ($element['type'] != 'category') {
1803             return;
1804         }
1805         if (empty($element['children']) or count($element['children']) < 2) {
1806             return;
1807         }
1809         if (in_array($element['object']->id, $collapsed['aggregatesonly'])) {
1810             $category_item = reset($element['children']); //keep only category item
1811             $element['children'] = array(key($element['children'])=>$category_item);
1813         } else {
1814             if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item
1815                 reset($element['children']);
1816                 $first_key = key($element['children']);
1817                 unset($element['children'][$first_key]);
1818             }
1819             foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children
1820                 grade_tree::category_collapse($element['children'][$sortorder], $collapsed);
1821             }
1822         }
1823     }
1825     /**
1826      * Static recursive helper - removes all outcomes
1827      *
1828      * @param array &$element The seed of the recursion
1829      *
1830      * @return void
1831      */
1832     public function no_outcomes(&$element) {
1833         if ($element['type'] != 'category') {
1834             return;
1835         }
1836         foreach ($element['children'] as $sortorder=>$child) {
1837             if ($element['children'][$sortorder]['type'] == 'item'
1838               and $element['children'][$sortorder]['object']->is_outcome_item()) {
1839                 unset($element['children'][$sortorder]);
1841             } else if ($element['children'][$sortorder]['type'] == 'category') {
1842                 grade_tree::no_outcomes($element['children'][$sortorder]);
1843             }
1844         }
1845     }
1847     /**
1848      * Static recursive helper - makes the grade_item for category the last children
1849      *
1850      * @param array &$element The seed of the recursion
1851      *
1852      * @return void
1853      */
1854     public function category_grade_last(&$element) {
1855         if (empty($element['children'])) {
1856             return;
1857         }
1858         if (count($element['children']) < 2) {
1859             return;
1860         }
1861         $first_item = reset($element['children']);
1862         if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') {
1863             // the category item might have been already removed
1864             $order = key($element['children']);
1865             unset($element['children'][$order]);
1866             $element['children'][$order] =& $first_item;
1867         }
1868         foreach ($element['children'] as $sortorder => $child) {
1869             grade_tree::category_grade_last($element['children'][$sortorder]);
1870         }
1871     }
1873     /**
1874      * Static recursive helper - fills the levels array, useful when accessing tree elements of one level
1875      *
1876      * @param array &$levels The levels of the grade tree through which to recurse
1877      * @param array &$element The seed of the recursion
1878      * @param int   $depth How deep are we?
1879      * @return void
1880      */
1881     public function fill_levels(&$levels, &$element, $depth) {
1882         if (!array_key_exists($depth, $levels)) {
1883             $levels[$depth] = array();
1884         }
1886         // prepare unique identifier
1887         if ($element['type'] == 'category') {
1888             $element['eid'] = 'c'.$element['object']->id;
1889         } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) {
1890             $element['eid'] = 'i'.$element['object']->id;
1891             $this->items[$element['object']->id] =& $element['object'];
1892         }
1894         $levels[$depth][] =& $element;
1895         $depth++;
1896         if (empty($element['children'])) {
1897             return;
1898         }
1899         $prev = 0;
1900         foreach ($element['children'] as $sortorder=>$child) {
1901             grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth);
1902             $element['children'][$sortorder]['prev'] = $prev;
1903             $element['children'][$sortorder]['next'] = 0;
1904             if ($prev) {
1905                 $element['children'][$prev]['next'] = $sortorder;
1906             }
1907             $prev = $sortorder;
1908         }
1909     }
1911     /**
1912      * Static recursive helper - makes full tree (all leafes are at the same level)
1913      *
1914      * @param array &$element The seed of the recursion
1915      * @param int   $depth How deep are we?
1916      *
1917      * @return int
1918      */
1919     public function inject_fillers(&$element, $depth) {
1920         $depth++;
1922         if (empty($element['children'])) {
1923             return $depth;
1924         }
1925         $chdepths = array();
1926         $chids = array_keys($element['children']);
1927         $last_child  = end($chids);
1928         $first_child = reset($chids);
1930         foreach ($chids as $chid) {
1931             $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth);
1932         }
1933         arsort($chdepths);
1935         $maxdepth = reset($chdepths);
1936         foreach ($chdepths as $chid=>$chd) {
1937             if ($chd == $maxdepth) {
1938                 continue;
1939             }
1940             for ($i=0; $i < $maxdepth-$chd; $i++) {
1941                 if ($chid == $first_child) {
1942                     $type = 'fillerfirst';
1943                 } else if ($chid == $last_child) {
1944                     $type = 'fillerlast';
1945                 } else {
1946                     $type = 'filler';
1947                 }
1948                 $oldchild =& $element['children'][$chid];
1949                 $element['children'][$chid] = array('object'=>'filler', 'type'=>$type,
1950                                                     'eid'=>'', 'depth'=>$element['object']->depth,
1951                                                     'children'=>array($oldchild));
1952             }
1953         }
1955         return $maxdepth;
1956     }
1958     /**
1959      * Static recursive helper - add colspan information into categories
1960      *
1961      * @param array &$element The seed of the recursion
1962      *
1963      * @return int
1964      */
1965     public function inject_colspans(&$element) {
1966         if (empty($element['children'])) {
1967             return 1;
1968         }
1969         $count = 0;
1970         foreach ($element['children'] as $key=>$child) {
1971             $count += grade_tree::inject_colspans($element['children'][$key]);
1972         }
1973         $element['colspan'] = $count;
1974         return $count;
1975     }
1977     /**
1978      * Parses the array in search of a given eid and returns a element object with
1979      * information about the element it has found.
1980      * @param int $eid Gradetree Element ID
1981      * @return object element
1982      */
1983     public function locate_element($eid) {
1984         // it is a grade - construct a new object
1985         if (strpos($eid, 'n') === 0) {
1986             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1987                 return null;
1988             }
1990             $itemid = $matches[1];
1991             $userid = $matches[2];
1993             //extra security check - the grade item must be in this tree
1994             if (!$item_el = $this->locate_element('i'.$itemid)) {
1995                 return null;
1996             }
1998             // $gradea->id may be null - means does not exist yet
1999             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
2001             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2002             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
2004         } else if (strpos($eid, 'g') === 0) {
2005             $id = (int) substr($eid, 1);
2006             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
2007                 return null;
2008             }
2009             //extra security check - the grade item must be in this tree
2010             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
2011                 return null;
2012             }
2013             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2014             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
2015         }
2017         // it is a category or item
2018         foreach ($this->levels as $row) {
2019             foreach ($row as $element) {
2020                 if ($element['type'] == 'filler') {
2021                     continue;
2022                 }
2023                 if ($element['eid'] == $eid) {
2024                     return $element;
2025                 }
2026             }
2027         }
2029         return null;
2030     }
2032     /**
2033      * Returns a well-formed XML representation of the grade-tree using recursion.
2034      *
2035      * @param array  $root The current element in the recursion. If null, starts at the top of the tree.
2036      * @param string $tabs The control character to use for tabs
2037      *
2038      * @return string $xml
2039      */
2040     public function exporttoxml($root=null, $tabs="\t") {
2041         $xml = null;
2042         $first = false;
2043         if (is_null($root)) {
2044             $root = $this->top_element;
2045             $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
2046             $xml .= "<gradetree>\n";
2047             $first = true;
2048         }
2050         $type = 'undefined';
2051         if (strpos($root['object']->table, 'grade_categories') !== false) {
2052             $type = 'category';
2053         } else if (strpos($root['object']->table, 'grade_items') !== false) {
2054             $type = 'item';
2055         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
2056             $type = 'outcome';
2057         }
2059         $xml .= "$tabs<element type=\"$type\">\n";
2060         foreach ($root['object'] as $var => $value) {
2061             if (!is_object($value) && !is_array($value) && !empty($value)) {
2062                 $xml .= "$tabs\t<$var>$value</$var>\n";
2063             }
2064         }
2066         if (!empty($root['children'])) {
2067             $xml .= "$tabs\t<children>\n";
2068             foreach ($root['children'] as $sortorder => $child) {
2069                 $xml .= $this->exportToXML($child, $tabs."\t\t");
2070             }
2071             $xml .= "$tabs\t</children>\n";
2072         }
2074         $xml .= "$tabs</element>\n";
2076         if ($first) {
2077             $xml .= "</gradetree>";
2078         }
2080         return $xml;
2081     }
2083     /**
2084      * Returns a JSON representation of the grade-tree using recursion.
2085      *
2086      * @param array $root The current element in the recursion. If null, starts at the top of the tree.
2087      * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy
2088      *
2089      * @return string
2090      */
2091     public function exporttojson($root=null, $tabs="\t") {
2092         $json = null;
2093         $first = false;
2094         if (is_null($root)) {
2095             $root = $this->top_element;
2096             $first = true;
2097         }
2099         $name = '';
2102         if (strpos($root['object']->table, 'grade_categories') !== false) {
2103             $name = $root['object']->fullname;
2104             if ($name == '?') {
2105                 $name = $root['object']->get_name();
2106             }
2107         } else if (strpos($root['object']->table, 'grade_items') !== false) {
2108             $name = $root['object']->itemname;
2109         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
2110             $name = $root['object']->itemname;
2111         }
2113         $json .= "$tabs {\n";
2114         $json .= "$tabs\t \"type\": \"{$root['type']}\",\n";
2115         $json .= "$tabs\t \"name\": \"$name\",\n";
2117         foreach ($root['object'] as $var => $value) {
2118             if (!is_object($value) && !is_array($value) && !empty($value)) {
2119                 $json .= "$tabs\t \"$var\": \"$value\",\n";
2120             }
2121         }
2123         $json = substr($json, 0, strrpos($json, ','));
2125         if (!empty($root['children'])) {
2126             $json .= ",\n$tabs\t\"children\": [\n";
2127             foreach ($root['children'] as $sortorder => $child) {
2128                 $json .= $this->exportToJSON($child, $tabs."\t\t");
2129             }
2130             $json = substr($json, 0, strrpos($json, ','));
2131             $json .= "\n$tabs\t]\n";
2132         }
2134         if ($first) {
2135             $json .= "\n}";
2136         } else {
2137             $json .= "\n$tabs},\n";
2138         }
2140         return $json;
2141     }
2143     /**
2144      * Returns the array of levels
2145      *
2146      * @return array
2147      */
2148     public function get_levels() {
2149         return $this->levels;
2150     }
2152     /**
2153      * Returns the array of grade items
2154      *
2155      * @return array
2156      */
2157     public function get_items() {
2158         return $this->items;
2159     }
2161     /**
2162      * Returns a specific Grade Item
2163      *
2164      * @param int $itemid The ID of the grade_item object
2165      *
2166      * @return grade_item
2167      */
2168     public function get_item($itemid) {
2169         if (array_key_exists($itemid, $this->items)) {
2170             return $this->items[$itemid];
2171         } else {
2172             return false;
2173         }
2174     }
2177 /**
2178  * Local shortcut function for creating an edit/delete button for a grade_* object.
2179  * @param string $type 'edit' or 'delete'
2180  * @param int $courseid The Course ID
2181  * @param grade_* $object The grade_* object
2182  * @return string html
2183  */
2184 function grade_button($type, $courseid, $object) {
2185     global $CFG, $OUTPUT;
2186     if (preg_match('/grade_(.*)/', get_class($object), $matches)) {
2187         $objectidstring = $matches[1] . 'id';
2188     } else {
2189         throw new coding_exception('grade_button() only accepts grade_* objects as third parameter!');
2190     }
2192     $strdelete = get_string('delete');
2193     $stredit   = get_string('edit');
2195     if ($type == 'delete') {
2196         $url = new moodle_url('index.php', array('id' => $courseid, $objectidstring => $object->id, 'action' => 'delete', 'sesskey' => sesskey()));
2197     } else if ($type == 'edit') {
2198         $url = new moodle_url('edit.php', array('courseid' => $courseid, 'id' => $object->id));
2199     }
2201     return $OUTPUT->action_icon($url, new pix_icon('t/'.$type, ${'str'.$type}));
2205 /**
2206  * This method adds settings to the settings block for the grade system and its
2207  * plugins
2208  *
2209  * @global moodle_page $PAGE
2210  */
2211 function grade_extend_settings($plugininfo, $courseid) {
2212     global $PAGE;
2214     $gradenode = $PAGE->settingsnav->prepend(get_string('gradeadministration', 'grades'), null, navigation_node::TYPE_CONTAINER);
2216     $strings = array_shift($plugininfo);
2218     if ($reports = grade_helper::get_plugins_reports($courseid)) {
2219         foreach ($reports as $report) {
2220             $gradenode->add($report->string, $report->link, navigation_node::TYPE_SETTING, null, $report->id, new pix_icon('i/report', ''));
2221         }
2222     }
2224     if ($imports = grade_helper::get_plugins_import($courseid)) {
2225         $importnode = $gradenode->add($strings['import'], null, navigation_node::TYPE_CONTAINER);
2226         foreach ($imports as $import) {
2227             $importnode->add($import->string, $import->link, navigation_node::TYPE_SETTING, null, $import->id, new pix_icon('i/restore', ''));
2228         }
2229     }
2231     if ($exports = grade_helper::get_plugins_export($courseid)) {
2232         $exportnode = $gradenode->add($strings['export'], null, navigation_node::TYPE_CONTAINER);
2233         foreach ($exports as $export) {
2234             $exportnode->add($export->string, $export->link, navigation_node::TYPE_SETTING, null, $export->id, new pix_icon('i/backup', ''));
2235         }
2236     }
2238     if ($setting = grade_helper::get_info_manage_settings($courseid)) {
2239         $gradenode->add(get_string('coursegradesettings', 'grades'), $setting->link, navigation_node::TYPE_SETTING, null, $setting->id, new pix_icon('i/settings', ''));
2240     }
2242     if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
2243         $preferencesnode = $gradenode->add(get_string('myreportpreferences', 'grades'), null, navigation_node::TYPE_CONTAINER);
2244         foreach ($preferences as $preference) {
2245             $preferencesnode->add($preference->string, $preference->link, navigation_node::TYPE_SETTING, null, $preference->id, new pix_icon('i/settings', ''));
2246         }
2247     }
2249     if ($letters = grade_helper::get_info_letters($courseid)) {
2250         $letters = array_shift($letters);
2251         $gradenode->add($strings['letter'], $letters->link, navigation_node::TYPE_SETTING, null, $letters->id, new pix_icon('i/settings', ''));
2252     }
2254     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
2255         $outcomes = array_shift($outcomes);
2256         $gradenode->add($strings['outcome'], $outcomes->link, navigation_node::TYPE_SETTING, null, $outcomes->id, new pix_icon('i/outcomes', ''));
2257     }
2259     if ($scales = grade_helper::get_info_scales($courseid)) {
2260         $gradenode->add($strings['scale'], $scales->link, navigation_node::TYPE_SETTING, null, $scales->id, new pix_icon('i/scales', ''));
2261     }
2263     if ($categories = grade_helper::get_info_edit_structure($courseid)) {
2264         $categoriesnode = $gradenode->add(get_string('categoriesanditems','grades'), null, navigation_node::TYPE_CONTAINER);
2265         foreach ($categories as $category) {
2266             $categoriesnode->add($category->string, $category->link, navigation_node::TYPE_SETTING, null, $category->id, new pix_icon('i/report', ''));
2267         }
2268     }
2270     if ($gradenode->contains_active_node()) {
2271         // If the gradenode is active include the settings base node (gradeadministration) in
2272         // the navbar, typcially this is ignored.
2273         $PAGE->navbar->includesettingsbase = true;
2275         // If we can get the course admin node make sure it is closed by default
2276         // as in this case the gradenode will be opened
2277         if ($coursenode = $PAGE->settingsnav->get('courseadmin', navigation_node::TYPE_COURSE)){
2278             $coursenode->make_inactive();
2279             $coursenode->forceopen = false;
2280         }
2281     }
2284 /**
2285  * Grade helper class
2286  *
2287  * This class provides several helpful functions that work irrespective of any
2288  * current state.
2289  *
2290  * @copyright 2010 Sam Hemelryk
2291  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2292  */
2293 abstract class grade_helper {
2294     /**
2295      * Cached manage settings info {@see get_info_settings}
2296      * @var grade_plugin_info|false
2297      */
2298     protected static $managesetting = null;
2299     /**
2300      * Cached grade report plugins {@see get_plugins_reports}
2301      * @var array|false
2302      */
2303     protected static $gradereports = null;
2304     /**
2305      * Cached grade report plugins preferences {@see get_info_scales}
2306      * @var array|false
2307      */
2308     protected static $gradereportpreferences = null;
2309     /**
2310      * Cached scale info {@see get_info_scales}
2311      * @var grade_plugin_info|false
2312      */
2313     protected static $scaleinfo = null;
2314     /**
2315      * Cached outcome info {@see get_info_outcomes}
2316      * @var grade_plugin_info|false
2317      */
2318     protected static $outcomeinfo = null;
2319     /**
2320      * Cached info on edit structure {@see get_info_edit_structure}
2321      * @var array|false
2322      */
2323     protected static $edittree = null;
2324     /**
2325      * Cached leftter info {@see get_info_letters}
2326      * @var grade_plugin_info|false
2327      */
2328     protected static $letterinfo = null;
2329     /**
2330      * Cached grade import plugins {@see get_plugins_import}
2331      * @var array|false
2332      */
2333     protected static $importplugins = null;
2334     /**
2335      * Cached grade export plugins {@see get_plugins_export}
2336      * @var array|false
2337      */
2338     protected static $exportplugins = null;
2339     /**
2340      * Cached grade plugin strings
2341      * @var array
2342      */
2343     protected static $pluginstrings = null;
2345     /**
2346      * Gets strings commonly used by the describe plugins
2347      *
2348      * report => get_string('view'),
2349      * edittree => get_string('edittree', 'grades'),
2350      * scale => get_string('scales'),
2351      * outcome => get_string('outcomes', 'grades'),
2352      * letter => get_string('letters', 'grades'),
2353      * export => get_string('export', 'grades'),
2354      * import => get_string('import'),
2355      * preferences => get_string('mypreferences', 'grades'),
2356      * settings => get_string('settings')
2357      *
2358      * @return array
2359      */
2360     public static function get_plugin_strings() {
2361         if (self::$pluginstrings === null) {
2362             self::$pluginstrings = array(
2363                 'report' => get_string('view'),
2364                 'edittree' => get_string('edittree', 'grades'),
2365                 'scale' => get_string('scales'),
2366                 'outcome' => get_string('outcomes', 'grades'),
2367                 'letter' => get_string('letters', 'grades'),
2368                 'export' => get_string('export', 'grades'),
2369                 'import' => get_string('import'),
2370                 'preferences' => get_string('mypreferences', 'grades'),
2371                 'settings' => get_string('settings')
2372             );
2373         }
2374         return self::$pluginstrings;
2375     }
2376     /**
2377      * Get grade_plugin_info object for managing settings if the user can
2378      *
2379      * @param int $courseid
2380      * @return grade_plugin_info
2381      */
2382     public static function get_info_manage_settings($courseid) {
2383         if (self::$managesetting !== null) {
2384             return self::$managesetting;
2385         }
2386         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2387         if (has_capability('moodle/course:update', $context)) {
2388             self::$managesetting = new grade_plugin_info('coursesettings', new moodle_url('/grade/edit/settings/index.php', array('id'=>$courseid)), get_string('course'));
2389         } else {
2390             self::$managesetting = false;
2391         }
2392         return self::$managesetting;
2393     }
2394     /**
2395      * Returns an array of plugin reports as grade_plugin_info objects
2396      *
2397      * @param int $courseid
2398      * @return array
2399      */
2400     public static function get_plugins_reports($courseid) {
2401         global $SITE;
2403         if (self::$gradereports !== null) {
2404             return self::$gradereports;
2405         }
2406         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2407         $gradereports = array();
2408         $gradepreferences = array();
2409         foreach (get_plugin_list('gradereport') as $plugin => $plugindir) {
2410             //some reports make no sense if we're not within a course
2411             if ($courseid==$SITE->id && ($plugin=='grader' || $plugin=='user')) {
2412                 continue;
2413             }
2415             // Remove ones we can't see
2416             if (!has_capability('gradereport/'.$plugin.':view', $context)) {
2417                 continue;
2418             }
2420             $pluginstr = get_string('pluginname', 'gradereport_'.$plugin);
2421             $url = new moodle_url('/grade/report/'.$plugin.'/index.php', array('id'=>$courseid));
2422             $gradereports[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2424             // Add link to preferences tab if such a page exists
2425             if (file_exists($plugindir.'/preferences.php')) {
2426                 $url = new moodle_url('/grade/report/'.$plugin.'/preferences.php', array('id'=>$courseid));
2427                 $gradepreferences[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2428             }
2429         }
2430         if (count($gradereports) == 0) {
2431             $gradereports = false;
2432             $gradepreferences = false;
2433         } else if (count($gradepreferences) == 0) {
2434             $gradepreferences = false;
2435             asort($gradereports);
2436         } else {
2437             asort($gradereports);
2438             asort($gradepreferences);
2439         }
2440         self::$gradereports = $gradereports;
2441         self::$gradereportpreferences = $gradepreferences;
2442         return self::$gradereports;
2443     }
2444     /**
2445      * Returns an array of grade plugin report preferences for plugin reports that
2446      * support preferences
2447      * @param int $courseid
2448      * @return array
2449      */
2450     public static function get_plugins_report_preferences($courseid) {
2451         if (self::$gradereportpreferences !== null) {
2452             return self::$gradereportpreferences;
2453         }
2454         self::get_plugins_reports($courseid);
2455         return self::$gradereportpreferences;
2456     }
2457     /**
2458      * Get information on scales
2459      * @param int $courseid
2460      * @return grade_plugin_info
2461      */
2462     public static function get_info_scales($courseid) {
2463         if (self::$scaleinfo !== null) {
2464             return self::$scaleinfo;
2465         }
2466         if (has_capability('moodle/course:managescales', get_context_instance(CONTEXT_COURSE, $courseid))) {
2467             $url = new moodle_url('/grade/edit/scale/index.php', array('id'=>$courseid));
2468             self::$scaleinfo = new grade_plugin_info('scale', $url, get_string('view'));
2469         } else {
2470             self::$scaleinfo = false;
2471         }
2472         return self::$scaleinfo;
2473     }
2474     /**
2475      * Get information on outcomes
2476      * @param int $courseid
2477      * @return grade_plugin_info
2478      */
2479     public static function get_info_outcomes($courseid) {
2480         global $CFG, $SITE;
2482         if (self::$outcomeinfo !== null) {
2483             return self::$outcomeinfo;
2484         }
2485         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2486         $canmanage = has_capability('moodle/grade:manage', $context);
2487         $canupdate = has_capability('moodle/course:update', $context);
2488         if (!empty($CFG->enableoutcomes) && ($canmanage || $canupdate)) {
2489             $outcomes = array();
2490             if ($canupdate) {
2491                 if ($courseid!=$SITE->id) {
2492                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2493                     $outcomes['course'] = new grade_plugin_info('course', $url, get_string('outcomescourse', 'grades'));
2494                 }
2495                 $url = new moodle_url('/grade/edit/outcome/index.php', array('id'=>$courseid));
2496                 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('editoutcomes', 'grades'));
2497                 $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid'=>$courseid));
2498                 $outcomes['import'] = new grade_plugin_info('import', $url, get_string('importoutcomes', 'grades'));
2499             } else {
2500                 if ($courseid!=$SITE->id) {
2501                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2502                     $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('outcomescourse', 'grades'));
2503                 }
2504             }
2505             self::$outcomeinfo = $outcomes;
2506         } else {
2507             self::$outcomeinfo = false;
2508         }
2509         return self::$outcomeinfo;
2510     }
2511     /**
2512      * Get information on editing structures
2513      * @param int $courseid
2514      * @return array
2515      */
2516     public static function get_info_edit_structure($courseid) {
2517         if (self::$edittree !== null) {
2518             return self::$edittree;
2519         }
2520         if (has_capability('moodle/grade:manage', get_context_instance(CONTEXT_COURSE, $courseid))) {
2521             $url = new moodle_url('/grade/edit/tree/index.php', array('sesskey'=>sesskey(), 'showadvanced'=>'0', 'id'=>$courseid));
2522             self::$edittree = array(
2523                 'simpleview' => new grade_plugin_info('simpleview', $url, get_string('simpleview', 'grades')),
2524                 'fullview' => new grade_plugin_info('fullview', new moodle_url($url, array('showadvanced'=>'1')), get_string('fullview', 'grades'))
2525             );
2526         } else {
2527             self::$edittree = false;
2528         }
2529         return self::$edittree;
2530     }
2531     /**
2532      * Get information on letters
2533      * @param int $courseid
2534      * @return array
2535      */
2536     public static function get_info_letters($courseid) {
2537         if (self::$letterinfo !== null) {
2538             return self::$letterinfo;
2539         }
2540         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2541         $canmanage = has_capability('moodle/grade:manage', $context);
2542         $canmanageletters = has_capability('moodle/grade:manageletters', $context);
2543         if ($canmanage || $canmanageletters) {
2544             self::$letterinfo = array(
2545                 'view' => new grade_plugin_info('view', new moodle_url('/grade/edit/letter/index.php', array('id'=>$context->id)), get_string('view')),
2546                 'edit' => new grade_plugin_info('edit', new moodle_url('/grade/edit/letter/index.php', array('edit'=>1,'id'=>$context->id)), get_string('edit'))
2547             );
2548         } else {
2549             self::$letterinfo = false;
2550         }
2551         return self::$letterinfo;
2552     }
2553     /**
2554      * Get information import plugins
2555      * @param int $courseid
2556      * @return array
2557      */
2558     public static function get_plugins_import($courseid) {
2559         global $CFG;
2561         if (self::$importplugins !== null) {
2562             return self::$importplugins;
2563         }
2564         $importplugins = array();
2565         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2567         if (has_capability('moodle/grade:import', $context)) {
2568             foreach (get_plugin_list('gradeimport') as $plugin => $plugindir) {
2569                 if (!has_capability('gradeimport/'.$plugin.':view', $context)) {
2570                     continue;
2571                 }
2572                 $pluginstr = get_string('pluginname', 'gradeimport_'.$plugin);
2573                 $url = new moodle_url('/grade/import/'.$plugin.'/index.php', array('id'=>$courseid));
2574                 $importplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2575             }
2578             if ($CFG->gradepublishing) {
2579                 $url = new moodle_url('/grade/import/keymanager.php', array('id'=>$courseid));
2580                 $importplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2581             }
2582         }
2584         if (count($importplugins) > 0) {
2585             asort($importplugins);
2586             self::$importplugins = $importplugins;
2587         } else {
2588             self::$importplugins = false;
2589         }
2590         return self::$importplugins;
2591     }
2592     /**
2593      * Get information export plugins
2594      * @param int $courseid
2595      * @return array
2596      */
2597     public static function get_plugins_export($courseid) {
2598         global $CFG;
2600         if (self::$exportplugins !== null) {
2601             return self::$exportplugins;
2602         }
2603         $context = get_context_instance(CONTEXT_COURSE, $courseid);
2604         $exportplugins = array();
2605         if (has_capability('moodle/grade:export', $context)) {
2606             foreach (get_plugin_list('gradeexport') as $plugin => $plugindir) {
2607                 if (!has_capability('gradeexport/'.$plugin.':view', $context)) {
2608                     continue;
2609                 }
2610                 $pluginstr = get_string('pluginname', 'gradeexport_'.$plugin);
2611                 $url = new moodle_url('/grade/export/'.$plugin.'/index.php', array('id'=>$courseid));
2612                 $exportplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2613             }
2615             if ($CFG->gradepublishing) {
2616                 $url = new moodle_url('/grade/export/keymanager.php', array('id'=>$courseid));
2617                 $exportplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2618             }
2619         }
2620         if (count($exportplugins) > 0) {
2621             asort($exportplugins);
2622             self::$exportplugins = $exportplugins;
2623         } else {
2624             self::$exportplugins = false;
2625         }
2626         return self::$exportplugins;
2627     }