navigation MDL-22044 Course format can now choose the string that is used for section...
[moodle.git] / lib / navigationlib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file contains classes used to manage the navigation structures in Moodle
20  * and was introduced as part of the changes occuring in Moodle 2.0
21  *
22  * @since 2.0
23  * @package moodlecore
24  * @subpackage navigation
25  * @copyright 2009 Sam Hemelryk
26  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 if (!function_exists('get_all_sections')) {
30     /** Include course lib for its functions */
31     require_once($CFG->dirroot.'/course/lib.php');
32 }
34 /**
35  * The name that will be used to separate the navigation cache within SESSION
36  */
37 define('NAVIGATION_CACHE_NAME', 'navigation');
39 /**
40  * This class is used to represent a node in a navigation tree
41  *
42  * This class is used to represent a node in a navigation tree within Moodle,
43  * the tree could be one of global navigation, settings navigation, or the navbar.
44  * Each node can be one of two types either a Leaf (default) or a branch.
45  * When a node is first created it is created as a leaf, when/if children are added
46  * the node then becomes a branch.
47  *
48  * @package moodlecore
49  * @subpackage navigation
50  * @copyright 2009 Sam Hemelryk
51  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
52  */
53 class navigation_node implements renderable {
54     /** @var int Used to identify this node a leaf (default) 0 */
55     const NODETYPE_LEAF =   0;
56     /** @var int Used to identify this node a branch, happens with children  1 */
57     const NODETYPE_BRANCH = 1;
58     /** @var null Unknown node type null */
59     const TYPE_UNKNOWN =    null;
60     /** @var int System node type 0 */
61     const TYPE_ROOTNODE =   0;
62     /** @var int System node type 1 */
63     const TYPE_SYSTEM =     1;
64     /** @var int Category node type 10 */
65     const TYPE_CATEGORY =   10;
66     /** @var int Course node type 20 */
67     const TYPE_COURSE =     20;
68     /** @var int Course Structure node type 30 */
69     const TYPE_SECTION =    30;
70     /** @var int Activity node type, e.g. Forum, Quiz 40 */
71     const TYPE_ACTIVITY =   40;
72     /** @var int Resource node type, e.g. Link to a file, or label 50 */
73     const TYPE_RESOURCE =   50;
74     /** @var int A custom node type, default when adding without specifing type 60 */
75     const TYPE_CUSTOM =     60;
76     /** @var int Setting node type, used only within settings nav 70 */
77     const TYPE_SETTING =    70;
78     /** @var int Setting node type, used only within settings nav 80 */
79     const TYPE_USER =       80;
80     /** @var int Setting node type, used for containers of no importance 90 */
81     const TYPE_CONTAINER =  90;
83     /** @var int Parameter to aid the coder in tracking [optional] */
84     public $id = null;
85     /** @var string|int The identifier for the node, used to retrieve the node */
86     public $key = null;
87     /** @var string The text to use for the node */
88     public $text = null;
89     /** @var string Short text to use if requested [optional] */
90     public $shorttext = null;
91     /** @var string The title attribute for an action if one is defined */
92     public $title = null;
93     /** @var string A string that can be used to build a help button */
94     public $helpbutton = null;
95     /** @var moodle_url|action_link|null An action for the node (link) */
96     public $action = null;
97     /** @var pix_icon The path to an icon to use for this node */
98     public $icon = null;
99     /** @var int See TYPE_* constants defined for this class */
100     public $type = self::TYPE_UNKNOWN;
101     /** @var int See NODETYPE_* constants defined for this class */
102     public $nodetype = self::NODETYPE_LEAF;
103     /** @var bool If set to true the node will be collapsed by default */
104     public $collapse = false;
105     /** @var bool If set to true the node will be expanded by default */
106     public $forceopen = false;
107     /** @var array An array of CSS classes for the node */
108     public $classes = array();
109     /** @var navigation_node_collection An array of child nodes */
110     public $children = array();
111     /** @var bool If set to true the node will be recognised as active */
112     public $isactive = false;
113     /** @var bool If set to true the node will be dimmed */
114     public $hidden = false;
115     /** @var bool If set to false the node will not be displayed */
116     public $display = true;
117     /** @var bool If set to true then an HR will be printed before the node */
118     public $preceedwithhr = false;
119     /** @var bool If set to true the the navigation bar should ignore this node */
120     public $mainnavonly = false;
121     /** @var bool If set to true a title will be added to the action no matter what */
122     public $forcetitle = false;
123     /** @var navigation_node A reference to the node parent */
124     public $parent = null;
125     /** @var array */
126     protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting', 80=>'user');
127     /** @var moodle_url */
128     protected static $fullmeurl = null;
129     /** @var bool toogles auto matching of active node */
130     public static $autofindactive = true;
132     /**
133      * Constructs a new navigation_node
134      *
135      * @param array|string $properties Either an array of properties or a string to use
136      *                     as the text for the node
137      */
138     public function __construct($properties) {
139         if (is_array($properties)) {
140             // Check the array for each property that we allow to set at construction.
141             // text         - The main content for the node
142             // shorttext    - A short text if required for the node
143             // icon         - The icon to display for the node
144             // type         - The type of the node
145             // key          - The key to use to identify the node
146             // parent       - A reference to the nodes parent
147             // action       - The action to attribute to this node, usually a URL to link to
148             if (array_key_exists('text', $properties)) {
149                 $this->text = $properties['text'];
150             }
151             if (array_key_exists('shorttext', $properties)) {
152                 $this->shorttext = $properties['shorttext'];
153             }
154             if (array_key_exists('icon', $properties)) {
155                 $this->icon = $properties['icon'];
156                 if ($this->icon instanceof pix_icon) {
157                     if (empty($this->icon->attributes['class'])) {
158                         $this->icon->attributes['class'] = 'navicon';
159                     } else {
160                         $this->icon->attributes['class'] .= ' navicon';
161                     }
162                 }
163             }
164             if (array_key_exists('type', $properties)) {
165                 $this->type = $properties['type'];
166             } else {
167                 $this->type = self::TYPE_CUSTOM;
168             }
169             if (array_key_exists('key', $properties)) {
170                 $this->key = $properties['key'];
171             }
172             if (array_key_exists('parent', $properties)) {
173                 $this->parent = $properties['parent'];
174             }
175             // This needs to happen last because of the check_if_active call that occurs
176             if (array_key_exists('action', $properties)) {
177                 $this->action = $properties['action'];
178                 if (is_string($this->action)) {
179                     $this->action = new moodle_url($this->action);
180                 }
181                 if (self::$autofindactive) {
182                     $this->check_if_active();
183                 }
184             }
185         } else if (is_string($properties)) {
186             $this->text = $properties;
187         }
188         if ($this->text === null) {
189             throw new coding_exception('You must set the text for the node when you create it.');
190         }
191         // Default the title to the text
192         $this->title = $this->text;
193         // Instantiate a new navigation node collection for this nodes children
194         $this->children = new navigation_node_collection();
195     }
197     /**
198      * Checks if this node is the active node.
199      *
200      * This is determined by comparing the action for the node against the
201      * defined URL for the page. A match will see this node marked as active.
202      *
203      * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
204      * @return bool
205      */
206     public function check_if_active($strength=URL_MATCH_EXACT) {
207         global $FULLME, $PAGE;
208         // Set fullmeurl if it hasn't already been set
209         if (self::$fullmeurl == null) {
210             if ($PAGE->has_set_url()) {
211                 self::override_active_url(new moodle_url($PAGE->url));
212             } else {
213                 self::override_active_url(new moodle_url($FULLME));
214             }
215         }
217         // Compare the action of this node against the fullmeurl
218         if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
219             $this->make_active();
220             return true;
221         }
222         return false;
223     }
225     /**
226      * Overrides the fullmeurl variable providing
227      *
228      * @param moodle_url $url The url to use for the fullmeurl.
229      */
230     public static function override_active_url(moodle_url $url) {
231         self::$fullmeurl = $url;
232     }
234     /**
235      * Adds a navigation node as a child of this node.
236      * 
237      * @param string $text
238      * @param moodle_url|action_link $action
239      * @param int $type
240      * @param string $shorttext
241      * @param string|int $key
242      * @param pix_icon $icon
243      * @return navigation_node
244      */
245     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
246         // First convert the nodetype for this node to a branch as it will now have children
247         if ($this->nodetype !== self::NODETYPE_BRANCH) {
248             $this->nodetype = self::NODETYPE_BRANCH;
249         }
250         // Properties array used when creating the new navigation node
251         $itemarray = array(
252             'text' => $text,
253             'type' => $type
254         );
255         // Set the action if one was provided
256         if ($action!==null) {
257             $itemarray['action'] = $action;
258         }
259         // Set the shorttext if one was provided
260         if ($shorttext!==null) {
261             $itemarray['shorttext'] = $shorttext;
262         }
263         // Set the icon if one was provided
264         if ($icon!==null) {
265             $itemarray['icon'] = $icon;
266         }
267         // Default the key to the number of children if not provided
268         if ($key === null) {
269             $key = $this->children->count();
270         }
271         // Set the key
272         $itemarray['key'] = $key;
273         // Set the parent to this node
274         $itemarray['parent'] = $this;
275         // Add the child using the navigation_node_collections add method
276         $node = $this->children->add(new navigation_node($itemarray));
277         // If the node is a category node or the user is logged in and its a course
278         // then mark this node as a branch (makes it expandable by AJAX)
279         if (($type==self::TYPE_CATEGORY) || (isloggedin() && $type==self::TYPE_COURSE)) {
280             $node->nodetype = self::NODETYPE_BRANCH;
281         }
282         // If this node is hidden mark it's children as hidden also
283         if ($this->hidden) {
284             $node->hidden = true;
285         }
286         // Return the node (reference returned by $this->children->add()
287         return $node;
288     }
290     /**
291      * Searches for a node of the given type with the given key.
292      *
293      * This searches this node plus all of its children, and their children....
294      * If you know the node you are looking for is a child of this node then please
295      * use the get method instead.
296      *
297      * @param int|string $key The key of the node we are looking for
298      * @param int $type One of navigation_node::TYPE_*
299      * @return navigation_node|false
300      */
301     public function find($key, $type) {
302         return $this->children->find($key, $type);
303     }
305     /**
306      * Get ths child of this node that has the given key + (optional) type.
307      *
308      * If you are looking for a node and want to search all children + thier children
309      * then please use the find method instead.
310      *
311      * @param int|string $key The key of the node we are looking for
312      * @param int $type One of navigation_node::TYPE_*
313      * @return navigation_node|false
314      */
315     public function get($key, $type=null) {
316         return $this->children->get($key, $type);
317     }
319     /**
320      * Removes this node.
321      *
322      * @return bool
323      */
324     public function remove() {
325         return $this->parent->children->remove($this->key, $this->type);
326     }
328     /**
329      * Checks if this node has or could have any children
330      *
331      * @return bool Returns true if it has children or could have (by AJAX expansion)
332      */
333     public function has_children() {
334         return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0);
335     }
337     /**
338      * Marks this node as active and forces it open.
339      */
340     public function make_active() {
341         $this->isactive = true;
342         $this->add_class('active_tree_node');
343         $this->force_open();
344         if ($this->parent !== null) {
345             $this->parent->make_inactive();
346         }
347     }
349     /**
350      * Marks a node as inactive and recusised back to the base of the tree
351      * doing the same to all parents.
352      */
353     public function make_inactive() {
354         $this->isactive = false;
355         $this->remove_class('active_tree_node');
356         if ($this->parent !== null) {
357             $this->parent->make_inactive();
358         }
359     }
361     /**
362      * Forces this node to be open and at the same time forces open all
363      * parents until the root node.
364      *
365      * Recursive.
366      */
367     public function force_open() {
368         $this->forceopen = true;
369         if ($this->parent !== null) {
370             $this->parent->force_open();
371         }
372     }
374     /**
375      * Adds a CSS class to this node.
376      *
377      * @param string $class
378      * @return bool
379      */
380     public function add_class($class) {
381         if (!in_array($class, $this->classes)) {
382             $this->classes[] = $class;
383         }
384         return true;
385     }
387     /**
388      * Removes a CSS class from this node.
389      *
390      * @param string $class
391      * @return bool True if the class was successfully removed.
392      */
393     public function remove_class($class) {
394         if (in_array($class, $this->classes)) {
395             $key = array_search($class,$this->classes);
396             if ($key!==false) {
397                 unset($this->classes[$key]);
398                 return true;
399             }
400         }
401         return false;
402     }
404     /**
405      * Sets the title for this node and forces Moodle to utilise it.
406      * @param string $title
407      */
408     public function title($title) {
409         $this->title = $title;
410         $this->forcetitle = true;
411     }
413     /**
414      * Resets the page specific information on this node if it is being unserialised.
415      */
416     public function __wakeup(){
417         $this->forceopen = false;
418         $this->isactive = false;
419         $this->remove_class('active_tree_node');
420     }
422     /**
423      * Checks if this node or any of its children contain the active node.
424      * 
425      * Recursive.
426      *
427      * @return bool
428      */
429     public function contains_active_node() {
430         if ($this->isactive) {
431             return true;
432         } else {
433             foreach ($this->children as $child) {
434                 if ($child->isactive || $child->contains_active_node()) {
435                     return true;
436                 }
437             }
438         }
439         return false;
440     }
442     /**
443      * Finds the active node.
444      *
445      * Searches this nodes children plus all of the children for the active node
446      * and returns it if found.
447      *
448      * Recursive.
449      *
450      * @return navigation_node|false
451      */
452     public function find_active_node() {
453         if ($this->isactive) {
454             return $this;
455         } else {
456             foreach ($this->children as &$child) {
457                 $outcome = $child->find_active_node();
458                 if ($outcome !== false) {
459                     return $outcome;
460                 }
461             }
462         }
463         return false;
464     }
466     /**
467      * Gets the content for this node.
468      *
469      * @param bool $shorttext If true shorttext is used rather than the normal text
470      * @return string
471      */
472     public function get_content($shorttext=false) {
473         if ($shorttext && $this->shorttext!==null) {
474             return format_string($this->shorttext);
475         } else {
476             return format_string($this->text);
477         }
478     }
480     /**
481      * Gets the title to use for this node.
482      * 
483      * @return string
484      */
485     public function get_title() {
486         if ($this->forcetitle || ($this->shorttext!==null && $this->title !== $this->shorttext) || $this->title !== $this->text) {
487             return $this->title;
488         } else {
489             return '';
490         }
491     }
493     /**
494      * Gets the CSS class to add to this node to describe its type
495      * 
496      * @return string
497      */
498     public function get_css_type() {
499         if (array_key_exists($this->type, $this->namedtypes)) {
500             return 'type_'.$this->namedtypes[$this->type];
501         }
502         return 'type_unknown';
503     }
505     /**
506      * Finds all nodes that are expandable by AJAX
507      *
508      * @param array $expandable An array by reference to populate with expandable nodes.
509      */
510     public function find_expandable(array &$expandable) {
511         if (!isloggedin()) {
512             return;
513         }
514         foreach ($this->children as &$child) {
515             if ($child->nodetype == self::NODETYPE_BRANCH && $child->children->count()==0 && $child->display) {
516                 $child->id = 'expandable_branch_'.(count($expandable)+1);
517                 $this->add_class('canexpand');
518                 $expandable[] = array('id'=>$child->id,'branchid'=>$child->key,'type'=>$child->type);
519             }
520             $child->find_expandable($expandable);
521         }
522     }
524     public function find_all_of_type($type) {
525         $nodes = $this->children->type($type);
526         foreach ($this->children as &$node) {
527             $childnodes = $node->find_all_of_type($type);
528             $nodes = array_merge($nodes, $childnodes);
529         }
530         return $nodes;
531     }
534 /**
535  * Navigation node collection
536  *
537  * This class is responsible for managing a collection of navigation nodes.
538  * It is required because a node's unique identifier is a combination of both its
539  * key and its type.
540  *
541  * Originally an array was used with a string key that was a combination of the two
542  * however it was decided that a better solution would be to use a class that
543  * implements the standard IteratorAggregate interface.
544  *
545  * @package moodlecore
546  * @subpackage navigation
547  * @copyright 2010 Sam Hemelryk
548  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
549  */
550 class navigation_node_collection implements IteratorAggregate {
551     /**
552      * A multidimensional array to where the first key is the type and the second
553      * key is the nodes key.
554      * @var array
555      */
556     protected $collection = array();
557     /**
558      * An array that contains references to nodes in the same order they were added.
559      * This is maintained as a progressive array.
560      * @var array
561      */
562     protected $orderedcollection = array();
563     /**
564      * A reference to the last node that was added to the collection
565      * @var navigation_node
566      */
567     protected $last = null;
568     /**
569      * The total number of items added to this array.
570      * @var int
571      */
572     protected $count = 0;
573     /**
574      * Adds a navigation node to the collection
575      *
576      * @param navigation_node $node
577      * @return navigation_node
578      */
579     public function add(navigation_node $node) {
580         global $CFG;
581         $key = $node->key;
582         $type = $node->type;
583         // First check we have a 2nd dimension for this type
584         if (!array_key_exists($type, $this->orderedcollection)) {
585             $this->orderedcollection[$type] = array();
586         }
587         // Check for a collision and report if debugging is turned on
588         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
589             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
590         }
591         // Add the node to the appropriate place in the ordered structure.
592         $this->orderedcollection[$type][$key] = $node;
593         // Add a reference to the node to the progressive collection.
594         $this->collection[$this->count] = &$this->orderedcollection[$type][$key];
595         // Update the last property to a reference to this new node.
596         $this->last = &$this->orderedcollection[$type][$key];
597         $this->count++;
598         // Return the reference to the now added node
599         return $this->last;
600     }
602     /**
603      * Fetches a node from this collection.
604      *
605      * @param string|int $key The key of the node we want to find.
606      * @param int $type One of navigation_node::TYPE_*.
607      * @return navigation_node|null
608      */
609     public function get($key, $type=null) {
610         if ($type !== null) {
611             // If the type is known then we can simply check and fetch
612             if (!empty($this->orderedcollection[$type][$key])) {
613                 return $this->orderedcollection[$type][$key];
614             }
615         } else {
616             // Because we don't know the type we look in the progressive array
617             foreach ($this->collection as $node) {
618                 if ($node->key === $key) {
619                     return $node;
620                 }
621             }
622         }
623         return false;
624     }
625     /**
626      * Searches for a node with matching key and type.
627      *
628      * This function searches both the nodes in this collection and all of
629      * the nodes in each collection belonging to the nodes in this collection.
630      *
631      * Recursive.
632      *
633      * @param string|int $key  The key of the node we want to find.
634      * @param int $type  One of navigation_node::TYPE_*.
635      * @return navigation_node|null
636      */
637     public function find($key, $type=null) {
638         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
639             return $this->orderedcollection[$type][$key];
640         } else {
641             $nodes = $this->getIterator();
642             // Search immediate children first
643             foreach ($nodes as &$node) {
644                 if ($node->key == $key && ($type == null || $type === $node->type)) {
645                     return $node;
646                 }
647             }
648             // Now search each childs children
649             foreach ($nodes as &$node) {
650                 $result = $node->children->find($key, $type);
651                 if ($result !== false) {
652                     return $result;
653                 }
654             }
655         }
656         return false;
657     }
659     /**
660      * Fetches the last node that was added to this collection
661      * 
662      * @return navigation_node
663      */
664     public function last() {
665         return $this->last;
666     }
667     /**
668      * Fetches all nodes of a given type from this collection
669      */
670     public function type($type) {
671         if (!array_key_exists($type, $this->orderedcollection)) {
672             $this->orderedcollection[$type] = array();
673         }
674         return $this->orderedcollection[$type];
675     }
676     /**
677      * Removes the node with the given key and type from the collection
678      *
679      * @param string|int $key
680      * @param int $type
681      * @return bool
682      */
683     public function remove($key, $type=null) {
684         $child = $this->get($key, $type);
685         if ($child !== false) {
686             foreach ($this->collection as $colkey => $node) {
687                 if ($node->key == $key && $node->type == $type) {
688                     unset($this->collection[$colkey]);
689                     break;
690                 }
691             }
692             unset($this->orderedcollection[$child->type][$child->key]);
693             $this->count--;
694             return true;
695         }
696         return false;
697     }
699     /**
700      * Gets the number of nodes in this collection
701      * @return int
702      */
703     public function count() {
704         return count($this->collection);
705     }
706     /**
707      * Gets an array iterator for the collection.
708      *
709      * This is required by the IteratorAggregator interface and is used by routines
710      * such as the foreach loop.
711      *
712      * @return ArrayIterator
713      */
714     public function getIterator() {
715         return new ArrayIterator($this->collection);
716     }
719 /**
720  * The global navigation class used for... the global navigation
721  *
722  * This class is used by PAGE to store the global navigation for the site
723  * and is then used by the settings nav and navbar to save on processing and DB calls
724  *
725  * See
726  * <ul>
727  * <li><b>{@link lib/pagelib.php}</b> {@link moodle_page::initialise_theme_and_output()}<li>
728  * <li><b>{@link lib/ajax/getnavbranch.php}</b> Called by ajax<li>
729  * </ul>
730  *
731  * @package moodlecore
732  * @subpackage navigation
733  * @copyright 2009 Sam Hemelryk
734  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
735  */
736 class global_navigation extends navigation_node {
737     /**
738      * The Moodle page this navigation object belongs to.
739      * @var moodle_page
740      */
741     protected $page;
742     /** @var bool */
743     protected $initialised = false;
744     /** @var array */
745     protected $mycourses = array();
746     /** @var array */
747     protected $rootnodes = array();
748     /** @var bool */
749     protected $showemptysections = false;
750     /** @var array */
751     protected $extendforuser = array();
752     /** @var navigation_cache */
753     protected $cache;
754     /** @var array */
755     protected $addedcourses = array();
756     /** @var int */
757     protected $expansionlimit = 0;
759     /**
760      * Constructs a new global navigation
761      *
762      * @param moodle_page $page The page this navigation object belongs to
763      */
764     public function __construct(moodle_page $page) {
765         global $SITE, $USER;
767         if (during_initial_install()) {
768             return;
769         }
771         // Use the parents consturctor.... good good reuse
772         $properties = array(
773             'key' => 'home',
774             'type' => navigation_node::TYPE_SYSTEM,
775             'text' => get_string('myhome'),
776             'action' => new moodle_url('/my/')
777         );
778         parent::__construct($properties);
780         // Initalise and set defaults
781         $this->page = $page;
782         $this->forceopen = true;
783         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
785         // Check if we need to clear the cache
786         $regenerate = optional_param('regenerate', null, PARAM_TEXT);
787         if ($regenerate === 'navigation') {
788             $this->cache->clear();
789         }
790     }
792     /**
793      * Initialises the navigation object.
794      *
795      * This causes the navigation object to look at the current state of the page
796      * that it is associated with and then load the appropriate content.
797      *
798      * This should only occur the first time that the navigation structure is utilised
799      * which will normally be either when the navbar is called to be displayed or
800      * when a block makes use of it.
801      *
802      * @return bool
803      */
804     public function initialise() {
805         global $SITE, $USER;
806         // Check if it has alread been initialised
807         if ($this->initialised || during_initial_install()) {
808             return true;
809         }
811         // Set up the five base root nodes. These are nodes where we will put our
812         // content and are as follows:
813         // site:        Navigation for the front page.
814         // myprofile:     User profile information goes here.
815         // mycourses:   The users courses get added here.
816         // courses:     Additional courses are added here.
817         // users:       Other users information loaded here.
818         $this->rootnodes = array();
819         $this->rootnodes['site']      = $this->add_course($SITE);
820         $this->rootnodes['myprofile']   = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
821         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses');
822         $this->rootnodes['courses']   = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
823         $this->rootnodes['users']     = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
825         // Fetch all of the users courses.
826         $this->mycourses = get_my_courses($USER->id);
827         // Check if any courses were returned.
828         if (count($this->mycourses) > 0) {
829             // Add all of the users courses to the navigation
830             foreach ($this->mycourses as &$course) {
831               $course->coursenode = $this->add_course($course);
832             }
833         } else {
834             // The user had no specific courses! they could be no logged in, guest
835             // or admin so load all courses instead.
836             $this->load_all_courses();
837         }
839         // Next load context specific content into the navigation
840         switch ($this->page->context->contextlevel) {
841             case CONTEXT_SYSTEM :
842             case CONTEXT_COURSECAT :
843                 // Load the front page course navigation
844                 $this->load_course($SITE);
845                 break;
846             case CONTEXT_BLOCK :
847             case CONTEXT_COURSE :
848                 // Load the course associated with the page into the navigation
849                 $course = $this->page->course;
850                 $coursenode = $this->load_course($course);
851                 // Make it active
852                 $coursenode->make_active();
853                 // Add the essentials such as reports etc...
854                 $this->add_course_essentials($coursenode, $course);
855                 if ($this->format_display_course_content($course->format)) {
856                     // Load the course sections
857                     $sections = $this->load_course_sections($course, $coursenode);
858                 }
859                 break;
860             case CONTEXT_MODULE :
861                 $course = $this->page->course;
862                 $cm = $this->page->cm;
863                 // Load the course associated with the page into the navigation
864                 $coursenode = $this->load_course($course);
865                 $this->add_course_essentials($coursenode, $course);
866                 // Load the course sections into the page
867                 $sections = $this->load_course_sections($course, $coursenode);
868                 if ($course->id !== SITEID) {
869                     // Find the section for the $CM associated with the page and collect
870                     // its section number.
871                     foreach ($sections as $section) {
872                         if ($section->id == $cm->section) {
873                             $cm->sectionnumber = $section->section;
874                             break;
875                         }
876                     }
878                     // Load all of the section activities for the section the cm belongs to.
879                     $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course));
880                     // Finally load the cm specific navigaton information
881                 } else {
882                     $activities = array();
883                     $activities[$cm->id] = $coursenode->get($cm->id, navigation_node::TYPE_ACTIVITY);
884                 }
885                 $this->load_activity($cm, $course, $activities[$cm->id]);
886                 // And make the activity node active.
887                 $activities[$cm->id]->make_active();
888                 break;
889             case CONTEXT_USER :
890                 $course = $this->page->course;
891                 if ($course->id != SITEID) {
892                     // Load the course associated with the user into the navigation
893                     $coursenode = $this->load_course($course);
894                     $this->add_course_essentials($coursenode, $course);
895                     $sections = $this->load_course_sections($course, $coursenode);
896                 }
897                 break;
898         }
900         // Load for the current user
901         $this->load_for_user();
902         // Load each extending user into the navigation.
903         foreach ($this->extendforuser as $user) {
904             if ($user->id !== $USER->id) {
905                 $this->load_for_user($user);
906             }
907         }
909         // Remove any empty root nodes
910         foreach ($this->rootnodes as $node) {
911             if (!$node->has_children()) {
912                 $node->remove();
913             }
914         }
916         // If the user is not logged in modify the navigation structure as detailed
917         // in {@link http://docs.moodle.org/en/Development:Navigation_2.0_structure}
918         if (!isloggedin()) {
919             $activities = clone($this->rootnodes['site']->children);
920             $this->rootnodes['site']->remove();
921             $children = clone($this->children);
922             $this->children = new navigation_node_collection();
923             foreach ($activities as $child) {
924                 $this->children->add($child);
925             }
926             foreach ($children as $child) {
927                 $this->children->add($child);
928             }
929             $this->action = new moodle_url('/');
930         }
932         $this->initialised = true;
933         return true;
934     }
935     /**
936      * Checks the course format to see whether it wants the navigation to load
937      * additional information for the course.
938      *
939      * This function utilises a callback that can exist within the course format lib.php file
940      * The callback should be a function called:
941      * callback_{formatname}_display_content()
942      * It doesn't get any arguments and should return true if additional content is
943      * desired. If the callback doesn't exist we assume additional content is wanted.
944      *
945      * @param string $format The course format
946      * @return bool
947      */
948     protected function format_display_course_content($format) {
949         global $CFG;
950         $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
951         if (file_exists($formatlib)) {
952             require_once($formatlib);
953             $displayfunc = 'callback_'.$format.'_display_content';
954             if (function_exists($displayfunc) && !$displayfunc()) {
955                 return $displayfunc();
956             }
957         }
958         return true;
959     }
961     /**
962      * Loads of the the courses in Moodle into the navigation.
963      *
964      * @return array An array of navigation_node
965      */
966     protected function load_all_courses() {
967         global $DB, $USER;
968         list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
969         $sql = "SELECT c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.category,cat.path AS categorypath $ccselect
970                 FROM {course} c
971                 $ccjoin
972                 LEFT JOIN {course_categories} cat ON cat.id=c.category
973                 WHERE c.id != :siteid
974                 ORDER BY c.sortorder ASC";
975         $courses = $DB->get_records_sql($sql, array('siteid'=>SITEID));
976         $coursenodes = array();
977         foreach ($courses as $course) {
978             context_instance_preload($course);
979             $coursenodes[$course->id] = $this->add_course($course);
980         }
981         return $coursenodes;
982     }
984     /**
985      * Loads the given course into the navigation
986      *
987      * @param stdClass $course
988      * @return navigation_node
989      */
990     protected function load_course(stdClass $course) {
991         if ($course->id == SITEID) {
992             $coursenode = $this->rootnodes['site'];
993         } else if (array_key_exists($course->id, $this->mycourses)) {
994             if (!isset($this->mycourses[$course->id]->coursenode)) {
995                 $this->mycourses[$course->id]->coursenode = $this->add_course($course);
996             }
997             $coursenode = $this->mycourses[$course->id]->coursenode;
998         } else {
999             $coursenode = $this->add_course($course);
1000         }
1001         return $coursenode;
1002     }
1004     /**
1005      * Loads all of the courses section into the navigation.
1006      *
1007      * This function utilisies a callback that can be implemented within the course
1008      * formats lib.php file to customise the navigation that is generated at this
1009      * point for the course.
1010      *
1011      * By default (if not defined) the method {@see load_generic_course_sections} is
1012      * called instead.
1013      *
1014      * @param stdClass $course Database record for the course
1015      * @param navigation_node $coursenode The course node within the navigation
1016      * @return array Array of navigation nodes for the section with key = section id
1017      */
1018     protected function load_course_sections(stdClass $course, navigation_node $coursenode) {
1019         global $CFG;
1020         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
1021         $structurefunc = 'callback_'.$course->format.'_load_content';
1022         if (function_exists($structurefunc)) {
1023             return $structurefunc($this, $course, $coursenode);
1024         } else if (file_exists($structurefile)) {
1025             require_once $structurefile;
1026             if (function_exists($structurefunc)) {
1027                 return $structurefunc($this, $course, $coursenode);
1028             } else {
1029                 return $this->load_generic_course_sections($course, $coursenode, get_string('topic'), 'topic');
1030             }
1031         } else {
1032             return $this->load_generic_course_sections($course, $coursenode, get_string('topic'), 'topic');
1033         }
1034     }
1036     /**
1037      * Generically loads the course sections into the course's navigation.
1038      *
1039      * @param stdClass $course
1040      * @param navigation_node $coursenode
1041      * @param string $name The string that identifies each section. e.g Topic, or Week
1042      * @param string $activeparam The url used to identify the active section
1043      * @return array An array of course section nodes
1044      */
1045     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $name, $activeparam, $section0name=null) {
1046         $modinfo = get_fast_modinfo($course);
1047         $sections = array_slice(get_all_sections($course->id), 0, $course->numsections+1, true);
1048         $viewhiddensections = has_capability('moodle/course:viewhiddensections', $this->page->context);
1050         if ($section0name === null) {
1051             $section0name = get_string('general');
1052         }
1053         foreach ($sections as &$section) {
1054             if ($course->id == SITEID) {
1055                 $this->load_section_activities($coursenode, $section->section, $modinfo);
1056             } else {
1057                 if ((!$viewhiddensections && !$section->visible) || (!$this->showemptysections && !array_key_exists($section->section, $modinfo->sections))) {
1058                     continue;
1059                 }
1060                 if ($section->section == 0) {
1061                     $sectionname = $section0name;
1062                 } else {
1063                     $sectionname = $name.' '.$section->section;
1064                 }
1065                 $url = new moodle_url('/course/view.php', array('id'=>$course->id, $activeparam=>$section->section));
1066                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1067                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1068                 $sectionnode->hidden = (!$section->visible);
1069                 if ($sectionnode->isactive) {
1070                     $this->load_section_activities($sectionnode, $section->section, $modinfo);
1071                 }
1072                 $section->sectionnode = $sectionnode;
1073             }
1074         }
1075         return $sections;
1076     }
1077     /**
1078      * Loads all of the activities for a section into the navigation structure.
1079      *
1080      * @param navigation_node $sectionnode
1081      * @param int $sectionnumber
1082      * @param stdClass $modinfo Object returned from {@see get_fast_modinfo()}
1083      * @return array Array of activity nodes
1084      */
1085     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, $modinfo) {
1086         if (!array_key_exists($sectionnumber, $modinfo->sections)) {
1087             return true;
1088         }
1090         $viewhiddenactivities = has_capability('moodle/course:viewhiddenactivities', $this->page->context);
1092         $activities = array();
1094         foreach ($modinfo->sections[$sectionnumber] as $cmid) {
1095             $cm = $modinfo->cms[$cmid];
1096             if (!$viewhiddenactivities && !$cm->visible) {
1097                 continue;
1098             }
1099             if ($cm->icon) {
1100                 $icon = new pix_icon($cm->icon, '', $cm->iconcomponent);
1101             } else {
1102                 $icon = new pix_icon('icon', '', $cm->modname);
1103             }
1104             $url = new moodle_url('/mod/'.$cm->modname.'/view.php', array('id'=>$cm->id));
1105             $activitynode = $sectionnode->add($cm->name, $url, navigation_node::TYPE_ACTIVITY, $cm->name, $cm->id, $icon);
1106             $activitynode->title(get_string('modulename', $cm->modname));
1107             $activitynode->hidden = (!$cm->visible);
1108             if ($this->module_extends_navigation($cm->modname)) {
1109                 $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
1110             }
1111             $activities[$cmid] = $activitynode;
1112         }
1114         return $activities;
1115     }
1116     /**
1117      * Loads the navigation structure for the given activity into the activities node.
1118      *
1119      * This method utilises a callback within the modules lib.php file to load the
1120      * content specific to activity given.
1121      *
1122      * The callback is a method: {modulename}_extend_navigation()
1123      * Examples:
1124      *  * {@see forum_extend_navigation()}
1125      *  * {@see workshop_extend_navigation()}
1126      *
1127      * @param stdClass $cm
1128      * @param stdClass $course
1129      * @param navigation_node $activity
1130      * @return bool
1131      */
1132     protected function load_activity(stdClass $cm, stdClass $course, navigation_node $activity) {
1133         global $CFG, $DB;
1135         $activity->make_active();
1136         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
1137         $function = $cm->modname.'_extend_navigation';
1139         if (file_exists($file)) {
1140             require_once($file);
1141             if (function_exists($function)) {
1142                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
1143                 $function($activity, $course, $activtyrecord, $cm);
1144                 return true;
1145             }
1146         }
1147         $activity->nodetype = navigation_node::NODETYPE_LEAF;
1148         return false;
1149     }
1150     /**
1151      * Loads user specific information into the navigation in the appopriate place.
1152      *
1153      * If no user is provided the current user is assumed.
1154      *
1155      * @param stdClass $user
1156      * @return bool
1157      */
1158     protected function load_for_user($user=null) {
1159         global $DB, $CFG, $USER;
1161         $iscurrentuser = false;
1162         if ($user === null) {
1163             // We can't require login here but if the user isn't logged in we don't
1164             // want to show anything
1165             if (!isloggedin()) {
1166                 return false;
1167             }
1168             $user = $USER;
1169             $iscurrentuser = true;
1170         } else if (!is_object($user)) {
1171             // If the user is not an object then get them from the database
1172             $user = $DB->get_record('user', array('id'=>(int)$user), '*', MUST_EXIST);
1173         }
1174         $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1176         // Get the course set against the page, by default this will be the site
1177         $course = $this->page->course;
1178         $baseargs = array('id'=>$user->id);
1179         if ($course->id !== SITEID) {
1180             if (array_key_exists($course->id, $this->mycourses)) {
1181                 $coursenode = $this->mycourses[$course->id]->coursenode;
1182             } else {
1183                 $coursenode = $this->rootnodes['courses']->find($course->id, navigation_node::TYPE_COURSE);
1184                 if (!$coursenode) {
1185                     $coursenode = $this->load_course($course);
1186                 }
1187             }
1188             $baseargs['course'] = $course->id;
1189             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1190             $issitecourse = false;
1191         } else {
1192             // Load all categories and get the context for the system
1193             $coursecontext = get_context_instance(CONTEXT_SYSTEM);
1194             $issitecourse = true;
1195         }
1197         // Create a node to add user information under.
1198         if ($iscurrentuser) {
1199             // If it's the current user the information will go under the profile root node
1200             $usernode = $this->rootnodes['myprofile'];
1201         } else {
1202             if (!$issitecourse) {
1203                 // Not the current user so add it to the participants node for the current course
1204                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
1205             } else {
1206                 // This is the site so add a users node to the root branch
1207                 $usersnode = $this->rootnodes['users'];
1208                 $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
1209             }
1210             // Add a branch for the current user
1211             $usernode = $usersnode->add(fullname($user, true));
1212         }
1214         if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
1215             $usernode->force_open();
1216         }
1218         // If the user is the current user or has permission to view the details of the requested
1219         // user than add a view profile link.
1220         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
1221             $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
1222         }
1224         // Add nodes for forum posts and discussions if the user can view either or both
1225         $canviewposts = has_capability('moodle/user:readuserposts', $usercontext);
1226         $canviewdiscussions = has_capability('mod/forum:viewdiscussion', $coursecontext);
1227         if ($canviewposts || $canviewdiscussions) {
1228             $forumtab = $usernode->add(get_string('forumposts', 'forum'));
1229             if ($canviewposts) {
1230                 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
1231             }
1232             if ($canviewdiscussions) {
1233                 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
1234             }
1235         }
1237         // Add a node to view the users notes if permitted
1238         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
1239             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
1240             if ($coursecontext->instanceid) {
1241                 $url->param('course', $coursecontext->instanceid);
1242             }
1243             $usernode->add(get_string('notes', 'notes'), $url);
1244         }
1246         // Add a reports tab and then add reports the the user has permission to see.
1247         $reporttab = $usernode->add(get_string('activityreports'));
1248         $anyreport  = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
1249         $viewreports = ($anyreport || ($course->showreports && $iscurrentuser));
1250         $reportargs = array('user'=>$user->id);
1251         if (!empty($course->id)) {
1252             $reportargs['id'] = $course->id;
1253         } else {
1254             $reportargs['id'] = SITEID;
1255         }
1256         if ($viewreports || has_capability('coursereport/outline:view', $coursecontext)) {
1257             $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
1258             $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
1259         }
1261         if ($viewreports || has_capability('coursereport/log:viewtoday', $coursecontext)) {
1262             $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
1263         }
1265         if ($viewreports || has_capability('coursereport/log:view', $coursecontext)) {
1266             $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
1267         }
1269         if (!empty($CFG->enablestats)) {
1270             if ($viewreports || has_capability('coursereport/stats:view', $coursecontext)) {
1271                 $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
1272             }
1273         }
1275         $gradeaccess = false;
1276         if (has_capability('moodle/grade:viewall', $coursecontext)) {
1277             //ok - can view all course grades
1278             $gradeaccess = true;
1279         } else if ($course->showgrades) {
1280             if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) {
1281                 //ok - can view own grades
1282                 $gradeaccess = true;
1283             } else if (has_capability('moodle/grade:viewall', $usercontext)) {
1284                 // ok - can view grades of this user - parent most probably
1285                 $gradeaccess = true;
1286             } else if ($anyreport) {
1287                 // ok - can view grades of this user - parent most probably
1288                 $gradeaccess = true;
1289             }
1290         }
1291         if ($gradeaccess) {
1292             $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'grade'))));
1293         }
1295         // Check the number of nodes in the report node... if there are none remove
1296         // the node
1297         if (count($reporttab->children)===0) {
1298             $usernode->remove_child($reporttab);
1299         }
1301         // If the user is the current user add the repositories for the current user
1302         if ($iscurrentuser) {
1303             require_once($CFG->dirroot . '/repository/lib.php');
1304             $editabletypes = repository::get_editable_types($usercontext);
1305             if (!empty($editabletypes)) {
1306                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
1307             }
1308         }
1309         return true;
1310     }
1312     /**
1313      * This method simply checks to see if a given module can extend the navigation.
1314      *
1315      * @param string $modname
1316      * @return bool
1317      */
1318     protected function module_extends_navigation($modname) {
1319         global $CFG;
1320         if ($this->cache->cached($modname.'_extends_navigation')) {
1321             return $this->cache->{$modname.'_extends_navigation'};
1322         }
1323         $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
1324         $function = $modname.'_extend_navigation';
1325         if (function_exists($function)) {
1326             $this->cache->{$modname.'_extends_navigation'} = true;
1327             return true;
1328         } else if (file_exists($file)) {
1329             require_once($file);
1330             if (function_exists($function)) {
1331                 $this->cache->{$modname.'_extends_navigation'} = true;
1332                 return true;
1333             }
1334         }
1335         $this->cache->{$modname.'_extends_navigation'} = false;
1336         return false;
1337     }
1338     /**
1339      * Extends the navigation for the given user.
1340      * 
1341      * @param stdClass $user A user from the database
1342      */
1343     public function extend_for_user($user) {
1344         $this->extendforuser[] = $user;
1345     }
1346     /**
1347      * Adds the given course to the navigation structure.
1348      *
1349      * @param stdClass $course
1350      * @return navigation_node
1351      */
1352     public function add_course(stdClass $course) {
1353         if (array_key_exists($course->id, $this->addedcourses)) {
1354             return $this->addedcourses[$course->id];
1355         }
1357         $canviewhidden = has_capability('moodle/course:viewhiddencourses', $this->page->context);
1358         if ($course->id !== SITEID && !$canviewhidden && (!$course->visible || !course_parent_visible($course))) {
1359             return false;
1360         }
1362         if ($course->id == SITEID) {
1363             $parent = $this;
1364             $url = new moodle_url('/');
1365         } else if (array_key_exists($course->id, $this->mycourses)) {
1366             $parent = $this->rootnodes['mycourses'];
1367             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
1368         } else {
1369             $parent = $this->rootnodes['courses'];
1370             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
1371         }
1372         $coursenode = $parent->add($course->fullname, $url, self::TYPE_COURSE, $course->shortname, $course->id);
1373         $coursenode->nodetype = self::NODETYPE_BRANCH;
1374         $coursenode->hidden = (!$course->visible);
1375         $this->addedcourses[$course->id] = &$coursenode;
1376         return $coursenode;
1377     }
1378     /**
1379      * Adds essential course nodes to the navigation for the given course.
1380      *
1381      * This method adds nodes such as reports, blogs and participants
1382      *
1383      * @param navigation_node $coursenode
1384      * @param stdClass $course
1385      * @return bool
1386      */
1387     public function add_course_essentials(navigation_node $coursenode, stdClass $course) {
1388         global $CFG;
1390         if ($course->id === SITEID) {
1391             return $this->add_front_page_course_essentials($coursenode, $course);
1392         }
1394         if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
1395             return true;
1396         }
1398         //Participants
1399         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
1400             require_once($CFG->dirroot.'/blog/lib.php');
1401             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
1402             $currentgroup = groups_get_course_group($course, true);
1403             if ($course->id == SITEID) {
1404                 $filterselect = '';
1405             } else if ($course->id && !$currentgroup) {
1406                 $filterselect = $course->id;
1407             } else {
1408                 $filterselect = $currentgroup;
1409             }
1410             $filterselect = clean_param($filterselect, PARAM_INT);
1411             if ($CFG->bloglevel >= 3) {
1412                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
1413                 $participants->add(get_string('blogs','blog'), $blogsurls->out());
1414             }
1415             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
1416                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
1417             }
1418         } else if (count($this->extendforuser) > 0) {
1419             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
1420         }
1422         // View course reports
1423         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
1424             $reportnav = $coursenode->add(get_string('reports'), new moodle_url('/course/report.php', array('id'=>$course->id)), self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
1425             $coursereports = get_plugin_list('coursereport');
1426             foreach ($coursereports as $report=>$dir) {
1427                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
1428                 if (file_exists($libfile)) {
1429                     require_once($libfile);
1430                     $reportfunction = $report.'_report_extend_navigation';
1431                     if (function_exists($report.'_report_extend_navigation')) {
1432                         $reportfunction($reportnav, $course, $this->page->context);
1433                     }
1434                 }
1435             }
1436         }
1437         return true;
1438     }
1440     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
1441         global $CFG;
1443         if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CUSTOM)) {
1444             return true;
1445         }
1447         //Participants
1448         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
1449             require_once($CFG->dirroot.'/blog/lib.php');
1450             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
1451         }
1452         
1453         $currentgroup = groups_get_course_group($course, true);
1454         if ($course->id == SITEID) {
1455             $filterselect = '';
1456         } else if ($course->id && !$currentgroup) {
1457             $filterselect = $course->id;
1458         } else {
1459             $filterselect = $currentgroup;
1460         }
1461         $filterselect = clean_param($filterselect, PARAM_INT);
1462         if ($CFG->bloglevel >= 3) {
1463             $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
1464             $coursenode->add(get_string('blogs','blog'), $blogsurls->out());
1465         }
1466         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
1467             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
1468         }
1469         if (!empty($CFG->usetags)) {
1470             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
1471         }
1474         // View course reports
1475         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
1476             $reportnav = $coursenode->add(get_string('reports'), new moodle_url('/course/report.php', array('id'=>$course->id)), self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
1477             $coursereports = get_plugin_list('coursereport');
1478             foreach ($coursereports as $report=>$dir) {
1479                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
1480                 if (file_exists($libfile)) {
1481                     require_once($libfile);
1482                     $reportfunction = $report.'_report_extend_navigation';
1483                     if (function_exists($report.'_report_extend_navigation')) {
1484                         $reportfunction($reportnav, $course, $this->page->context);
1485                     }
1486                 }
1487             }
1488         }
1489         return true;
1490     }
1492     /**
1493      * Clears the navigation cache
1494      */
1495     public function clear_cache() {
1496         $this->cache->clear();
1497     }
1499     public function set_expansion_limit($type) {
1500         $nodes = $this->find_all_of_type($type);
1501         foreach ($nodes as &$node) {
1502             foreach ($node->children as &$child) {
1503                 $child->display = false;
1504             }
1505         }
1506         return true;
1507     }
1510 /**
1511  * The limited global navigation class used for the AJAX extension of the global
1512  * navigation class.
1513  *
1514  * The primary methods that are used in the global navigation class have been overriden
1515  * to ensure that only the relevant branch is generated at the root of the tree.
1516  * This can be done because AJAX is only used when the backwards structure for the
1517  * requested branch exists.
1518  * This has been done only because it shortens the amounts of information that is generated
1519  * which of course will speed up the response time.. because no one likes laggy AJAX.
1520  *
1521  * @package moodlecore
1522  * @subpackage navigation
1523  * @copyright 2009 Sam Hemelryk
1524  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1525  */
1526 class global_navigation_for_ajax extends global_navigation {
1528     /** @var array */
1529     protected $expandable = array();
1531     /**
1532      * Constructs the navigation for use in AJAX request
1533      */
1534     public function __construct() {
1535         global $SITE;
1536         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
1537         $this->children = new navigation_node_collection();
1538         $this->rootnodes = array();
1539         //$this->rootnodes['site']      = $this->add_course($SITE);
1540         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
1541     }
1542     /**
1543      * Initialise the navigation given the type and id for the branch to expand.
1544      *
1545      * @param int $branchtype One of navigation_node::TYPE_*
1546      * @param int $id
1547      * @return array The expandable nodes
1548      */
1549     public function initialise($branchtype, $id) {
1550         global $DB, $PAGE;
1552         if ($this->initialised || during_initial_install()) {
1553             return $this->expandable;
1554         }
1556         // Branchtype will be one of navigation_node::TYPE_*
1557         switch ($branchtype) {
1558             case self::TYPE_COURSE :
1559                 $course = $DB->get_record('course', array('id' => $id), '*', MUST_EXIST);
1560                 require_course_login($course);
1561                 $this->page = $PAGE;
1562                 $coursenode = $this->add_course($course);
1563                 $this->add_course_essentials($coursenode, $course);
1564                 if ($this->format_display_course_content($course->format)) {
1565                     $this->load_course_sections($course, $coursenode);
1566                 }
1567                 break;
1568             case self::TYPE_SECTION :
1569                 $sql = 'SELECT c.*, cs.section AS sectionnumber
1570                         FROM {course} c
1571                         LEFT JOIN {course_sections} cs ON cs.course = c.id
1572                         WHERE cs.id = ?';
1573                 $course = $DB->get_record_sql($sql, array($id), MUST_EXIST);
1574                 require_course_login($course);
1575                 $this->page = $PAGE;
1576                 $coursenode = $this->add_course($course);
1577                 $this->add_course_essentials($coursenode, $course);
1578                 $sections = $this->load_course_sections($course, $coursenode);
1579                 $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, get_fast_modinfo($course));
1580                 break;
1581             case self::TYPE_ACTIVITY :
1582                 $cm = get_coursemodule_from_id(false, $id, 0, false, MUST_EXIST);
1583                 $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
1584                 require_course_login($course, true, $cm);
1585                 $this->page = $PAGE;
1586                 $coursenode = $this->load_course($course);
1587                 $sections = $this->load_course_sections($course, $coursenode);
1588                 foreach ($sections as $section) {
1589                     if ($section->id == $cm->section) {
1590                         $cm->sectionnumber = $section->section;
1591                         break;
1592                     }
1593                 }
1594                 $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course));
1595                 $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]);
1596                 break;
1597             default:
1598                 throw new Exception('Unknown type');
1599                 return $this->expandable;
1600         }
1602         $this->find_expandable($this->expandable);
1603         return $this->expandable;
1604     }
1607 /**
1608  * Navbar class
1609  *
1610  * This class is used to manage the navbar, which is initialised from the navigation
1611  * object held by PAGE
1612  *
1613  * @package moodlecore
1614  * @subpackage navigation
1615  * @copyright 2009 Sam Hemelryk
1616  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1617  */
1618 class navbar extends navigation_node {
1619     /** @var bool */
1620     protected $initialised = false;
1621     /** @var mixed */
1622     protected $keys = array();
1623     /** @var null|string */
1624     protected $content = null;
1625     /** @var moodle_page object */
1626     protected $page;
1627     /** @var bool */
1628     protected $ignoreactive = false;
1629     /** @var bool */
1630     protected $duringinstall = false;
1631     /** @var bool */
1632     protected $hasitems = false;
1633     /** @var array */
1634     protected $items;
1635     /** @var array */
1636     public $children = array();
1637     /**
1638      * The almighty constructor
1639      *
1640      * @param moodle_page $page
1641      */
1642     public function __construct(moodle_page $page) {
1643         global $CFG;
1644         if (during_initial_install()) {
1645             $this->duringinstall = true;
1646             return false;
1647         }
1648         $this->page = $page;
1649         $this->text = get_string('home');
1650         $this->shorttext = get_string('home');
1651         $this->action = new moodle_url($CFG->wwwroot);
1652         $this->nodetype = self::NODETYPE_BRANCH;
1653         $this->type = self::TYPE_SYSTEM;
1654     }
1656     /**
1657      * Quick check to see if the navbar will have items in.
1658      *
1659      * @return bool Returns true if the navbar will have items, false otherwise
1660      */
1661     public function has_items() {
1662         if ($this->duringinstall) {
1663             return false;
1664         } else if ($this->hasitems !== false) {
1665             return true;
1666         }
1667         $this->page->navigation->initialise($this->page);
1669         $activenodefound = ($this->page->navigation->contains_active_node() ||
1670                             $this->page->settingsnav->contains_active_node());
1672         $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
1673         $this->hasitems = $outcome;
1674         return $outcome;
1675     }
1677     /**
1678      * Turn on/off ignore active
1679      *
1680      * @param bool $setting
1681      */
1682     public function ignore_active($setting=true) {
1683         $this->ignoreactive = ($setting);
1684     }
1685     public function get($key, $type = null) {
1686         foreach ($this->children as &$child) {
1687             if ($child->key === $key && ($type == null || $type == $child->type)) {
1688                 return $child;
1689             }
1690         }
1691         return false;
1692     }
1693     /**
1694      * Returns an array of navigation_node's that make up the navbar.
1695      * 
1696      * @return array
1697      */
1698     public function get_items() {
1699         $items = array();
1700         // Make sure that navigation is initialised
1701         if (!$this->has_items()) {
1702             return $items;
1703         }
1704         if ($this->items !== null) {
1705             return $this->items;
1706         }
1708         if (count($this->children) > 0) {
1709             // Add the custom children
1710             $items = array_reverse($this->children);
1711         }
1713         $navigationactivenode = $this->page->navigation->find_active_node();
1714         $settingsactivenode = $this->page->settingsnav->find_active_node();
1716         // Check if navigation contains the active node
1717         if (!$this->ignoreactive) {
1718             
1719             if ($navigationactivenode && $settingsactivenode) {
1720                 // Parse a combined navigation tree
1721                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
1722                     if (!$settingsactivenode->mainnavonly) {
1723                         $items[] = $settingsactivenode;
1724                     }
1725                     $settingsactivenode = $settingsactivenode->parent;
1726                 }
1727                 // Removes the first node from the settings (root node) from the list
1728                 array_pop($items);
1729                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
1730                     if (!$navigationactivenode->mainnavonly) {
1731                         $items[] = $navigationactivenode;
1732                     }
1733                     $navigationactivenode = $navigationactivenode->parent;
1734                 }
1735             } else if ($navigationactivenode) {
1736                 // Parse the navigation tree to get the active node
1737                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
1738                     if (!$navigationactivenode->mainnavonly) {
1739                         $items[] = $navigationactivenode;
1740                     }
1741                     $navigationactivenode = $navigationactivenode->parent;
1742                 }
1743             } else if ($settingsactivenode) {
1744                 // Parse the settings navigation to get the active node
1745                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
1746                     if (!$settingsactivenode->mainnavonly) {
1747                         $items[] = $settingsactivenode;
1748                     }
1749                     $settingsactivenode = $settingsactivenode->parent;
1750                 }
1751             }
1752         }
1754         $items[] = new navigation_node(array(
1755             'text'=>$this->page->navigation->text,
1756             'shorttext'=>$this->page->navigation->shorttext,
1757             'key'=>$this->page->navigation->key,
1758             'action'=>$this->page->navigation->action
1759         ));
1761         $this->items = array_reverse($items);
1762         return $this->items;
1763     }
1765     /**
1766      * Add a new navigation_node to the navbar, overrides parent::add
1767      *
1768      * This function overrides {@link navigation_node::add()} so that we can change
1769      * the way nodes get added to allow us to simply call add and have the node added to the
1770      * end of the navbar
1771      *
1772      * @param string $text
1773      * @param string|moodle_url $action
1774      * @param int $type
1775      * @param string|int $key
1776      * @param string $shorttext
1777      * @param string $icon
1778      * @return navigation_node
1779      */
1780     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
1781         if ($this->content !== null) {
1782             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
1783         }
1784         
1785         // Properties array used when creating the new navigation node
1786         $itemarray = array(
1787             'text' => $text,
1788             'type' => $type
1789         );
1790         // Set the action if one was provided
1791         if ($action!==null) {
1792             $itemarray['action'] = $action;
1793         }
1794         // Set the shorttext if one was provided
1795         if ($shorttext!==null) {
1796             $itemarray['shorttext'] = $shorttext;
1797         }
1798         // Set the icon if one was provided
1799         if ($icon!==null) {
1800             $itemarray['icon'] = $icon;
1801         }
1802         // Default the key to the number of children if not provided
1803         if ($key === null) {
1804             $key = count($this->children);
1805         }
1806         // Set the key
1807         $itemarray['key'] = $key;
1808         // Set the parent to this node
1809         $itemarray['parent'] = $this;
1810         // Add the child using the navigation_node_collections add method
1811         $this->children[] = new navigation_node($itemarray);
1812         return $this;
1813     }
1816 /**
1817  * Class used to manage the settings option for the current page
1818  *
1819  * This class is used to manage the settings options in a tree format (recursively)
1820  * and was created initially for use with the settings blocks.
1821  *
1822  * @package moodlecore
1823  * @subpackage navigation
1824  * @copyright 2009 Sam Hemelryk
1825  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1826  */
1827 class settings_navigation extends navigation_node {
1828     /** @var stdClass */
1829     protected $context;
1830     /** @var navigation_cache */
1831     protected $cache;
1832     /** @var moodle_page */
1833     protected $page;
1834     /** @var string */
1835     protected $adminsection;
1836     /**
1837      * Sets up the object with basic settings and preparse it for use
1838      * 
1839      * @param moodle_page $page
1840      */
1841     public function __construct(moodle_page &$page) {
1842         if (during_initial_install()) {
1843             return false;
1844         }
1845         $this->page = $page;
1846         // Initialise the main navigation. It is most important that this is done
1847         // before we try anything
1848         $this->page->navigation->initialise();
1849         // Initialise the navigation cache
1850         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
1851         $this->children = new navigation_node_collection();
1852     }
1853     /**
1854      * Initialise the settings navigation based on the current context
1855      *
1856      * This function initialises the settings navigation tree for a given context
1857      * by calling supporting functions to generate major parts of the tree.
1858      *
1859      */
1860     public function initialise() {
1861         global $DB;
1863         if (during_initial_install()) {
1864             return false;
1865         }
1866         $this->id = 'settingsnav';
1867         $this->context = $this->page->context;
1869         $context = $this->context;
1870         if ($context->contextlevel == CONTEXT_BLOCK) {
1871             $this->load_block_settings();
1872             $context = $DB->get_record_sql('SELECT ctx.* FROM {block_instances} bi LEFT JOIN {context} ctx ON ctx.id=bi.parentcontextid WHERE bi.id=?', array($context->instanceid));
1873         }
1875         switch ($context->contextlevel) {
1876             case CONTEXT_SYSTEM:
1877                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
1878                     $this->load_front_page_settings(($context->id == $this->context->id));
1879                 }
1880                 break;
1881             case CONTEXT_COURSECAT:
1882                 $this->load_category_settings();
1883                 break;
1884             case CONTEXT_COURSE:
1885                 if ($this->page->course->id != SITEID) {
1886                     $this->load_course_settings(($context->id == $this->context->id));
1887                 } else {
1888                     $this->load_front_page_settings(($context->id == $this->context->id));
1889                 }
1890                 break;
1891             case CONTEXT_MODULE:
1892                 $this->load_module_settings();
1893                 $this->load_course_settings();
1894                 break;
1895             case CONTEXT_USER:
1896                 if ($this->page->course->id != SITEID) {
1897                     $this->load_course_settings();
1898                 }
1899                 break;
1900         }
1902         $settings = $this->load_user_settings($this->page->course->id);
1903         $admin = $this->load_administration_settings();
1905         if ($context->contextlevel == CONTEXT_SYSTEM && $admin) {
1906             $admin->force_open();
1907         } else if ($context->contextlevel == CONTEXT_USER && $settings) {
1908             $settings->force_open();
1909         }
1911         // Check if the user is currently logged in as another user
1912         if (session_is_loggedinas()) {
1913             // Get the actual user, we need this so we can display an informative return link
1914             $realuser = session_get_realuser();
1915             // Add the informative return to original user link
1916             $url = new moodle_url('/course/loginas.php',array('id'=>$this->page->course->id, 'return'=>1,'sesskey'=>sesskey()));
1917             $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self::TYPE_SETTING, null, null, new pix_icon('t/left', ''));
1918         }
1920         // Make sure the first child doesnt have proceed with hr set to true
1922         foreach ($this->children as $key=>$node) {
1923             if ($node->nodetype != self::NODETYPE_BRANCH || $node->children->count()===0) {
1924                 $node->remove();
1925             }
1926         }
1927     }
1928     /**
1929      * Override the parent function so that we can add preceeding hr's and set a
1930      * root node class against all first level element
1931      *
1932      * It does this by first calling the parent's add method {@link navigation_node::add()}
1933      * and then proceeds to use the key to set class and hr
1934      *
1935      * @param string $text
1936      * @param sting|moodle_url $url
1937      * @param string $shorttext
1938      * @param string|int $key
1939      * @param int $type
1940      * @param string $icon
1941      * @return navigation_node
1942      */
1943     public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
1944         $node = parent::add($text, $url, $type, $shorttext, $key, $icon);
1945         $node->add_class('root_node');
1946         return $node;
1947     }
1949     /**
1950      * This function allows the user to add something to the start of the settings
1951      * navigation, which means it will be at the top of the settings navigation block
1952      *
1953      * @param string $text
1954      * @param sting|moodle_url $url
1955      * @param string $shorttext
1956      * @param string|int $key
1957      * @param int $type
1958      * @param string $icon
1959      * @return navigation_node
1960      */
1961     public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
1962         $children = $this->children;
1963         $this->children = new get_class($children);
1964         $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
1965         foreach ($children as $child) {
1966             $this->children->add($child);
1967         }
1968         return $node;
1969     }
1970     /**
1971      * Load the site administration tree
1972      *
1973      * This function loads the site administration tree by using the lib/adminlib library functions
1974      *
1975      * @param navigation_node $referencebranch A reference to a branch in the settings
1976      *      navigation tree
1977      * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
1978      *      tree and start at the beginning
1979      * @return mixed A key to access the admin tree by
1980      */
1981     protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) {
1982         global $CFG;
1984         // Check if we are just starting to generate this navigation.
1985         if ($referencebranch === null) {
1987             // Require the admin lib then get an admin structure
1988             if (!function_exists('admin_get_root')) {
1989                 require_once($CFG->dirroot.'/lib/adminlib.php');
1990             }
1991             $adminroot = admin_get_root(false, false);
1992             // This is the active section identifier
1993             $this->adminsection = $this->page->url->param('section');
1995             // Disable the navigation from automatically finding the active node
1996             navigation_node::$autofindactive = false;
1997             $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SETTING, null, 'root');
1998             foreach ($adminroot->children as $adminbranch) {
1999                 $this->load_administration_settings($referencebranch, $adminbranch);
2000             }
2001             navigation_node::$autofindactive = true;
2003             // Use the admin structure to locate the active page
2004             if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) {
2005                 $currentnode = $this;
2006                 while (($pathkey = array_pop($current->path))!==null && $currentnode) {
2007                     $currentnode = $currentnode->get($pathkey);
2008                 }
2009                 if ($currentnode) {
2010                     $currentnode->make_active();
2011                 }
2012             }
2013             return $referencebranch;
2014         } else if ($adminbranch->check_access()) {
2015             // We have a reference branch that we can access and is not hidden `hurrah`
2016             // Now we need to display it and any children it may have
2017             $url = null;
2018             $icon = null;
2019             if ($adminbranch instanceof admin_settingpage) {
2020                 $url = new moodle_url('/admin/settings.php', array('section'=>$adminbranch->name));
2021             } else if ($adminbranch instanceof admin_externalpage) {
2022                 $url = $adminbranch->url;
2023             }
2025             // Add the branch
2026             $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon);
2028             if ($adminbranch->is_hidden()) {
2029                 if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) {
2030                     $reference->add_class('hidden');
2031                 } else {
2032                     $reference->display = false;
2033                 }
2034             }
2036             // Check if we are generating the admin notifications and whether notificiations exist
2037             if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) {
2038                 $reference->add_class('criticalnotification');
2039             }
2040             // Check if this branch has children
2041             if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) {
2042                 foreach ($adminbranch->children as $branch) {
2043                     // Generate the child branches as well now using this branch as the reference
2044                     $this->load_administration_settings($reference, $branch);
2045                 }
2046             } else {
2047                 $reference->icon = new pix_icon('i/settings', '');
2048             }
2049         }
2050     }
2052     /**
2053      * Gets a navigation node given an array of keys that represent the path to
2054      * the desired node.
2055      *
2056      * @param array $path
2057      * @return navigation_node|false
2058      */
2059     protected function get_by_path(array $path) {
2060         $node = $this->get(array_shift($path));
2061         foreach ($path as $key) {
2062             $node->get($key);
2063         }
2064         return $node;
2065     }
2067     /**
2068      * Generate the list of modules for the given course.
2069      *
2070      * The array of resources and activities that can be added to a course is then
2071      * stored in the cache so that we can access it for anywhere.
2072      * It saves us generating it all the time
2073      *
2074      * <code php>
2075      * // To get resources:
2076      * $this->cache->{'course'.$courseid.'resources'}
2077      * // To get activities:
2078      * $this->cache->{'course'.$courseid.'activities'}
2079      * </code>
2080      *
2081      * @param stdClass $course The course to get modules for
2082      */
2083     protected function get_course_modules($course) {
2084         global $CFG;
2085         $mods = $modnames = $modnamesplural = $modnamesused = array();
2086         // This function is included when we include course/lib.php at the top
2087         // of this file
2088         get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused);
2089         $resources = array();
2090         $activities = array();
2091         foreach($modnames as $modname=>$modnamestr) {
2092             if (!course_allowed_module($course, $modname)) {
2093                 continue;
2094             }
2096             $libfile = "$CFG->dirroot/mod/$modname/lib.php";
2097             if (!file_exists($libfile)) {
2098                 continue;
2099             }
2100             include_once($libfile);
2101             $gettypesfunc =  $modname.'_get_types';
2102             if (function_exists($gettypesfunc)) {
2103                 $types = $gettypesfunc();
2104                 foreach($types as $type) {
2105                     if (!isset($type->modclass) || !isset($type->typestr)) {
2106                         debugging('Incorrect activity type in '.$modname);
2107                         continue;
2108                     }
2109                     if ($type->modclass == MOD_CLASS_RESOURCE) {
2110                         $resources[html_entity_decode($type->type)] = $type->typestr;
2111                     } else {
2112                         $activities[html_entity_decode($type->type)] = $type->typestr;
2113                     }
2114                 }
2115             } else {
2116                 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2117                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
2118                     $resources[$modname] = $modnamestr;
2119                 } else {
2120                     // all other archetypes are considered activity
2121                     $activities[$modname] = $modnamestr;
2122                 }
2123             }
2124         }
2125         $this->cache->{'course'.$course->id.'resources'} = $resources;
2126         $this->cache->{'course'.$course->id.'activities'} = $activities;
2127     }
2129     /**
2130      * This function loads the course settings that are available for the user
2131      *
2132      * @param bool $forceopen If set to true the course node will be forced open
2133      * @return navigation_node|false
2134      */
2135     protected function load_course_settings($forceopen = false) {
2136         global $CFG, $USER, $SESSION, $OUTPUT;
2138         $course = $this->page->course;
2139         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2140         if (!$this->cache->cached('canviewcourse'.$course->id)) {
2141             $this->cache->{'canviewcourse'.$course->id} = has_capability('moodle/course:participate', $coursecontext);
2142         }
2143         if ($course->id === SITEID || !$this->cache->{'canviewcourse'.$course->id}) {
2144             return false;
2145         }
2147         $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin');
2148         if ($forceopen) {
2149             $coursenode->force_open();
2150         }
2152         if (has_capability('moodle/course:update', $coursecontext)) {
2153             // Add the turn on/off settings
2154             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
2155             if ($this->page->user_is_editing()) {
2156                 $url->param('edit', 'off');
2157                 $editstring = get_string('turneditingoff');
2158             } else {
2159                 $url->param('edit', 'on');
2160                 $editstring = get_string('turneditingon');
2161             }
2162             $coursenode->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
2164             if ($this->page->user_is_editing()) {
2165                 // Add `add` resources|activities branches
2166                 $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
2167                 if (file_exists($structurefile)) {
2168                     require_once($structurefile);
2169                     $formatstring = call_user_func('callback_'.$course->format.'_definition');
2170                     $formatidentifier = optional_param(call_user_func('callback_'.$course->format.'_request_key'), 0, PARAM_INT);
2171                 } else {
2172                     $formatstring = get_string('topic');
2173                     $formatidentifier = optional_param('topic', 0, PARAM_INT);
2174                 }
2175                 if (!$this->cache->cached('coursesections'.$course->id)) {
2176                     $this->cache->{'coursesections'.$course->id} = get_all_sections($course->id);
2177                 }
2178                 $sections = $this->cache->{'coursesections'.$course->id};
2180                 $addresource = $this->add(get_string('addresource'));
2181                 $addactivity = $this->add(get_string('addactivity'));
2182                 if ($formatidentifier!==0) {
2183                     $addresource->force_open();
2184                     $addactivity->force_open();
2185                 }
2187                 if (!$this->cache->cached('course'.$course->id.'resources')) {
2188                     $this->get_course_modules($course);
2189                 }
2190                 $resources = $this->cache->{'course'.$course->id.'resources'};
2191                 $activities = $this->cache->{'course'.$course->id.'activities'};
2193                 $textlib = textlib_get_instance();
2195                 foreach ($sections as $section) {
2196                     if ($formatidentifier !== 0 && $section->section != $formatidentifier) {
2197                         continue;
2198                     }
2199                     $sectionurl = new moodle_url('/course/view.php', array('id'=>$course->id, $formatstring=>$section->section));
2200                     if ($section->section == 0) {
2201                         $sectionresources = $addresource->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
2202                         $sectionactivities = $addactivity->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
2203                     } else {
2204                         $sectionresources = $addresource->add($formatstring.' '.$section->section, $sectionurl, self::TYPE_SETTING);
2205                         $sectionactivities = $addactivity->add($formatstring.' '.$section->section, $sectionurl, self::TYPE_SETTING);
2206                     }
2207                     foreach ($resources as $value=>$resource) {
2208                         $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
2209                         $pos = strpos($value, '&type=');
2210                         if ($pos!==false) {
2211                             $url->param('add', $textlib->substr($value, 0,$pos));
2212                             $url->param('type', $textlib->substr($value, $pos+6));
2213                         } else {
2214                             $url->param('add', $value);
2215                         }
2216                         $sectionresources->add($resource, $url, self::TYPE_SETTING);
2217                     }
2218                     $subbranch = false;
2219                     foreach ($activities as $activityname=>$activity) {
2220                         if ($activity==='--') {
2221                             $subbranch = false;
2222                             continue;
2223                         }
2224                         if (strpos($activity, '--')===0) {
2225                             $subbranch = $sectionresources->add(trim($activity, '-'));
2226                             continue;
2227                         }
2228                         $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
2229                         $pos = strpos($activityname, '&type=');
2230                         if ($pos!==false) {
2231                             $url->param('add', $textlib->substr($activityname, 0,$pos));
2232                             $url->param('type', $textlib->substr($activityname, $pos+6));
2233                         } else {
2234                             $url->param('add', $activityname);
2235                         }
2236                         if ($subbranch !== false) {
2237                             $subbranch->add($activity, $url, self::TYPE_SETTING);
2238                         } else {
2239                             $sectionresources->add($activity, $url, self::TYPE_SETTING);
2240                         }
2241                     }
2242                 }
2243             }
2245             // Add the course settings link
2246             $url = new moodle_url('/course/edit.php', array('id'=>$course->id));
2247             $coursenode->add(get_string('settings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
2248         }
2250         if (has_capability('moodle/role:assign', $coursecontext)) {
2251             // Add assign or override roles if allowed
2252             $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$coursecontext->id));
2253             $coursenode->add(get_string('assignroles', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2254             // Override roles
2255             if (has_capability('moodle/role:review', $coursecontext) or count(get_overridable_roles($coursecontext))>0) {
2256                 $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$coursecontext->id));
2257                 $coursenode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2258             }
2259             // Check role permissions
2260             if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $coursecontext)) {
2261                 $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$coursecontext->id));
2262                 $coursenode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2263             }
2264             // Manage filters
2265             if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
2266                 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
2267                 $coursenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
2268             }
2269         }
2271         // Add view grade report is permitted
2272         $reportavailable = false;
2273         if (has_capability('moodle/grade:viewall', $coursecontext)) {
2274             $reportavailable = true;
2275         } else if (!empty($course->showgrades)) {
2276             $reports = get_plugin_list('gradereport');
2277             if (is_array($reports) && count($reports)>0) {     // Get all installed reports
2278                 arsort($reports); // user is last, we want to test it first
2279                 foreach ($reports as $plugin => $plugindir) {
2280                     if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
2281                         //stop when the first visible plugin is found
2282                         $reportavailable = true;
2283                         break;
2284                     }
2285                 }
2286             }
2287         }
2288         if ($reportavailable) {
2289             $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id));
2290             $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
2291         }
2293         //  Add outcome if permitted
2294         if (!empty($CFG->enableoutcomes) && has_capability('moodle/course:update', $coursecontext)) {
2295             $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id));
2296             $coursenode->add(get_string('outcomes', 'grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/outcomes', ''));
2297         }
2299         // Add meta course links
2300         if ($course->metacourse) {
2301             if (has_capability('moodle/course:managemetacourse', $coursecontext)) {
2302                 $url = new moodle_url('/course/importstudents.php', array('id'=>$course->id));
2303                 $coursenode->add(get_string('childcourses'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/course', ''));
2304             } else if (has_capability('moodle/role:assign', $coursecontext)) {
2305                 $roleassign = $coursenode->add(get_string('childcourses'), null,  self::TYPE_SETTING, null, null, new pix_icon('i/course', ''));
2306                 $roleassign->hidden = true;
2307             }
2308         }
2310         // Manage groups in this course
2311         if (($course->groupmode || !$course->groupmodeforce) && has_capability('moodle/course:managegroups', $coursecontext)) {
2312             $url = new moodle_url('/group/index.php', array('id'=>$course->id));
2313             $coursenode->add(get_string('groups'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/group', ''));
2314         }
2316         // Backup this course
2317         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
2318             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
2319             $coursenode->add(get_string('backup'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/backup', ''));
2320         }
2322         // Restore to this course
2323         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
2324             $url = new moodle_url('/files/index.php', array('id'=>$course->id, 'wdir'=>'/backupdata'));
2325             $coursenode->add(get_string('restore'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/restore', ''));
2326         }
2328         // Import data from other courses
2329         if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
2330             $url = new moodle_url('/course/import.php', array('id'=>$course->id));
2331             $coursenode->add(get_string('import'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/restore', ''));
2332         }
2334         // Reset this course
2335         if (has_capability('moodle/course:reset', $coursecontext)) {
2336             $url = new moodle_url('/course/reset.php', array('id'=>$course->id));
2337             $coursenode->add(get_string('reset'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/return', ''));
2338         }
2340         // Manage questions
2341         $questioncaps = array('moodle/question:add',
2342                               'moodle/question:editmine',
2343                               'moodle/question:editall',
2344                               'moodle/question:viewmine',
2345                               'moodle/question:viewall',
2346                               'moodle/question:movemine',
2347                               'moodle/question:moveall');
2348         if (has_any_capability($questioncaps, $this->context)) {
2349             $questionlink = $CFG->wwwroot.'/question/edit.php';
2350         } else if (has_capability('moodle/question:managecategory', $this->context)) {
2351             $questionlink = $CFG->wwwroot.'/question/category.php';
2352         }
2353         if (isset($questionlink)) {
2354             $url = new moodle_url($questionlink, array('courseid'=>$course->id));
2355             $coursenode->add(get_string('questions','quiz'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/questions', ''));
2356         }
2358         // Repository Instances
2359         require_once($CFG->dirroot.'/repository/lib.php');
2360         $editabletypes = repository::get_editable_types($this->context);
2361         if (has_capability('moodle/course:update', $this->context) && !empty($editabletypes)) {
2362             $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$this->context->id));
2363             $coursenode->add(get_string('repositories'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/repository', ''));
2364         }
2366         // Manage files
2367         if (has_capability('moodle/course:managefiles', $this->context)) {
2368             $url = new moodle_url('/files/index.php', array('id'=>$course->id));
2369             $coursenode->add(get_string('files'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/files', ''));
2370         }
2372         // Authorize hooks
2373         if ($course->enrol == 'authorize' || (empty($course->enrol) && $CFG->enrol == 'authorize')) {
2374             require_once($CFG->dirroot.'/enrol/authorize/const.php');
2375             $url = new moodle_url('/enrol/authorize/index.php', array('course'=>$course->id));
2376             $coursenode->add(get_string('payments'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/payment', ''));
2377             if (has_capability('enrol/authorize:managepayments', $this->page->context)) {
2378                 $cnt = $DB->count_records('enrol_authorize', array('status'=>AN_STATUS_AUTH, 'courseid'=>$course->id));
2379                 if ($cnt) {
2380                     $url = new moodle_url('/enrol/authorize/index.php', array('course'=>$course->id,'status'=>AN_STATUS_AUTH));
2381                     $coursenode->add(get_string('paymentpending', 'moodle', $cnt), $url, self::TYPE_SETTING, null, null, new pix_icon('i/payment', ''));
2382                 }
2383             }
2384         }
2386         // Unenrol link
2387         if (empty($course->metacourse) && ($course->id!==SITEID)) {
2388             if (is_enrolled(get_context_instance(CONTEXT_COURSE, $course->id))) {
2389                 if (has_capability('moodle/role:unassignself', $this->page->context, NULL, false) and get_user_roles($this->page->context, $USER->id, false)) {  // Have some role
2390                     $this->content->items[]='<a href="'.$CFG->wwwroot.'/course/unenrol.php?id='.$course->id.'">'.get_string('unenrolme', '', format_string($course->shortname)).'</a>';
2391                     $this->content->icons[]='<img src="'.$OUTPUT->pix_url('i/user') . '" class="icon" alt="" />';
2392                 }
2394             } else if (is_viewing(get_context_instance(CONTEXT_COURSE, $course->id))) {
2395                 // inspector, manager, etc. - do not show anything
2396             } else {
2397                 // access because otherwise they would not get into this course at all
2398                 $this->content->items[]='<a href="'.$CFG->wwwroot.'/course/enrol.php?id='.$course->id.'">'.get_string('enrolme', '', format_string($course->shortname)).'</a>';
2399                 $this->content->icons[]='<img src="'.$OUTPUT->pix_url('i/user') . '" class="icon" alt="" />';
2400             }
2401         }
2403         // Switch roles
2404         $roles = array();
2405         $assumedrole = $this->in_alternative_role();
2406         if ($assumedrole!==false) {
2407             $roles[0] = get_string('switchrolereturn');
2408         }
2409         if (has_capability('moodle/role:switchroles', $this->context)) {
2410             $availableroles = get_switchable_roles($this->context);
2411             if (is_array($availableroles)) {
2412                 foreach ($availableroles as $key=>$role) {
2413                     if ($key == $CFG->guestroleid || $assumedrole===(int)$key) {
2414                         continue;
2415                     }
2416                     $roles[$key] = $role;
2417                 }
2418             }
2419         }
2420         if (is_array($roles) && count($roles)>0) {
2421             $switchroles = $this->add(get_string('switchroleto'));
2422             if ((count($roles)==1 && array_key_exists(0, $roles))|| $assumedrole!==false) {
2423                 $switchroles->force_open();
2424             }
2425             $returnurl = $this->page->url;
2426             $returnurl->param('sesskey', sesskey());
2427             $SESSION->returnurl = serialize($returnurl);
2428             foreach ($roles as $key=>$name) {
2429                 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>'1'));
2430                 $switchroles->add($name, $url, self::TYPE_SETTING, null, $key, new pix_icon('i/roles', ''));
2431             }
2432         }
2433         // Return we are done
2434         return $coursenode;
2435     }
2437     /**
2438      * This function calls the module function to inject module settings into the
2439      * settings navigation tree.
2440      *
2441      * This only gets called if there is a corrosponding function in the modules
2442      * lib file.
2443      *
2444      * For examples mod/forum/lib.php ::: forum_extend_settings_navigation()
2445      *
2446      * @return navigation_node|false
2447      */
2448     protected function load_module_settings() {
2449         global $CFG;
2451         if (!$this->page->cm && $this->context->contextlevel == CONTEXT_MODULE && $this->context->instanceid) {
2452             $cm = get_coursemodule_from_id(false, $this->context->instanceid, 0, false, MUST_EXIST);
2453             $this->page->set_cm($cm, $this->page->course);
2454         }
2456         $modulenode = $this->add(get_string($this->page->activityname.'administration', $this->page->activityname));
2457         $modulenode->force_open();
2459         // Settings for the module
2460         if (has_capability('moodle/course:manageactivities', $this->page->cm->context)) {
2461             $url = new moodle_url('/course/modedit.php', array('update' => $this->page->cm->id, 'return' => true, 'sesskey' => sesskey()));
2462             $modulenode->add(get_string('settings'), $url, navigation_node::TYPE_SETTING);
2463         }
2464         // Assign local roles
2465         if (count(get_assignable_roles($this->page->cm->context))>0) {
2466             $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->page->cm->context->id));
2467             $modulenode->add(get_string('localroles', 'role'), $url, self::TYPE_SETTING);
2468         }
2469         // Override roles
2470         if (has_capability('moodle/role:review', $this->page->cm->context) or count(get_overridable_roles($this->page->cm->context))>0) {
2471             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->page->cm->context->id));
2472             $modulenode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
2473         }
2474         // Check role permissions
2475         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page->cm->context)) {
2476             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->page->cm->context->id));
2477             $modulenode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
2478         }
2479         // Manage filters
2480         if (has_capability('moodle/filter:manage', $this->page->cm->context) && count(filter_get_available_in_context($this->page->cm->context))>0) {
2481             $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page->cm->context->id));
2482             $modulenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING);
2483         }
2485         $file = $CFG->dirroot.'/mod/'.$this->page->activityname.'/lib.php';
2486         $function = $this->page->activityname.'_extend_settings_navigation';
2488         if (file_exists($file)) {
2489             require_once($file);
2490         }
2491         if (!function_exists($function)) {
2492             return $modulenode;
2493         }
2495         $function($this, $modulenode);
2497         // Remove the module node if there are no children
2498         if (empty($modulenode->children)) {
2499             $modulenode->remove();
2500         }
2502         return $modulenode;
2503     }
2505     /**
2506      * Loads the user settings block of the settings nav
2507      *
2508      * This function is simply works out the userid and whether we need to load
2509      * just the current users profile settings, or the current user and the user the
2510      * current user is viewing.
2511      *
2512      * This function has some very ugly code to work out the user, if anyone has
2513      * any bright ideas please feel free to intervene.
2514      *
2515      * @param int $courseid The course id of the current course
2516      * @return navigation_node|false
2517      */
2518     protected function load_user_settings($courseid=SITEID) {
2519         global $USER, $FULLME, $CFG;
2521         if (isguestuser() || !isloggedin()) {
2522             return false;
2523         }
2525         // This is terribly ugly code, but I couldn't see a better way around it
2526         // we need to pick up the user id, it can be the current user or someone else
2527         // and the key depends on the current location
2528         // Default to look at id
2529         $userkey='id';
2530         if (strpos($FULLME,'/blog/') || strpos($FULLME, $CFG->admin.'/roles/')) {
2531             // And blog and roles just do thier own thing using `userid`
2532             $userkey = 'userid';
2533         } else if ($this->context->contextlevel >= CONTEXT_COURSECAT && strpos($FULLME, '/message/')===false && strpos($FULLME, '/mod/forum/user')===false && strpos($FULLME, '/user/editadvanced')===false) {
2534             // If we have a course context and we are not in message or forum
2535             // Message and forum both pick the user up from `id`
2536             $userkey = 'user';
2537         }
2539         $userid = optional_param($userkey, $USER->id, PARAM_INT);
2540         if ($userid!=$USER->id) {
2541             $usernode = $this->generate_user_settings($courseid, $userid, 'userviewingsettings');
2542             $this->generate_user_settings($courseid, $USER->id);
2543         } else {
2544             $usernode = $this->generate_user_settings($courseid, $USER->id);
2545         }
2546         return $usernode;
2547     }
2549     /**
2550      * This function gets called by {@link load_user_settings()} and actually works out
2551      * what can be shown/done
2552      *
2553      * @param int $courseid The current course' id
2554      * @param int $userid The user id to load for
2555      * @param string $gstitle The string to pass to get_string for the branch title
2556      * @return navigation_node|false
2557      */
2558     protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') {
2559         global $DB, $CFG, $USER, $SITE;
2561         if ($courseid != SITEID) {
2562             if (!empty($this->page->course->id) && $this->page->course->id == $courseid) {
2563                 $course = $this->page->course;
2564             } else {
2565                 $course = $DB->get_record("course", array("id"=>$courseid), '*', MUST_EXIST);
2566             }
2567         } else {
2568             $course = $SITE;
2569         }
2571         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);   // Course context
2572         $systemcontext   = get_system_context();
2573         $currentuser = ($USER->id == $userid);
2575         if ($currentuser) {
2576             $user = $USER;
2577             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
2578         } else {
2579             if (!$user = $DB->get_record('user', array('id'=>$userid))) {
2580                 return false;
2581             }
2582             // Check that the user can view the profile
2583             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
2584             if ($course->id==SITEID) {
2585                 if ($CFG->forceloginforprofiles && !!has_coursemanager_role($user->id) && !has_capability('moodle/user:viewdetails', $usercontext)) {  // Reduce possibility of "browsing" userbase at site level
2586                     // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366)
2587                     return false;
2588                 }
2589             } else {
2590                 if ((!has_capability('moodle/user:viewdetails', $coursecontext) && !has_capability('moodle/user:viewdetails', $usercontext)) || !has_capability('moodle/course:participate', $coursecontext, $user->id, false)) {
2591                     return false;
2592                 }
2593                 if (groups_get_course_groupmode($course) == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $coursecontext)) {
2594                     // If groups are in use, make sure we can see that group
2595                     return false;
2596                 }
2597             }
2598         }
2600         $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $this->page->context));
2602         // Add a user setting branch
2603         $usersetting = $this->add(get_string($gstitle, 'moodle', $fullname));
2604         $usersetting->id = 'usersettings';
2606         // Check if the user has been deleted
2607         if ($user->deleted) {
2608             if (!has_capability('moodle/user:update', $coursecontext)) {
2609                 // We can't edit the user so just show the user deleted message
2610                 $usersetting->add(get_string('userdeleted'), null, self::TYPE_SETTING);
2611             } else {
2612                 // We can edit the user so show the user deleted message and link it to the profile
2613                 $profileurl = new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$course->id));
2614                 $usersetting->add(get_string('userdeleted'), $profileurl, self::TYPE_SETTING);
2615             }
2616             return true;
2617         }
2619         // Add the profile edit link
2620         if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
2621             if (($currentuser || !is_primary_admin($user->id)) && has_capability('moodle/user:update', $systemcontext)) {
2622                 $url = new moodle_url('/user/editadvanced.php', array('id'=>$user->id, 'course'=>$course->id));
2623                 $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
2624             } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_primary_admin($user->id)) || ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
2625                 $url = new moodle_url('/user/edit.php', array('id'=>$user->id, 'course'=>$course->id));
2626                 $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
2627             }
2628         }
2630         // Change password link
2631         if (!empty($user->auth)) {
2632             $userauth = get_auth_plugin($user->auth);
2633             if ($currentuser && !session_is_loggedinas() && $userauth->can_change_password() && !isguestuser() && has_capability('moodle/user:changeownpassword', $systemcontext)) {
2634                 $passwordchangeurl = $userauth->change_password_url();
2635                 if (!$passwordchangeurl) {
2636                     if (empty($CFG->loginhttps)) {
2637                         $wwwroot = $CFG->wwwroot;
2638                     } else {
2639                         $wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
2640                     }
2641                     $passwordchangeurl = new moodle_url('/login/change_password.php');
2642                 } else {
2643                     $urlbits = explode($passwordchangeurl. '?', 1);
2644                     $passwordchangeurl = new moodle_url($urlbits[0]);
2645                     if (count($urlbits)==2 && preg_match_all('#\&([^\=]*?)\=([^\&]*)#si', '&'.$urlbits[1], $matches)) {
2646                         foreach ($matches as $pair) {
2647                             $fullmeurl->param($pair[1],$pair[2]);
2648                         }
2649                     }
2650                 }
2651                 $passwordchangeurl->param('id', $course->id);
2652                 $usersetting->add(get_string("changepassword"), $passwordchangeurl, self::TYPE_SETTING);
2653             }
2654         }
2656         // View the roles settings
2657         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:manage'), $usercontext)) {
2658             $roles = $usersetting->add(get_string('roles'), null, self::TYPE_SETTING);
2660             $url = new moodle_url('/admin/roles/usersroles.php', array('userid'=>$user->id, 'courseid'=>$course->id));
2661             $roles->add(get_string('thisusersroles', 'role'), $url, self::TYPE_SETTING);
2663             $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH);
2665             if (!empty($assignableroles)) {
2666                 $url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
2667                 $roles->add(get_string('assignrolesrelativetothisuser', 'role'), $url, self::TYPE_SETTING);
2668             }
2670             if (has_capability('moodle/role:review', $usercontext) || count(get_overridable_roles($usercontext, ROLENAME_BOTH))>0) {
2671                 $url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
2672                 $roles->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
2673             }
2675             $url = new moodle_url('/admin/roles/check.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
2676             $roles->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
2677         }
2679         // Portfolio
2680         if ($currentuser && !empty($CFG->enableportfolios) && has_capability('moodle/portfolio:export', $systemcontext)) {
2681             require_once($CFG->libdir . '/portfoliolib.php');
2682             if (portfolio_instances(true, false)) {
2683                 $portfolio = $usersetting->add(get_string('portfolios', 'portfolio'), null, self::TYPE_SETTING);
2684                 $portfolio->add(get_string('configure', 'portfolio'), new moodle_url('/user/portfolio.php'), self::TYPE_SETTING);
2685                 $portfolio->add(get_string('logs', 'portfolio'), new moodle_url('/user/portfoliologs.php'), self::TYPE_SETTING);
2686             }
2687         }
2689         // Security keys
2690         if ($currentuser && !is_siteadmin($USER->id) && !empty($CFG->enablewebservices) && has_capability('moodle/webservice:createtoken', $systemcontext)) {
2691             $url = new moodle_url('/user/managetoken.php', array('sesskey'=>sesskey()));
2692             $usersetting->add(get_string('securitykeys', 'webservice'), $url, self::TYPE_SETTING);
2693         }
2695         // Repository
2696         if (!$currentuser) {
2697             require_once($CFG->dirroot . '/repository/lib.php');
2698             $editabletypes = repository::get_editable_types($usercontext);
2699             if ($usercontext->contextlevel == CONTEXT_USER && !empty($editabletypes)) {
2700                 $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$usercontext->id));
2701                 $usersetting->add(get_string('repositories', 'repository'), $url, self::TYPE_SETTING);
2702             }
2703         }
2705         // Messaging
2706         if (has_capability('moodle/user:editownmessageprofile', $systemcontext)) {
2707             $url = new moodle_url('/message/edit.php', array('id'=>$user->id, 'course'=>$course->id));
2708             $usersetting->add(get_string('editmymessage', 'message'), $url, self::TYPE_SETTING);
2709         }
2711         return $usersetting;
2712     }
2714     /**
2715      * Loads block specific settings in the navigation
2716      *
2717      * @return navigation_node
2718      */
2719     protected function load_block_settings() {
2720         global $CFG;
2722         $blocknode = $this->add(print_context_name($this->context));
2723         $blocknode->force_open();
2725         // Assign local roles
2726         $assignurl = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->context->id));
2727         $blocknode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING);
2729         // Override roles
2730         if (has_capability('moodle/role:review', $this->context) or  count(get_overridable_roles($this->context))>0) {
2731             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->context->id));
2732             $blocknode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
2733         }
2734         // Check role permissions
2735         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context)) {
2736             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->context->id));
2737             $blocknode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
2738         }
2740         return $blocknode;
2741     }
2743     /**
2744      * Loads category specific settings in the navigation
2745      *
2746      * @return navigation_node
2747      */
2748     protected function load_category_settings() {
2749         global $CFG;
2751         $categorynode = $this->add(print_context_name($this->context));
2752         $categorynode->force_open();
2754         if ($this->page->user_is_editing() && has_capability('moodle/category:manage', $this->context)) {
2755             $categorynode->add(get_string('editcategorythis'), new moodle_url('/course/editcategory.php', array('id' => $this->context->instanceid)));
2756             $categorynode->add(get_string('addsubcategory'), new moodle_url('/course/editcategory.php', array('parent' => $this->context->instanceid)));
2757         }
2759         // Assign local roles
2760         $assignurl = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->context->id));
2761         $categorynode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING);
2763         // Override roles
2764         if (has_capability('moodle/role:review', $this->context) or count(get_overridable_roles($this->context))>0) {
2765             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->context->id));
2766             $categorynode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
2767         }
2768         // Check role permissions
2769         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context)) {
2770             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->context->id));
2771             $categorynode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
2772         }
2773         // Manage filters
2774         if (has_capability('moodle/filter:manage', $this->context) && count(filter_get_available_in_context($this->context))>0) {
2775             $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->context->id));
2776             $categorynode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING);
2777         }
2779         return $categorynode;
2780     }
2782     /**
2783      * Determine whether the user is assuming another role
2784      *
2785      * This function checks to see if the user is assuming another role by means of
2786      * role switching. In doing this we compare each RSW key (context path) against
2787      * the current context path. This ensures that we can provide the switching
2788      * options against both the course and any page shown under the course.
2789      *
2790      * @return bool|int The role(int) if the user is in another role, false otherwise
2791      */
2792     protected function in_alternative_role() {
2793         global $USER;
2794         if (!empty($USER->access['rsw']) && is_array($USER->access['rsw'])) {
2795             if (!empty($this->page->context) && !empty($USER->access['rsw'][$this->page->context->path])) {
2796                 return $USER->access['rsw'][$this->page->context->path];
2797             }
2798             foreach ($USER->access['rsw'] as $key=>$role) {
2799                 if (strpos($this->context->path,$key)===0) {
2800                     return $role;
2801                 }
2802             }
2803         }
2804         return false;
2805     }
2807     /**
2808      * This function loads all of the front page settings into the settings navigation.
2809      * This function is called when the user is on the front page, or $COURSE==$SITE
2810      * @return navigation_node
2811      */
2812     protected function load_front_page_settings($forceopen = false) {
2813         global $SITE, $CFG;
2815         $course = clone($SITE);
2816         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);   // Course context
2818         $frontpage = $this->add(get_string('frontpagesettings'), null, self::TYPE_SETTING, null, 'frontpage');
2819         if ($forceopen) {
2820             $frontpage->force_open();
2821         }
2822         $frontpage->id = 'frontpagesettings';
2824         if (has_capability('moodle/course:update', $coursecontext)) {
2826             // Add the turn on/off settings
2827             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
2828             if ($this->page->user_is_editing()) {
2829                 $url->param('edit', 'off');
2830                 $editstring = get_string('turneditingoff');
2831             } else {
2832                 $url->param('edit', 'on');
2833                 $editstring = get_string('turneditingon');
2834             }
2835             $frontpage->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
2837             // Add the course settings link
2838             $url = new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings'));
2839             $frontpage->add(get_string('settings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
2840         }
2842         //Participants
2843         if (has_capability('moodle/site:viewparticipants', $coursecontext)) {
2844             $url = new moodle_url('/user/index.php', array('contextid'=>$coursecontext->id));
2845             $frontpage->add(get_string('participants'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/users', ''));
2846         }
2848         // Roles
2849         if (has_capability('moodle/role:assign', $coursecontext)) {
2850             // Add assign or override roles if allowed
2851             $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$coursecontext->id));
2852             $frontpage->add(get_string('assignroles', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2853             // Override roles
2854             if (has_capability('moodle/role:review', $coursecontext) or count(get_overridable_roles($coursecontext))>0) {
2855                 $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$coursecontext->id));
2856                 $frontpage->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2857             }
2858             // Check role permissions
2859             if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $coursecontext)) {
2860                 $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$coursecontext->id));
2861                 $frontpage->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2862             }
2863             // Manage filters
2864             if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
2865                 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
2866                 $frontpage->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
2867             }
2868         }
2870         // Backup this course
2871         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
2872             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
2873             $frontpage->add(get_string('backup'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/backup', ''));
2874         }
2876         // Restore to this course
2877         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
2878             $url = new moodle_url('/files/index.php', array('id'=>$course->id, 'wdir'=>'/backupdata'));
2879             $frontpage->add(get_string('restore'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/restore', ''));
2880         }
2882         // Manage questions
2883         $questioncaps = array('moodle/question:add',
2884                               'moodle/question:editmine',
2885                               'moodle/question:editall',
2886                               'moodle/question:viewmine',
2887                               'moodle/question:viewall',
2888                               'moodle/question:movemine',
2889                               'moodle/question:moveall');
2890         if (has_any_capability($questioncaps, $this->context)) {
2891             $questionlink = $CFG->wwwroot.'/question/edit.php';
2892         } else if (has_capability('moodle/question:managecategory', $this->context)) {
2893             $questionlink = $CFG->wwwroot.'/question/category.php';
2894         }
2895         if (isset($questionlink)) {
2896             $url = new moodle_url($questionlink, array('courseid'=>$course->id));
2897             $frontpage->add(get_string('questions','quiz'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/questions', ''));
2898         }
2900         // Manage files
2901         if (has_capability('moodle/course:managefiles', $this->context)) {
2902             $url = new moodle_url('/files/index.php', array('id'=>$course->id));
2903             $frontpage->add(get_string('files'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/files', ''));
2904         }
2905         return $frontpage;
2906     }
2908     /**
2909      * This function marks the cache as volatile so it is cleared during shutdown
2910      */
2911     public function clear_cache() {
2912         $this->cache->volatile();
2913     }
2916 /**
2917  * Simple class used to output a navigation branch in XML
2918  *
2919  * @package moodlecore
2920  * @subpackage navigation
2921  * @copyright 2009 Sam Hemelryk
2922  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2923  */
2924 class navigation_json {
2925     /** @var array */
2926     protected $nodetype = array('node','branch');
2927     /** @var array */
2928     protected $expandable = array();
2929     /**
2930      * Turns a branch and all of its children into XML
2931      *
2932      * @param navigation_node $branch
2933      * @return string XML string
2934      */
2935     public function convert($branch) {
2936         $xml = $this->convert_child($branch);
2937         return $xml;
2938     }
2939     /**
2940      * Set the expandable items in the array so that we have enough information
2941      * to attach AJAX events
2942      * @param array $expandable
2943      */
2944     public function set_expandable($expandable) {
2945         foreach ($expandable as $node) {
2946             $this->expandable[(string)$node['branchid']] = $node;
2947         }
2948     }
2949     /**
2950      * Recusively converts a child node and its children to XML for output
2951      *
2952      * @param navigation_node $child The child to convert
2953      * @param int $depth Pointlessly used to track the depth of the XML structure
2954      * @return string JSON
2955      */
2956     protected function convert_child($child, $depth=1) {
2957         global $OUTPUT;
2959         if (!$child->display) {
2960             return '';
2961         }
2962         $attributes = array();
2963         $attributes['id'] = $child->id;
2964         $attributes['name'] = $child->text;
2965         $attributes['type'] = $child->type;
2966         $attributes['key'] = $child->key;
2967         $attributes['class'] = $child->get_css_type();
2969         if ($child->icon instanceof pix_icon) {
2970             $attributes['icon'] = array(
2971                 'component' => $child->icon->component,
2972                 'pix' => $child->icon->pix,
2973             );
2974             foreach ($child->icon->attributes as $key=>$value) {
2975                 if ($key == 'class') {
2976                     $attributes['icon']['classes'] = explode(' ', $value);
2977                 } else if (!array_key_exists($key, $attributes['icon'])) {
2978                     $attributes['icon'][$key] = $value;
2979                 }
2981             }
2982         } else if (!empty($child->icon)) {
2983             $attributes['icon'] = (string)$child->icon;
2984         }
2986         if ($child->forcetitle || $child->title !== $child->text) {
2987             $attributes['title'] = htmlentities($child->title);
2988         }
2989         if (array_key_exists((string)$child->key, $this->expandable)) {
2990             $attributes['expandable'] = $child->key;
2991             $child->add_class($this->expandable[$child->key]['id']);
2992         }
2994         if (count($child->classes)>0) {
2995             $attributes['class'] .= ' '.join(' ',$child->classes);
2996         }
2997         if (is_string($child->action)) {
2998             $attributes['link'] = $child->action;
2999         } else if ($child->action instanceof moodle_url) {
3000             $attributes['link'] = $child->action->out();
3001         }
3002         $attributes['hidden'] = ($child->hidden);
3003         $attributes['haschildren'] = ($child->children->count()>0 || $child->type == navigation_node::TYPE_CATEGORY);
3005         if (count($child->children)>0) {
3006             $attributes['children'] = array();
3007             foreach ($child->children as $subchild) {
3008                 $attributes['children'][] = $this->convert_child($subchild, $depth+1);
3009             }
3010         }
3012         if ($depth > 1) {
3013             return $attributes;
3014         } else {
3015             return json_encode($attributes);
3016         }
3017     }
3020 /**
3021  * The cache class used by global navigation and settings navigation to cache bits
3022  * and bobs that are used during their generation.
3023  *
3024  * It is basically an easy access point to session with a bit of smarts to make
3025  * sure that the information that is cached is valid still.
3026  *
3027  * Example use:
3028  * <code php>
3029  * if (!$cache->viewdiscussion()) {
3030  *     // Code to do stuff and produce cachable content
3031  *     $cache->viewdiscussion = has_capability('mod/forum:viewdiscussion', $coursecontext);
3032  * }
3033  * $content = $cache->viewdiscussion;
3034  * </code>
3035  *
3036  * @package moodlecore
3037  * @subpackage navigation
3038  * @copyright 2009 Sam Hemelryk
3039  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3040  */
3041 class navigation_cache {
3042     /** @var int */
3043     protected $creation;
3044     /** @var array */
3045     protected $session;
3046     /** @var string */
3047     protected $area;
3048     /** @var int */
3049     protected $timeout;
3050     /** @var stdClass */
3051     protected $currentcontext;
3052     /** @var int */
3053     const CACHETIME = 0;
3054     /** @var int */
3055     const CACHEUSERID = 1;
3056     /** @var int */
3057     const CACHEVALUE = 2;
3058     /** @var null|array An array of navigation cache areas to expire on shutdown */
3059     public static $volatilecaches;
3061     /**
3062      * Contructor for the cache. Requires two arguments
3063      *
3064      * @param string $area The string to use to segregate this particular cache
3065      *                it can either be unique to start a fresh cache or if you want
3066      *                to share a cache then make it the string used in the original
3067      *                cache
3068      * @param int $timeout The number of seconds to time the information out after
3069      */
3070     public function __construct($area, $timeout=60) {
3071         global $SESSION;
3072         $this->creation = time();
3073         $this->area = $area;
3075         if (!isset($SESSION->navcache)) {
3076             $SESSION->navcache = new stdClass;
3077         }
3079         if (!isset($SESSION->navcache->{$area})) {
3080             $SESSION->navcache->{$area} = array();
3081         }
3082         $this->session = &$SESSION->navcache->{$area};
3083         $this->timeout = time()-$timeout;
3084         if (rand(0,10)===0) {
3085             $this->garbage_collection();
3086         }
3087     }
3089     /**
3090      * Magic Method to retrieve something by simply calling using = cache->key
3091      *
3092      * @param mixed $key The identifier for the information you want out again
3093      * @return void|mixed Either void or what ever was put in
3094      */
3095     public function __get($key) {
3096         if (!$this->cached($key)) {
3097             return;
3098         }
3099         $information = $this->session[$key][self::CACHEVALUE];
3100         return unserialize($information);
3101     }
3103     /**
3104      * Magic method that simply uses {@link set();} to store something in the cache
3105      *
3106      * @param string|int $key
3107      * @param mixed $information
3108      */
3109     public function __set($key, $information) {
3110         $this->set($key, $information);
3111     }
3113     /**
3114      * Sets some information against the cache (session) for later retrieval
3115      *
3116      * @param string|int $key
3117      * @param mixed $information
3118      */
3119     public function set($key, $information) {
3120         global $USER;
3121         $information = serialize($information);
3122         $this->session[$key]= array(self::CACHETIME=>time(), self::CACHEUSERID=>$USER->id, self::CACHEVALUE=>$information);
3123     }
3124     /**
3125      * Check the existence of the identifier in the cache
3126      *
3127      * @param string|int $key
3128      * @return bool
3129      */
3130     public function cached($key) {
3131         global $USER;
3132         if (!array_key_exists($key, $this->session) || !is_array($this->session[$key]) || $this->session[$key][self::CACHEUSERID]!=$USER->id || $this->session[$key][self::CACHETIME] < $this->timeout) {
3133             return false;
3134         }
3135         return true;
3136     }
3137     /**
3138      * Compare something to it's equivilant in the cache
3139      *
3140      * @param string $key
3141      * @param mixed $value
3142      * @param bool $serialise Whether to serialise the value before comparison
3143      *              this should only be set to false if the value is already
3144      *              serialised
3145      * @return bool If the value is the same false if it is not set or doesn't match
3146      */
3147     public function compare($key, $value, $serialise=true) {
3148         if ($this->cached($key)) {
3149             if ($serialise) {
3150                 $value = serialize($value);
3151             }
3152             if ($this->session[$key][self::CACHEVALUE] === $value) {
3153                 return true;
3154             }
3155         }
3156         return false;
3157     }
3158     /**
3159      * Wipes the entire cache, good to force regeneration
3160      */
3161     public function clear() {
3162         $this->session = array();
3163     }
3164     /**
3165      * Checks all cache entries and removes any that have expired, good ole cleanup
3166      */
3167     protected function garbage_collection() {
3168         foreach ($this->session as $key=>$cachedinfo) {
3169             if (is_array($cachedinfo) && $cachedinfo[self::CACHETIME]<$this->timeout) {
3170                 unset($this->session[$key]);
3171             }
3172         }
3173     }
3175     /**
3176      * Marks the cache as being volatile (likely to change)
3177      *
3178      * Any caches marked as volatile will be destroyed at the on shutdown by
3179      * {@link navigation_node::destroy_volatile_caches()} which is registered
3180      * as a shutdown function if any caches are marked as volatile.
3181      *
3182      * @param bool $setting True to destroy the cache false not too
3183      */
3184     public function volatile($setting = true) {
3185         if (self::$volatilecaches===null) {
3186             self::$volatilecaches = array();
3187             register_shutdown_function(array('navigation_cache','destroy_volatile_caches'));
3188         }
3190         if ($setting) {
3191             self::$volatilecaches[$this->area] = $this->area;
3192         } else if (array_key_exists($this->area, self::$volatilecaches)) {
3193             unset(self::$volatilecaches[$this->area]);
3194         }
3195     }
3197     /**
3198      * Destroys all caches marked as volatile
3199      *
3200      * This function is static and works in conjunction with the static volatilecaches
3201      * property of navigation cache.
3202      * Because this function is static it manually resets the cached areas back to an
3203      * empty array.
3204      */
3205     public static function destroy_volatile_caches() {
3206         global $SESSION;
3207         if (is_array(self::$volatilecaches) && count(self::$volatilecaches)>0) {
3208             foreach (self::$volatilecaches as $area) {
3209                 $SESSION->navcache->{$area} = array();
3210             }
3211         }
3212     }