MDL-18167 towareds reimplementing of win installer support
[moodle.git] / grade / lib.php
1 <?php //$Id$
3 ///////////////////////////////////////////////////////////////////////////
4 //                                                                       //
5 // NOTICE OF COPYRIGHT                                                   //
6 //                                                                       //
7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
8 //          http://moodle.com                                            //
9 //                                                                       //
10 // Copyright (C) 1999 onwards  Martin Dougiamas  http://moodle.com       //
11 //                                                                       //
12 // This program is free software; you can redistribute it and/or modify  //
13 // it under the terms of the GNU General Public License as published by  //
14 // the Free Software Foundation; either version 2 of the License, or     //
15 // (at your option) any later version.                                   //
16 //                                                                       //
17 // This program is distributed in the hope that it will be useful,       //
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
20 // GNU General Public License for more details:                          //
21 //                                                                       //
22 //          http://www.gnu.org/copyleft/gpl.html                         //
23 //                                                                       //
24 ///////////////////////////////////////////////////////////////////////////
26 require_once $CFG->libdir.'/gradelib.php';
28 /**
29  * This class iterates over all users that are graded in a course.
30  * Returns detailed info about users and their grades.
31  */
32 class graded_users_iterator {
33     public $course;
34     public $grade_items;
35     public $groupid;
36     public $users_rs;
37     public $grades_rs;
38     public $gradestack;
39     public $sortfield1;
40     public $sortorder1;
41     public $sortfield2;
42     public $sortorder2;
44     /**
45      * Constructor
46      * @param $course object
47      * @param array grade_items array of grade items, if not specified only user info returned
48      * @param int $groupid iterate only group users if present
49      * @param string $sortfield1 The first field of the users table by which the array of users will be sorted
50      * @param string $sortorder1 The order in which the first sorting field will be sorted (ASC or DESC)
51      * @param string $sortfield2 The second field of the users table by which the array of users will be sorted
52      * @param string $sortorder2 The order in which the second sorting field will be sorted (ASC or DESC)
53      */
54     public function graded_users_iterator($course, $grade_items=null, $groupid=0, $sortfield1='lastname', $sortorder1='ASC', $sortfield2='firstname', $sortorder2='ASC') {
55         $this->course      = $course;
56         $this->grade_items = $grade_items;
57         $this->groupid     = $groupid;
58         $this->sortfield1  = $sortfield1;
59         $this->sortorder1  = $sortorder1;
60         $this->sortfield2  = $sortfield2;
61         $this->sortorder2  = $sortorder2;
63         $this->gradestack  = array();
64     }
66     /**
67      * Initialise the iterator
68      * @return boolean success
69      */
70     public function init() {
71         global $CFG, $DB;
73         $this->close();
75         grade_regrade_final_grades($this->course->id);
76         $course_item = grade_item::fetch_course_item($this->course->id);
77         if ($course_item->needsupdate) {
78             // can not calculate all final grades - sorry
79             return false;
80         }
82         list($gradebookroles_sql, $params) = $DB->get_in_or_equal(explode(',', $CFG->gradebookroles), SQL_PARAMS_NAMED, 'grbr0');
84         $relatedcontexts = get_related_contexts_string(get_context_instance(CONTEXT_COURSE, $this->course->id));
86         if ($this->groupid) {
87             $groupsql = "INNER JOIN {groups_members} gm ON gm.userid = u.id";
88             $groupwheresql = "AND gm.groupid = :groupid";
89             // $params contents: gradebookroles
90             $params['groupid'] = $this->groupid;
91         } else {
92             $groupsql = "";
93             $groupwheresql = "";
94         }
96         if (empty($this->sortfield1)) {
97             // we must do some sorting even if not specified
98             $ofields = ", u.id AS usrt";
99             $order   = "usrt ASC";
101         } else {
102             $ofields = ", u.$this->sortfield1 AS usrt1";
103             $order   = "usrt1 $this->sortorder1";
104             if (!empty($this->sortfield2)) {
105                 $ofields .= ", u.$this->sortfield1 AS usrt2";
106                 $order   .= ", usrt2 $this->sortorder2";
107             }
108             if ($this->sortfield1 != 'id' and $this->sortfield2 != 'id') {
109                 // user order MUST be the same in both queries, must include the only unique user->id if not already present
110                 $ofields .= ", u.id AS usrt";
111                 $order   .= ", usrt ASC";
112             }
113         }
115         // $params contents: gradebookroles and groupid (for $groupwheresql)
116         $users_sql = "SELECT u.* $ofields
117                         FROM {user} u
118                              INNER JOIN {role_assignments} ra ON u.id = ra.userid
119                              $groupsql
120                        WHERE ra.roleid $gradebookroles_sql
121                              AND ra.contextid $relatedcontexts
122                              $groupwheresql
123                     ORDER BY $order";
125         $this->users_rs = $DB->get_recordset_sql($users_sql, $params);
127         if (!empty($this->grade_items)) {
128             $itemids = array_keys($this->grade_items);
129             list($itemidsql, $grades_params) = $DB->get_in_or_equal($itemids, SQL_PARAMS_NAMED, 'items0');
130             $params = array_merge($params, $grades_params);
132             // $params contents: gradebookroles, groupid (for $groupwheresql) and itemids
133             $grades_sql = "SELECT g.* $ofields
134                              FROM {grade_grades} g
135                                   INNER JOIN {user} u ON g.userid = u.id
136                                   INNER JOIN {role_assignments} ra ON u.id = ra.userid
137                                   $groupsql
138                             WHERE ra.roleid $gradebookroles_sql
139                                   AND ra.contextid $relatedcontexts
140                                   $groupwheresql
141                                   AND g.itemid $itemidsql
142                          ORDER BY $order, g.itemid ASC";
143             $this->grades_rs = $DB->get_recordset_sql($grades_sql, $params);
144         } else {
145             $this->grades_rs = false;
146         }
148         return true;
149     }
151     /**
152      * Returns information about the next user
153      * @return mixed array of user info, all grades and feedback or null when no more users found
154      */
155     function next_user() {
156         if (!$this->users_rs) {
157             return false; // no users present
158         }
160         if (!$this->users_rs->valid()) {
161             if ($current = $this->_pop()) {
162                 // this is not good - user or grades updated between the two reads above :-(
163             }
165             return false; // no more users
166         } else {
167             $user = $this->users_rs->current();
168             $this->users_rs->next();
169         }
171         // find grades of this user
172         $grade_records = array();
173         while (true) {
174             if (!$current = $this->_pop()) {
175                 break; // no more grades
176             }
178             if (empty($current->userid)) {
179                 break;
180             }
182             if ($current->userid != $user->id) {
183                 // grade of the next user, we have all for this user
184                 $this->_push($current);
185                 break;
186             }
188             $grade_records[$current->itemid] = $current;
189         }
191         $grades = array();
192         $feedbacks = array();
194         if (!empty($this->grade_items)) {
195             foreach ($this->grade_items as $grade_item) {
196                 if (array_key_exists($grade_item->id, $grade_records)) {
197                     $feedbacks[$grade_item->id]->feedback       = $grade_records[$grade_item->id]->feedback;
198                     $feedbacks[$grade_item->id]->feedbackformat = $grade_records[$grade_item->id]->feedbackformat;
199                     unset($grade_records[$grade_item->id]->feedback);
200                     unset($grade_records[$grade_item->id]->feedbackformat);
201                     $grades[$grade_item->id] = new grade_grade($grade_records[$grade_item->id], false);
202                 } else {
203                     $feedbacks[$grade_item->id]->feedback       = '';
204                     $feedbacks[$grade_item->id]->feedbackformat = FORMAT_MOODLE;
205                     $grades[$grade_item->id] = new grade_grade(array('userid'=>$user->id, 'itemid'=>$grade_item->id), false);
206                 }
207             }
208         }
210         $result = new object();
211         $result->user      = $user;
212         $result->grades    = $grades;
213         $result->feedbacks = $feedbacks;
215         return $result;
216     }
218     /**
219      * Close the iterator, do not forget to call this function.
220      * @return void
221      */
222     function close() {
223         if ($this->users_rs) {
224             $this->users_rs->close();
225             $this->users_rs = null;
226         }
227         if ($this->grades_rs) {
228             $this->grades_rs->close();
229             $this->grades_rs = null;
230         }
231         $this->gradestack = array();
232     }
234     /**
235      * Internal function
236      */
237     function _push($grade) {
238         array_push($this->gradestack, $grade);
239     }
241     /**
242      * Internal function
243      */
244     function _pop() {
245         global $DB;
246         if (empty($this->gradestack)) {
247             if (!$this->grades_rs) {
248                 return NULL; // no grades present
249             }
251             if ($this->grades_rs->next()) {
252                 return NULL; // no more grades
253             }
255             return $this->grades_rs->current();
256         } else {
257             return array_pop($this->gradestack);
258         }
259     }
262 /**
263  * Print a selection popup form of the graded users in a course.
264  *
265  * @param int $courseid id of the course
266  * @param string $actionpage The page receiving the data from the popoup form
267  * @param int $userid   id of the currently selected user (or 'all' if they are all selected)
268  * @param bool $return If true, will return the HTML, otherwise, will print directly
269  * @return null
270  */
271 function print_graded_users_selector($course, $actionpage, $userid=null, $return=false) {
272     global $CFG, $USER;
274     if (is_null($userid)) {
275         $userid = $USER->id;
276     }
278     $context = get_context_instance(CONTEXT_COURSE, $course->id);
280     $menu = array(); // Will be a list of userid => user name
282     $gui = new graded_users_iterator($course);
283     $gui->init();
285     if ($userid !== 0) {
286         $menu[0] = get_string('allusers', 'grades');
287     }
289     $nextuser = $gui->next_user();
291     while ($userdata = $gui->next_user()) {
292         $user = $userdata->user;
293         $menu[$user->id] = fullname($user);
294     }
296     $gui->close();
298     if ($userid !== 0) {
299         $menu[0] .= " (" . (count($menu) - 1) . ")";
300     }
302     return popup_form($CFG->wwwroot.'/grade/' . $actionpage . '&amp;userid=', $menu, 'choosegradeduser', $userid, 'choose', '', '',
303                         $return, 'self', get_string('selectalloroneuser', 'grades'));
306 /**
307  * Print grading plugin selection popup form.
308  *
309  * @param int $courseid id of course
310  * @param string $active_type type of plugin on current page - import, export, report or edit
311  * @param string $active_plugin active plugin type - grader, user, cvs, ...
312  * @param boolean $return return as string
313  * @return nothing or string if $return true
314  */
315 function print_grade_plugin_selector($courseid, $active_type, $active_plugin, $return=false) {
316     global $CFG;
318     $context = get_context_instance(CONTEXT_COURSE, $courseid);
320     $menu = array();
321     $count = 0;
322     $active = '';
324 /// report plugins with its special structure
325     if ($reports = get_list_of_plugins('grade/report', 'CVS')) {         // Get all installed reports
326         foreach ($reports as $key => $plugin) {                      // Remove ones we can't see
327             if (!has_capability('gradereport/'.$plugin.':view', $context)) {
328                 unset($reports[$key]);
329             }
330         }
331     }
332     $reportnames = array();
333     if (!empty($reports)) {
334         foreach ($reports as $plugin) {
335             $url = 'report/'.$plugin.'/index.php?id='.$courseid;
336             if ($active_type == 'report' and $active_plugin == $plugin ) {
337                 $active = $url;
338             }
339             $reportnames[$url] = get_string('modulename', 'gradereport_'.$plugin);
340             $count++;
341         }
342         asort($reportnames);
343     }
344     if (!empty($reportnames)) {
345         $menu['reportgroup']='--'.get_string('view');
346         $menu = $menu+$reportnames;
347     }
349 /// standard import plugins
350     if ($imports = get_list_of_plugins('grade/import', 'CVS')) {         // Get all installed import plugins
351         foreach ($imports as $key => $plugin) {                      // Remove ones we can't see
352             if (!has_capability('gradeimport/'.$plugin.':view', $context)) {
353                 unset($imports[$key]);
354             }
355         }
356     }
357     $importnames = array();
358     if (!empty($imports)) {
359         foreach ($imports as $plugin) {
360             $url = 'import/'.$plugin.'/index.php?id='.$courseid;
361             if ($active_type == 'import' and $active_plugin == $plugin ) {
362                 $active = $url;
363             }
364             $importnames[$url] = get_string('modulename', 'gradeimport_'.$plugin);
365             $count++;
366         }
367         asort($importnames);
368     }
369     if (!empty($importnames)) {
370         $menu['importgroup']='--'.get_string('importfrom', 'grades');
371         $menu = $menu+$importnames;
372     }
374 /// standard export plugins
375     if ($exports = get_list_of_plugins('grade/export', 'CVS')) {         // Get all installed export plugins
376         foreach ($exports as $key => $plugin) {                      // Remove ones we can't see
377             if (!has_capability('gradeexport/'.$plugin.':view', $context)) {
378                 unset($exports[$key]);
379             }
380         }
381     }
382     $exportnames = array();
383     if (!empty($exports)) {
384         foreach ($exports as $plugin) {
385             $url = 'export/'.$plugin.'/index.php?id='.$courseid;
386             if ($active_type == 'export' and $active_plugin == $plugin ) {
387                 $active = $url;
388             }
389             $exportnames[$url] = get_string('modulename', 'gradeexport_'.$plugin);
390             $count++;
391         }
392         asort($exportnames);
393     }
394     if (!empty($exportnames)) {
395         $menu['exportgroup']='--'.get_string('exportto', 'grades');
396         $menu = $menu+$exportnames;
397     }
399 /// editing scripts - not real plugins
400     if (has_capability('moodle/grade:manage', $context)
401       or has_capability('moodle/grade:manageletters', $context)
402       or has_capability('moodle/course:managescales', $context)
403       or has_capability('moodle/course:update', $context)) {
404         $menu['edit']='--'.get_string('edit');
406         if (has_capability('moodle/grade:manage', $context)) {
407             $url = 'edit/tree/index.php?id='.$courseid;
408             if ($active_type == 'edit' and $active_plugin == 'tree' ) {
409                 $active = $url;
410             }
411             $menu[$url] = get_string('edittree', 'grades');
412             $count++;
413         }
415         if (has_capability('moodle/course:managescales', $context)) {
416             $url = 'edit/scale/index.php?id='.$courseid;
417             if ($active_type == 'edit' and $active_plugin == 'scale' ) {
418                 $active = $url;
419             }
420             $menu[$url] = get_string('scales');
421             $count++;
422         }
424         if (!empty($CFG->enableoutcomes) && (has_capability('moodle/grade:manage', $context) or
425                                              has_capability('moodle/course:update', $context))) {
426             if (has_capability('moodle/course:update', $context)) {  // Default to course assignment
427                 $url = 'edit/outcome/course.php?id='.$courseid;
428             } else {
429                 $url = 'edit/outcome/index.php?id='.$courseid;
430             }
431             if ($active_type == 'edit' and $active_plugin == 'outcome' ) {
432                 $active = $url;
433             }
434             $menu[$url] = get_string('outcomes', 'grades');
435             $count++;
436         }
438         if (has_capability('moodle/grade:manage', $context) or has_capability('moodle/grade:manageletters', $context)) {
439             $url = 'edit/letter/index.php?id='.$courseid;
440             if ($active_type == 'edit' and $active_plugin == 'letter' ) {
441                 $active = $url;
442             }
443             $menu[$url] = get_string('letters', 'grades');
444             $count++;
445         }
447         if (has_capability('moodle/grade:manage', $context)) {
448             $url = 'edit/settings/index.php?id='.$courseid;
449             if ($active_type == 'edit' and $active_plugin == 'settings' ) {
450                 $active = $url;
451             }
452             $menu[$url] = get_string('coursesettings', 'grades');
453             $count++;
454         }
456         if (has_capability('moodle/grade:manage', $context)) {
457             $url = 'edit/weights/index.php?id='.$courseid;
458             if ($active_type == 'edit' and $active_plugin == 'weights' ) {
459                 $active = $url;
460             }
461             $menu[$url] = get_string('weights', 'grades');
462             $count++;
463         }
464     }
466 /// finally print/return the popup form
467     if ($count > 1) {
468         return popup_form($CFG->wwwroot.'/grade/', $menu, 'choosepluginreport', '',
469                 get_string('chooseaction', 'grades'), '', '', $return, 'self');
470     } else {
471         // only one option - no plugin selector needed
472         return '';
473     }
476 /**
477  * Utility class used for return tracking when using edit and other forms in grade plugins
478  */
479 class grade_plugin_return {
480     public $type;
481     public $plugin;
482     public $courseid;
483     public $userid;
484     public $page;
486     /**
487      * Constructor
488      * @param array $params - associative array with return parameters, if null parameter are taken from _GET or _POST
489      */
490     public function grade_plugin_return ($params=null) {
491         if (empty($params)) {
492             $this->type     = optional_param('gpr_type', null, PARAM_SAFEDIR);
493             $this->plugin   = optional_param('gpr_plugin', null, PARAM_SAFEDIR);
494             $this->courseid = optional_param('gpr_courseid', null, PARAM_INT);
495             $this->userid   = optional_param('gpr_userid', null, PARAM_INT);
496             $this->page     = optional_param('gpr_page', null, PARAM_INT);
498         } else {
499             foreach ($params as $key=>$value) {
500                 if (array_key_exists($key, $this)) {
501                     $this->$key = $value;
502                 }
503             }
504         }
505     }
507     /**
508      * Returns return parameters as options array suitable for buttons.
509      * @return array options
510      */
511     public function get_options() {
512         if (empty($this->type)) {
513             return array();
514         }
516         $params = array();
518         if (!empty($this->plugin)) {
519             $params['plugin'] = $this->plugin;
520         }
522         if (!empty($this->courseid)) {
523             $params['id'] = $this->courseid;
524         }
526         if (!empty($this->userid)) {
527             $params['userid'] = $this->userid;
528         }
530         if (!empty($this->page)) {
531             $params['page'] = $this->page;
532         }
534         return $params;
535     }
537     /**
538      * Returns return url
539      * @param string $default default url when params not set
540      * @return string url
541      */
542     public function get_return_url($default, $extras=null) {
543         global $CFG;
545         if (empty($this->type) or empty($this->plugin)) {
546             return $default;
547         }
549         $url = $CFG->wwwroot.'/grade/'.$this->type.'/'.$this->plugin.'/index.php';
550         $glue = '?';
552         if (!empty($this->courseid)) {
553             $url .= $glue.'id='.$this->courseid;
554             $glue = '&amp;';
555         }
557         if (!empty($this->userid)) {
558             $url .= $glue.'userid='.$this->userid;
559             $glue = '&amp;';
560         }
562         if (!empty($this->page)) {
563             $url .= $glue.'page='.$this->page;
564             $glue = '&amp;';
565         }
567         if (!empty($extras)) {
568             foreach($extras as $key=>$value) {
569                 $url .= $glue.$key.'='.$value;
570                 $glue = '&amp;';
571             }
572         }
574         return $url;
575     }
577     /**
578      * Returns string with hidden return tracking form elements.
579      * @return string
580      */
581     public function get_form_fields() {
582         if (empty($this->type)) {
583             return '';
584         }
586         $result  = '<input type="hidden" name="gpr_type" value="'.$this->type.'" />';
588         if (!empty($this->plugin)) {
589             $result .= '<input type="hidden" name="gpr_plugin" value="'.$this->plugin.'" />';
590         }
592         if (!empty($this->courseid)) {
593             $result .= '<input type="hidden" name="gpr_courseid" value="'.$this->courseid.'" />';
594         }
596         if (!empty($this->userid)) {
597             $result .= '<input type="hidden" name="gpr_userid" value="'.$this->userid.'" />';
598         }
600         if (!empty($this->page)) {
601             $result .= '<input type="hidden" name="gpr_page" value="'.$this->page.'" />';
602         }
603     }
605     /**
606      * Add hidden elements into mform
607      * @param object $mform moodle form object
608      * @return void
609      */
610     public function add_mform_elements(&$mform) {
611         if (empty($this->type)) {
612             return;
613         }
615         $mform->addElement('hidden', 'gpr_type', $this->type);
616         $mform->setType('gpr_type', PARAM_SAFEDIR);
618         if (!empty($this->plugin)) {
619             $mform->addElement('hidden', 'gpr_plugin', $this->plugin);
620             $mform->setType('gpr_plugin', PARAM_SAFEDIR);
621         }
623         if (!empty($this->courseid)) {
624             $mform->addElement('hidden', 'gpr_courseid', $this->courseid);
625             $mform->setType('gpr_courseid', PARAM_INT);
626         }
628         if (!empty($this->userid)) {
629             $mform->addElement('hidden', 'gpr_userid', $this->userid);
630             $mform->setType('gpr_userid', PARAM_INT);
631         }
633         if (!empty($this->page)) {
634             $mform->addElement('hidden', 'gpr_page', $this->page);
635             $mform->setType('gpr_page', PARAM_INT);
636         }
637     }
639     /**
640      * Add return tracking params into url
641      * @param string $url
642      * @return string $url with erturn tracking params
643      */
644     public function add_url_params($url) {
645         if (empty($this->type)) {
646             return $url;
647         }
649         if (strpos($url, '?') === false) {
650             $url .= '?gpr_type='.$this->type;
651         } else {
652             $url .= '&amp;gpr_type='.$this->type;
653         }
655         if (!empty($this->plugin)) {
656             $url .= '&amp;gpr_plugin='.$this->plugin;
657         }
659         if (!empty($this->courseid)) {
660             $url .= '&amp;gpr_courseid='.$this->courseid;
661         }
663         if (!empty($this->userid)) {
664             $url .= '&amp;gpr_userid='.$this->userid;
665         }
667         if (!empty($this->page)) {
668             $url .= '&amp;gpr_page='.$this->page;
669         }
671         return $url;
672     }
675 /**
676  * Function central to gradebook for building and printing the navigation (breadcrumb trail).
677  * @param string $path The path of the calling script (using __FILE__?)
678  * @param string $pagename The language string to use as the last part of the navigation (non-link)
679  * @param mixed  $id Either a plain integer (assuming the key is 'id') or an array of keys and values (e.g courseid => $courseid, itemid...)
680  * @return string
681  */
682 function grade_build_nav($path, $pagename=null, $id=null) {
683     global $CFG, $COURSE;
685     $strgrades = get_string('grades', 'grades');
687     // Parse the path and build navlinks from its elements
688     $dirroot_length = strlen($CFG->dirroot) + 1; // Add 1 for the first slash
689     $path = substr($path, $dirroot_length);
690     $path = str_replace('\\', '/', $path);
692     $path_elements = explode('/', $path);
694     $path_elements_count = count($path_elements);
696     // First link is always 'grade'
697     $navlinks = array();
698     $navlinks[] = array('name' => $strgrades,
699                         'link' => $CFG->wwwroot.'/grade/index.php?id='.$COURSE->id,
700                         'type' => 'misc');
702     $link = '';
703     $numberofelements = 3;
705     // Prepare URL params string
706     $id_string = '?';
707     if (!is_null($id)) {
708         if (is_array($id)) {
709             foreach ($id as $idkey => $idvalue) {
710                 $id_string .= "$idkey=$idvalue&amp;";
711             }
712         } else {
713             $id_string .= "id=$id";
714         }
715     }
717     $navlink4 = null;
719     // Remove file extensions from filenames
720     foreach ($path_elements as $key => $filename) {
721         $path_elements[$key] = str_replace('.php', '', $filename);
722     }
724     // Second level links
725     switch ($path_elements[1]) {
726         case 'edit': // No link
727             if ($path_elements[3] != 'index.php') {
728                 $numberofelements = 4;
729             }
730             break;
731         case 'import': // No link
732             break;
733         case 'export': // No link
734             break;
735         case 'report':
736             // $id is required for this link. Do not print it if $id isn't given
737             if (!is_null($id)) {
738                 $link = $CFG->wwwroot . '/grade/report/index.php' . $id_string;
739             }
741             if ($path_elements[2] == 'grader') {
742                 $numberofelements = 4;
743             }
744             break;
746         default:
747             // If this element isn't among the ones already listed above, it isn't supported, throw an error.
748             debugging("grade_build_nav() doesn't support ". $path_elements[1] . " as the second path element after 'grade'.");
749             return false;
750     }
752     $navlinks[] = array('name' => get_string($path_elements[1], 'grades'), 'link' => $link, 'type' => 'misc');
754     // Third level links
755     if (empty($pagename)) {
756         $pagename = get_string($path_elements[2], 'grades');
757     }
759     switch ($numberofelements) {
760         case 3:
761             $navlinks[] = array('name' => $pagename, 'link' => $link, 'type' => 'misc');
762             break;
763         case 4:
765             if ($path_elements[2] == 'grader' AND $path_elements[3] != 'index.php') {
766                 $navlinks[] = array('name' => get_string('modulename', 'gradereport_grader'),
767                                     'link' => "$CFG->wwwroot/grade/report/grader/index.php$id_string",
768                                     'type' => 'misc');
769             }
770             $navlinks[] = array('name' => $pagename, 'link' => '', 'type' => 'misc');
771             break;
772     }
773     $navigation = build_navigation($navlinks);
775     return $navigation;
778 /**
779  * General structure representing grade items in course
780  */
781 class grade_structure {
782     public $context;
784     public $courseid;
786     /**
787      * 1D array of grade items only
788      */
789     public $items;
791     /**
792      * Returns icon of element
793      * @param object $element
794      * @param bool $spacerifnone return spacer if no icon found
795      * @return string icon or spacer
796      */
797     public function get_element_icon(&$element, $spacerifnone=false) {
798         global $CFG;
800         switch ($element['type']) {
801             case 'item':
802             case 'courseitem':
803             case 'categoryitem':
804                 if ($element['object']->is_calculated()) {
805                     return '<img src="'.$CFG->pixpath.'/i/calc.gif" class="icon itemicon" alt="'.get_string('calculation', 'grades').'"/>';
807                 } else if (($element['object']->is_course_item() or $element['object']->is_category_item())
808                   and ($element['object']->gradetype == GRADE_TYPE_SCALE or $element['object']->gradetype == GRADE_TYPE_VALUE)) {
809                     if ($category = $element['object']->get_item_category()) {
810                         switch ($category->aggregation) {
811                             case GRADE_AGGREGATE_MEAN:
812                             case GRADE_AGGREGATE_MEDIAN:
813                             case GRADE_AGGREGATE_WEIGHTED_MEAN:
814                             case GRADE_AGGREGATE_WEIGHTED_MEAN2:
815                             case GRADE_AGGREGATE_EXTRACREDIT_MEAN:
816                                 return '<img src="'.$CFG->pixpath.'/i/agg_mean.gif" class="icon itemicon" alt="'.get_string('aggregation', 'grades').'"/>';
817                             case GRADE_AGGREGATE_SUM:
818                                 return '<img src="'.$CFG->pixpath.'/i/agg_sum.gif" class="icon itemicon" alt="'.get_string('aggregation', 'grades').'"/>';
819                         }
820                     }
822                 } else if ($element['object']->itemtype == 'mod') {
823                     return '<img src="'.$CFG->modpixpath.'/'.$element['object']->itemmodule.'/icon.gif" class="icon itemicon" alt="'
824                            .get_string('modulename', $element['object']->itemmodule).'"/>';
826                 } else if ($element['object']->itemtype == 'manual') {
827                     if ($element['object']->is_outcome_item()) {
828                         return '<img src="'.$CFG->pixpath.'/i/outcomes.gif" class="icon itemicon" alt="'.get_string('outcome', 'grades').'"/>';
829                     } else {
830                         return '<img src="'.$CFG->pixpath.'/t/manual_item.gif" class="icon itemicon" alt="'.get_string('manualitem', 'grades').'"/>';
831                     }
832                 }
833                 break;
835             case 'category':
836                 return '<img src="'.$CFG->pixpath.'/f/folder.gif" class="icon itemicon" alt="'.get_string('category', 'grades').'"/>';
837         }
839         if ($spacerifnone) {
840             return '<img src="'.$CFG->wwwroot.'/pix/spacer.gif" class="icon itemicon" alt=""/>';
841         } else {
842             return '';
843         }
844     }
846     /**
847      * Returns name of element optionally with icon and link
848      * @param object $element
849      * @param bool $withlinks
850      * @param bool $icons
851      * @param bool $spacerifnone return spacer if no icon found
852      * @return header string
853      */
854     public function get_element_header(&$element, $withlink=false, $icon=true, $spacerifnone=false) {
855         global $CFG;
857         $header = '';
859         if ($icon) {
860             $header .= $this->get_element_icon($element, $spacerifnone);
861         }
863         $title = $element['object']->get_name();
864         $header .= $title;
866         if ($element['type'] != 'item' and $element['type'] != 'categoryitem' and $element['type'] != 'courseitem') {
867             return $header;
868         }
870         $itemtype     = $element['object']->itemtype;
871         $itemmodule   = $element['object']->itemmodule;
872         $iteminstance = $element['object']->iteminstance;
874         if ($withlink and $itemtype=='mod' and $iteminstance and $itemmodule) {
875             if ($cm = get_coursemodule_from_instance($itemmodule, $iteminstance, $this->courseid)) {
877                 $dir = $CFG->dirroot.'/mod/'.$itemmodule;
879                 if (file_exists($dir.'/grade.php')) {
880                     $url = $CFG->wwwroot.'/mod/'.$itemmodule.'/grade.php?id='.$cm->id;
881                 } else {
882                     $url = $CFG->wwwroot.'/mod/'.$itemmodule.'/view.php?id='.$cm->id;
883                 }
885                 $header = '<a href="'.$url.'" title="'.$title.'">'.$header.'</a>';
886             }
887         }
889         return $header;
890     }
892     /**
893      * Returns the grade eid - the grade may not exist yet.
894      * @param $grade_grade object
895      * @return string eid
896      */
897     public function get_grade_eid($grade_grade) {
898         if (empty($grade_grade->id)) {
899             return 'n'.$grade_grade->itemid.'u'.$grade_grade->userid;
900         } else {
901             return 'g'.$grade_grade->id;
902         }
903     }
905     /**
906      * Returns the grade_item eid
907      * @param $grade_item object
908      * @return string eid
909      */
910     public function get_item_eid($grade_item) {
911         return 'i'.$grade_item->id;
912     }
914     function get_params_for_iconstr($element) {
915         $strparams = new stdClass();
916         $strparams->category = '';
917         $strparams->itemname = '';
918         $strparams->itemmodule = '';
919         if (!method_exists($element['object'], 'get_name')) {
920             return $strparams;
921         }
923         $strparams->itemname = $element['object']->get_name();
925         // If element name is categorytotal, get the name of the parent category
926         if ($strparams->itemname == get_string('categorytotal', 'grades')) {
927             $parent = $element['object']->get_parent_category();
928             $strparams->category = $parent->get_name() . ' ';
929         } else {
930             $strparams->category = '';
931         }
933         $strparams->itemmodule = null;
934         if (isset($element['object']->itemmodule)) {
935             $strparams->itemmodule = $element['object']->itemmodule;
936         }
937         return $strparams;
938     }
940     /**
941      * Return edit icon for give element
942      * @param object $element
943      * @return string
944      */
945     public function get_edit_icon($element, $gpr) {
946         global $CFG;
948         if (!has_capability('moodle/grade:manage', $this->context)) {
949             if ($element['type'] == 'grade' and has_capability('moodle/grade:edit', $this->context)) {
950                 // oki - let them override grade
951             } else {
952                 return '';
953             }
954         }
956         static $strfeedback   = null;
957         static $streditgrade = null;
958         if (is_null($streditgrade)) {
959             $streditgrade = get_string('editgrade', 'grades');
960             $strfeedback  = get_string('feedback');
961         }
963         $strparams = $this->get_params_for_iconstr($element);
964         if ($element['type'] == 'item' or $element['type'] == 'category') {
965         }
967         $object = $element['object'];
968         $overlib = '';
970         switch ($element['type']) {
971             case 'item':
972             case 'categoryitem':
973             case 'courseitem':
974                 $stredit = get_string('editverbose', 'grades', $strparams);
975                 if (empty($object->outcomeid) || empty($CFG->enableoutcomes)) {
976                     $url = $CFG->wwwroot.'/grade/edit/tree/item.php?courseid='.$this->courseid.'&amp;id='.$object->id;
977                 } else {
978                     $url = $CFG->wwwroot.'/grade/edit/tree/outcomeitem.php?courseid='.$this->courseid.'&amp;id='.$object->id;
979                 }
980                 $url = $gpr->add_url_params($url);
981                 break;
983             case 'category':
984                 $stredit = get_string('editverbose', 'grades', $strparams);
985                 $url = $CFG->wwwroot.'/grade/edit/tree/category.php?courseid='.$this->courseid.'&amp;id='.$object->id;
986                 $url = $gpr->add_url_params($url);
987                 break;
989             case 'grade':
990                 $stredit = $streditgrade;
991                 if (empty($object->id)) {
992                     $url = $CFG->wwwroot.'/grade/edit/tree/grade.php?courseid='.$this->courseid.'&amp;itemid='.$object->itemid.'&amp;userid='.$object->userid;
993                 } else {
994                     $url = $CFG->wwwroot.'/grade/edit/tree/grade.php?courseid='.$this->courseid.'&amp;id='.$object->id;
995                 }
996                 $url = $gpr->add_url_params($url);
997                 if (!empty($object->feedback)) {
998                     $feedback = addslashes_js(trim(format_string($object->feedback, $object->feedbackformat)));
999                     $function = "return overlib('$feedback', BORDER, 0, FGCLASS, 'feedback', "
1000                               ."CAPTIONFONTCLASS, 'caption', CAPTION, '$strfeedback');";
1001                     $overlib = 'onmouseover="'.s($function).'" onmouseout="return nd();"';
1002                 }
1003                 break;
1005             default:
1006                 $url = null;
1007         }
1009         if ($url) {
1010             return '<a href="'.$url.'" class="edit"><img '.$overlib.' src="'.$CFG->pixpath.'/t/edit.gif" class="iconsmall" alt="'.$stredit.'" title="'.$stredit.'"/></a>';
1012         } else {
1013             return '';
1014         }
1015     }
1017     /**
1018      * Return hiding icon for give element
1019      * @param object $element
1020      * @return string
1021      */
1022     public function get_hiding_icon($element, $gpr) {
1023         global $CFG;
1025         if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:hide', $this->context)) {
1026             return '';
1027         }
1029         $strparams = $this->get_params_for_iconstr($element);
1030         $strshow = get_string('showverbose', 'grades', $strparams);
1031         $strhide = get_string('hideverbose', 'grades', $strparams);
1033         if ($element['object']->is_hidden()) {
1034             $icon = 'show';
1035             $tooltip = $strshow;
1037             if ($element['type'] != 'category' and $element['object']->get_hidden() > 1) { // Change the icon and add a tooltip showing the date
1038                 $icon = 'hiddenuntil';
1039                 $tooltip = get_string('hiddenuntildate', 'grades', userdate($element['object']->get_hidden()));
1040             }
1042             $url     = $CFG->wwwroot.'/grade/edit/tree/action.php?id='.$this->courseid.'&amp;action=show&amp;sesskey='.sesskey()
1043                      . '&amp;eid='.$element['eid'];
1044             $url     = $gpr->add_url_params($url);
1045             $action  = '<a href="'.$url.'" class="hide"><img alt="'.$strshow.'" src="'.$CFG->pixpath.'/t/'.$icon.'.gif" class="iconsmall" title="'.$tooltip.'"/></a>';
1047         } else {
1048             $url     = $CFG->wwwroot.'/grade/edit/tree/action.php?id='.$this->courseid.'&amp;action=hide&amp;sesskey='.sesskey()
1049                      . '&amp;eid='.$element['eid'];
1050             $url     = $gpr->add_url_params($url);
1051             $action  = '<a href="'.$url.'" class="hide"><img src="'.$CFG->pixpath.'/t/hide.gif" class="iconsmall" alt="'.$strhide.'" title="'.$strhide.'"/></a>';
1052         }
1053         return $action;
1054     }
1056     /**
1057      * Return locking icon for given element
1058      * @param object $element
1059      * @return string
1060      */
1061     public function get_locking_icon($element, $gpr) {
1062         global $CFG;
1064         $strparams = $this->get_params_for_iconstr($element);
1065         $strunlock = get_string('unlockverbose', 'grades', $strparams);
1066         $strlock = get_string('lockverbose', 'grades', $strparams);
1068         // Don't allow an unlocking action for a grade whose grade item is locked: just print a state icon
1069         if ($element['type'] == 'grade' && $element['object']->grade_item->is_locked()) {
1070             $strparamobj = new stdClass();
1071             $strparamobj->itemname = $element['object']->grade_item->itemname;
1072             $strnonunlockable = get_string('nonunlockableverbose', 'grades', $strparamobj);
1073             $action  = '<img src="'.$CFG->pixpath.'/t/unlock_gray.gif" alt="'.$strnonunlockable.'" class="iconsmall" title="'.$strnonunlockable.'"/>';
1074         } elseif ($element['object']->is_locked()) {
1075             $icon = 'unlock';
1076             $tooltip = $strunlock;
1078             if ($element['type'] != 'category' and $element['object']->get_locktime() > 1) { // Change the icon and add a tooltip showing the date
1079                 $icon = 'locktime';
1080                 $tooltip = get_string('locktimedate', 'grades', userdate($element['object']->get_locktime()));
1081             }
1083             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:unlock', $this->context)) {
1084                 return '';
1085             }
1086             $url     = $CFG->wwwroot.'/grade/edit/tree/action.php?id='.$this->courseid.'&amp;action=unlock&amp;sesskey='.sesskey()
1087                      . '&amp;eid='.$element['eid'];
1088             $url     = $gpr->add_url_params($url);
1089             $action  = '<a href="'.$url.'" class="lock"><img src="'.$CFG->pixpath.'/t/'.$icon.'.gif" alt="'.$strunlock.'" class="iconsmall" title="'.$tooltip.'"/></a>';
1091         } else {
1092             if (!has_capability('moodle/grade:manage', $this->context) and !has_capability('moodle/grade:lock', $this->context)) {
1093                 return '';
1094             }
1095             $url     = $CFG->wwwroot.'/grade/edit/tree/action.php?id='.$this->courseid.'&amp;action=lock&amp;sesskey='.sesskey()
1096                      . '&amp;eid='.$element['eid'];
1097             $url     = $gpr->add_url_params($url);
1098             $action  = '<a href="'.$url.'" class="lock"><img src="'.$CFG->pixpath.'/t/lock.gif" class="iconsmall" alt="'.$strlock.'" title="'
1099                      . $strlock.'"/></a>';
1100         }
1101         return $action;
1102     }
1104     /**
1105      * Return calculation icon for given element
1106      * @param object $element
1107      * @return string
1108      */
1109     public function get_calculation_icon($element, $gpr) {
1110         global $CFG;
1111         if (!has_capability('moodle/grade:manage', $this->context)) {
1112             return '';
1113         }
1115         $calculation_icon = '';
1117         $type   = $element['type'];
1118         $object = $element['object'];
1121         if ($type == 'item' or $type == 'courseitem' or $type == 'categoryitem') {
1122             $strparams = $this->get_params_for_iconstr($element);
1123             $streditcalculation = get_string('editcalculationverbose', 'grades', $strparams);
1125             // show calculation icon only when calculation possible
1126             if (!$object->is_external_item() and ($object->gradetype == GRADE_TYPE_SCALE or $object->gradetype == GRADE_TYPE_VALUE)) {
1127                 if ($object->is_calculated()) {
1128                     $icon = 'calc.gif';
1129                 } else {
1130                     $icon = 'calc_off.gif';
1131                 }
1132                 $url = $CFG->wwwroot.'/grade/edit/tree/calculation.php?courseid='.$this->courseid.'&amp;id='.$object->id;
1133                 $url = $gpr->add_url_params($url);
1134                 $calculation_icon = '<a href="'. $url.'" class="calculation"><img src="'.$CFG->pixpath.'/t/'.$icon.'" class="iconsmall" alt="'
1135                                        . $streditcalculation.'" title="'.$streditcalculation.'" /></a>'. "\n";
1136             }
1137         }
1139         return $calculation_icon;
1140     }
1143 /**
1144  * Flat structure similar to grade tree.
1145  */
1146 class grade_seq extends grade_structure {
1148     /**
1149      * A string of GET URL variables, namely courseid and sesskey, used in most URLs built by this class.
1150      * @var string $commonvars
1151      */
1152     public $commonvars;
1154     /**
1155      * 1D array of elements
1156      */
1157     public $elements;
1159     /**
1160      * Constructor, retrieves and stores array of all grade_category and grade_item
1161      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1162      * @param int $courseid
1163      * @param boolean $category_grade_last category grade item is the last child
1164      * @param array $collapsed array of collapsed categories
1165      */
1166     public function grade_seq($courseid, $category_grade_last=false, $nooutcomes=false) {
1167         global $USER, $CFG;
1169         $this->courseid   = $courseid;
1170         $this->commonvars = "&amp;sesskey=".sesskey()."&amp;id=$this->courseid";
1171         $this->context    = get_context_instance(CONTEXT_COURSE, $courseid);
1173         // get course grade tree
1174         $top_element = grade_category::fetch_course_tree($courseid, true);
1176         $this->elements = grade_seq::flatten($top_element, $category_grade_last, $nooutcomes);
1178         foreach ($this->elements as $key=>$unused) {
1179             $this->items[$this->elements[$key]['object']->id] =& $this->elements[$key]['object'];
1180         }
1181     }
1183     /**
1184      * Static recursive helper - makes the grade_item for category the last children
1185      * @static
1186      * @param array $element The seed of the recursion
1187      * @return void
1188      */
1189     public function flatten(&$element, $category_grade_last, $nooutcomes) {
1190         if (empty($element['children'])) {
1191             return array();
1192         }
1193         $children = array();
1195         foreach ($element['children'] as $sortorder=>$unused) {
1196             if ($nooutcomes and $element['type'] != 'category' and $element['children'][$sortorder]['object']->is_outcome_item()) {
1197                 continue;
1198             }
1199             $children[] = $element['children'][$sortorder];
1200         }
1201         unset($element['children']);
1203         if ($category_grade_last and count($children) > 1) {
1204             $cat_item = array_shift($children);
1205             array_push($children, $cat_item);
1206         }
1208         $result = array();
1209         foreach ($children as $child) {
1210             if ($child['type'] == 'category') {
1211                 $result = $result + grade_seq::flatten($child, $category_grade_last, $nooutcomes);
1212             } else {
1213                 $child['eid'] = 'i'.$child['object']->id;
1214                 $result[$child['object']->id] = $child;
1215             }
1216         }
1218         return $result;
1219     }
1221     /**
1222      * Parses the array in search of a given eid and returns a element object with
1223      * information about the element it has found.
1224      * @param int $eid
1225      * @return object element
1226      */
1227     public function locate_element($eid) {
1228         // it is a grade - construct a new object
1229         if (strpos($eid, 'n') === 0) {
1230             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1231                 return null;
1232             }
1234             $itemid = $matches[1];
1235             $userid = $matches[2];
1237             //extra security check - the grade item must be in this tree
1238             if (!$item_el = $this->locate_element('i'.$itemid)) {
1239                 return null;
1240             }
1242             // $gradea->id may be null - means does not exist yet
1243             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
1245             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1246             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
1248         } else if (strpos($eid, 'g') === 0) {
1249             $id = (int)substr($eid, 1);
1250             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
1251                 return null;
1252             }
1253             //extra security check - the grade item must be in this tree
1254             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
1255                 return null;
1256             }
1257             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1258             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
1259         }
1261         // it is a category or item
1262         foreach ($this->elements as $element) {
1263             if ($element['eid'] == $eid) {
1264                 return $element;
1265             }
1266         }
1268         return null;
1269     }
1272 /**
1273  * This class represents a complete tree of categories, grade_items and final grades,
1274  * organises as an array primarily, but which can also be converted to other formats.
1275  * It has simple method calls with complex implementations, allowing for easy insertion,
1276  * deletion and moving of items and categories within the tree.
1277  */
1278 class grade_tree extends grade_structure {
1280     /**
1281      * The basic representation of the tree as a hierarchical, 3-tiered array.
1282      * @var object $top_element
1283      */
1284     public $top_element;
1286     /**
1287      * A string of GET URL variables, namely courseid and sesskey, used in most URLs built by this class.
1288      * @var string $commonvars
1289      */
1290     public $commonvars;
1292     /**
1293      * 2D array of grade items and categories
1294      */
1295     public $levels;
1297     /**
1298      * Grade items
1299      */
1300     public $items;
1302     /**
1303      * Constructor, retrieves and stores a hierarchical array of all grade_category and grade_item
1304      * objects for the given courseid. Full objects are instantiated. Ordering sequence is fixed if needed.
1305      * @param int $courseid
1306      * @param boolean $fillers include fillers and colspans, make the levels var "rectangular"
1307      * @param boolean $category_grade_last category grade item is the last child
1308      * @param array $collapsed array of collapsed categories
1309      */
1310     public function grade_tree($courseid, $fillers=true, $category_grade_last=false, $collapsed=null, $nooutcomes=false) {
1311         global $USER, $CFG;
1313         $this->courseid   = $courseid;
1314         $this->commonvars = "&amp;sesskey=".sesskey()."&amp;id=$this->courseid";
1315         $this->levels     = array();
1316         $this->context    = get_context_instance(CONTEXT_COURSE, $courseid);
1318         // get course grade tree
1319         $this->top_element = grade_category::fetch_course_tree($courseid, true);
1321         // collapse the categories if requested
1322         if (!empty($collapsed)) {
1323             grade_tree::category_collapse($this->top_element, $collapsed);
1324         }
1326         // no otucomes if requested
1327         if (!empty($nooutcomes)) {
1328             grade_tree::no_outcomes($this->top_element);
1329         }
1331         // move category item to last position in category
1332         if ($category_grade_last) {
1333             grade_tree::category_grade_last($this->top_element);
1334         }
1336         if ($fillers) {
1337             // inject fake categories == fillers
1338             grade_tree::inject_fillers($this->top_element, 0);
1339             // add colspans to categories and fillers
1340             grade_tree::inject_colspans($this->top_element);
1341         }
1343         grade_tree::fill_levels($this->levels, $this->top_element, 0);
1345     }
1347     /**
1348      * Static recursive helper - removes items from collapsed categories
1349      * @static
1350      * @param array $element The seed of the recursion
1351      * @param array $collapsed array of collapsed categories
1352      * @return void
1353      */
1354     public function category_collapse(&$element, $collapsed) {
1355         if ($element['type'] != 'category') {
1356             return;
1357         }
1358         if (empty($element['children']) or count($element['children']) < 2) {
1359             return;
1360         }
1362         if (in_array($element['object']->id, $collapsed['aggregatesonly'])) {
1363             $category_item = reset($element['children']); //keep only category item
1364             $element['children'] = array(key($element['children'])=>$category_item);
1366         } else {
1367             if (in_array($element['object']->id, $collapsed['gradesonly'])) { // Remove category item
1368                 reset($element['children']);
1369                 $first_key = key($element['children']);
1370                 unset($element['children'][$first_key]);
1371             }
1372             foreach ($element['children'] as $sortorder=>$child) { // Recurse through the element's children
1373                 grade_tree::category_collapse($element['children'][$sortorder], $collapsed);
1374             }
1375         }
1376     }
1378     /**
1379      * Static recursive helper - removes all outcomes
1380      * @static
1381      * @param array $element The seed of the recursion
1382      * @return void
1383      */
1384     public function no_outcomes(&$element) {
1385         if ($element['type'] != 'category') {
1386             return;
1387         }
1388         foreach ($element['children'] as $sortorder=>$child) {
1389             if ($element['children'][$sortorder]['type'] == 'item'
1390               and $element['children'][$sortorder]['object']->is_outcome_item()) {
1391                 unset($element['children'][$sortorder]);
1393             } else if ($element['children'][$sortorder]['type'] == 'category') {
1394                 grade_tree::no_outcomes($element['children'][$sortorder]);
1395             }
1396         }
1397     }
1399     /**
1400      * Static recursive helper - makes the grade_item for category the last children
1401      * @static
1402      * @param array $element The seed of the recursion
1403      * @return void
1404      */
1405     public function category_grade_last(&$element) {
1406         if (empty($element['children'])) {
1407             return;
1408         }
1409         if (count($element['children']) < 2) {
1410             return;
1411         }
1412         $first_item = reset($element['children']);
1413         if ($first_item['type'] == 'categoryitem' or $first_item['type'] == 'courseitem') {
1414             // the category item might have been already removed
1415             $order = key($element['children']);
1416             unset($element['children'][$order]);
1417             $element['children'][$order] =& $first_item;
1418         }
1419         foreach ($element['children'] as $sortorder => $child) {
1420             grade_tree::category_grade_last($element['children'][$sortorder]);
1421         }
1422     }
1424     /**
1425      * Static recursive helper - fills the levels array, useful when accessing tree elements of one level
1426      * @static
1427      * @param int $levels
1428      * @param array $element The seed of the recursion
1429      * @param int $depth
1430      * @return void
1431      */
1432     public function fill_levels(&$levels, &$element, $depth) {
1433         if (!array_key_exists($depth, $levels)) {
1434             $levels[$depth] = array();
1435         }
1437         // prepare unique identifier
1438         if ($element['type'] == 'category') {
1439             $element['eid'] = 'c'.$element['object']->id;
1440         } else if (in_array($element['type'], array('item', 'courseitem', 'categoryitem'))) {
1441             $element['eid'] = 'i'.$element['object']->id;
1442             $this->items[$element['object']->id] =& $element['object'];
1443         }
1445         $levels[$depth][] =& $element;
1446         $depth++;
1447         if (empty($element['children'])) {
1448             return;
1449         }
1450         $prev = 0;
1451         foreach ($element['children'] as $sortorder=>$child) {
1452             grade_tree::fill_levels($levels, $element['children'][$sortorder], $depth);
1453             $element['children'][$sortorder]['prev'] = $prev;
1454             $element['children'][$sortorder]['next'] = 0;
1455             if ($prev) {
1456                 $element['children'][$prev]['next'] = $sortorder;
1457             }
1458             $prev = $sortorder;
1459         }
1460     }
1462     /**
1463      * Static recursive helper - makes full tree (all leafes are at the same level)
1464      */
1465     public function inject_fillers(&$element, $depth) {
1466         $depth++;
1468         if (empty($element['children'])) {
1469             return $depth;
1470         }
1471         $chdepths = array();
1472         $chids = array_keys($element['children']);
1473         $last_child  = end($chids);
1474         $first_child = reset($chids);
1476         foreach ($chids as $chid) {
1477             $chdepths[$chid] = grade_tree::inject_fillers($element['children'][$chid], $depth);
1478         }
1479         arsort($chdepths);
1481         $maxdepth = reset($chdepths);
1482         foreach ($chdepths as $chid=>$chd) {
1483             if ($chd == $maxdepth) {
1484                 continue;
1485             }
1486             for ($i=0; $i < $maxdepth-$chd; $i++) {
1487                 if ($chid == $first_child) {
1488                     $type = 'fillerfirst';
1489                 } else if ($chid == $last_child) {
1490                     $type = 'fillerlast';
1491                 } else {
1492                     $type = 'filler';
1493                 }
1494                 $oldchild =& $element['children'][$chid];
1495                 $element['children'][$chid] = array('object'=>'filler', 'type'=>$type, 'eid'=>'', 'depth'=>$element['object']->depth,'children'=>array($oldchild));
1496             }
1497         }
1499         return $maxdepth;
1500     }
1502     /**
1503      * Static recursive helper - add colspan information into categories
1504      */
1505     public function inject_colspans(&$element) {
1506         if (empty($element['children'])) {
1507             return 1;
1508         }
1509         $count = 0;
1510         foreach ($element['children'] as $key=>$child) {
1511             $count += grade_tree::inject_colspans($element['children'][$key]);
1512         }
1513         $element['colspan'] = $count;
1514         return $count;
1515     }
1517     /**
1518      * Parses the array in search of a given eid and returns a element object with
1519      * information about the element it has found.
1520      * @param int $eid
1521      * @return object element
1522      */
1523     public function locate_element($eid) {
1524         // it is a grade - construct a new object
1525         if (strpos($eid, 'n') === 0) {
1526             if (!preg_match('/n(\d+)u(\d+)/', $eid, $matches)) {
1527                 return null;
1528             }
1530             $itemid = $matches[1];
1531             $userid = $matches[2];
1533             //extra security check - the grade item must be in this tree
1534             if (!$item_el = $this->locate_element('i'.$itemid)) {
1535                 return null;
1536             }
1538             // $gradea->id may be null - means does not exist yet
1539             $grade = new grade_grade(array('itemid'=>$itemid, 'userid'=>$userid));
1541             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1542             return array('eid'=>'n'.$itemid.'u'.$userid,'object'=>$grade, 'type'=>'grade');
1544         } else if (strpos($eid, 'g') === 0) {
1545             $id = (int)substr($eid, 1);
1546             if (!$grade = grade_grade::fetch(array('id'=>$id))) {
1547                 return null;
1548             }
1549             //extra security check - the grade item must be in this tree
1550             if (!$item_el = $this->locate_element('i'.$grade->itemid)) {
1551                 return null;
1552             }
1553             $grade->grade_item =& $item_el['object']; // this may speedup grade_grade methods!
1554             return array('eid'=>'g'.$id,'object'=>$grade, 'type'=>'grade');
1555         }
1557         // it is a category or item
1558         foreach ($this->levels as $row) {
1559             foreach ($row as $element) {
1560                 if ($element['type'] == 'filler') {
1561                     continue;
1562                 }
1563                 if ($element['eid'] == $eid) {
1564                     return $element;
1565                 }
1566             }
1567         }
1569         return null;
1570     }
1572     /**
1573      * Returns a well-formed XML representation of the grade-tree using recursion.
1574      * @param array $root The current element in the recursion. If null, starts at the top of the tree.
1575      * @return string $xml
1576      */
1577     public function exportToXML($root=null, $tabs="\t") {
1578         $xml = null;
1579         $first = false;
1580         if (is_null($root)) {
1581             $root = $this->top_element;
1582             $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
1583             $xml .= "<gradetree>\n";
1584             $first = true;
1585         }
1587         $type = 'undefined';
1588         if (strpos($root['object']->table, 'grade_categories') !== false) {
1589             $type = 'category';
1590         } elseif (strpos($root['object']->table, 'grade_items') !== false) {
1591             $type = 'item';
1592         } elseif (strpos($root['object']->table, 'grade_outcomes') !== false) {
1593             $type = 'outcome';
1594         }
1596         $xml .= "$tabs<element type=\"$type\">\n";
1597         foreach ($root['object'] as $var => $value) {
1598             if (!is_object($value) && !is_array($value) && !empty($value)) {
1599                 $xml .= "$tabs\t<$var>$value</$var>\n";
1600             }
1601         }
1603         if (!empty($root['children'])) {
1604             $xml .= "$tabs\t<children>\n";
1605             foreach ($root['children'] as $sortorder => $child) {
1606                 $xml .= $this->exportToXML($child, $tabs."\t\t");
1607             }
1608             $xml .= "$tabs\t</children>\n";
1609         }
1611         $xml .= "$tabs</element>\n";
1613         if ($first) {
1614             $xml .= "</gradetree>";
1615         }
1617         return $xml;
1618     }
1620     /**
1621      * Returns a JSON representation of the grade-tree using recursion.
1622      * @param array $root The current element in the recursion. If null, starts at the top of the tree.
1623      * @param string $tabs Tab characters used to indent the string nicely for humans to enjoy
1624      * @param int    $switch The position (first or last) of the aggregations
1625      * @return string $xml
1626      */
1627     public function exportToJSON($root=null, $tabs="\t") {
1628         $json = null;
1629         $first = false;
1630         if (is_null($root)) {
1631             $root = $this->top_element;
1632             $first = true;
1633         }
1635         $name = '';
1638         if (strpos($root['object']->table, 'grade_categories') !== false) {
1639             $name = $root['object']->fullname;
1640             if ($name == '?') {
1641                 $name = $root['object']->get_name();
1642             }
1643         } elseif (strpos($root['object']->table, 'grade_items') !== false) {
1644             $name = $root['object']->itemname;
1645         } elseif (strpos($root['object']->table, 'grade_outcomes') !== false) {
1646             $name = $root['object']->itemname;
1647         }
1649         $json .= "$tabs {\n";
1650         $json .= "$tabs\t \"type\": \"{$root['type']}\",\n";
1651         $json .= "$tabs\t \"name\": \"$name\",\n";
1653         foreach ($root['object'] as $var => $value) {
1654             if (!is_object($value) && !is_array($value) && !empty($value)) {
1655                 $json .= "$tabs\t \"$var\": \"$value\",\n";
1656             }
1657         }
1659         $json = substr($json, 0, strrpos($json, ','));
1661         if (!empty($root['children'])) {
1662             $json .= ",\n$tabs\t\"children\": [\n";
1663             foreach ($root['children'] as $sortorder => $child) {
1664                 $json .= $this->exportToJSON($child, $tabs."\t\t");
1665             }
1666             $json = substr($json, 0, strrpos($json, ','));
1667             $json .= "\n$tabs\t]\n";
1668         }
1670         if ($first) {
1671             $json .= "\n}";
1672         } else {
1673             $json .= "\n$tabs},\n";
1674         }
1676         return $json;
1677     }
1679     public function get_levels() {
1680         return $this->levels;
1681     }
1683     public function get_items() {
1684         return $this->items;
1685     }
1687     public function get_item($itemid) {
1688         if (array_key_exists($itemid, $this->items)) {
1689             return $this->items[$itemid];
1690         } else {
1691             return false;
1692         }
1693     }
1696 ?>