MDL-36559 usability: Gradebook CSS styling for new icons
[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 {
36     /**
37      * The couse whose users we are interested in
38      */
39     protected $course;
41     /**
42      * An array of grade items or null if only user data was requested
43      */
44     protected $grade_items;
46     /**
47      * The group ID we are interested in. 0 means all groups.
48      */
49     protected $groupid;
51     /**
52      * A recordset of graded users
53      */
54     protected $users_rs;
56     /**
57      * A recordset of user grades (grade_grade instances)
58      */
59     protected $grades_rs;
61     /**
62      * Array used when moving to next user while iterating through the grades recordset
63      */
64     protected $gradestack;
66     /**
67      * The first field of the users table by which the array of users will be sorted
68      */
69     protected $sortfield1;
71     /**
72      * Should sortfield1 be ASC or DESC
73      */
74     protected $sortorder1;
76     /**
77      * The second field of the users table by which the array of users will be sorted
78      */
79     protected $sortfield2;
81     /**
82      * Should sortfield2 be ASC or DESC
83      */
84     protected $sortorder2;
86     /**
87      * Should users whose enrolment has been suspended be ignored?
88      */
89     protected $onlyactive = false;
91     /**
92      * Enable user custom fields
93      */
94     protected $allowusercustomfields = false;
96     /**
97      * Constructor
98      *
99      * @param object $course A course object
100      * @param array  $grade_items array of grade items, if not specified only user info returned
101      * @param int    $groupid iterate only group users if present
102      * @param string $sortfield1 The first field of the users table by which the array of users will be sorted
103      * @param string $sortorder1 The order in which the first sorting field will be sorted (ASC or DESC)
104      * @param string $sortfield2 The second field of the users table by which the array of users will be sorted
105      * @param string $sortorder2 The order in which the second sorting field will be sorted (ASC or DESC)
106      */
107     public function __construct($course, $grade_items=null, $groupid=0,
108                                           $sortfield1='lastname', $sortorder1='ASC',
109                                           $sortfield2='firstname', $sortorder2='ASC') {
110         $this->course      = $course;
111         $this->grade_items = $grade_items;
112         $this->groupid     = $groupid;
113         $this->sortfield1  = $sortfield1;
114         $this->sortorder1  = $sortorder1;
115         $this->sortfield2  = $sortfield2;
116         $this->sortorder2  = $sortorder2;
118         $this->gradestack  = array();
119     }
121     /**
122      * Initialise the iterator
123      *
124      * @return boolean success
125      */
126     public function init() {
127         global $CFG, $DB;
129         $this->close();
131         grade_regrade_final_grades($this->course->id);
132         $course_item = grade_item::fetch_course_item($this->course->id);
133         if ($course_item->needsupdate) {
134             // can not calculate all final grades - sorry
135             return false;
136         }
138         $coursecontext = context_course::instance($this->course->id);
139         $relatedcontexts = get_related_contexts_string($coursecontext);
141         list($gradebookroles_sql, $params) =
142             $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr');
143         list($enrolledsql, $enrolledparams) = get_enrolled_sql($coursecontext, '', 0, $this->onlyactive);
145         $params = array_merge($params, $enrolledparams);
147         if ($this->groupid) {
148             $groupsql = "INNER JOIN {groups_members} gm ON gm.userid = u.id";
149             $groupwheresql = "AND gm.groupid = :groupid";
150             // $params contents: gradebookroles
151             $params['groupid'] = $this->groupid;
152         } else {
153             $groupsql = "";
154             $groupwheresql = "";
155         }
157         if (empty($this->sortfield1)) {
158             // we must do some sorting even if not specified
159             $ofields = ", u.id AS usrt";
160             $order   = "usrt ASC";
162         } else {
163             $ofields = ", u.$this->sortfield1 AS usrt1";
164             $order   = "usrt1 $this->sortorder1";
165             if (!empty($this->sortfield2)) {
166                 $ofields .= ", u.$this->sortfield2 AS usrt2";
167                 $order   .= ", usrt2 $this->sortorder2";
168             }
169             if ($this->sortfield1 != 'id' and $this->sortfield2 != 'id') {
170                 // user order MUST be the same in both queries,
171                 // must include the only unique user->id if not already present
172                 $ofields .= ", u.id AS usrt";
173                 $order   .= ", usrt ASC";
174             }
175         }
177         $userfields = 'u.*';
178         $customfieldssql = '';
179         if ($this->allowusercustomfields && !empty($CFG->grade_export_customprofilefields)) {
180             $customfieldscount = 0;
181             $customfieldsarray = grade_helper::get_user_profile_fields($this->course->id, $this->allowusercustomfields);
182             foreach ($customfieldsarray as $field) {
183                 if (!empty($field->customid)) {
184                     $customfieldssql .= "
185                             LEFT JOIN (SELECT * FROM {user_info_data}
186                                 WHERE fieldid = :cf$customfieldscount) cf$customfieldscount
187                             ON u.id = cf$customfieldscount.userid";
188                     $userfields .= ", cf$customfieldscount.data AS 'customfield_{$field->shortname}'";
189                     $params['cf'.$customfieldscount] = $field->customid;
190                     $customfieldscount++;
191                 }
192             }
193         }
195         // $params contents: gradebookroles and groupid (for $groupwheresql)
196         $users_sql = "SELECT $userfields $ofields
197                         FROM {user} u
198                         JOIN ($enrolledsql) je ON je.id = u.id
199                              $groupsql $customfieldssql
200                         JOIN (
201                                   SELECT DISTINCT ra.userid
202                                     FROM {role_assignments} ra
203                                    WHERE ra.roleid $gradebookroles_sql
204                                      AND ra.contextid $relatedcontexts
205                              ) rainner ON rainner.userid = u.id
206                          WHERE u.deleted = 0
207                              $groupwheresql
208                     ORDER BY $order";
209         $this->users_rs = $DB->get_recordset_sql($users_sql, $params);
211         if (!empty($this->grade_items)) {
212             $itemids = array_keys($this->grade_items);
213             list($itemidsql, $grades_params) = $DB->get_in_or_equal($itemids, SQL_PARAMS_NAMED, 'items');
214             $params = array_merge($params, $grades_params);
215             // $params contents: gradebookroles, enrolledparams, groupid (for $groupwheresql) and itemids
217             $grades_sql = "SELECT g.* $ofields
218                              FROM {grade_grades} g
219                              JOIN {user} u ON g.userid = u.id
220                              JOIN ($enrolledsql) je ON je.id = u.id
221                                   $groupsql
222                              JOIN (
223                                       SELECT DISTINCT ra.userid
224                                         FROM {role_assignments} ra
225                                        WHERE ra.roleid $gradebookroles_sql
226                                          AND ra.contextid $relatedcontexts
227                                   ) rainner ON rainner.userid = u.id
228                               WHERE u.deleted = 0
229                               AND g.itemid $itemidsql
230                               $groupwheresql
231                          ORDER BY $order, g.itemid ASC";
232             $this->grades_rs = $DB->get_recordset_sql($grades_sql, $params);
233         } else {
234             $this->grades_rs = false;
235         }
237         return true;
238     }
240     /**
241      * Returns information about the next user
242      * @return mixed array of user info, all grades and feedback or null when no more users found
243      */
244     public function next_user() {
245         if (!$this->users_rs) {
246             return false; // no users present
247         }
249         if (!$this->users_rs->valid()) {
250             if ($current = $this->_pop()) {
251                 // this is not good - user or grades updated between the two reads above :-(
252             }
254             return false; // no more users
255         } else {
256             $user = $this->users_rs->current();
257             $this->users_rs->next();
258         }
260         // find grades of this user
261         $grade_records = array();
262         while (true) {
263             if (!$current = $this->_pop()) {
264                 break; // no more grades
265             }
267             if (empty($current->userid)) {
268                 break;
269             }
271             if ($current->userid != $user->id) {
272                 // grade of the next user, we have all for this user
273                 $this->_push($current);
274                 break;
275             }
277             $grade_records[$current->itemid] = $current;
278         }
280         $grades = array();
281         $feedbacks = array();
283         if (!empty($this->grade_items)) {
284             foreach ($this->grade_items as $grade_item) {
285                 if (!isset($feedbacks[$grade_item->id])) {
286                     $feedbacks[$grade_item->id] = new stdClass();
287                 }
288                 if (array_key_exists($grade_item->id, $grade_records)) {
289                     $feedbacks[$grade_item->id]->feedback       = $grade_records[$grade_item->id]->feedback;
290                     $feedbacks[$grade_item->id]->feedbackformat = $grade_records[$grade_item->id]->feedbackformat;
291                     unset($grade_records[$grade_item->id]->feedback);
292                     unset($grade_records[$grade_item->id]->feedbackformat);
293                     $grades[$grade_item->id] = new grade_grade($grade_records[$grade_item->id], false);
294                 } else {
295                     $feedbacks[$grade_item->id]->feedback       = '';
296                     $feedbacks[$grade_item->id]->feedbackformat = FORMAT_MOODLE;
297                     $grades[$grade_item->id] =
298                         new grade_grade(array('userid'=>$user->id, 'itemid'=>$grade_item->id), false);
299                 }
300             }
301         }
303         $result = new stdClass();
304         $result->user      = $user;
305         $result->grades    = $grades;
306         $result->feedbacks = $feedbacks;
307         return $result;
308     }
310     /**
311      * Close the iterator, do not forget to call this function
312      */
313     public function close() {
314         if ($this->users_rs) {
315             $this->users_rs->close();
316             $this->users_rs = null;
317         }
318         if ($this->grades_rs) {
319             $this->grades_rs->close();
320             $this->grades_rs = null;
321         }
322         $this->gradestack = array();
323     }
325     /**
326      * Should all enrolled users be exported or just those with an active enrolment?
327      *
328      * @param bool $onlyactive True to limit the export to users with an active enrolment
329      */
330     public function require_active_enrolment($onlyactive = true) {
331         if (!empty($this->users_rs)) {
332             debugging('Calling require_active_enrolment() has no effect unless you call init() again', DEBUG_DEVELOPER);
333         }
334         $this->onlyactive  = $onlyactive;
335     }
337     /**
338      * Allow custom fields to be included
339      *
340      * @param bool $allow Whether to allow custom fields or not
341      * @return void
342      */
343     public function allow_user_custom_fields($allow = true) {
344         if ($allow) {
345             $this->allowusercustomfields = true;
346         } else {
347             $this->allowusercustomfields = false;
348         }
349     }
351     /**
352      * Add a grade_grade instance to the grade stack
353      *
354      * @param grade_grade $grade Grade object
355      *
356      * @return void
357      */
358     private function _push($grade) {
359         array_push($this->gradestack, $grade);
360     }
363     /**
364      * Remove a grade_grade instance from the grade stack
365      *
366      * @return grade_grade current grade object
367      */
368     private function _pop() {
369         global $DB;
370         if (empty($this->gradestack)) {
371             if (empty($this->grades_rs) || !$this->grades_rs->valid()) {
372                 return null; // no grades present
373             }
375             $current = $this->grades_rs->current();
377             $this->grades_rs->next();
379             return $current;
380         } else {
381             return array_pop($this->gradestack);
382         }
383     }
386 /**
387  * Print a selection popup form of the graded users in a course.
388  *
389  * @deprecated since 2.0
390  *
391  * @param int    $course id of the course
392  * @param string $actionpage The page receiving the data from the popoup form
393  * @param int    $userid   id of the currently selected user (or 'all' if they are all selected)
394  * @param int    $groupid id of requested group, 0 means all
395  * @param int    $includeall bool include all option
396  * @param bool   $return If true, will return the HTML, otherwise, will print directly
397  * @return null
398  */
399 function print_graded_users_selector($course, $actionpage, $userid=0, $groupid=0, $includeall=true, $return=false) {
400     global $CFG, $USER, $OUTPUT;
401     return $OUTPUT->render(grade_get_graded_users_select(substr($actionpage, 0, strpos($actionpage, '/')), $course, $userid, $groupid, $includeall));
404 function grade_get_graded_users_select($report, $course, $userid, $groupid, $includeall) {
405     global $USER;
407     if (is_null($userid)) {
408         $userid = $USER->id;
409     }
411     $menu = array(); // Will be a list of userid => user name
412     $gui = new graded_users_iterator($course, null, $groupid);
413     $gui->init();
414     $label = get_string('selectauser', 'grades');
415     if ($includeall) {
416         $menu[0] = get_string('allusers', 'grades');
417         $label = get_string('selectalloroneuser', 'grades');
418     }
419     while ($userdata = $gui->next_user()) {
420         $user = $userdata->user;
421         $menu[$user->id] = fullname($user);
422     }
423     $gui->close();
425     if ($includeall) {
426         $menu[0] .= " (" . (count($menu) - 1) . ")";
427     }
428     $select = new single_select(new moodle_url('/grade/report/'.$report.'/index.php', array('id'=>$course->id)), 'userid', $menu, $userid);
429     $select->label = $label;
430     $select->formid = 'choosegradeuser';
431     return $select;
434 /**
435  * Print grading plugin selection popup form.
436  *
437  * @param array   $plugin_info An array of plugins containing information for the selector
438  * @param boolean $return return as string
439  *
440  * @return nothing or string if $return true
441  */
442 function print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return=false) {
443     global $CFG, $OUTPUT, $PAGE;
445     $menu = array();
446     $count = 0;
447     $active = '';
449     foreach ($plugin_info as $plugin_type => $plugins) {
450         if ($plugin_type == 'strings') {
451             continue;
452         }
454         $first_plugin = reset($plugins);
456         $sectionname = $plugin_info['strings'][$plugin_type];
457         $section = array();
459         foreach ($plugins as $plugin) {
460             $link = $plugin->link->out(false);
461             $section[$link] = $plugin->string;
462             $count++;
463             if ($plugin_type === $active_type and $plugin->id === $active_plugin) {
464                 $active = $link;
465             }
466         }
468         if ($section) {
469             $menu[] = array($sectionname=>$section);
470         }
471     }
473     // finally print/return the popup form
474     if ($count > 1) {
475         $select = new url_select($menu, $active, null, 'choosepluginreport');
476         $select->set_label(get_string('gradereport', 'grades'), array('class' => 'accesshide'));
477         if ($return) {
478             return $OUTPUT->render($select);
479         } else {
480             echo $OUTPUT->render($select);
481         }
482     } else {
483         // only one option - no plugin selector needed
484         return '';
485     }
488 /**
489  * Print grading plugin selection tab-based navigation.
490  *
491  * @param string  $active_type type of plugin on current page - import, export, report or edit
492  * @param string  $active_plugin active plugin type - grader, user, cvs, ...
493  * @param array   $plugin_info Array of plugins
494  * @param boolean $return return as string
495  *
496  * @return nothing or string if $return true
497  */
498 function grade_print_tabs($active_type, $active_plugin, $plugin_info, $return=false) {
499     global $CFG, $COURSE;
501     if (!isset($currenttab)) { //TODO: this is weird
502         $currenttab = '';
503     }
505     $tabs = array();
506     $top_row  = array();
507     $bottom_row = array();
508     $inactive = array($active_plugin);
509     $activated = array();
511     $count = 0;
512     $active = '';
514     foreach ($plugin_info as $plugin_type => $plugins) {
515         if ($plugin_type == 'strings') {
516             continue;
517         }
519         // If $plugins is actually the definition of a child-less parent link:
520         if (!empty($plugins->id)) {
521             $string = $plugins->string;
522             if (!empty($plugin_info[$active_type]->parent)) {
523                 $string = $plugin_info[$active_type]->parent->string;
524             }
526             $top_row[] = new tabobject($plugin_type, $plugins->link, $string);
527             continue;
528         }
530         $first_plugin = reset($plugins);
531         $url = $first_plugin->link;
533         if ($plugin_type == 'report') {
534             $url = $CFG->wwwroot.'/grade/report/index.php?id='.$COURSE->id;
535         }
537         $top_row[] = new tabobject($plugin_type, $url, $plugin_info['strings'][$plugin_type]);
539         if ($active_type == $plugin_type) {
540             foreach ($plugins as $plugin) {
541                 $bottom_row[] = new tabobject($plugin->id, $plugin->link, $plugin->string);
542                 if ($plugin->id == $active_plugin) {
543                     $inactive = array($plugin->id);
544                 }
545             }
546         }
547     }
549     $tabs[] = $top_row;
550     $tabs[] = $bottom_row;
552     if ($return) {
553         return print_tabs($tabs, $active_type, $inactive, $activated, true);
554     } else {
555         print_tabs($tabs, $active_type, $inactive, $activated);
556     }
559 /**
560  * grade_get_plugin_info
561  *
562  * @param int    $courseid The course id
563  * @param string $active_type type of plugin on current page - import, export, report or edit
564  * @param string $active_plugin active plugin type - grader, user, cvs, ...
565  *
566  * @return array
567  */
568 function grade_get_plugin_info($courseid, $active_type, $active_plugin) {
569     global $CFG, $SITE;
571     $context = context_course::instance($courseid);
573     $plugin_info = array();
574     $count = 0;
575     $active = '';
576     $url_prefix = $CFG->wwwroot . '/grade/';
578     // Language strings
579     $plugin_info['strings'] = grade_helper::get_plugin_strings();
581     if ($reports = grade_helper::get_plugins_reports($courseid)) {
582         $plugin_info['report'] = $reports;
583     }
585     //showing grade categories and items make no sense if we're not within a course
586     if ($courseid!=$SITE->id) {
587         if ($edittree = grade_helper::get_info_edit_structure($courseid)) {
588             $plugin_info['edittree'] = $edittree;
589         }
590     }
592     if ($scale = grade_helper::get_info_scales($courseid)) {
593         $plugin_info['scale'] = array('view'=>$scale);
594     }
596     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
597         $plugin_info['outcome'] = $outcomes;
598     }
600     if ($letters = grade_helper::get_info_letters($courseid)) {
601         $plugin_info['letter'] = $letters;
602     }
604     if ($imports = grade_helper::get_plugins_import($courseid)) {
605         $plugin_info['import'] = $imports;
606     }
608     if ($exports = grade_helper::get_plugins_export($courseid)) {
609         $plugin_info['export'] = $exports;
610     }
612     foreach ($plugin_info as $plugin_type => $plugins) {
613         if (!empty($plugins->id) && $active_plugin == $plugins->id) {
614             $plugin_info['strings']['active_plugin_str'] = $plugins->string;
615             break;
616         }
617         foreach ($plugins as $plugin) {
618             if (is_a($plugin, 'grade_plugin_info')) {
619                 if ($active_plugin == $plugin->id) {
620                     $plugin_info['strings']['active_plugin_str'] = $plugin->string;
621                 }
622             }
623         }
624     }
626     //hide course settings if we're not in a course
627     if ($courseid!=$SITE->id) {
628         if ($setting = grade_helper::get_info_manage_settings($courseid)) {
629             $plugin_info['settings'] = array('course'=>$setting);
630         }
631     }
633     // Put preferences last
634     if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
635         $plugin_info['preferences'] = $preferences;
636     }
638     foreach ($plugin_info as $plugin_type => $plugins) {
639         if (!empty($plugins->id) && $active_plugin == $plugins->id) {
640             $plugin_info['strings']['active_plugin_str'] = $plugins->string;
641             break;
642         }
643         foreach ($plugins as $plugin) {
644             if (is_a($plugin, 'grade_plugin_info')) {
645                 if ($active_plugin == $plugin->id) {
646                     $plugin_info['strings']['active_plugin_str'] = $plugin->string;
647                 }
648             }
649         }
650     }
652     return $plugin_info;
655 /**
656  * A simple class containing info about grade plugins.
657  * Can be subclassed for special rules
658  *
659  * @package core_grades
660  * @copyright 2009 Nicolas Connault
661  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
662  */
663 class grade_plugin_info {
664     /**
665      * A unique id for this plugin
666      *
667      * @var mixed
668      */
669     public $id;
670     /**
671      * A URL to access this plugin
672      *
673      * @var mixed
674      */
675     public $link;
676     /**
677      * The name of this plugin
678      *
679      * @var mixed
680      */
681     public $string;
682     /**
683      * Another grade_plugin_info object, parent of the current one
684      *
685      * @var mixed
686      */
687     public $parent;
689     /**
690      * Constructor
691      *
692      * @param int $id A unique id for this plugin
693      * @param string $link A URL to access this plugin
694      * @param string $string The name of this plugin
695      * @param object $parent Another grade_plugin_info object, parent of the current one
696      *
697      * @return void
698      */
699     public function __construct($id, $link, $string, $parent=null) {
700         $this->id = $id;
701         $this->link = $link;
702         $this->string = $string;
703         $this->parent = $parent;
704     }
707 /**
708  * Prints the page headers, breadcrumb trail, page heading, (optional) dropdown navigation menu and
709  * (optional) navigation tabs for any gradebook page. All gradebook pages MUST use these functions
710  * in favour of the usual print_header(), print_header_simple(), print_heading() etc.
711  * !IMPORTANT! Use of tabs.php file in gradebook pages is forbidden unless tabs are switched off at
712  * the site level for the gradebook ($CFG->grade_navmethod = GRADE_NAVMETHOD_DROPDOWN).
713  *
714  * @param int     $courseid Course id
715  * @param string  $active_type The type of the current page (report, settings,
716  *                             import, export, scales, outcomes, letters)
717  * @param string  $active_plugin The plugin of the current page (grader, fullview etc...)
718  * @param string  $heading The heading of the page. Tries to guess if none is given
719  * @param boolean $return Whether to return (true) or echo (false) the HTML generated by this function
720  * @param string  $bodytags Additional attributes that will be added to the <body> tag
721  * @param string  $buttons Additional buttons to display on the page
722  * @param boolean $shownavigation should the gradebook navigation drop down (or tabs) be shown?
723  *
724  * @return string HTML code or nothing if $return == false
725  */
726 function print_grade_page_head($courseid, $active_type, $active_plugin=null,
727                                $heading = false, $return=false,
728                                $buttons=false, $shownavigation=true) {
729     global $CFG, $OUTPUT, $PAGE;
731     $plugin_info = grade_get_plugin_info($courseid, $active_type, $active_plugin);
733     // Determine the string of the active plugin
734     $stractive_plugin = ($active_plugin) ? $plugin_info['strings']['active_plugin_str'] : $heading;
735     $stractive_type = $plugin_info['strings'][$active_type];
737     if (empty($plugin_info[$active_type]->id) || !empty($plugin_info[$active_type]->parent)) {
738         $title = $PAGE->course->fullname.': ' . $stractive_type . ': ' . $stractive_plugin;
739     } else {
740         $title = $PAGE->course->fullname.': ' . $stractive_plugin;
741     }
743     if ($active_type == 'report') {
744         $PAGE->set_pagelayout('report');
745     } else {
746         $PAGE->set_pagelayout('admin');
747     }
748     $PAGE->set_title(get_string('grades') . ': ' . $stractive_type);
749     $PAGE->set_heading($title);
750     if ($buttons instanceof single_button) {
751         $buttons = $OUTPUT->render($buttons);
752     }
753     $PAGE->set_button($buttons);
754     grade_extend_settings($plugin_info, $courseid);
756     $returnval = $OUTPUT->header();
757     if (!$return) {
758         echo $returnval;
759     }
761     // Guess heading if not given explicitly
762     if (!$heading) {
763         $heading = $stractive_plugin;
764     }
766     if ($shownavigation) {
767         if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_DROPDOWN) {
768             $returnval .= print_grade_plugin_selector($plugin_info, $active_type, $active_plugin, $return);
769         }
771         if ($return) {
772             $returnval .= $OUTPUT->heading($heading);
773         } else {
774             echo $OUTPUT->heading($heading);
775         }
777         if ($CFG->grade_navmethod == GRADE_NAVMETHOD_COMBO || $CFG->grade_navmethod == GRADE_NAVMETHOD_TABS) {
778             $returnval .= grade_print_tabs($active_type, $active_plugin, $plugin_info, $return);
779         }
780     }
782     if ($return) {
783         return $returnval;
784     }
787 /**
788  * Utility class used for return tracking when using edit and other forms in grade plugins
789  *
790  * @package core_grades
791  * @copyright 2009 Nicolas Connault
792  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
793  */
794 class grade_plugin_return {
795     public $type;
796     public $plugin;
797     public $courseid;
798     public $userid;
799     public $page;
801     /**
802      * Constructor
803      *
804      * @param array $params - associative array with return parameters, if null parameter are taken from _GET or _POST
805      */
806     public function grade_plugin_return($params = null) {
807         if (empty($params)) {
808             $this->type     = optional_param('gpr_type', null, PARAM_SAFEDIR);
809             $this->plugin   = optional_param('gpr_plugin', null, PARAM_PLUGIN);
810             $this->courseid = optional_param('gpr_courseid', null, PARAM_INT);
811             $this->userid   = optional_param('gpr_userid', null, PARAM_INT);
812             $this->page     = optional_param('gpr_page', null, PARAM_INT);
814         } else {
815             foreach ($params as $key=>$value) {
816                 if (property_exists($this, $key)) {
817                     $this->$key = $value;
818                 }
819             }
820         }
821     }
823     /**
824      * Returns return parameters as options array suitable for buttons.
825      * @return array options
826      */
827     public function get_options() {
828         if (empty($this->type)) {
829             return array();
830         }
832         $params = array();
834         if (!empty($this->plugin)) {
835             $params['plugin'] = $this->plugin;
836         }
838         if (!empty($this->courseid)) {
839             $params['id'] = $this->courseid;
840         }
842         if (!empty($this->userid)) {
843             $params['userid'] = $this->userid;
844         }
846         if (!empty($this->page)) {
847             $params['page'] = $this->page;
848         }
850         return $params;
851     }
853     /**
854      * Returns return url
855      *
856      * @param string $default default url when params not set
857      * @param array  $extras Extra URL parameters
858      *
859      * @return string url
860      */
861     public function get_return_url($default, $extras=null) {
862         global $CFG;
864         if (empty($this->type) or empty($this->plugin)) {
865             return $default;
866         }
868         $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php';
869         $glue = '?';
871         if (!empty($this->courseid)) {
872             $url .= $glue.'id='.$this->courseid;
873             $glue = '&amp;';
874         }
876         if (!empty($this->userid)) {
877             $url .= $glue.'userid='.$this->userid;
878             $glue = '&amp;';
879         }
881         if (!empty($this->page)) {
882             $url .= $glue.'page='.$this->page;
883             $glue = '&amp;';
884         }
886         if (!empty($extras)) {
887             foreach ($extras as $key=>$value) {
888                 $url .= $glue.$key.'='.$value;
889                 $glue = '&amp;';
890             }
891         }
893         return $url;
894     }
896     /**
897      * Returns string with hidden return tracking form elements.
898      * @return string
899      */
900     public function get_form_fields() {
901         if (empty($this->type)) {
902             return '';
903         }
905         $result  = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />';
907         if (!empty($this->plugin)) {
908             $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />';
909         }
911         if (!empty($this->courseid)) {
912             $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />';
913         }
915         if (!empty($this->userid)) {
916             $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />';
917         }
919         if (!empty($this->page)) {
920             $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />';
921         }
922     }
924     /**
925      * Add hidden elements into mform
926      *
927      * @param object &$mform moodle form object
928      *
929      * @return void
930      */
931     public function add_mform_elements(&$mform) {
932         if (empty($this->type)) {
933             return;
934         }
936         $mform->addElement('hidden', 'gpr_type', $this->type);
937         $mform->setType('gpr_type', PARAM_SAFEDIR);
939         if (!empty($this->plugin)) {
940             $mform->addElement('hidden', 'gpr_plugin', $this->plugin);
941             $mform->setType('gpr_plugin', PARAM_PLUGIN);
942         }
944         if (!empty($this->courseid)) {
945             $mform->addElement('hidden', 'gpr_courseid', $this->courseid);
946             $mform->setType('gpr_courseid', PARAM_INT);
947         }
949         if (!empty($this->userid)) {
950             $mform->addElement('hidden', 'gpr_userid', $this->userid);
951             $mform->setType('gpr_userid', PARAM_INT);
952         }
954         if (!empty($this->page)) {
955             $mform->addElement('hidden', 'gpr_page', $this->page);
956             $mform->setType('gpr_page', PARAM_INT);
957         }
958     }
960     /**
961      * Add return tracking params into url
962      *
963      * @param moodle_url $url A URL
964      *
965      * @return string $url with return tracking params
966      */
967     public function add_url_params(moodle_url $url) {
968         if (empty($this->type)) {
969             return $url;
970         }
972         $url->param('gpr_type', $this->type);
974         if (!empty($this->plugin)) {
975             $url->param('gpr_plugin', $this->plugin);
976         }
978         if (!empty($this->courseid)) {
979             $url->param('gpr_courseid' ,$this->courseid);
980         }
982         if (!empty($this->userid)) {
983             $url->param('gpr_userid', $this->userid);
984         }
986         if (!empty($this->page)) {
987             $url->param('gpr_page', $this->page);
988         }
990         return $url;
991     }
994 /**
995  * Function central to gradebook for building and printing the navigation (breadcrumb trail).
996  *
997  * @param string $path The path of the calling script (using __FILE__?)
998  * @param string $pagename The language string to use as the last part of the navigation (non-link)
999  * @param mixed  $id Either a plain integer (assuming the key is 'id') or
1000  *                   an array of keys and values (e.g courseid => $courseid, itemid...)
1001  *
1002  * @return string
1003  */
1004 function grade_build_nav($path, $pagename=null, $id=null) {
1005     global $CFG, $COURSE, $PAGE;
1007     $strgrades = get_string('grades', 'grades');
1009     // Parse the path and build navlinks from its elements
1010     $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash
1011     $path = substr($path, $dirroot_length);
1012     $path = str_replace('\\', '/', $path);
1014     $path_elements = explode('/', $path);
1016     $path_elements_count = count($path_elements);
1018     // First link is always 'grade'
1019     $PAGE->navbar->add($strgrades, new moodle_url('/grade/index.php', array('id'=>$COURSE->id)));
1021     $link = null;
1022     $numberofelements = 3;
1024     // Prepare URL params string
1025     $linkparams = array();
1026     if (!is_null($id)) {
1027         if (is_array($id)) {
1028             foreach ($id as $idkey => $idvalue) {
1029                 $linkparams[$idkey] = $idvalue;
1030             }
1031         } else {
1032             $linkparams['id'] = $id;
1033         }
1034     }
1036     $navlink4 = null;
1038     // Remove file extensions from filenames
1039     foreach ($path_elements as $key => $filename) {
1040         $path_elements[$key] = str_replace('.php', '', $filename);
1041     }
1043     // Second level links
1044     switch ($path_elements[1]) {
1045         case 'edit': // No link
1046             if ($path_elements[3] != 'index.php') {
1047                 $numberofelements = 4;
1048             }
1049             break;
1050         case 'import': // No link
1051             break;
1052         case 'export': // No link
1053             break;
1054         case 'report':
1055             // $id is required for this link. Do not print it if $id isn't given
1056             if (!is_null($id)) {
1057                 $link = new moodle_url('/grade/report/index.php', $linkparams);
1058             }
1060             if ($path_elements[2] == 'grader') {
1061                 $numberofelements = 4;
1062             }
1063             break;
1065         default:
1066             // If this element isn't among the ones already listed above, it isn't supported, throw an error.
1067             debugging("grade_build_nav() doesn't support ". $path_elements[1] .
1068                     " as the second path element after 'grade'.");
1069             return false;
1070     }
1071     $PAGE->navbar->add(get_string($path_elements[1], 'grades'), $link);
1073     // Third level links
1074     if (empty($pagename)) {
1075         $pagename = get_string($path_elements[2], 'grades');
1076     }
1078     switch ($numberofelements) {
1079         case 3:
1080             $PAGE->navbar->add($pagename, $link);
1081             break;
1082         case 4:
1083             if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') {
1084                 $PAGE->navbar->add(get_string('pluginname', 'gradereport_grader'), new moodle_url('/grade/report/grader/index.php', $linkparams));
1085             }
1086             $PAGE->navbar->add($pagename);
1087             break;
1088     }
1090     return '';
1093 /**
1094  * General structure representing grade items in course
1095  *
1096  * @package core_grades
1097  * @copyright 2009 Nicolas Connault
1098  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1099  */
1100 class grade_structure {
1101     public $context;
1103     public $courseid;
1105     /**
1106     * Reference to modinfo for current course (for performance, to save
1107     * retrieving it from courseid every time). Not actually set except for
1108     * the grade_tree type.
1109     * @var course_modinfo
1110     */
1111     public $modinfo;
1113     /**
1114      * 1D array of grade items only
1115      */
1116     public $items;
1118     /**
1119      * Returns icon of element
1120      *
1121      * @param array &$element An array representing an element in the grade_tree
1122      * @param bool  $spacerifnone return spacer if no icon found
1123      *
1124      * @return string icon or spacer
1125      */
1126     public function get_element_icon(&$element, $spacerifnone=false) {
1127         global $CFG, $OUTPUT;
1128         require_once $CFG->libdir.'/filelib.php';
1130         switch ($element['type']) {
1131             case 'item':
1132             case 'courseitem':
1133             case 'categoryitem':
1134                 $is_course   = $element['object']->is_course_item();
1135                 $is_category = $element['object']->is_category_item();
1136                 $is_scale    = $element['object']->gradetype == GRADE_TYPE_SCALE;
1137                 $is_value    = $element['object']->gradetype == GRADE_TYPE_VALUE;
1138                 $is_outcome  = !empty($element['object']->outcomeid);
1140                 if ($element['object']->is_calculated()) {
1141                     $strcalc = get_string('calculatedgrade', 'grades');
1142                     return '<img src="'.$OUTPUT->pix_url('i/calc') . '" class="icon itemicon" title="'.
1143                             s($strcalc).'" alt="'.s($strcalc).'"/>';
1145                 } else if (($is_course or $is_category) and ($is_scale or $is_value)) {
1146                     if ($category = $element['object']->get_item_category()) {
1147                         switch ($category->aggregation) {
1148                             case GRADE_AGGREGATE_MEAN:
1149                             case GRADE_AGGREGATE_MEDIAN:
1150                             case GRADE_AGGREGATE_WEIGHTED_MEAN:
1151                             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
1152                             case GRADE_AGGREGATE_EXTRACREDIT_MEAN:
1153                                 $stragg = get_string('aggregation', 'grades');
1154                                 return '<img src="'.$OUTPUT->pix_url('i/agg_mean') . '" ' .
1155                                         'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
1156                             case GRADE_AGGREGATE_SUM:
1157                                 $stragg = get_string('aggregation', 'grades');
1158                                 return '<img src="'.$OUTPUT->pix_url('i/agg_sum') . '" ' .
1159                                         'class="icon itemicon" title="'.s($stragg).'" alt="'.s($stragg).'"/>';
1160                         }
1161                     }
1163                 } else if ($element['object']->itemtype == 'mod') {
1164                     //prevent outcomes being displaying the same icon as the activity they are attached to
1165                     if ($is_outcome) {
1166                         $stroutcome = s(get_string('outcome', 'grades'));
1167                         return '<img src="'.$OUTPUT->pix_url('i/outcomes') . '" ' .
1168                             'class="icon itemicon" title="'.$stroutcome.
1169                             '" alt="'.$stroutcome.'"/>';
1170                     } else {
1171                         $strmodname = get_string('modulename', $element['object']->itemmodule);
1172                         return '<img src="'.$OUTPUT->pix_url('icon',
1173                             $element['object']->itemmodule) . '" ' .
1174                             'class="icon itemicon" title="' .s($strmodname).
1175                             '" alt="' .s($strmodname).'"/>';
1176                     }
1177                 } else if ($element['object']->itemtype == 'manual') {
1178                     if ($element['object']->is_outcome_item()) {
1179                         $stroutcome = get_string('outcome', 'grades');
1180                         return '<img src="'.$OUTPUT->pix_url('i/outcomes') . '" ' .
1181                                 'class="icon itemicon" title="'.s($stroutcome).
1182                                 '" alt="'.s($stroutcome).'"/>';
1183                     } else {
1184                         $strmanual = get_string('manualitem', 'grades');
1185                         return '<img src="'.$OUTPUT->pix_url('i/manual_item') . '" '.
1186                                 'class="icon itemicon" title="'.s($strmanual).
1187                                 '" alt="'.s($strmanual).'"/>';
1188                     }
1189                 }
1190                 break;
1192             case 'category':
1193                 $strcat = get_string('category', 'grades');
1194                 return '<img src="'.$OUTPUT->pix_url('i/folder') . '" class="icon itemicon" ' .
1195                         'title="'.s($strcat).'" alt="'.s($strcat).'" />';
1196         }
1198         if ($spacerifnone) {
1199             return $OUTPUT->spacer().' ';
1200         } else {
1201             return '';
1202         }
1203     }
1205     /**
1206      * Returns name of element optionally with icon and link
1207      *
1208      * @param array &$element An array representing an element in the grade_tree
1209      * @param bool  $withlink Whether or not this header has a link
1210      * @param bool  $icon Whether or not to display an icon with this header
1211      * @param bool  $spacerifnone return spacer if no icon found
1212      *
1213      * @return string header
1214      */
1215     public function get_element_header(&$element, $withlink=false, $icon=true, $spacerifnone=false) {
1216         $header = '';
1218         if ($icon) {
1219             $header .= $this->get_element_icon($element, $spacerifnone);
1220         }
1222         $header .= $element['object']->get_name();
1224         if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and
1225             $element['type'] != 'courseitem') {
1226             return $header;
1227         }
1229         if ($withlink) {
1230             $url = $this->get_activity_link($element);
1231             if ($url) {
1232                 $a = new stdClass();
1233                 $a->name = get_string('modulename', $element['object']->itemmodule);
1234                 $title = get_string('linktoactivity', 'grades', $a);
1236                 $header = html_writer::link($url, $header, array('title' => $title));
1237             }
1238         }
1240         return $header;
1241     }
1243     private function get_activity_link($element) {
1244         global $CFG;
1245         /** @var array static cache of the grade.php file existence flags */
1246         static $hasgradephp = array();
1248         $itemtype = $element['object']->itemtype;
1249         $itemmodule = $element['object']->itemmodule;
1250         $iteminstance = $element['object']->iteminstance;
1251         $itemnumber = $element['object']->itemnumber;
1253         // Links only for module items that have valid instance, module and are
1254         // called from grade_tree with valid modinfo
1255         if ($itemtype != 'mod' || !$iteminstance || !$itemmodule || !$this->modinfo) {
1256             return null;
1257         }
1259         // Get $cm efficiently and with visibility information using modinfo
1260         $instances = $this->modinfo->get_instances();
1261         if (empty($instances[$itemmodule][$iteminstance])) {
1262             return null;
1263         }
1264         $cm = $instances[$itemmodule][$iteminstance];
1266         // Do not add link if activity is not visible to the current user
1267         if (!$cm->uservisible) {
1268             return null;
1269         }
1271         if (!array_key_exists($itemmodule, $hasgradephp)) {
1272             if (file_exists($CFG->dirroot . '/mod/' . $itemmodule . '/grade.php')) {
1273                 $hasgradephp[$itemmodule] = true;
1274             } else {
1275                 $hasgradephp[$itemmodule] = false;
1276             }
1277         }
1279         // If module has grade.php, link to that, otherwise view.php
1280         if ($hasgradephp[$itemmodule]) {
1281             $args = array('id' => $cm->id, 'itemnumber' => $itemnumber);
1282             if (isset($element['userid'])) {
1283                 $args['userid'] = $element['userid'];
1284             }
1285             return new moodle_url('/mod/' . $itemmodule . '/grade.php', $args);
1286         } else {
1287             return new moodle_url('/mod/' . $itemmodule . '/view.php', array('id' => $cm->id));
1288         }
1289     }
1291     /**
1292      * Returns URL of a page that is supposed to contain detailed grade analysis
1293      *
1294      * At the moment, only activity modules are supported. The method generates link
1295      * to the module's file grade.php with the parameters id (cmid), itemid, itemnumber,
1296      * gradeid and userid. If the grade.php does not exist, null is returned.
1297      *
1298      * @return moodle_url|null URL or null if unable to construct it
1299      */
1300     public function get_grade_analysis_url(grade_grade $grade) {
1301         global $CFG;
1302         /** @var array static cache of the grade.php file existence flags */
1303         static $hasgradephp = array();
1305         if (empty($grade->grade_item) or !($grade->grade_item instanceof grade_item)) {
1306             throw new coding_exception('Passed grade without the associated grade item');
1307         }
1308         $item = $grade->grade_item;
1310         if (!$item->is_external_item()) {
1311             // at the moment, only activity modules are supported
1312             return null;
1313         }
1314         if ($item->itemtype !== 'mod') {
1315             throw new coding_exception('Unknown external itemtype: '.$item->itemtype);
1316         }
1317         if (empty($item->iteminstance) or empty($item->itemmodule) or empty($this->modinfo)) {
1318             return null;
1319         }
1321         if (!array_key_exists($item->itemmodule, $hasgradephp)) {
1322             if (file_exists($CFG->dirroot . '/mod/' . $item->itemmodule . '/grade.php')) {
1323                 $hasgradephp[$item->itemmodule] = true;
1324             } else {
1325                 $hasgradephp[$item->itemmodule] = false;
1326             }
1327         }
1329         if (!$hasgradephp[$item->itemmodule]) {
1330             return null;
1331         }
1333         $instances = $this->modinfo->get_instances();
1334         if (empty($instances[$item->itemmodule][$item->iteminstance])) {
1335             return null;
1336         }
1337         $cm = $instances[$item->itemmodule][$item->iteminstance];
1338         if (!$cm->uservisible) {
1339             return null;
1340         }
1342         $url = new moodle_url('/mod/'.$item->itemmodule.'/grade.php', array(
1343             'id'         => $cm->id,
1344             'itemid'     => $item->id,
1345             'itemnumber' => $item->itemnumber,
1346             'gradeid'    => $grade->id,
1347             'userid'     => $grade->userid,
1348         ));
1350         return $url;
1351     }
1353     /**
1354      * Returns an action icon leading to the grade analysis page
1355      *
1356      * @param grade_grade $grade
1357      * @return string
1358      */
1359     public function get_grade_analysis_icon(grade_grade $grade) {
1360         global $OUTPUT;
1362         $url = $this->get_grade_analysis_url($grade);
1363         if (is_null($url)) {
1364             return '';
1365         }
1367         return $OUTPUT->action_icon($url, new pix_icon('t/preview',
1368             get_string('gradeanalysis', 'core_grades')));
1369     }
1371     /**
1372      * Returns the grade eid - the grade may not exist yet.
1373      *
1374      * @param grade_grade $grade_grade A grade_grade object
1375      *
1376      * @return string eid
1377      */
1378     public function get_grade_eid($grade_grade) {
1379         if (empty($grade_grade->id)) {
1380             return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid;
1381         } else {
1382             return 'g'.$grade_grade->id;
1383         }
1384     }
1386     /**
1387      * Returns the grade_item eid
1388      * @param grade_item $grade_item A grade_item object
1389      * @return string eid
1390      */
1391     public function get_item_eid($grade_item) {
1392         return 'i'.$grade_item->id;
1393     }
1395     /**
1396      * Given a grade_tree element, returns an array of parameters
1397      * used to build an icon for that element.
1398      *
1399      * @param array $element An array representing an element in the grade_tree
1400      *
1401      * @return array
1402      */
1403     public function get_params_for_iconstr($element) {
1404         $strparams = new stdClass();
1405         $strparams->category = '';
1406         $strparams->itemname = '';
1407         $strparams->itemmodule = '';
1409         if (!method_exists($element['object'], 'get_name')) {
1410             return $strparams;
1411         }
1413         $strparams->itemname = html_to_text($element['object']->get_name());
1415         // If element name is categorytotal, get the name of the parent category
1416         if ($strparams->itemname == get_string('categorytotal', 'grades')) {
1417             $parent = $element['object']->get_parent_category();
1418             $strparams->category = $parent->get_name() . ' ';
1419         } else {
1420             $strparams->category = '';
1421         }
1423         $strparams->itemmodule = null;
1424         if (isset($element['object']->itemmodule)) {
1425             $strparams->itemmodule = $element['object']->itemmodule;
1426         }
1427         return $strparams;
1428     }
1430     /**
1431      * Return edit 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_edit_icon($element, $gpr) {
1439         global $CFG, $OUTPUT;
1441         if (!has_capability('moodle/grade:manage', $this->context)) {
1442             if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) {
1443                 // oki - let them override grade
1444             } else {
1445                 return '';
1446             }
1447         }
1449         static $strfeedback   = null;
1450         static $streditgrade = null;
1451         if (is_null($streditgrade)) {
1452             $streditgrade = get_string('editgrade', 'grades');
1453             $strfeedback  = get_string('feedback');
1454         }
1456         $strparams = $this->get_params_for_iconstr($element);
1458         $object = $element['object'];
1460         switch ($element['type']) {
1461             case 'item':
1462             case 'categoryitem':
1463             case 'courseitem':
1464                 $stredit = get_string('editverbose', 'grades', $strparams);
1465                 if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) {
1466                     $url = new moodle_url('/grade/edit/tree/item.php',
1467                             array('courseid' => $this->courseid, 'id' => $object->id));
1468                 } else {
1469                     $url = new moodle_url('/grade/edit/tree/outcomeitem.php',
1470                             array('courseid' => $this->courseid, 'id' => $object->id));
1471                 }
1472                 break;
1474             case 'category':
1475                 $stredit = get_string('editverbose', 'grades', $strparams);
1476                 $url = new moodle_url('/grade/edit/tree/category.php',
1477                         array('courseid' => $this->courseid, 'id' => $object->id));
1478                 break;
1480             case 'grade':
1481                 $stredit = $streditgrade;
1482                 if (empty($object->id)) {
1483                     $url = new moodle_url('/grade/edit/tree/grade.php',
1484                             array('courseid' => $this->courseid, 'itemid' => $object->itemid, 'userid' => $object->userid));
1485                 } else {
1486                     $url = new moodle_url('/grade/edit/tree/grade.php',
1487                             array('courseid' => $this->courseid, 'id' => $object->id));
1488                 }
1489                 if (!empty($object->feedback)) {
1490                     $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat)));
1491                 }
1492                 break;
1494             default:
1495                 $url = null;
1496         }
1498         if ($url) {
1499             return $OUTPUT->action_icon($gpr->add_url_params($url), new pix_icon('t/edit', $stredit));
1501         } else {
1502             return '';
1503         }
1504     }
1506     /**
1507      * Return hiding icon for give element
1508      *
1509      * @param array  $element An array representing an element in the grade_tree
1510      * @param object $gpr A grade_plugin_return object
1511      *
1512      * @return string
1513      */
1514     public function get_hiding_icon($element, $gpr) {
1515         global $CFG, $OUTPUT;
1517         if (!has_capability('moodle/grade:manage', $this->context) and
1518             !has_capability('moodle/grade:hide', $this->context)) {
1519             return '';
1520         }
1522         $strparams = $this->get_params_for_iconstr($element);
1523         $strshow = get_string('showverbose', 'grades', $strparams);
1524         $strhide = get_string('hideverbose', 'grades', $strparams);
1526         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1527         $url = $gpr->add_url_params($url);
1529         if ($element['object']->is_hidden()) {
1530             $type = 'show';
1531             $tooltip = $strshow;
1533             // Change the icon and add a tooltip showing the date
1534             if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) {
1535                 $type = 'hiddenuntil';
1536                 $tooltip = get_string('hiddenuntildate', 'grades',
1537                         userdate($element['object']->get_hidden()));
1538             }
1540             $url->param('action', 'show');
1542             $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strshow, 'class'=>'smallicon')));
1544         } else {
1545             $url->param('action', 'hide');
1546             $hideicon = $OUTPUT->action_icon($url, new pix_icon('t/hide', $strhide));
1547         }
1549         return $hideicon;
1550     }
1552     /**
1553      * Return locking icon for given element
1554      *
1555      * @param array  $element An array representing an element in the grade_tree
1556      * @param object $gpr A grade_plugin_return object
1557      *
1558      * @return string
1559      */
1560     public function get_locking_icon($element, $gpr) {
1561         global $CFG, $OUTPUT;
1563         $strparams = $this->get_params_for_iconstr($element);
1564         $strunlock = get_string('unlockverbose', 'grades', $strparams);
1565         $strlock = get_string('lockverbose', 'grades', $strparams);
1567         $url = new moodle_url('/grade/edit/tree/action.php', array('id' => $this->courseid, 'sesskey' => sesskey(), 'eid' => $element['eid']));
1568         $url = $gpr->add_url_params($url);
1570         // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon
1571         if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) {
1572             $strparamobj = new stdClass();
1573             $strparamobj->itemname = $element['object']->grade_item->itemname;
1574             $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj);
1576             $action = html_writer::tag('span', $OUTPUT->pix_icon('t/locked', $strnonunlockable),
1577                     array('class' => 'action-icon'));
1579         } else if ($element['object']->is_locked()) {
1580             $type = 'unlock';
1581             $tooltip = $strunlock;
1583             // Change the icon and add a tooltip showing the date
1584             if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) {
1585                 $type = 'locktime';
1586                 $tooltip = get_string('locktimedate', 'grades',
1587                         userdate($element['object']->get_locktime()));
1588             }
1590             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) {
1591                 $action = '';
1592             } else {
1593                 $url->param('action', 'unlock');
1594                 $action = $OUTPUT->action_icon($url, new pix_icon('t/'.$type, $tooltip, 'moodle', array('alt'=>$strunlock, 'class'=>'smallicon')));
1595             }
1597         } else {
1598             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) {
1599                 $action = '';
1600             } else {
1601                 $url->param('action', 'lock');
1602                 $action = $OUTPUT->action_icon($url, new pix_icon('t/lock', $strlock));
1603             }
1604         }
1606         return $action;
1607     }
1609     /**
1610      * Return calculation icon for given element
1611      *
1612      * @param array  $element An array representing an element in the grade_tree
1613      * @param object $gpr A grade_plugin_return object
1614      *
1615      * @return string
1616      */
1617     public function get_calculation_icon($element, $gpr) {
1618         global $CFG, $OUTPUT;
1619         if (!has_capability('moodle/grade:manage', $this->context)) {
1620             return '';
1621         }
1623         $type   = $element['type'];
1624         $object = $element['object'];
1626         if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') {
1627             $strparams = $this->get_params_for_iconstr($element);
1628             $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams);
1630             $is_scale = $object->gradetype == GRADE_TYPE_SCALE;
1631             $is_value = $object->gradetype == GRADE_TYPE_VALUE;
1633             // show calculation icon only when calculation possible
1634             if (!$object->is_external_item() and ($is_scale or $is_value)) {
1635                 if ($object->is_calculated()) {
1636                     $icon = 't/calc';
1637                 } else {
1638                     $icon = 't/calc_off';
1639                 }
1641                 $url = new moodle_url('/grade/edit/tree/calculation.php', array('courseid' => $this->courseid, 'id' => $object->id));
1642                 $url = $gpr->add_url_params($url);
1643                 return $OUTPUT->action_icon($url, new pix_icon($icon, $streditcalculation));
1644             }
1645         }
1647         return '';
1648     }
1651 /**
1652  * Flat structure similar to grade tree.
1653  *
1654  * @uses grade_structure
1655  * @package core_grades
1656  * @copyright 2009 Nicolas Connault
1657  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1658  */
1659 class grade_seq extends grade_structure {
1661     /**
1662      * 1D array of elements
1663      */
1664     public $elements;
1666     /**
1667      * Constructor, retrieves and stores array of all grade_category and grade_item
1668      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1669      *
1670      * @param int  $courseid The course id
1671      * @param bool $category_grade_last category grade item is the last child
1672      * @param bool $nooutcomes Whether or not outcomes should be included
1673      */
1674     public function grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) {
1675         global $USER, $CFG;
1677         $this->courseid   = $courseid;
1678         $this->context    = context_course::instance($courseid);
1680         // get course grade tree
1681         $top_element = grade_category::fetch_course_tree($courseid, true);
1683         $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes);
1685         foreach ($this->elements as $key=>$unused) {
1686             $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object'];
1687         }
1688     }
1690     /**
1691      * Static recursive helper - makes the grade_item for category the last children
1692      *
1693      * @param array &$element The seed of the recursion
1694      * @param bool $category_grade_last category grade item is the last child
1695      * @param bool $nooutcomes Whether or not outcomes should be included
1696      *
1697      * @return array
1698      */
1699     public function flatten(&$element, $category_grade_last, $nooutcomes) {
1700         if (empty($element['children'])) {
1701             return array();
1702         }
1703         $children = array();
1705         foreach ($element['children'] as $sortorder=>$unused) {
1706             if ($nooutcomes and $element['type'] != 'category' and
1707                 $element['children'][$sortorder]['object']->is_outcome_item()) {
1708                 continue;
1709             }
1710             $children[] = $element['children'][$sortorder];
1711         }
1712         unset($element['children']);
1714         if ($category_grade_last and count($children) > 1) {
1715             $cat_item = array_shift($children);
1716             array_push($children, $cat_item);
1717         }
1719         $result = array();
1720         foreach ($children as $child) {
1721             if ($child['type'] == 'category') {
1722                 $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes);
1723             } else {
1724                 $child['eid'] = 'i'.$child['object']->id;
1725                 $result[$child['object']->id] = $child;
1726             }
1727         }
1729         return $result;
1730     }
1732     /**
1733      * Parses the array in search of a given eid and returns a element object with
1734      * information about the element it has found.
1735      *
1736      * @param int $eid Gradetree Element ID
1737      *
1738      * @return object element
1739      */
1740     public function locate_element($eid) {
1741         // it is a grade - construct a new object
1742         if (strpos($eid, 'n') === 0) {
1743             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1744                 return null;
1745             }
1747             $itemid = $matches[1];
1748             $userid = $matches[2];
1750             //extra security check - the grade item must be in this tree
1751             if (!$item_el = $this->locate_element('i'.$itemid)) {
1752                 return null;
1753             }
1755             // $gradea->id may be null - means does not exist yet
1756             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
1758             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1759             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
1761         } else if (strpos($eid, 'g') === 0) {
1762             $id = (int) substr($eid, 1);
1763             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
1764                 return null;
1765             }
1766             //extra security check - the grade item must be in this tree
1767             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
1768                 return null;
1769             }
1770             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1771             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
1772         }
1774         // it is a category or item
1775         foreach ($this->elements as $element) {
1776             if ($element['eid'] == $eid) {
1777                 return $element;
1778             }
1779         }
1781         return null;
1782     }
1785 /**
1786  * This class represents a complete tree of categories, grade_items and final grades,
1787  * organises as an array primarily, but which can also be converted to other formats.
1788  * It has simple method calls with complex implementations, allowing for easy insertion,
1789  * deletion and moving of items and categories within the tree.
1790  *
1791  * @uses grade_structure
1792  * @package core_grades
1793  * @copyright 2009 Nicolas Connault
1794  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1795  */
1796 class grade_tree extends grade_structure {
1798     /**
1799      * The basic representation of the tree as a hierarchical, 3-tiered array.
1800      * @var object $top_element
1801      */
1802     public $top_element;
1804     /**
1805      * 2D array of grade items and categories
1806      * @var array $levels
1807      */
1808     public $levels;
1810     /**
1811      * Grade items
1812      * @var array $items
1813      */
1814     public $items;
1816     /**
1817      * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item
1818      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1819      *
1820      * @param int   $courseid The Course ID
1821      * @param bool  $fillers include fillers and colspans, make the levels var "rectangular"
1822      * @param bool  $category_grade_last category grade item is the last child
1823      * @param array $collapsed array of collapsed categories
1824      * @param bool  $nooutcomes Whether or not outcomes should be included
1825      */
1826     public function grade_tree($courseid, $fillers=true, $category_grade_last=false,
1827                                $collapsed=null, $nooutcomes=false) {
1828         global $USER, $CFG, $COURSE, $DB;
1830         $this->courseid   = $courseid;
1831         $this->levels     = array();
1832         $this->context    = context_course::instance($courseid);
1834         if (!empty($COURSE->id) && $COURSE->id == $this->courseid) {
1835             $course = $COURSE;
1836         } else {
1837             $course = $DB->get_record('course', array('id' => $this->courseid));
1838         }
1839         $this->modinfo = get_fast_modinfo($course);
1841         // get course grade tree
1842         $this->top_element = grade_category::fetch_course_tree($courseid, true);
1844         // collapse the categories if requested
1845         if (!empty($collapsed)) {
1846             grade_tree::category_collapse($this->top_element, $collapsed);
1847         }
1849         // no otucomes if requested
1850         if (!empty($nooutcomes)) {
1851             grade_tree::no_outcomes($this->top_element);
1852         }
1854         // move category item to last position in category
1855         if ($category_grade_last) {
1856             grade_tree::category_grade_last($this->top_element);
1857         }
1859         if ($fillers) {
1860             // inject fake categories == fillers
1861             grade_tree::inject_fillers($this->top_element, 0);
1862             // add colspans to categories and fillers
1863             grade_tree::inject_colspans($this->top_element);
1864         }
1866         grade_tree::fill_levels($this->levels, $this->top_element, 0);
1868     }
1870     /**
1871      * Static recursive helper - removes items from collapsed categories
1872      *
1873      * @param array &$element The seed of the recursion
1874      * @param array $collapsed array of collapsed categories
1875      *
1876      * @return void
1877      */
1878     public function category_collapse(&$element, $collapsed) {
1879         if ($element['type'] != 'category') {
1880             return;
1881         }
1882         if (empty($element['children']) or count($element['children']) < 2) {
1883             return;
1884         }
1886         if (in_array($element['object']->id, $collapsed['aggregatesonly'])) {
1887             $category_item = reset($element['children']); //keep only category item
1888             $element['children'] = array(key($element['children'])=>$category_item);
1890         } else {
1891             if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item
1892                 reset($element['children']);
1893                 $first_key = key($element['children']);
1894                 unset($element['children'][$first_key]);
1895             }
1896             foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children
1897                 grade_tree::category_collapse($element['children'][$sortorder], $collapsed);
1898             }
1899         }
1900     }
1902     /**
1903      * Static recursive helper - removes all outcomes
1904      *
1905      * @param array &$element The seed of the recursion
1906      *
1907      * @return void
1908      */
1909     public function no_outcomes(&$element) {
1910         if ($element['type'] != 'category') {
1911             return;
1912         }
1913         foreach ($element['children'] as $sortorder=>$child) {
1914             if ($element['children'][$sortorder]['type'] == 'item'
1915               and $element['children'][$sortorder]['object']->is_outcome_item()) {
1916                 unset($element['children'][$sortorder]);
1918             } else if ($element['children'][$sortorder]['type'] == 'category') {
1919                 grade_tree::no_outcomes($element['children'][$sortorder]);
1920             }
1921         }
1922     }
1924     /**
1925      * Static recursive helper - makes the grade_item for category the last children
1926      *
1927      * @param array &$element The seed of the recursion
1928      *
1929      * @return void
1930      */
1931     public function category_grade_last(&$element) {
1932         if (empty($element['children'])) {
1933             return;
1934         }
1935         if (count($element['children']) < 2) {
1936             return;
1937         }
1938         $first_item = reset($element['children']);
1939         if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') {
1940             // the category item might have been already removed
1941             $order = key($element['children']);
1942             unset($element['children'][$order]);
1943             $element['children'][$order] =& $first_item;
1944         }
1945         foreach ($element['children'] as $sortorder => $child) {
1946             grade_tree::category_grade_last($element['children'][$sortorder]);
1947         }
1948     }
1950     /**
1951      * Static recursive helper - fills the levels array, useful when accessing tree elements of one level
1952      *
1953      * @param array &$levels The levels of the grade tree through which to recurse
1954      * @param array &$element The seed of the recursion
1955      * @param int   $depth How deep are we?
1956      * @return void
1957      */
1958     public function fill_levels(&$levels, &$element, $depth) {
1959         if (!array_key_exists($depth, $levels)) {
1960             $levels[$depth] = array();
1961         }
1963         // prepare unique identifier
1964         if ($element['type'] == 'category') {
1965             $element['eid'] = 'c'.$element['object']->id;
1966         } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) {
1967             $element['eid'] = 'i'.$element['object']->id;
1968             $this->items[$element['object']->id] =& $element['object'];
1969         }
1971         $levels[$depth][] =& $element;
1972         $depth++;
1973         if (empty($element['children'])) {
1974             return;
1975         }
1976         $prev = 0;
1977         foreach ($element['children'] as $sortorder=>$child) {
1978             grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth);
1979             $element['children'][$sortorder]['prev'] = $prev;
1980             $element['children'][$sortorder]['next'] = 0;
1981             if ($prev) {
1982                 $element['children'][$prev]['next'] = $sortorder;
1983             }
1984             $prev = $sortorder;
1985         }
1986     }
1988     /**
1989      * Static recursive helper - makes full tree (all leafes are at the same level)
1990      *
1991      * @param array &$element The seed of the recursion
1992      * @param int   $depth How deep are we?
1993      *
1994      * @return int
1995      */
1996     public function inject_fillers(&$element, $depth) {
1997         $depth++;
1999         if (empty($element['children'])) {
2000             return $depth;
2001         }
2002         $chdepths = array();
2003         $chids = array_keys($element['children']);
2004         $last_child  = end($chids);
2005         $first_child = reset($chids);
2007         foreach ($chids as $chid) {
2008             $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth);
2009         }
2010         arsort($chdepths);
2012         $maxdepth = reset($chdepths);
2013         foreach ($chdepths as $chid=>$chd) {
2014             if ($chd == $maxdepth) {
2015                 continue;
2016             }
2017             for ($i=0; $i < $maxdepth-$chd; $i++) {
2018                 if ($chid == $first_child) {
2019                     $type = 'fillerfirst';
2020                 } else if ($chid == $last_child) {
2021                     $type = 'fillerlast';
2022                 } else {
2023                     $type = 'filler';
2024                 }
2025                 $oldchild =& $element['children'][$chid];
2026                 $element['children'][$chid] = array('object'=>'filler', 'type'=>$type,
2027                                                     'eid'=>'', 'depth'=>$element['object']->depth,
2028                                                     'children'=>array($oldchild));
2029             }
2030         }
2032         return $maxdepth;
2033     }
2035     /**
2036      * Static recursive helper - add colspan information into categories
2037      *
2038      * @param array &$element The seed of the recursion
2039      *
2040      * @return int
2041      */
2042     public function inject_colspans(&$element) {
2043         if (empty($element['children'])) {
2044             return 1;
2045         }
2046         $count = 0;
2047         foreach ($element['children'] as $key=>$child) {
2048             $count += grade_tree::inject_colspans($element['children'][$key]);
2049         }
2050         $element['colspan'] = $count;
2051         return $count;
2052     }
2054     /**
2055      * Parses the array in search of a given eid and returns a element object with
2056      * information about the element it has found.
2057      * @param int $eid Gradetree Element ID
2058      * @return object element
2059      */
2060     public function locate_element($eid) {
2061         // it is a grade - construct a new object
2062         if (strpos($eid, 'n') === 0) {
2063             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
2064                 return null;
2065             }
2067             $itemid = $matches[1];
2068             $userid = $matches[2];
2070             //extra security check - the grade item must be in this tree
2071             if (!$item_el = $this->locate_element('i'.$itemid)) {
2072                 return null;
2073             }
2075             // $gradea->id may be null - means does not exist yet
2076             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
2078             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2079             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
2081         } else if (strpos($eid, 'g') === 0) {
2082             $id = (int) substr($eid, 1);
2083             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
2084                 return null;
2085             }
2086             //extra security check - the grade item must be in this tree
2087             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
2088                 return null;
2089             }
2090             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
2091             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
2092         }
2094         // it is a category or item
2095         foreach ($this->levels as $row) {
2096             foreach ($row as $element) {
2097                 if ($element['type'] == 'filler') {
2098                     continue;
2099                 }
2100                 if ($element['eid'] == $eid) {
2101                     return $element;
2102                 }
2103             }
2104         }
2106         return null;
2107     }
2109     /**
2110      * Returns a well-formed XML representation of the grade-tree using recursion.
2111      *
2112      * @param array  $root The current element in the recursion. If null, starts at the top of the tree.
2113      * @param string $tabs The control character to use for tabs
2114      *
2115      * @return string $xml
2116      */
2117     public function exporttoxml($root=null, $tabs="\t") {
2118         $xml = null;
2119         $first = false;
2120         if (is_null($root)) {
2121             $root = $this->top_element;
2122             $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
2123             $xml .= "<gradetree>\n";
2124             $first = true;
2125         }
2127         $type = 'undefined';
2128         if (strpos($root['object']->table, 'grade_categories') !== false) {
2129             $type = 'category';
2130         } else if (strpos($root['object']->table, 'grade_items') !== false) {
2131             $type = 'item';
2132         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
2133             $type = 'outcome';
2134         }
2136         $xml .= "$tabs<element type=\"$type\">\n";
2137         foreach ($root['object'] as $var => $value) {
2138             if (!is_object($value) && !is_array($value) && !empty($value)) {
2139                 $xml .= "$tabs\t<$var>$value</$var>\n";
2140             }
2141         }
2143         if (!empty($root['children'])) {
2144             $xml .= "$tabs\t<children>\n";
2145             foreach ($root['children'] as $sortorder => $child) {
2146                 $xml .= $this->exportToXML($child, $tabs."\t\t");
2147             }
2148             $xml .= "$tabs\t</children>\n";
2149         }
2151         $xml .= "$tabs</element>\n";
2153         if ($first) {
2154             $xml .= "</gradetree>";
2155         }
2157         return $xml;
2158     }
2160     /**
2161      * Returns a JSON representation of the grade-tree using recursion.
2162      *
2163      * @param array $root The current element in the recursion. If null, starts at the top of the tree.
2164      * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy
2165      *
2166      * @return string
2167      */
2168     public function exporttojson($root=null, $tabs="\t") {
2169         $json = null;
2170         $first = false;
2171         if (is_null($root)) {
2172             $root = $this->top_element;
2173             $first = true;
2174         }
2176         $name = '';
2179         if (strpos($root['object']->table, 'grade_categories') !== false) {
2180             $name = $root['object']->fullname;
2181             if ($name == '?') {
2182                 $name = $root['object']->get_name();
2183             }
2184         } else if (strpos($root['object']->table, 'grade_items') !== false) {
2185             $name = $root['object']->itemname;
2186         } else if (strpos($root['object']->table, 'grade_outcomes') !== false) {
2187             $name = $root['object']->itemname;
2188         }
2190         $json .= "$tabs {\n";
2191         $json .= "$tabs\t \"type\": \"{$root['type']}\",\n";
2192         $json .= "$tabs\t \"name\": \"$name\",\n";
2194         foreach ($root['object'] as $var => $value) {
2195             if (!is_object($value) && !is_array($value) && !empty($value)) {
2196                 $json .= "$tabs\t \"$var\": \"$value\",\n";
2197             }
2198         }
2200         $json = substr($json, 0, strrpos($json, ','));
2202         if (!empty($root['children'])) {
2203             $json .= ",\n$tabs\t\"children\": [\n";
2204             foreach ($root['children'] as $sortorder => $child) {
2205                 $json .= $this->exportToJSON($child, $tabs."\t\t");
2206             }
2207             $json = substr($json, 0, strrpos($json, ','));
2208             $json .= "\n$tabs\t]\n";
2209         }
2211         if ($first) {
2212             $json .= "\n}";
2213         } else {
2214             $json .= "\n$tabs},\n";
2215         }
2217         return $json;
2218     }
2220     /**
2221      * Returns the array of levels
2222      *
2223      * @return array
2224      */
2225     public function get_levels() {
2226         return $this->levels;
2227     }
2229     /**
2230      * Returns the array of grade items
2231      *
2232      * @return array
2233      */
2234     public function get_items() {
2235         return $this->items;
2236     }
2238     /**
2239      * Returns a specific Grade Item
2240      *
2241      * @param int $itemid The ID of the grade_item object
2242      *
2243      * @return grade_item
2244      */
2245     public function get_item($itemid) {
2246         if (array_key_exists($itemid, $this->items)) {
2247             return $this->items[$itemid];
2248         } else {
2249             return false;
2250         }
2251     }
2254 /**
2255  * Local shortcut function for creating an edit/delete button for a grade_* object.
2256  * @param string $type 'edit' or 'delete'
2257  * @param int $courseid The Course ID
2258  * @param grade_* $object The grade_* object
2259  * @return string html
2260  */
2261 function grade_button($type, $courseid, $object) {
2262     global $CFG, $OUTPUT;
2263     if (preg_match('/grade_(.*)/', get_class($object), $matches)) {
2264         $objectidstring = $matches[1] . 'id';
2265     } else {
2266         throw new coding_exception('grade_button() only accepts grade_* objects as third parameter!');
2267     }
2269     $strdelete = get_string('delete');
2270     $stredit   = get_string('edit');
2272     if ($type == 'delete') {
2273         $url = new moodle_url('index.php', array('id' => $courseid, $objectidstring => $object->id, 'action' => 'delete', 'sesskey' => sesskey()));
2274     } else if ($type == 'edit') {
2275         $url = new moodle_url('edit.php', array('courseid' => $courseid, 'id' => $object->id));
2276     }
2278     return $OUTPUT->action_icon($url, new pix_icon('t/'.$type, ${'str'.$type}, '', array('class' => 'iconsmall')));
2282 /**
2283  * This method adds settings to the settings block for the grade system and its
2284  * plugins
2285  *
2286  * @global moodle_page $PAGE
2287  */
2288 function grade_extend_settings($plugininfo, $courseid) {
2289     global $PAGE;
2291     $gradenode = $PAGE->settingsnav->prepend(get_string('gradeadministration', 'grades'), null, navigation_node::TYPE_CONTAINER);
2293     $strings = array_shift($plugininfo);
2295     if ($reports = grade_helper::get_plugins_reports($courseid)) {
2296         foreach ($reports as $report) {
2297             $gradenode->add($report->string, $report->link, navigation_node::TYPE_SETTING, null, $report->id, new pix_icon('i/report', ''));
2298         }
2299     }
2301     if ($imports = grade_helper::get_plugins_import($courseid)) {
2302         $importnode = $gradenode->add($strings['import'], null, navigation_node::TYPE_CONTAINER);
2303         foreach ($imports as $import) {
2304             $importnode->add($import->string, $import->link, navigation_node::TYPE_SETTING, null, $import->id, new pix_icon('i/import', ''));
2305         }
2306     }
2308     if ($exports = grade_helper::get_plugins_export($courseid)) {
2309         $exportnode = $gradenode->add($strings['export'], null, navigation_node::TYPE_CONTAINER);
2310         foreach ($exports as $export) {
2311             $exportnode->add($export->string, $export->link, navigation_node::TYPE_SETTING, null, $export->id, new pix_icon('i/export', ''));
2312         }
2313     }
2315     if ($setting = grade_helper::get_info_manage_settings($courseid)) {
2316         $gradenode->add(get_string('coursegradesettings', 'grades'), $setting->link, navigation_node::TYPE_SETTING, null, $setting->id, new pix_icon('i/settings', ''));
2317     }
2319     if ($preferences = grade_helper::get_plugins_report_preferences($courseid)) {
2320         $preferencesnode = $gradenode->add(get_string('myreportpreferences', 'grades'), null, navigation_node::TYPE_CONTAINER);
2321         foreach ($preferences as $preference) {
2322             $preferencesnode->add($preference->string, $preference->link, navigation_node::TYPE_SETTING, null, $preference->id, new pix_icon('i/settings', ''));
2323         }
2324     }
2326     if ($letters = grade_helper::get_info_letters($courseid)) {
2327         $letters = array_shift($letters);
2328         $gradenode->add($strings['letter'], $letters->link, navigation_node::TYPE_SETTING, null, $letters->id, new pix_icon('i/settings', ''));
2329     }
2331     if ($outcomes = grade_helper::get_info_outcomes($courseid)) {
2332         $outcomes = array_shift($outcomes);
2333         $gradenode->add($strings['outcome'], $outcomes->link, navigation_node::TYPE_SETTING, null, $outcomes->id, new pix_icon('i/outcomes', ''));
2334     }
2336     if ($scales = grade_helper::get_info_scales($courseid)) {
2337         $gradenode->add($strings['scale'], $scales->link, navigation_node::TYPE_SETTING, null, $scales->id, new pix_icon('i/scales', ''));
2338     }
2340     if ($categories = grade_helper::get_info_edit_structure($courseid)) {
2341         $categoriesnode = $gradenode->add(get_string('categoriesanditems','grades'), null, navigation_node::TYPE_CONTAINER);
2342         foreach ($categories as $category) {
2343             $categoriesnode->add($category->string, $category->link, navigation_node::TYPE_SETTING, null, $category->id, new pix_icon('i/report', ''));
2344         }
2345     }
2347     if ($gradenode->contains_active_node()) {
2348         // If the gradenode is active include the settings base node (gradeadministration) in
2349         // the navbar, typcially this is ignored.
2350         $PAGE->navbar->includesettingsbase = true;
2352         // If we can get the course admin node make sure it is closed by default
2353         // as in this case the gradenode will be opened
2354         if ($coursenode = $PAGE->settingsnav->get('courseadmin', navigation_node::TYPE_COURSE)){
2355             $coursenode->make_inactive();
2356             $coursenode->forceopen = false;
2357         }
2358     }
2361 /**
2362  * Grade helper class
2363  *
2364  * This class provides several helpful functions that work irrespective of any
2365  * current state.
2366  *
2367  * @copyright 2010 Sam Hemelryk
2368  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2369  */
2370 abstract class grade_helper {
2371     /**
2372      * Cached manage settings info {@see get_info_settings}
2373      * @var grade_plugin_info|false
2374      */
2375     protected static $managesetting = null;
2376     /**
2377      * Cached grade report plugins {@see get_plugins_reports}
2378      * @var array|false
2379      */
2380     protected static $gradereports = null;
2381     /**
2382      * Cached grade report plugins preferences {@see get_info_scales}
2383      * @var array|false
2384      */
2385     protected static $gradereportpreferences = null;
2386     /**
2387      * Cached scale info {@see get_info_scales}
2388      * @var grade_plugin_info|false
2389      */
2390     protected static $scaleinfo = null;
2391     /**
2392      * Cached outcome info {@see get_info_outcomes}
2393      * @var grade_plugin_info|false
2394      */
2395     protected static $outcomeinfo = null;
2396     /**
2397      * Cached info on edit structure {@see get_info_edit_structure}
2398      * @var array|false
2399      */
2400     protected static $edittree = null;
2401     /**
2402      * Cached leftter info {@see get_info_letters}
2403      * @var grade_plugin_info|false
2404      */
2405     protected static $letterinfo = null;
2406     /**
2407      * Cached grade import plugins {@see get_plugins_import}
2408      * @var array|false
2409      */
2410     protected static $importplugins = null;
2411     /**
2412      * Cached grade export plugins {@see get_plugins_export}
2413      * @var array|false
2414      */
2415     protected static $exportplugins = null;
2416     /**
2417      * Cached grade plugin strings
2418      * @var array
2419      */
2420     protected static $pluginstrings = null;
2422     /**
2423      * Gets strings commonly used by the describe plugins
2424      *
2425      * report => get_string('view'),
2426      * edittree => get_string('edittree', 'grades'),
2427      * scale => get_string('scales'),
2428      * outcome => get_string('outcomes', 'grades'),
2429      * letter => get_string('letters', 'grades'),
2430      * export => get_string('export', 'grades'),
2431      * import => get_string('import'),
2432      * preferences => get_string('mypreferences', 'grades'),
2433      * settings => get_string('settings')
2434      *
2435      * @return array
2436      */
2437     public static function get_plugin_strings() {
2438         if (self::$pluginstrings === null) {
2439             self::$pluginstrings = array(
2440                 'report' => get_string('view'),
2441                 'edittree' => get_string('edittree', 'grades'),
2442                 'scale' => get_string('scales'),
2443                 'outcome' => get_string('outcomes', 'grades'),
2444                 'letter' => get_string('letters', 'grades'),
2445                 'export' => get_string('export', 'grades'),
2446                 'import' => get_string('import'),
2447                 'preferences' => get_string('mypreferences', 'grades'),
2448                 'settings' => get_string('settings')
2449             );
2450         }
2451         return self::$pluginstrings;
2452     }
2453     /**
2454      * Get grade_plugin_info object for managing settings if the user can
2455      *
2456      * @param int $courseid
2457      * @return grade_plugin_info
2458      */
2459     public static function get_info_manage_settings($courseid) {
2460         if (self::$managesetting !== null) {
2461             return self::$managesetting;
2462         }
2463         $context = context_course::instance($courseid);
2464         if (has_capability('moodle/course:update', $context)) {
2465             self::$managesetting = new grade_plugin_info('coursesettings', new moodle_url('/grade/edit/settings/index.php', array('id'=>$courseid)), get_string('course'));
2466         } else {
2467             self::$managesetting = false;
2468         }
2469         return self::$managesetting;
2470     }
2471     /**
2472      * Returns an array of plugin reports as grade_plugin_info objects
2473      *
2474      * @param int $courseid
2475      * @return array
2476      */
2477     public static function get_plugins_reports($courseid) {
2478         global $SITE;
2480         if (self::$gradereports !== null) {
2481             return self::$gradereports;
2482         }
2483         $context = context_course::instance($courseid);
2484         $gradereports = array();
2485         $gradepreferences = array();
2486         foreach (get_plugin_list('gradereport') as $plugin => $plugindir) {
2487             //some reports make no sense if we're not within a course
2488             if ($courseid==$SITE->id && ($plugin=='grader' || $plugin=='user')) {
2489                 continue;
2490             }
2492             // Remove ones we can't see
2493             if (!has_capability('gradereport/'.$plugin.':view', $context)) {
2494                 continue;
2495             }
2497             $pluginstr = get_string('pluginname', 'gradereport_'.$plugin);
2498             $url = new moodle_url('/grade/report/'.$plugin.'/index.php', array('id'=>$courseid));
2499             $gradereports[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2501             // Add link to preferences tab if such a page exists
2502             if (file_exists($plugindir.'/preferences.php')) {
2503                 $url = new moodle_url('/grade/report/'.$plugin.'/preferences.php', array('id'=>$courseid));
2504                 $gradepreferences[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2505             }
2506         }
2507         if (count($gradereports) == 0) {
2508             $gradereports = false;
2509             $gradepreferences = false;
2510         } else if (count($gradepreferences) == 0) {
2511             $gradepreferences = false;
2512             asort($gradereports);
2513         } else {
2514             asort($gradereports);
2515             asort($gradepreferences);
2516         }
2517         self::$gradereports = $gradereports;
2518         self::$gradereportpreferences = $gradepreferences;
2519         return self::$gradereports;
2520     }
2521     /**
2522      * Returns an array of grade plugin report preferences for plugin reports that
2523      * support preferences
2524      * @param int $courseid
2525      * @return array
2526      */
2527     public static function get_plugins_report_preferences($courseid) {
2528         if (self::$gradereportpreferences !== null) {
2529             return self::$gradereportpreferences;
2530         }
2531         self::get_plugins_reports($courseid);
2532         return self::$gradereportpreferences;
2533     }
2534     /**
2535      * Get information on scales
2536      * @param int $courseid
2537      * @return grade_plugin_info
2538      */
2539     public static function get_info_scales($courseid) {
2540         if (self::$scaleinfo !== null) {
2541             return self::$scaleinfo;
2542         }
2543         if (has_capability('moodle/course:managescales', context_course::instance($courseid))) {
2544             $url = new moodle_url('/grade/edit/scale/index.php', array('id'=>$courseid));
2545             self::$scaleinfo = new grade_plugin_info('scale', $url, get_string('view'));
2546         } else {
2547             self::$scaleinfo = false;
2548         }
2549         return self::$scaleinfo;
2550     }
2551     /**
2552      * Get information on outcomes
2553      * @param int $courseid
2554      * @return grade_plugin_info
2555      */
2556     public static function get_info_outcomes($courseid) {
2557         global $CFG, $SITE;
2559         if (self::$outcomeinfo !== null) {
2560             return self::$outcomeinfo;
2561         }
2562         $context = context_course::instance($courseid);
2563         $canmanage = has_capability('moodle/grade:manage', $context);
2564         $canupdate = has_capability('moodle/course:update', $context);
2565         if (!empty($CFG->enableoutcomes) && ($canmanage || $canupdate)) {
2566             $outcomes = array();
2567             if ($canupdate) {
2568                 if ($courseid!=$SITE->id) {
2569                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2570                     $outcomes['course'] = new grade_plugin_info('course', $url, get_string('outcomescourse', 'grades'));
2571                 }
2572                 $url = new moodle_url('/grade/edit/outcome/index.php', array('id'=>$courseid));
2573                 $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('editoutcomes', 'grades'));
2574                 $url = new moodle_url('/grade/edit/outcome/import.php', array('courseid'=>$courseid));
2575                 $outcomes['import'] = new grade_plugin_info('import', $url, get_string('importoutcomes', 'grades'));
2576             } else {
2577                 if ($courseid!=$SITE->id) {
2578                     $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$courseid));
2579                     $outcomes['edit'] = new grade_plugin_info('edit', $url, get_string('outcomescourse', 'grades'));
2580                 }
2581             }
2582             self::$outcomeinfo = $outcomes;
2583         } else {
2584             self::$outcomeinfo = false;
2585         }
2586         return self::$outcomeinfo;
2587     }
2588     /**
2589      * Get information on editing structures
2590      * @param int $courseid
2591      * @return array
2592      */
2593     public static function get_info_edit_structure($courseid) {
2594         if (self::$edittree !== null) {
2595             return self::$edittree;
2596         }
2597         if (has_capability('moodle/grade:manage', context_course::instance($courseid))) {
2598             $url = new moodle_url('/grade/edit/tree/index.php', array('sesskey'=>sesskey(), 'showadvanced'=>'0', 'id'=>$courseid));
2599             self::$edittree = array(
2600                 'simpleview' => new grade_plugin_info('simpleview', $url, get_string('simpleview', 'grades')),
2601                 'fullview' => new grade_plugin_info('fullview', new moodle_url($url, array('showadvanced'=>'1')), get_string('fullview', 'grades'))
2602             );
2603         } else {
2604             self::$edittree = false;
2605         }
2606         return self::$edittree;
2607     }
2608     /**
2609      * Get information on letters
2610      * @param int $courseid
2611      * @return array
2612      */
2613     public static function get_info_letters($courseid) {
2614         global $SITE;
2615         if (self::$letterinfo !== null) {
2616             return self::$letterinfo;
2617         }
2618         $context = context_course::instance($courseid);
2619         $canmanage = has_capability('moodle/grade:manage', $context);
2620         $canmanageletters = has_capability('moodle/grade:manageletters', $context);
2621         if ($canmanage || $canmanageletters) {
2622             // Redirect to system context when report is accessed from admin settings MDL-31633
2623             if ($context->instanceid == $SITE->id) {
2624                 $param = array('edit' => 1);
2625             } else {
2626                 $param = array('edit' => 1,'id' => $context->id);
2627             }
2628             self::$letterinfo = array(
2629                 'view' => new grade_plugin_info('view', new moodle_url('/grade/edit/letter/index.php', array('id'=>$context->id)), get_string('view')),
2630                 'edit' => new grade_plugin_info('edit', new moodle_url('/grade/edit/letter/index.php', $param), get_string('edit'))
2631             );
2632         } else {
2633             self::$letterinfo = false;
2634         }
2635         return self::$letterinfo;
2636     }
2637     /**
2638      * Get information import plugins
2639      * @param int $courseid
2640      * @return array
2641      */
2642     public static function get_plugins_import($courseid) {
2643         global $CFG;
2645         if (self::$importplugins !== null) {
2646             return self::$importplugins;
2647         }
2648         $importplugins = array();
2649         $context = context_course::instance($courseid);
2651         if (has_capability('moodle/grade:import', $context)) {
2652             foreach (get_plugin_list('gradeimport') as $plugin => $plugindir) {
2653                 if (!has_capability('gradeimport/'.$plugin.':view', $context)) {
2654                     continue;
2655                 }
2656                 $pluginstr = get_string('pluginname', 'gradeimport_'.$plugin);
2657                 $url = new moodle_url('/grade/import/'.$plugin.'/index.php', array('id'=>$courseid));
2658                 $importplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2659             }
2662             if ($CFG->gradepublishing) {
2663                 $url = new moodle_url('/grade/import/keymanager.php', array('id'=>$courseid));
2664                 $importplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2665             }
2666         }
2668         if (count($importplugins) > 0) {
2669             asort($importplugins);
2670             self::$importplugins = $importplugins;
2671         } else {
2672             self::$importplugins = false;
2673         }
2674         return self::$importplugins;
2675     }
2676     /**
2677      * Get information export plugins
2678      * @param int $courseid
2679      * @return array
2680      */
2681     public static function get_plugins_export($courseid) {
2682         global $CFG;
2684         if (self::$exportplugins !== null) {
2685             return self::$exportplugins;
2686         }
2687         $context = context_course::instance($courseid);
2688         $exportplugins = array();
2689         if (has_capability('moodle/grade:export', $context)) {
2690             foreach (get_plugin_list('gradeexport') as $plugin => $plugindir) {
2691                 if (!has_capability('gradeexport/'.$plugin.':view', $context)) {
2692                     continue;
2693                 }
2694                 $pluginstr = get_string('pluginname', 'gradeexport_'.$plugin);
2695                 $url = new moodle_url('/grade/export/'.$plugin.'/index.php', array('id'=>$courseid));
2696                 $exportplugins[$plugin] = new grade_plugin_info($plugin, $url, $pluginstr);
2697             }
2699             if ($CFG->gradepublishing) {
2700                 $url = new moodle_url('/grade/export/keymanager.php', array('id'=>$courseid));
2701                 $exportplugins['keymanager'] = new grade_plugin_info('keymanager', $url, get_string('keymanager', 'grades'));
2702             }
2703         }
2704         if (count($exportplugins) > 0) {
2705             asort($exportplugins);
2706             self::$exportplugins = $exportplugins;
2707         } else {
2708             self::$exportplugins = false;
2709         }
2710         return self::$exportplugins;
2711     }
2713     /**
2714      * Returns the value of a field from a user record
2715      *
2716      * @param stdClass $user object
2717      * @param stdClass $field object
2718      * @return string value of the field
2719      */
2720     public static function get_user_field_value($user, $field) {
2721         if (!empty($field->customid)) {
2722             $fieldname = 'customfield_' . $field->shortname;
2723             if (!empty($user->{$fieldname}) || is_numeric($user->{$fieldname})) {
2724                 $fieldvalue = $user->{$fieldname};
2725             } else {
2726                 $fieldvalue = $field->default;
2727             }
2728         } else {
2729             $fieldvalue = $user->{$field->shortname};
2730         }
2731         return $fieldvalue;
2732     }
2734     /**
2735      * Returns an array of user profile fields to be included in export
2736      *
2737      * @param int $courseid
2738      * @param bool $includecustomfields
2739      * @return array An array of stdClass instances with customid, shortname, datatype, default and fullname fields
2740      */
2741     public static function get_user_profile_fields($courseid, $includecustomfields = false) {
2742         global $CFG, $DB;
2744         // Gets the fields that have to be hidden
2745         $hiddenfields = array_map('trim', explode(',', $CFG->hiddenuserfields));
2746         $context = context_course::instance($courseid);
2747         $canseehiddenfields = has_capability('moodle/course:viewhiddenuserfields', $context);
2748         if ($canseehiddenfields) {
2749             $hiddenfields = array();
2750         }
2752         $fields = array();
2753         require_once($CFG->dirroot.'/user/lib.php');                // Loads user_get_default_fields()
2754         require_once($CFG->dirroot.'/user/profile/lib.php');        // Loads constants, such as PROFILE_VISIBLE_ALL
2755         $userdefaultfields = user_get_default_fields();
2757         // Sets the list of profile fields
2758         $userprofilefields = array_map('trim', explode(',', $CFG->grade_export_userprofilefields));
2759         if (!empty($userprofilefields)) {
2760             foreach ($userprofilefields as $field) {
2761                 $field = trim($field);
2762                 if (in_array($field, $hiddenfields) || !in_array($field, $userdefaultfields)) {
2763                     continue;
2764                 }
2765                 $obj = new stdClass();
2766                 $obj->customid  = 0;
2767                 $obj->shortname = $field;
2768                 $obj->fullname  = get_string($field);
2769                 $fields[] = $obj;
2770             }
2771         }
2773         // Sets the list of custom profile fields
2774         $customprofilefields = array_map('trim', explode(',', $CFG->grade_export_customprofilefields));
2775         if ($includecustomfields && !empty($customprofilefields)) {
2776             list($wherefields, $whereparams) = $DB->get_in_or_equal($customprofilefields);
2777             $customfields = $DB->get_records_sql("SELECT f.*
2778                                                     FROM {user_info_field} f
2779                                                     JOIN {user_info_category} c ON f.categoryid=c.id
2780                                                     WHERE f.shortname $wherefields
2781                                                     ORDER BY c.sortorder ASC, f.sortorder ASC", $whereparams);
2782             if (!is_array($customfields)) {
2783                 continue;
2784             }
2786             foreach ($customfields as $field) {
2787                 // Make sure we can display this custom field
2788                 if (!in_array($field->shortname, $customprofilefields)) {
2789                     continue;
2790                 } else if (in_array($field->shortname, $hiddenfields)) {
2791                     continue;
2792                 } else if ($field->visible != PROFILE_VISIBLE_ALL && !$canseehiddenfields) {
2793                     continue;
2794                 }
2796                 $obj = new stdClass();
2797                 $obj->customid  = $field->id;
2798                 $obj->shortname = $field->shortname;
2799                 $obj->fullname  = format_string($field->name);
2800                 $obj->datatype  = $field->datatype;
2801                 $obj->default   = $field->defaultdata;
2802                 $fields[] = $obj;
2803             }
2804         }
2806         return $fields;
2807     }