6de4a2b3dd05e8a2f696b7e1c4c6aeba2d437b71
[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         $textlib = textlib_get_instance();
194         if (strlen($this->text)>50) {
195             // Truncate the text to 50 characters
196             $this->text = $textlib->substr($this->text, 0, 50).'...';
197         }
198         if (is_string($this->shorttext) && strlen($this->shorttext)>25) {
199             // Truncate the shorttext
200             $this->shorttext = $textlib->substr($this->shorttext, 0, 25).'...';
201         }
202         // Instantiate a new navigation node collection for this nodes children
203         $this->children = new navigation_node_collection();
204     }
206     /**
207      * Checks if this node is the active node.
208      *
209      * This is determined by comparing the action for the node against the
210      * defined URL for the page. A match will see this node marked as active.
211      *
212      * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
213      * @return bool
214      */
215     public function check_if_active($strength=URL_MATCH_EXACT) {
216         global $FULLME, $PAGE;
217         // Set fullmeurl if it hasn't already been set
218         if (self::$fullmeurl == null) {
219             if ($PAGE->has_set_url()) {
220                 self::override_active_url(new moodle_url($PAGE->url));
221             } else {
222                 self::override_active_url(new moodle_url($FULLME));
223             }
224         }
226         // Compare the action of this node against the fullmeurl
227         if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
228             $this->make_active();
229             return true;
230         }
231         return false;
232     }
234     /**
235      * Overrides the fullmeurl variable providing
236      *
237      * @param moodle_url $url The url to use for the fullmeurl.
238      */
239     public static function override_active_url(moodle_url $url) {
240         self::$fullmeurl = $url;
241     }
243     /**
244      * Adds a navigation node as a child of this node.
245      * 
246      * @param string $text
247      * @param moodle_url|action_link $action
248      * @param int $type
249      * @param string $shorttext
250      * @param string|int $key
251      * @param pix_icon $icon
252      * @return navigation_node
253      */
254     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
255         // First convert the nodetype for this node to a branch as it will now have children
256         if ($this->nodetype !== self::NODETYPE_BRANCH) {
257             $this->nodetype = self::NODETYPE_BRANCH;
258         }
259         // Properties array used when creating the new navigation node
260         $itemarray = array(
261             'text' => $text,
262             'type' => $type
263         );
264         // Set the action if one was provided
265         if ($action!==null) {
266             $itemarray['action'] = $action;
267         }
268         // Set the shorttext if one was provided
269         if ($shorttext!==null) {
270             $itemarray['shorttext'] = $shorttext;
271         }
272         // Set the icon if one was provided
273         if ($icon!==null) {
274             $itemarray['icon'] = $icon;
275         }
276         // Default the key to the number of children if not provided
277         if ($key === null) {
278             $key = $this->children->count();
279         }
280         // Set the key
281         $itemarray['key'] = $key;
282         // Set the parent to this node
283         $itemarray['parent'] = $this;
284         // Add the child using the navigation_node_collections add method
285         $node = $this->children->add(new navigation_node($itemarray));
286         // If the node is a category node or the user is logged in and its a course
287         // then mark this node as a branch (makes it expandable by AJAX)
288         if (($type==self::TYPE_CATEGORY) || (isloggedin() && $type==self::TYPE_COURSE)) {
289             $node->nodetype = self::NODETYPE_BRANCH;
290         }
291         // If this node is hidden mark it's children as hidden also
292         if ($this->hidden) {
293             $node->hidden = true;
294         }
295         // Return the node (reference returned by $this->children->add()
296         return $node;
297     }
299     /**
300      * Searches for a node of the given type with the given key.
301      *
302      * This searches this node plus all of its children, and their children....
303      * If you know the node you are looking for is a child of this node then please
304      * use the get method instead.
305      *
306      * @param int|string $key The key of the node we are looking for
307      * @param int $type One of navigation_node::TYPE_*
308      * @return navigation_node|false
309      */
310     public function find($key, $type) {
311         return $this->children->find($key, $type);
312     }
314     /**
315      * Get ths child of this node that has the given key + (optional) type.
316      *
317      * If you are looking for a node and want to search all children + thier children
318      * then please use the find method instead.
319      *
320      * @param int|string $key The key of the node we are looking for
321      * @param int $type One of navigation_node::TYPE_*
322      * @return navigation_node|false
323      */
324     public function get($key, $type=null) {
325         return $this->children->get($key, $type);
326     }
328     /**
329      * Removes this node.
330      *
331      * @return bool
332      */
333     public function remove() {
334         return $this->parent->children->remove($this->key, $this->type);
335     }
337     /**
338      * Checks if this node has or could have any children
339      *
340      * @return bool Returns true if it has children or could have (by AJAX expansion)
341      */
342     public function has_children() {
343         return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0);
344     }
346     /**
347      * Marks this node as active and forces it open.
348      */
349     public function make_active() {
350         $this->isactive = true;
351         $this->add_class('active_tree_node');
352         $this->force_open();
353         if ($this->parent !== null) {
354             $this->parent->make_inactive();
355         }
356     }
358     /**
359      * Marks a node as inactive and recusised back to the base of the tree
360      * doing the same to all parents.
361      */
362     public function make_inactive() {
363         $this->isactive = false;
364         $this->remove_class('active_tree_node');
365         if ($this->parent !== null) {
366             $this->parent->make_inactive();
367         }
368     }
370     /**
371      * Forces this node to be open and at the same time forces open all
372      * parents until the root node.
373      *
374      * Recursive.
375      */
376     public function force_open() {
377         $this->forceopen = true;
378         if ($this->parent !== null) {
379             $this->parent->force_open();
380         }
381     }
383     /**
384      * Adds a CSS class to this node.
385      *
386      * @param string $class
387      * @return bool
388      */
389     public function add_class($class) {
390         if (!in_array($class, $this->classes)) {
391             $this->classes[] = $class;
392         }
393         return true;
394     }
396     /**
397      * Removes a CSS class from this node.
398      *
399      * @param string $class
400      * @return bool True if the class was successfully removed.
401      */
402     public function remove_class($class) {
403         if (in_array($class, $this->classes)) {
404             $key = array_search($class,$this->classes);
405             if ($key!==false) {
406                 unset($this->classes[$key]);
407                 return true;
408             }
409         }
410         return false;
411     }
413     /**
414      * Sets the title for this node and forces Moodle to utilise it.
415      * @param string $title
416      */
417     public function title($title) {
418         $this->title = $title;
419         $this->forcetitle = true;
420     }
422     /**
423      * Resets the page specific information on this node if it is being unserialised.
424      */
425     public function __wakeup(){
426         $this->forceopen = false;
427         $this->isactive = false;
428         $this->remove_class('active_tree_node');
429     }
431     /**
432      * Checks if this node or any of its children contain the active node.
433      * 
434      * Recursive.
435      *
436      * @return bool
437      */
438     public function contains_active_node() {
439         if ($this->isactive) {
440             return true;
441         } else {
442             foreach ($this->children as $child) {
443                 if ($child->isactive || $child->contains_active_node()) {
444                     return true;
445                 }
446             }
447         }
448         return false;
449     }
451     /**
452      * Finds the active node.
453      *
454      * Searches this nodes children plus all of the children for the active node
455      * and returns it if found.
456      *
457      * Recursive.
458      *
459      * @return navigation_node|false
460      */
461     public function find_active_node() {
462         if ($this->isactive) {
463             return $this;
464         } else {
465             foreach ($this->children as &$child) {
466                 $outcome = $child->find_active_node();
467                 if ($outcome !== false) {
468                     return $outcome;
469                 }
470             }
471         }
472         return false;
473     }
475     /**
476      * Gets the content for this node.
477      *
478      * @param bool $shorttext If true shorttext is used rather than the normal text
479      * @return string
480      */
481     public function get_content($shorttext=false) {
482         if ($shorttext && $this->shorttext!==null) {
483             return format_string($this->shorttext);
484         } else {
485             return format_string($this->text);
486         }
487     }
489     /**
490      * Gets the title to use for this node.
491      * 
492      * @return string
493      */
494     public function get_title() {
495         if ($this->forcetitle || ($this->shorttext!==null && $this->title !== $this->shorttext) || $this->title !== $this->text) {
496             return $this->title;
497         } else {
498             return '';
499         }
500     }
502     /**
503      * Gets the CSS class to add to this node to describe its type
504      * 
505      * @return string
506      */
507     public function get_css_type() {
508         if (array_key_exists($this->type, $this->namedtypes)) {
509             return 'type_'.$this->namedtypes[$this->type];
510         }
511         return 'type_unknown';
512     }
514     /**
515      * Finds all nodes that are expandable by AJAX
516      *
517      * @param array $expandable An array by reference to populate with expandable nodes.
518      */
519     public function find_expandable(array &$expandable) {
520         if (!isloggedin()) {
521             return;
522         }
523         foreach ($this->children as &$child) {
524             if ($child->nodetype == self::NODETYPE_BRANCH && $child->children->count()==0) {
525                 $child->id = 'expandable_branch_'.(count($expandable)+1);
526                 $this->add_class('canexpand');
527                 $expandable[] = array('id'=>$child->id,'branchid'=>$child->key,'type'=>$child->type);
528             }
529             $child->find_expandable($expandable);
530         }
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     /**
757      * Constructs a new global navigation
758      *
759      * @param moodle_page $page The page this navigation object belongs to
760      */
761     public function __construct(moodle_page $page) {
762         global $SITE, $USER;
764         if (during_initial_install()) {
765             return;
766         }
768         // Use the parents consturctor.... good good reuse
769         $properties = array(
770             'key' => 'home',
771             'type' => navigation_node::TYPE_SYSTEM,
772             'text' => get_string('myhome'),
773             'action' => new moodle_url('/my/')
774         );
775         parent::__construct($properties);
777         // Initalise and set defaults
778         $this->page = $page;
779         $this->forceopen = true;
780         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
782         // Check if we need to clear the cache
783         $regenerate = optional_param('regenerate', null, PARAM_TEXT);
784         if ($regenerate === 'navigation') {
785             $this->cache->clear();
786         }
787     }
789     /**
790      * Initialises the navigation object.
791      *
792      * This causes the navigation object to look at the current state of the page
793      * that it is associated with and then load the appropriate content.
794      *
795      * This should only occur the first time that the navigation structure is utilised
796      * which will normally be either when the navbar is called to be displayed or
797      * when a block makes use of it.
798      *
799      * @return bool
800      */
801     public function initialise() {
802         global $SITE, $USER;
803         // Check if it has alread been initialised
804         if ($this->initialised || during_initial_install()) {
805             return true;
806         }
808         // Set up the five base root nodes. These are nodes where we will put our
809         // content and are as follows:
810         // site:        Navigation for the front page.
811         // myprofile:     User profile information goes here.
812         // mycourses:   The users courses get added here.
813         // courses:     Additional courses are added here.
814         // users:       Other users information loaded here.
815         $this->rootnodes = array();
816         $this->rootnodes['site']      = $this->add_course($SITE);
817         $this->rootnodes['myprofile']   = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
818         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses');
819         $this->rootnodes['courses']   = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
820         $this->rootnodes['users']     = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
822         // Fetch all of the users courses.
823         $this->mycourses = get_my_courses($USER->id);
824         // Check if any courses were returned.
825         if (count($this->mycourses) > 0) {
826             // Add all of the users courses to the navigation
827             foreach ($this->mycourses as &$course) {
828               $course->coursenode = $this->add_course($course);
829             }
830         } else {
831             // The user had no specific courses! they could be no logged in, guest
832             // or admin so load all courses instead.
833             $this->load_all_courses();
834         }
836         // Next load context specific content into the navigation
837         switch ($this->page->context->contextlevel) {
838             case CONTEXT_SYSTEM :
839             case CONTEXT_COURSECAT :
840                 // Load the front page course navigation
841                 $this->load_course($SITE);
842                 break;
843             case CONTEXT_BLOCK :
844             case CONTEXT_COURSE :
845                 // Load the course associated with the page into the navigation
846                 $course = $this->page->course;
847                 $coursenode = $this->load_course($course);
848                 // Make it active
849                 $coursenode->make_active();
850                 // Add the essentials such as reports etc...
851                 $this->add_course_essentials($coursenode, $course);
852                 if ($this->format_display_course_content($course->format)) {
853                     // Load the course sections
854                     $sections = $this->load_course_sections($course, $coursenode);
855                 }
856                 break;
857             case CONTEXT_MODULE :
858                 $course = $this->page->course;
859                 $cm = $this->page->cm;
860                 // Load the course associated with the page into the navigation
861                 $coursenode = $this->load_course($course);
862                 $this->add_course_essentials($coursenode, $course);
863                 // Load the course sections into the page
864                 $sections = $this->load_course_sections($course, $coursenode);
865                 if ($course->id !== SITEID) {
866                     // Find the section for the $CM associated with the page and collect
867                     // its section number.
868                     foreach ($sections as $section) {
869                         if ($section->id == $cm->section) {
870                             $cm->sectionnumber = $section->section;
871                             break;
872                         }
873                     }
875                     // Load all of the section activities for the section the cm belongs to.
876                     $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course));
877                     // Finally load the cm specific navigaton information
878                 } else {
879                     $activities = array();
880                     $activities[$cm->id] = $coursenode->get($cm->id, navigation_node::TYPE_ACTIVITY);
881                 }
882                 $this->load_activity($cm, $course, $activities[$cm->id]);
883                 // And make the activity node active.
884                 $activities[$cm->id]->make_active();
885                 break;
886             case CONTEXT_USER :
887                 $course = $this->page->course;
888                 if ($course->id != SITEID) {
889                     // Load the course associated with the user into the navigation
890                     $coursenode = $this->load_course($course);
891                     $this->add_course_essentials($coursenode, $course);
892                     $sections = $this->load_course_sections($course, $coursenode);
893                 }
894                 break;
895         }
897         // Load for the current user
898         $this->load_for_user();
899         // Load each extending user into the navigation.
900         foreach ($this->extendforuser as $user) {
901             if ($user->id !== $USER->id) {
902                 $this->load_for_user($user);
903             }
904         }
906         // Remove any empty root nodes
907         foreach ($this->rootnodes as $node) {
908             if (!$node->has_children()) {
909                 $node->remove();
910             }
911         }
913         // If the user is not logged in modify the navigation structure as detailed
914         // in {@link http://docs.moodle.org/en/Development:Navigation_2.0_structure}
915         if (!isloggedin()) {
916             $activities = clone($this->rootnodes['site']->children);
917             $this->rootnodes['site']->remove();
918             $children = clone($this->children);
919             $this->children = new navigation_node_collection();
920             foreach ($activities as $child) {
921                 $this->children->add($child);
922             }
923             foreach ($children as $child) {
924                 $this->children->add($child);
925             }
926             $this->action = new moodle_url('/');
927         }
929         $this->initialised = true;
930         return true;
931     }
932     /**
933      * Checks the course format to see whether it wants the navigation to load
934      * additional information for the course.
935      *
936      * This function utilises a callback that can exist within the course format lib.php file
937      * The callback should be a function called:
938      * callback_{formatname}_display_content()
939      * It doesn't get any arguments and should return true if additional content is
940      * desired. If the callback doesn't exist we assume additional content is wanted.
941      *
942      * @param string $format The course format
943      * @return bool
944      */
945     protected function format_display_course_content($format) {
946         global $CFG;
947         $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
948         if (file_exists($formatlib)) {
949             require_once($formatlib);
950             $displayfunc = 'callback_'.$format.'_display_content';
951             if (function_exists($displayfunc) && !$displayfunc()) {
952                 return $displayfunc();
953             }
954         }
955         return true;
956     }
958     /**
959      * Loads of the the courses in Moodle into the navigation.
960      *
961      * @return array An array of navigation_node
962      */
963     protected function load_all_courses() {
964         global $DB, $USER;
965         list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
966         $sql = "SELECT c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.category,cat.path AS categorypath $ccselect
967                 FROM {course} c
968                 $ccjoin
969                 LEFT JOIN {course_categories} cat ON cat.id=c.category
970                 WHERE c.id != :siteid
971                 ORDER BY c.sortorder ASC";
972         $courses = $DB->get_records_sql($sql, array('siteid'=>SITEID));
973         $coursenodes = array();
974         foreach ($courses as $course) {
975             context_instance_preload($course);
976             $coursenodes[$course->id] = $this->add_course($course);
977         }
978         return $coursenodes;
979     }
981     /**
982      * Loads the given course into the navigation
983      *
984      * @param stdClass $course
985      * @return navigation_node
986      */
987     protected function load_course(stdClass $course) {
988         if ($course->id == SITEID) {
989             $coursenode = $this->rootnodes['site'];
990         } else if (array_key_exists($course->id, $this->mycourses)) {
991             if (!isset($this->mycourses[$course->id]->coursenode)) {
992                 $this->mycourses[$course->id]->coursenode = $this->add_course($course);
993             }
994             $coursenode = $this->mycourses[$course->id]->coursenode;
995         } else {
996             $coursenode = $this->add_course($course);
997         }
998         return $coursenode;
999     }
1001     /**
1002      * Loads all of the courses section into the navigation.
1003      *
1004      * This function utilisies a callback that can be implemented within the course
1005      * formats lib.php file to customise the navigation that is generated at this
1006      * point for the course.
1007      *
1008      * By default (if not defined) the method {@see load_generic_course_sections} is
1009      * called instead.
1010      *
1011      * @param stdClass $course Database record for the course
1012      * @param navigation_node $coursenode The course node within the navigation
1013      * @return array Array of navigation nodes for the section with key = section id
1014      */
1015     protected function load_course_sections(stdClass $course, navigation_node $coursenode) {
1016         global $CFG;
1017         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
1018         $structurefunc = 'callback_'.$course->format.'_load_content';
1019         if (function_exists($structurefunc)) {
1020             return $structurefunc($this, $course, $coursenode);
1021         } else if (file_exists($structurefile)) {
1022             require_once $structurefile;
1023             if (function_exists($structurefunc)) {
1024                 return $structurefunc($this, $course, $coursenode);
1025             } else {
1026                 return $this->load_generic_course_sections($course, $coursenode, get_string('topic'), 'topic');
1027             }
1028         } else {
1029             return $this->load_generic_course_sections($course, $coursenode, get_string('topic'), 'topic');
1030         }
1031     }
1033     /**
1034      * Generically loads the course sections into the course's navigation.
1035      *
1036      * @param stdClass $course
1037      * @param navigation_node $coursenode
1038      * @param string $name The string that identifies each section. e.g Topic, or Week
1039      * @param string $activeparam The url used to identify the active section
1040      * @return array An array of course section nodes
1041      */
1042     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $name, $activeparam) {
1043         $modinfo = get_fast_modinfo($course);
1044         $sections = array_slice(get_all_sections($course->id), 0, $course->numsections+1, true);
1045         $viewhiddensections = has_capability('moodle/course:viewhiddensections', $this->page->context);
1047         $strgeneral = get_string('general');
1048         foreach ($sections as &$section) {
1049             if ($course->id == SITEID) {
1050                 $this->load_section_activities($coursenode, $section->section, $modinfo);
1051             } else {
1052                 if ((!$viewhiddensections && !$section->visible) || (!$this->showemptysections && !array_key_exists($section->section, $modinfo->sections))) {
1053                     continue;
1054                 }
1055                 if ($section->section == 0) {
1056                     $sectionname = $strgeneral;
1057                 } else {
1058                     $sectionname = $name.' '.$section->section;
1059                 }
1060                 $url = new moodle_url('/course/view.php', array('id'=>$course->id, $activeparam=>$section->section));
1061                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1062                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1063                 $sectionnode->hidden = (!$section->visible);
1064                 if ($sectionnode->isactive) {
1065                     $this->load_section_activities($sectionnode, $section->section, $modinfo);
1066                 }
1067                 $section->sectionnode = $sectionnode;
1068             }
1069         }
1070         return $sections;
1071     }
1072     /**
1073      * Loads all of the activities for a section into the navigation structure.
1074      *
1075      * @param navigation_node $sectionnode
1076      * @param int $sectionnumber
1077      * @param stdClass $modinfo Object returned from {@see get_fast_modinfo()}
1078      * @return array Array of activity nodes
1079      */
1080     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, $modinfo) {
1081         if (!array_key_exists($sectionnumber, $modinfo->sections)) {
1082             return true;
1083         }
1085         $viewhiddenactivities = has_capability('moodle/course:viewhiddenactivities', $this->page->context);
1087         $activities = array();
1089         foreach ($modinfo->sections[$sectionnumber] as $cmid) {
1090             $cm = $modinfo->cms[$cmid];
1091             if (!$viewhiddenactivities && !$cm->visible) {
1092                 continue;
1093             }
1094             if ($cm->icon) {
1095                 $icon = new pix_icon($cm->icon, '', $cm->iconcomponent);
1096             } else {
1097                 $icon = new pix_icon('icon', '', $cm->modname);
1098             }
1099             $url = new moodle_url('/mod/'.$cm->modname.'/view.php', array('id'=>$cm->id));
1100             $activitynode = $sectionnode->add($cm->name, $url, navigation_node::TYPE_ACTIVITY, $cm->name, $cm->id, $icon);
1101             $activitynode->title(get_string('modulename', $cm->modname));
1102             $activitynode->hidden = (!$cm->visible);
1103             if ($this->module_extends_navigation($cm->modname)) {
1104                 $child->nodetype = navigation_node::NODETYPE_BRANCH;
1105             }
1106             $activities[$cmid] = $activitynode;
1107         }
1109         return $activities;
1110     }
1111     /**
1112      * Loads the navigation structure for the given activity into the activities node.
1113      *
1114      * This method utilises a callback within the modules lib.php file to load the
1115      * content specific to activity given.
1116      *
1117      * The callback is a method: {modulename}_extend_navigation()
1118      * Examples:
1119      *  * {@see forum_extend_navigation()}
1120      *  * {@see workshop_extend_navigation()}
1121      *
1122      * @param stdClass $cm
1123      * @param stdClass $course
1124      * @param navigation_node $activity
1125      * @return bool
1126      */
1127     protected function load_activity(stdClass $cm, stdClass $course, navigation_node $activity) {
1128         global $CFG, $DB;
1130         $activity->make_active();
1131         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
1132         $function = $cm->modname.'_extend_navigation';
1134         if (file_exists($file)) {
1135             require_once($file);
1136             if (function_exists($function)) {
1137                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
1138                 $function($activity, $course, $activtyrecord, $cm);
1139                 return true;
1140             }
1141         }
1142         $activity->nodetype = navigation_node::NODETYPE_LEAF;
1143         return false;
1144     }
1145     /**
1146      * Loads user specific information into the navigation in the appopriate place.
1147      *
1148      * If no user is provided the current user is assumed.
1149      *
1150      * @param stdClass $user
1151      * @return bool
1152      */
1153     protected function load_for_user($user=null) {
1154         global $DB, $CFG, $USER;
1156         $iscurrentuser = false;
1157         if ($user === null) {
1158             // We can't require login here but if the user isn't logged in we don't
1159             // want to show anything
1160             if (!isloggedin()) {
1161                 return false;
1162             }
1163             $user = $USER;
1164             $iscurrentuser = true;
1165         } else if (!is_object($user)) {
1166             // If the user is not an object then get them from the database
1167             $user = $DB->get_record('user', array('id'=>(int)$user), '*', MUST_EXIST);
1168         }
1169         $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1171         // Get the course set against the page, by default this will be the site
1172         $course = $this->page->course;
1173         $baseargs = array('id'=>$user->id);
1174         if ($course->id !== SITEID) {
1175             if (array_key_exists($course->id, $this->mycourses)) {
1176                 $coursenode = $this->mycourses[$course->id]->coursenode;
1177             } else {
1178                 $coursenode = $this->rootnodes['courses']->find($course->id, navigation_node::TYPE_COURSE);
1179                 if (!$coursenode) {
1180                     $coursenode = $this->load_course($course);
1181                 }
1182             }
1183             $baseargs['course'] = $course->id;
1184             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1185             $issitecourse = false;
1186         } else {
1187             // Load all categories and get the context for the system
1188             $coursecontext = get_context_instance(CONTEXT_SYSTEM);
1189             $issitecourse = true;
1190         }
1192         // Create a node to add user information under.
1193         if ($iscurrentuser) {
1194             // If it's the current user the information will go under the profile root node
1195             $usernode = $this->rootnodes['myprofile'];
1196         } else {
1197             if (!$issitecourse) {
1198                 // Not the current user so add it to the participants node for the current course
1199                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
1200             } else {
1201                 // This is the site so add a users node to the root branch
1202                 $usersnode = $this->rootnodes['users'];
1203                 $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
1204             }
1205             // Add a branch for the current user
1206             $usernode = $usersnode->add(fullname($user, true));
1207         }
1209         if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
1210             $usernode->force_open();
1211         }
1213         // If the user is the current user or has permission to view the details of the requested
1214         // user than add a view profile link.
1215         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
1216             $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
1217         }
1219         // Add nodes for forum posts and discussions if the user can view either or both
1220         $canviewposts = has_capability('moodle/user:readuserposts', $usercontext);
1221         $canviewdiscussions = has_capability('mod/forum:viewdiscussion', $coursecontext);
1222         if ($canviewposts || $canviewdiscussions) {
1223             $forumtab = $usernode->add(get_string('forumposts', 'forum'));
1224             if ($canviewposts) {
1225                 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
1226             }
1227             if ($canviewdiscussions) {
1228                 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
1229             }
1230         }
1232         // Add a node to view the users notes if permitted
1233         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
1234             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
1235             if ($coursecontext->instanceid) {
1236                 $url->param('course', $coursecontext->instanceid);
1237             }
1238             $usernode->add(get_string('notes', 'notes'), $url);
1239         }
1241         // Add a reports tab and then add reports the the user has permission to see.
1242         $reporttab = $usernode->add(get_string('activityreports'));
1243         $anyreport  = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
1244         $viewreports = ($anyreport || ($course->showreports && $iscurrentuser));
1245         $reportargs = array('user'=>$user->id);
1246         if (!empty($course->id)) {
1247             $reportargs['id'] = $course->id;
1248         } else {
1249             $reportargs['id'] = SITEID;
1250         }
1251         if ($viewreports || has_capability('coursereport/outline:view', $coursecontext)) {
1252             $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
1253             $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
1254         }
1256         if ($viewreports || has_capability('coursereport/log:viewtoday', $coursecontext)) {
1257             $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
1258         }
1260         if ($viewreports || has_capability('coursereport/log:view', $coursecontext)) {
1261             $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
1262         }
1264         if (!empty($CFG->enablestats)) {
1265             if ($viewreports || has_capability('coursereport/stats:view', $coursecontext)) {
1266                 $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
1267             }
1268         }
1270         $gradeaccess = false;
1271         if (has_capability('moodle/grade:viewall', $coursecontext)) {
1272             //ok - can view all course grades
1273             $gradeaccess = true;
1274         } else if ($course->showgrades) {
1275             if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) {
1276                 //ok - can view own grades
1277                 $gradeaccess = true;
1278             } else if (has_capability('moodle/grade:viewall', $usercontext)) {
1279                 // ok - can view grades of this user - parent most probably
1280                 $gradeaccess = true;
1281             } else if ($anyreport) {
1282                 // ok - can view grades of this user - parent most probably
1283                 $gradeaccess = true;
1284             }
1285         }
1286         if ($gradeaccess) {
1287             $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'grade'))));
1288         }
1290         // Check the number of nodes in the report node... if there are none remove
1291         // the node
1292         if (count($reporttab->children)===0) {
1293             $usernode->remove_child($reporttab);
1294         }
1296         // If the user is the current user add the repositories for the current user
1297         if ($iscurrentuser) {
1298             require_once($CFG->dirroot . '/repository/lib.php');
1299             $editabletypes = repository::get_editable_types($usercontext);
1300             if (!empty($editabletypes)) {
1301                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
1302             }
1303         }
1304         return true;
1305     }
1307     /**
1308      * This method simply checks to see if a given module can extend the navigation.
1309      *
1310      * @param string $modname
1311      * @return bool
1312      */
1313     protected function module_extends_navigation($modname) {
1314         global $CFG;
1315         if ($this->cache->cached($modname.'_extends_navigation')) {
1316             return $this->cache->{$modname.'_extends_navigation'};
1317         }
1318         $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
1319         $function = $modname.'_extend_navigation';
1320         if (function_exists($function)) {
1321             $this->cache->{$modname.'_extends_navigation'} = true;
1322             return true;
1323         } else if (file_exists($file)) {
1324             require_once($file);
1325             if (function_exists($function)) {
1326                 $this->cache->{$modname.'_extends_navigation'} = true;
1327                 return true;
1328             }
1329         }
1330         $this->cache->{$modname.'_extends_navigation'} = false;
1331         return false;
1332     }
1333     /**
1334      * Extends the navigation for the given user.
1335      * 
1336      * @param stdClass $user A user from the database
1337      */
1338     public function extend_for_user($user) {
1339         $this->extendforuser[] = $user;
1340     }
1341     /**
1342      * Adds the given course to the navigation structure.
1343      *
1344      * @param stdClass $course
1345      * @return navigation_node
1346      */
1347     public function add_course(stdClass $course) {
1348         if (array_key_exists($course->id, $this->addedcourses)) {
1349             return $this->addedcourses[$course->id];
1350         }
1352         $canviewhidden = has_capability('moodle/course:viewhiddencourses', $this->page->context);
1353         if ($course->id !== SITEID && !$canviewhidden && (!$course->visible || !course_parent_visible($course))) {
1354             return false;
1355         }
1357         if ($course->id == SITEID) {
1358             $parent = $this;
1359             $url = new moodle_url('/');
1360         } else if (array_key_exists($course->id, $this->mycourses)) {
1361             $parent = $this->rootnodes['mycourses'];
1362             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
1363         } else {
1364             $parent = $this->rootnodes['courses'];
1365             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
1366         }
1367         $coursenode = $parent->add($course->fullname, $url, self::TYPE_COURSE, $course->shortname, $course->id);
1368         $coursenode->nodetype = self::NODETYPE_BRANCH;
1369         $coursenode->hidden = (!$course->visible);
1370         $this->addedcourses[$course->id] = &$coursenode;
1371         return $coursenode;
1372     }
1373     /**
1374      * Adds essential course nodes to the navigation for the given course.
1375      *
1376      * This method adds nodes such as reports, blogs and participants
1377      *
1378      * @param navigation_node $coursenode
1379      * @param stdClass $course
1380      * @return bool
1381      */
1382     public function add_course_essentials(navigation_node $coursenode, stdClass $course) {
1383         global $CFG;
1385         if ($course->id === SITEID) {
1386             return $this->add_front_page_course_essentials($coursenode, $course);
1387         }
1389         if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
1390             return true;
1391         }
1393         //Participants
1394         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
1395             require_once($CFG->dirroot.'/blog/lib.php');
1396             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
1397             $currentgroup = groups_get_course_group($course, true);
1398             if ($course->id == SITEID) {
1399                 $filterselect = '';
1400             } else if ($course->id && !$currentgroup) {
1401                 $filterselect = $course->id;
1402             } else {
1403                 $filterselect = $currentgroup;
1404             }
1405             $filterselect = clean_param($filterselect, PARAM_INT);
1406             if ($CFG->bloglevel >= 3) {
1407                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
1408                 $participants->add(get_string('blogs','blog'), $blogsurls->out());
1409             }
1410             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
1411                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
1412             }
1413         } else if (count($this->extendforuser) > 0) {
1414             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
1415         }
1417         // View course reports
1418         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
1419             $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', ''));
1420             $coursereports = get_plugin_list('coursereport');
1421             foreach ($coursereports as $report=>$dir) {
1422                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
1423                 if (file_exists($libfile)) {
1424                     require_once($libfile);
1425                     $reportfunction = $report.'_report_extend_navigation';
1426                     if (function_exists($report.'_report_extend_navigation')) {
1427                         $reportfunction($reportnav, $course, $this->page->context);
1428                     }
1429                 }
1430             }
1431         }
1432         return true;
1433     }
1435     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
1436         global $CFG;
1438         if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CUSTOM)) {
1439             return true;
1440         }
1442         //Participants
1443         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
1444             require_once($CFG->dirroot.'/blog/lib.php');
1445             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
1446         }
1447         
1448         $currentgroup = groups_get_course_group($course, true);
1449         if ($course->id == SITEID) {
1450             $filterselect = '';
1451         } else if ($course->id && !$currentgroup) {
1452             $filterselect = $course->id;
1453         } else {
1454             $filterselect = $currentgroup;
1455         }
1456         $filterselect = clean_param($filterselect, PARAM_INT);
1457         if ($CFG->bloglevel >= 3) {
1458             $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
1459             $coursenode->add(get_string('blogs','blog'), $blogsurls->out());
1460         }
1461         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
1462             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
1463         }
1464         if (!empty($CFG->usetags)) {
1465             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
1466         }
1469         // View course reports
1470         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
1471             $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', ''));
1472             $coursereports = get_plugin_list('coursereport');
1473             foreach ($coursereports as $report=>$dir) {
1474                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
1475                 if (file_exists($libfile)) {
1476                     require_once($libfile);
1477                     $reportfunction = $report.'_report_extend_navigation';
1478                     if (function_exists($report.'_report_extend_navigation')) {
1479                         $reportfunction($reportnav, $course, $this->page->context);
1480                     }
1481                 }
1482             }
1483         }
1484         return true;
1485     }
1487     /**
1488      * Clears the navigation cache
1489      */
1490     public function clear_cache() {
1491         $this->cache->clear();
1492     }
1495 /**
1496  * The limited global navigation class used for the AJAX extension of the global
1497  * navigation class.
1498  *
1499  * The primary methods that are used in the global navigation class have been overriden
1500  * to ensure that only the relevant branch is generated at the root of the tree.
1501  * This can be done because AJAX is only used when the backwards structure for the
1502  * requested branch exists.
1503  * This has been done only because it shortens the amounts of information that is generated
1504  * which of course will speed up the response time.. because no one likes laggy AJAX.
1505  *
1506  * @package moodlecore
1507  * @subpackage navigation
1508  * @copyright 2009 Sam Hemelryk
1509  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1510  */
1511 class global_navigation_for_ajax extends global_navigation {
1513     /** @var array */
1514     protected $expandable = array();
1516     /**
1517      * Constructs the navigation for use in AJAX request
1518      */
1519     public function __construct() {
1520         global $SITE;
1521         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
1522         $this->children = new navigation_node_collection();
1523         $this->rootnodes = array();
1524         //$this->rootnodes['site']      = $this->add_course($SITE);
1525         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
1526     }
1527     /**
1528      * Initialise the navigation given the type and id for the branch to expand.
1529      *
1530      * @param int $branchtype One of navigation_node::TYPE_*
1531      * @param int $id
1532      * @return array The expandable nodes
1533      */
1534     public function initialise($branchtype, $id) {
1535         global $DB, $PAGE;
1537         if ($this->initialised || during_initial_install()) {
1538             return $this->expandable;
1539         }
1541         // Branchtype will be one of navigation_node::TYPE_*
1542         switch ($branchtype) {
1543             case self::TYPE_COURSE :
1544                 $course = $DB->get_record('course', array('id' => $id), '*', MUST_EXIST);
1545                 require_course_login($course);
1546                 $this->page = $PAGE;
1547                 $coursenode = $this->add_course($course);
1548                 $this->add_course_essentials($coursenode, $course);
1549                 if ($this->format_display_course_content($course->format)) {
1550                     $this->load_course_sections($course, $coursenode);
1551                 }
1552                 break;
1553             case self::TYPE_SECTION :
1554                 $sql = 'SELECT c.*, cs.section AS sectionnumber
1555                         FROM {course} c
1556                         LEFT JOIN {course_sections} cs ON cs.course = c.id
1557                         WHERE cs.id = ?';
1558                 $course = $DB->get_record_sql($sql, array($id), MUST_EXIST);
1559                 require_course_login($course);
1560                 $this->page = $PAGE;
1561                 $coursenode = $this->add_course($course);
1562                 $this->add_course_essentials($coursenode, $course);
1563                 $sections = $this->load_course_sections($course, $coursenode);
1564                 $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, get_fast_modinfo($course));
1565                 break;
1566             case self::TYPE_ACTIVITY :
1567                 $cm = get_coursemodule_from_id(false, $id, 0, false, MUST_EXIST);
1568                 $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
1569                 require_course_login($course, true, $cm);
1570                 $this->page = $PAGE;
1571                 $coursenode = $this->load_course($course);
1572                 $sections = $this->load_course_sections($course, $coursenode);
1573                 foreach ($sections as $section) {
1574                     if ($section->id == $cm->section) {
1575                         $cm->sectionnumber = $section->section;
1576                         break;
1577                     }
1578                 }
1579                 $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course));
1580                 $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]);
1581                 break;
1582             default:
1583                 throw new Exception('Unknown type');
1584                 return $this->expandable;
1585         }
1587         $this->find_expandable($this->expandable);
1588         return $this->expandable;
1589     }
1592 /**
1593  * Navbar class
1594  *
1595  * This class is used to manage the navbar, which is initialised from the navigation
1596  * object held by PAGE
1597  *
1598  * @package moodlecore
1599  * @subpackage navigation
1600  * @copyright 2009 Sam Hemelryk
1601  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1602  */
1603 class navbar extends navigation_node {
1604     /** @var bool */
1605     protected $initialised = false;
1606     /** @var mixed */
1607     protected $keys = array();
1608     /** @var null|string */
1609     protected $content = null;
1610     /** @var moodle_page object */
1611     protected $page;
1612     /** @var bool */
1613     protected $ignoreactive = false;
1614     /** @var bool */
1615     protected $duringinstall = false;
1616     /** @var bool */
1617     protected $hasitems = false;
1618     /** @var array */
1619     protected $items;
1620     /** @var array */
1621     public $children = array();
1622     /**
1623      * The almighty constructor
1624      *
1625      * @param moodle_page $page
1626      */
1627     public function __construct(moodle_page $page) {
1628         global $CFG;
1629         if (during_initial_install()) {
1630             $this->duringinstall = true;
1631             return false;
1632         }
1633         $this->page = $page;
1634         $this->text = get_string('home');
1635         $this->shorttext = get_string('home');
1636         $this->action = new moodle_url($CFG->wwwroot);
1637         $this->nodetype = self::NODETYPE_BRANCH;
1638         $this->type = self::TYPE_SYSTEM;
1639     }
1641     /**
1642      * Quick check to see if the navbar will have items in.
1643      *
1644      * @return bool Returns true if the navbar will have items, false otherwise
1645      */
1646     public function has_items() {
1647         if ($this->duringinstall) {
1648             return false;
1649         } else if ($this->hasitems !== false) {
1650             return true;
1651         }
1652         $this->page->navigation->initialise($this->page);
1654         $activenodefound = ($this->page->navigation->contains_active_node() ||
1655                             $this->page->settingsnav->contains_active_node());
1657         $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
1658         $this->hasitems = $outcome;
1659         return $outcome;
1660     }
1662     /**
1663      * Turn on/off ignore active
1664      *
1665      * @param bool $setting
1666      */
1667     public function ignore_active($setting=true) {
1668         $this->ignoreactive = ($setting);
1669     }
1670     public function get($key, $type = null) {
1671         foreach ($this->children as &$child) {
1672             if ($child->key === $key && ($type == null || $type == $child->type)) {
1673                 return $child;
1674             }
1675         }
1676         return false;
1677     }
1678     /**
1679      * Returns an array of navigation_node's that make up the navbar.
1680      * 
1681      * @return array
1682      */
1683     public function get_items() {
1684         $items = array();
1685         // Make sure that navigation is initialised
1686         if (!$this->has_items()) {
1687             return $items;
1688         }
1689         if ($this->items !== null) {
1690             return $this->items;
1691         }
1693         if (count($this->children) > 0) {
1694             // Add the custom children
1695             $items = array_reverse($this->children);
1696         }
1698         $navigationactivenode = $this->page->navigation->find_active_node();
1699         $settingsactivenode = $this->page->settingsnav->find_active_node();
1701         // Check if navigation contains the active node
1702         if (!$this->ignoreactive) {
1703             
1704             if ($navigationactivenode && $settingsactivenode) {
1705                 // Parse a combined navigation tree
1706                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
1707                     if (!$settingsactivenode->mainnavonly) {
1708                         $items[] = $settingsactivenode;
1709                     }
1710                     $settingsactivenode = $settingsactivenode->parent;
1711                 }
1712                 // Removes the first node from the settings (root node) from the list
1713                 array_pop($items);
1714                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
1715                     if (!$navigationactivenode->mainnavonly) {
1716                         $items[] = $navigationactivenode;
1717                     }
1718                     $navigationactivenode = $navigationactivenode->parent;
1719                 }
1720             } else if ($navigationactivenode) {
1721                 // Parse the navigation tree to get the active node
1722                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
1723                     if (!$navigationactivenode->mainnavonly) {
1724                         $items[] = $navigationactivenode;
1725                     }
1726                     $navigationactivenode = $navigationactivenode->parent;
1727                 }
1728             } else if ($settingsactivenode) {
1729                 // Parse the settings navigation to get the active node
1730                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
1731                     if (!$settingsactivenode->mainnavonly) {
1732                         $items[] = $settingsactivenode;
1733                     }
1734                     $settingsactivenode = $settingsactivenode->parent;
1735                 }
1736             }
1737         }
1739         $items[] = new navigation_node(array(
1740             'text'=>$this->page->navigation->text,
1741             'shorttext'=>$this->page->navigation->shorttext,
1742             'key'=>$this->page->navigation->key,
1743             'action'=>$this->page->navigation->action
1744         ));
1746         $this->items = array_reverse($items);
1747         return $this->items;
1748     }
1750     /**
1751      * Add a new navigation_node to the navbar, overrides parent::add
1752      *
1753      * This function overrides {@link navigation_node::add()} so that we can change
1754      * the way nodes get added to allow us to simply call add and have the node added to the
1755      * end of the navbar
1756      *
1757      * @param string $text
1758      * @param string|moodle_url $action
1759      * @param int $type
1760      * @param string|int $key
1761      * @param string $shorttext
1762      * @param string $icon
1763      * @return navigation_node
1764      */
1765     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
1766         if ($this->content !== null) {
1767             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
1768         }
1769         
1770         // Properties array used when creating the new navigation node
1771         $itemarray = array(
1772             'text' => $text,
1773             'type' => $type
1774         );
1775         // Set the action if one was provided
1776         if ($action!==null) {
1777             $itemarray['action'] = $action;
1778         }
1779         // Set the shorttext if one was provided
1780         if ($shorttext!==null) {
1781             $itemarray['shorttext'] = $shorttext;
1782         }
1783         // Set the icon if one was provided
1784         if ($icon!==null) {
1785             $itemarray['icon'] = $icon;
1786         }
1787         // Default the key to the number of children if not provided
1788         if ($key === null) {
1789             $key = count($this->children);
1790         }
1791         // Set the key
1792         $itemarray['key'] = $key;
1793         // Set the parent to this node
1794         $itemarray['parent'] = $this;
1795         // Add the child using the navigation_node_collections add method
1796         $this->children[] = new navigation_node($itemarray);
1797         return $this;
1798     }
1801 /**
1802  * Class used to manage the settings option for the current page
1803  *
1804  * This class is used to manage the settings options in a tree format (recursively)
1805  * and was created initially for use with the settings blocks.
1806  *
1807  * @package moodlecore
1808  * @subpackage navigation
1809  * @copyright 2009 Sam Hemelryk
1810  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1811  */
1812 class settings_navigation extends navigation_node {
1813     /** @var stdClass */
1814     protected $context;
1815     /** @var navigation_cache */
1816     protected $cache;
1817     /** @var moodle_page */
1818     protected $page;
1819     /** @var string */
1820     protected $adminsection;
1821     /**
1822      * Sets up the object with basic settings and preparse it for use
1823      * 
1824      * @param moodle_page $page
1825      */
1826     public function __construct(moodle_page &$page) {
1827         if (during_initial_install()) {
1828             return false;
1829         }
1830         $this->page = $page;
1831         // Initialise the main navigation. It is most important that this is done
1832         // before we try anything
1833         $this->page->navigation->initialise();
1834         // Initialise the navigation cache
1835         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
1836         $this->children = new navigation_node_collection();
1837     }
1838     /**
1839      * Initialise the settings navigation based on the current context
1840      *
1841      * This function initialises the settings navigation tree for a given context
1842      * by calling supporting functions to generate major parts of the tree.
1843      *
1844      */
1845     public function initialise() {
1846         global $DB;
1848         if (during_initial_install()) {
1849             return false;
1850         }
1851         $this->id = 'settingsnav';
1852         $this->context = $this->page->context;
1854         $context = $this->context;
1855         if ($context->contextlevel == CONTEXT_BLOCK) {
1856             $this->load_block_settings();
1857             $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));
1858         }
1860         switch ($context->contextlevel) {
1861             case CONTEXT_SYSTEM:
1862                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
1863                     $this->load_front_page_settings(($context->id == $this->context->id));
1864                 }
1865                 break;
1866             case CONTEXT_COURSECAT:
1867                 $this->load_category_settings();
1868                 break;
1869             case CONTEXT_COURSE:
1870                 if ($this->page->course->id != SITEID) {
1871                     $this->load_course_settings(($context->id == $this->context->id));
1872                 } else {
1873                     $this->load_front_page_settings(($context->id == $this->context->id));
1874                 }
1875                 break;
1876             case CONTEXT_MODULE:
1877                 $this->load_module_settings();
1878                 $this->load_course_settings();
1879                 break;
1880             case CONTEXT_USER:
1881                 if ($this->page->course->id != SITEID) {
1882                     $this->load_course_settings();
1883                 }
1884                 break;
1885         }
1887         $settings = $this->load_user_settings($this->page->course->id);
1888         $admin = $this->load_administration_settings();
1890         if ($context->contextlevel == CONTEXT_SYSTEM && $admin) {
1891             $admin->force_open();
1892         } else if ($context->contextlevel == CONTEXT_USER && $settings) {
1893             $settings->force_open();
1894         }
1896         // Check if the user is currently logged in as another user
1897         if (session_is_loggedinas()) {
1898             // Get the actual user, we need this so we can display an informative return link
1899             $realuser = session_get_realuser();
1900             // Add the informative return to original user link
1901             $url = new moodle_url('/course/loginas.php',array('id'=>$this->page->course->id, 'return'=>1,'sesskey'=>sesskey()));
1902             $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self::TYPE_SETTING, null, null, new pix_icon('t/left', ''));
1903         }
1905         // Make sure the first child doesnt have proceed with hr set to true
1907         foreach ($this->children as $key=>$node) {
1908             if ($node->nodetype != self::NODETYPE_BRANCH || $node->children->count()===0) {
1909                 $node->remove();
1910             }
1911         }
1912     }
1913     /**
1914      * Override the parent function so that we can add preceeding hr's and set a
1915      * root node class against all first level element
1916      *
1917      * It does this by first calling the parent's add method {@link navigation_node::add()}
1918      * and then proceeds to use the key to set class and hr
1919      *
1920      * @param string $text
1921      * @param sting|moodle_url $url
1922      * @param string $shorttext
1923      * @param string|int $key
1924      * @param int $type
1925      * @param string $icon
1926      * @return navigation_node
1927      */
1928     public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
1929         $node = parent::add($text, $url, $type, $shorttext, $key, $icon);
1930         $node->add_class('root_node');
1931         return $node;
1932     }
1934     /**
1935      * This function allows the user to add something to the start of the settings
1936      * navigation, which means it will be at the top of the settings navigation block
1937      *
1938      * @param string $text
1939      * @param sting|moodle_url $url
1940      * @param string $shorttext
1941      * @param string|int $key
1942      * @param int $type
1943      * @param string $icon
1944      * @return navigation_node
1945      */
1946     public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
1947         $children = $this->children;
1948         $this->children = new get_class($children);
1949         $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
1950         foreach ($children as $child) {
1951             $this->children->add($child);
1952         }
1953         return $node;
1954     }
1955     /**
1956      * Load the site administration tree
1957      *
1958      * This function loads the site administration tree by using the lib/adminlib library functions
1959      *
1960      * @param navigation_node $referencebranch A reference to a branch in the settings
1961      *      navigation tree
1962      * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
1963      *      tree and start at the beginning
1964      * @return mixed A key to access the admin tree by
1965      */
1966     protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) {
1967         global $CFG;
1969         // Check if we are just starting to generate this navigation.
1970         if ($referencebranch === null) {
1972             // Require the admin lib then get an admin structure
1973             if (!function_exists('admin_get_root')) {
1974                 require_once($CFG->dirroot.'/lib/adminlib.php');
1975             }
1976             $adminroot = admin_get_root(false, false);
1977             // This is the active section identifier
1978             $this->adminsection = $this->page->url->param('section');
1980             // Disable the navigation from automatically finding the active node
1981             navigation_node::$autofindactive = false;
1982             $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SETTING, null, 'root');
1983             foreach ($adminroot->children as $adminbranch) {
1984                 $this->load_administration_settings($referencebranch, $adminbranch);
1985             }
1986             navigation_node::$autofindactive = true;
1988             // Use the admin structure to locate the active page
1989             if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) {
1990                 $currentnode = $this;
1991                 while (($pathkey = array_pop($current->path))!==null && $currentnode) {
1992                     $currentnode = $currentnode->get($pathkey);
1993                 }
1994                 if ($currentnode) {
1995                     $currentnode->make_active();
1996                 }
1997             }
1998             return $referencebranch;
1999         } else if ($adminbranch->check_access()) {
2000             // We have a reference branch that we can access and is not hidden `hurrah`
2001             // Now we need to display it and any children it may have
2002             $url = null;
2003             $icon = null;
2004             if ($adminbranch instanceof admin_settingpage) {
2005                 $url = new moodle_url('/admin/settings.php', array('section'=>$adminbranch->name));
2006             } else if ($adminbranch instanceof admin_externalpage) {
2007                 $url = $adminbranch->url;
2008             }
2010             // Add the branch
2011             $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon);
2013             if ($adminbranch->is_hidden()) {
2014                 if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) {
2015                     $reference->add_class('hidden');
2016                 } else {
2017                     $reference->display = false;
2018                 }
2019             }
2021             // Check if we are generating the admin notifications and whether notificiations exist
2022             if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) {
2023                 $reference->add_class('criticalnotification');
2024             }
2025             // Check if this branch has children
2026             if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) {
2027                 foreach ($adminbranch->children as $branch) {
2028                     // Generate the child branches as well now using this branch as the reference
2029                     $this->load_administration_settings($reference, $branch);
2030                 }
2031             } else {
2032                 $reference->icon = new pix_icon('i/settings', '');
2033             }
2034         }
2035     }
2037     /**
2038      * Gets a navigation node given an array of keys that represent the path to
2039      * the desired node.
2040      *
2041      * @param array $path
2042      * @return navigation_node|false
2043      */
2044     protected function get_by_path(array $path) {
2045         $node = $this->get(array_shift($path));
2046         foreach ($path as $key) {
2047             $node->get($key);
2048         }
2049         return $node;
2050     }
2052     /**
2053      * Generate the list of modules for the given course.
2054      *
2055      * The array of resources and activities that can be added to a course is then
2056      * stored in the cache so that we can access it for anywhere.
2057      * It saves us generating it all the time
2058      *
2059      * <code php>
2060      * // To get resources:
2061      * $this->cache->{'course'.$courseid.'resources'}
2062      * // To get activities:
2063      * $this->cache->{'course'.$courseid.'activities'}
2064      * </code>
2065      *
2066      * @param stdClass $course The course to get modules for
2067      */
2068     protected function get_course_modules($course) {
2069         global $CFG;
2070         $mods = $modnames = $modnamesplural = $modnamesused = array();
2071         // This function is included when we include course/lib.php at the top
2072         // of this file
2073         get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused);
2074         $resources = array();
2075         $activities = array();
2076         foreach($modnames as $modname=>$modnamestr) {
2077             if (!course_allowed_module($course, $modname)) {
2078                 continue;
2079             }
2081             $libfile = "$CFG->dirroot/mod/$modname/lib.php";
2082             if (!file_exists($libfile)) {
2083                 continue;
2084             }
2085             include_once($libfile);
2086             $gettypesfunc =  $modname.'_get_types';
2087             if (function_exists($gettypesfunc)) {
2088                 $types = $gettypesfunc();
2089                 foreach($types as $type) {
2090                     if (!isset($type->modclass) || !isset($type->typestr)) {
2091                         debugging('Incorrect activity type in '.$modname);
2092                         continue;
2093                     }
2094                     if ($type->modclass == MOD_CLASS_RESOURCE) {
2095                         $resources[html_entity_decode($type->type)] = $type->typestr;
2096                     } else {
2097                         $activities[html_entity_decode($type->type)] = $type->typestr;
2098                     }
2099                 }
2100             } else {
2101                 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2102                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
2103                     $resources[$modname] = $modnamestr;
2104                 } else {
2105                     // all other archetypes are considered activity
2106                     $activities[$modname] = $modnamestr;
2107                 }
2108             }
2109         }
2110         $this->cache->{'course'.$course->id.'resources'} = $resources;
2111         $this->cache->{'course'.$course->id.'activities'} = $activities;
2112     }
2114     /**
2115      * This function loads the course settings that are available for the user
2116      *
2117      * @param bool $forceopen If set to true the course node will be forced open
2118      * @return navigation_node|false
2119      */
2120     protected function load_course_settings($forceopen = false) {
2121         global $CFG, $USER, $SESSION, $OUTPUT;
2123         $course = $this->page->course;
2124         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2125         if (!$this->cache->cached('canviewcourse'.$course->id)) {
2126             $this->cache->{'canviewcourse'.$course->id} = has_capability('moodle/course:participate', $coursecontext);
2127         }
2128         if ($course->id === SITEID || !$this->cache->{'canviewcourse'.$course->id}) {
2129             return false;
2130         }
2132         $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin');
2133         if ($forceopen) {
2134             $coursenode->force_open();
2135         }
2137         if (has_capability('moodle/course:update', $coursecontext)) {
2138             // Add the turn on/off settings
2139             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
2140             if ($this->page->user_is_editing()) {
2141                 $url->param('edit', 'off');
2142                 $editstring = get_string('turneditingoff');
2143             } else {
2144                 $url->param('edit', 'on');
2145                 $editstring = get_string('turneditingon');
2146             }
2147             $coursenode->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
2149             if ($this->page->user_is_editing()) {
2150                 // Add `add` resources|activities branches
2151                 $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
2152                 if (file_exists($structurefile)) {
2153                     require_once($structurefile);
2154                     $formatstring = call_user_func('callback_'.$course->format.'_definition');
2155                     $formatidentifier = optional_param(call_user_func('callback_'.$course->format.'_request_key'), 0, PARAM_INT);
2156                 } else {
2157                     $formatstring = get_string('topic');
2158                     $formatidentifier = optional_param('topic', 0, PARAM_INT);
2159                 }
2160                 if (!$this->cache->cached('coursesections'.$course->id)) {
2161                     $this->cache->{'coursesections'.$course->id} = get_all_sections($course->id);
2162                 }
2163                 $sections = $this->cache->{'coursesections'.$course->id};
2165                 $addresource = $this->add(get_string('addresource'));
2166                 $addactivity = $this->add(get_string('addactivity'));
2167                 if ($formatidentifier!==0) {
2168                     $addresource->force_open();
2169                     $addactivity->force_open();
2170                 }
2172                 if (!$this->cache->cached('course'.$course->id.'resources')) {
2173                     $this->get_course_modules($course);
2174                 }
2175                 $resources = $this->cache->{'course'.$course->id.'resources'};
2176                 $activities = $this->cache->{'course'.$course->id.'activities'};
2178                 $textlib = textlib_get_instance();
2180                 foreach ($sections as $section) {
2181                     if ($formatidentifier !== 0 && $section->section != $formatidentifier) {
2182                         continue;
2183                     }
2184                     $sectionurl = new moodle_url('/course/view.php', array('id'=>$course->id, $formatstring=>$section->section));
2185                     if ($section->section == 0) {
2186                         $sectionresources = $addresource->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
2187                         $sectionactivities = $addactivity->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
2188                     } else {
2189                         $sectionresources = $addresource->add($formatstring.' '.$section->section, $sectionurl, self::TYPE_SETTING);
2190                         $sectionactivities = $addactivity->add($formatstring.' '.$section->section, $sectionurl, self::TYPE_SETTING);
2191                     }
2192                     foreach ($resources as $value=>$resource) {
2193                         $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
2194                         $pos = strpos($value, '&type=');
2195                         if ($pos!==false) {
2196                             $url->param('add', $textlib->substr($value, 0,$pos));
2197                             $url->param('type', $textlib->substr($value, $pos+6));
2198                         } else {
2199                             $url->param('add', $value);
2200                         }
2201                         $sectionresources->add($resource, $url, self::TYPE_SETTING);
2202                     }
2203                     $subbranch = false;
2204                     foreach ($activities as $activityname=>$activity) {
2205                         if ($activity==='--') {
2206                             $subbranch = false;
2207                             continue;
2208                         }
2209                         if (strpos($activity, '--')===0) {
2210                             $subbranch = $sectionresources->add(trim($activity, '-'));
2211                             continue;
2212                         }
2213                         $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
2214                         $pos = strpos($activityname, '&type=');
2215                         if ($pos!==false) {
2216                             $url->param('add', $textlib->substr($activityname, 0,$pos));
2217                             $url->param('type', $textlib->substr($activityname, $pos+6));
2218                         } else {
2219                             $url->param('add', $activityname);
2220                         }
2221                         if ($subbranch !== false) {
2222                             $subbranch->add($activity, $url, self::TYPE_SETTING);
2223                         } else {
2224                             $sectionresources->add($activity, $url, self::TYPE_SETTING);
2225                         }
2226                     }
2227                 }
2228             }
2230             // Add the course settings link
2231             $url = new moodle_url('/course/edit.php', array('id'=>$course->id));
2232             $coursenode->add(get_string('settings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
2233         }
2235         if (has_capability('moodle/role:assign', $coursecontext)) {
2236             // Add assign or override roles if allowed
2237             $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$coursecontext->id));
2238             $coursenode->add(get_string('assignroles', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2239             // Override roles
2240             if (has_capability('moodle/role:review', $coursecontext) or count(get_overridable_roles($coursecontext))>0) {
2241                 $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$coursecontext->id));
2242                 $coursenode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2243             }
2244             // Check role permissions
2245             if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $coursecontext)) {
2246                 $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$coursecontext->id));
2247                 $coursenode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2248             }
2249             // Manage filters
2250             if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
2251                 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
2252                 $coursenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
2253             }
2254         }
2256         // Add view grade report is permitted
2257         $reportavailable = false;
2258         if (has_capability('moodle/grade:viewall', $coursecontext)) {
2259             $reportavailable = true;
2260         } else if (!empty($course->showgrades)) {
2261             $reports = get_plugin_list('gradereport');
2262             if (is_array($reports) && count($reports)>0) {     // Get all installed reports
2263                 arsort($reports); // user is last, we want to test it first
2264                 foreach ($reports as $plugin => $plugindir) {
2265                     if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
2266                         //stop when the first visible plugin is found
2267                         $reportavailable = true;
2268                         break;
2269                     }
2270                 }
2271             }
2272         }
2273         if ($reportavailable) {
2274             $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id));
2275             $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
2276         }
2278         //  Add outcome if permitted
2279         if (!empty($CFG->enableoutcomes) && has_capability('moodle/course:update', $coursecontext)) {
2280             $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id));
2281             $coursenode->add(get_string('outcomes', 'grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/outcomes', ''));
2282         }
2284         // Add meta course links
2285         if ($course->metacourse) {
2286             if (has_capability('moodle/course:managemetacourse', $coursecontext)) {
2287                 $url = new moodle_url('/course/importstudents.php', array('id'=>$course->id));
2288                 $coursenode->add(get_string('childcourses'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/course', ''));
2289             } else if (has_capability('moodle/role:assign', $coursecontext)) {
2290                 $roleassign = $coursenode->add(get_string('childcourses'), null,  self::TYPE_SETTING, null, null, new pix_icon('i/course', ''));
2291                 $roleassign->hidden = true;
2292             }
2293         }
2295         // Manage groups in this course
2296         if (($course->groupmode || !$course->groupmodeforce) && has_capability('moodle/course:managegroups', $coursecontext)) {
2297             $url = new moodle_url('/group/index.php', array('id'=>$course->id));
2298             $coursenode->add(get_string('groups'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/group', ''));
2299         }
2301         // Backup this course
2302         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
2303             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
2304             $coursenode->add(get_string('backup'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/backup', ''));
2305         }
2307         // Restore to this course
2308         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
2309             $url = new moodle_url('/files/index.php', array('id'=>$course->id, 'wdir'=>'/backupdata'));
2310             $coursenode->add(get_string('restore'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/restore', ''));
2311         }
2313         // Import data from other courses
2314         if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
2315             $url = new moodle_url('/course/import.php', array('id'=>$course->id));
2316             $coursenode->add(get_string('import'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/restore', ''));
2317         }
2319         // Reset this course
2320         if (has_capability('moodle/course:reset', $coursecontext)) {
2321             $url = new moodle_url('/course/reset.php', array('id'=>$course->id));
2322             $coursenode->add(get_string('reset'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/return', ''));
2323         }
2325         // Manage questions
2326         $questioncaps = array('moodle/question:add',
2327                               'moodle/question:editmine',
2328                               'moodle/question:editall',
2329                               'moodle/question:viewmine',
2330                               'moodle/question:viewall',
2331                               'moodle/question:movemine',
2332                               'moodle/question:moveall');
2333         if (has_any_capability($questioncaps, $this->context)) {
2334             $questionlink = $CFG->wwwroot.'/question/edit.php';
2335         } else if (has_capability('moodle/question:managecategory', $this->context)) {
2336             $questionlink = $CFG->wwwroot.'/question/category.php';
2337         }
2338         if (isset($questionlink)) {
2339             $url = new moodle_url($questionlink, array('courseid'=>$course->id));
2340             $coursenode->add(get_string('questions','quiz'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/questions', ''));
2341         }
2343         // Repository Instances
2344         require_once($CFG->dirroot.'/repository/lib.php');
2345         $editabletypes = repository::get_editable_types($this->context);
2346         if (has_capability('moodle/course:update', $this->context) && !empty($editabletypes)) {
2347             $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$this->context->id));
2348             $coursenode->add(get_string('repositories'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/repository', ''));
2349         }
2351         // Manage files
2352         if (has_capability('moodle/course:managefiles', $this->context)) {
2353             $url = new moodle_url('/files/index.php', array('id'=>$course->id));
2354             $coursenode->add(get_string('files'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/files', ''));
2355         }
2357         // Authorize hooks
2358         if ($course->enrol == 'authorize' || (empty($course->enrol) && $CFG->enrol == 'authorize')) {
2359             require_once($CFG->dirroot.'/enrol/authorize/const.php');
2360             $url = new moodle_url('/enrol/authorize/index.php', array('course'=>$course->id));
2361             $coursenode->add(get_string('payments'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/payment', ''));
2362             if (has_capability('enrol/authorize:managepayments', $this->page->context)) {
2363                 $cnt = $DB->count_records('enrol_authorize', array('status'=>AN_STATUS_AUTH, 'courseid'=>$course->id));
2364                 if ($cnt) {
2365                     $url = new moodle_url('/enrol/authorize/index.php', array('course'=>$course->id,'status'=>AN_STATUS_AUTH));
2366                     $coursenode->add(get_string('paymentpending', 'moodle', $cnt), $url, self::TYPE_SETTING, null, null, new pix_icon('i/payment', ''));
2367                 }
2368             }
2369         }
2371         // Unenrol link
2372         if (empty($course->metacourse) && ($course->id!==SITEID)) {
2373             if (is_enrolled(get_context_instance(CONTEXT_COURSE, $course->id))) {
2374                 if (has_capability('moodle/role:unassignself', $this->page->context, NULL, false) and get_user_roles($this->page->context, $USER->id, false)) {  // Have some role
2375                     $this->content->items[]='<a href="'.$CFG->wwwroot.'/course/unenrol.php?id='.$course->id.'">'.get_string('unenrolme', '', format_string($course->shortname)).'</a>';
2376                     $this->content->icons[]='<img src="'.$OUTPUT->pix_url('i/user') . '" class="icon" alt="" />';
2377                 }
2379             } else if (is_viewing(get_context_instance(CONTEXT_COURSE, $course->id))) {
2380                 // inspector, manager, etc. - do not show anything
2381             } else {
2382                 // access because otherwise they would not get into this course at all
2383                 $this->content->items[]='<a href="'.$CFG->wwwroot.'/course/enrol.php?id='.$course->id.'">'.get_string('enrolme', '', format_string($course->shortname)).'</a>';
2384                 $this->content->icons[]='<img src="'.$OUTPUT->pix_url('i/user') . '" class="icon" alt="" />';
2385             }
2386         }
2388         // Switch roles
2389         $roles = array();
2390         $assumedrole = $this->in_alternative_role();
2391         if ($assumedrole!==false) {
2392             $roles[0] = get_string('switchrolereturn');
2393         }
2394         if (has_capability('moodle/role:switchroles', $this->context)) {
2395             $availableroles = get_switchable_roles($this->context);
2396             if (is_array($availableroles)) {
2397                 foreach ($availableroles as $key=>$role) {
2398                     if ($key == $CFG->guestroleid || $assumedrole===(int)$key) {
2399                         continue;
2400                     }
2401                     $roles[$key] = $role;
2402                 }
2403             }
2404         }
2405         if (is_array($roles) && count($roles)>0) {
2406             $switchroles = $this->add(get_string('switchroleto'));
2407             if ((count($roles)==1 && array_key_exists(0, $roles))|| $assumedrole!==false) {
2408                 $switchroles->force_open();
2409             }
2410             $returnurl = $this->page->url;
2411             $returnurl->param('sesskey', sesskey());
2412             $SESSION->returnurl = serialize($returnurl);
2413             foreach ($roles as $key=>$name) {
2414                 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>'1'));
2415                 $switchroles->add($name, $url, self::TYPE_SETTING, null, $key, new pix_icon('i/roles', ''));
2416             }
2417         }
2418         // Return we are done
2419         return $coursenode;
2420     }
2422     /**
2423      * This function calls the module function to inject module settings into the
2424      * settings navigation tree.
2425      *
2426      * This only gets called if there is a corrosponding function in the modules
2427      * lib file.
2428      *
2429      * For examples mod/forum/lib.php ::: forum_extend_settings_navigation()
2430      *
2431      * @return navigation_node|false
2432      */
2433     protected function load_module_settings() {
2434         global $CFG;
2436         if (!$this->page->cm && $this->context->contextlevel == CONTEXT_MODULE && $this->context->instanceid) {
2437             $cm = get_coursemodule_from_id(false, $this->context->instanceid, 0, false, MUST_EXIST);
2438             $this->page->set_cm($cm, $this->page->course);
2439         }
2441         $modulenode = $this->add(get_string($this->page->activityname.'administration', $this->page->activityname));
2442         $modulenode->force_open();
2444         // Settings for the module
2445         if (has_capability('moodle/course:manageactivities', $this->page->cm->context)) {
2446             $url = new moodle_url('/course/modedit.php', array('update' => $this->page->cm->id, 'return' => true, 'sesskey' => sesskey()));
2447             $modulenode->add(get_string('settings'), $url, navigation_node::TYPE_SETTING);
2448         }
2449         // Assign local roles
2450         if (count(get_assignable_roles($this->page->cm->context))>0) {
2451             $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->page->cm->context->id));
2452             $modulenode->add(get_string('localroles', 'role'), $url, self::TYPE_SETTING);
2453         }
2454         // Override roles
2455         if (has_capability('moodle/role:review', $this->page->cm->context) or count(get_overridable_roles($this->page->cm->context))>0) {
2456             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->page->cm->context->id));
2457             $modulenode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
2458         }
2459         // Check role permissions
2460         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page->cm->context)) {
2461             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->page->cm->context->id));
2462             $modulenode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
2463         }
2464         // Manage filters
2465         if (has_capability('moodle/filter:manage', $this->page->cm->context) && count(filter_get_available_in_context($this->page->cm->context))>0) {
2466             $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page->cm->context->id));
2467             $modulenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING);
2468         }
2470         $file = $CFG->dirroot.'/mod/'.$this->page->activityname.'/lib.php';
2471         $function = $this->page->activityname.'_extend_settings_navigation';
2473         if (file_exists($file)) {
2474             require_once($file);
2475         }
2476         if (!function_exists($function)) {
2477             return $modulenode;
2478         }
2480         $function($this, $modulenode);
2482         // Remove the module node if there are no children
2483         if (empty($modulenode->children)) {
2484             $modulenode->remove();
2485         }
2487         return $modulenode;
2488     }
2490     /**
2491      * Loads the user settings block of the settings nav
2492      *
2493      * This function is simply works out the userid and whether we need to load
2494      * just the current users profile settings, or the current user and the user the
2495      * current user is viewing.
2496      *
2497      * This function has some very ugly code to work out the user, if anyone has
2498      * any bright ideas please feel free to intervene.
2499      *
2500      * @param int $courseid The course id of the current course
2501      * @return navigation_node|false
2502      */
2503     protected function load_user_settings($courseid=SITEID) {
2504         global $USER, $FULLME, $CFG;
2506         if (isguestuser() || !isloggedin()) {
2507             return false;
2508         }
2510         // This is terribly ugly code, but I couldn't see a better way around it
2511         // we need to pick up the user id, it can be the current user or someone else
2512         // and the key depends on the current location
2513         // Default to look at id
2514         $userkey='id';
2515         if (strpos($FULLME,'/blog/') || strpos($FULLME, $CFG->admin.'/roles/')) {
2516             // And blog and roles just do thier own thing using `userid`
2517             $userkey = 'userid';
2518         } else if ($this->context->contextlevel >= CONTEXT_COURSECAT && strpos($FULLME, '/message/')===false && strpos($FULLME, '/mod/forum/user')===false && strpos($FULLME, '/user/editadvanced')===false) {
2519             // If we have a course context and we are not in message or forum
2520             // Message and forum both pick the user up from `id`
2521             $userkey = 'user';
2522         }
2524         $userid = optional_param($userkey, $USER->id, PARAM_INT);
2525         if ($userid!=$USER->id) {
2526             $usernode = $this->generate_user_settings($courseid, $userid, 'userviewingsettings');
2527             $this->generate_user_settings($courseid, $USER->id);
2528         } else {
2529             $usernode = $this->generate_user_settings($courseid, $USER->id);
2530         }
2531         return $usernode;
2532     }
2534     /**
2535      * This function gets called by {@link load_user_settings()} and actually works out
2536      * what can be shown/done
2537      *
2538      * @param int $courseid The current course' id
2539      * @param int $userid The user id to load for
2540      * @param string $gstitle The string to pass to get_string for the branch title
2541      * @return navigation_node|false
2542      */
2543     protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') {
2544         global $DB, $CFG, $USER, $SITE;
2546         if ($courseid != SITEID) {
2547             if (!empty($this->page->course->id) && $this->page->course->id == $courseid) {
2548                 $course = $this->page->course;
2549             } else {
2550                 $course = $DB->get_record("course", array("id"=>$courseid), '*', MUST_EXIST);
2551             }
2552         } else {
2553             $course = $SITE;
2554         }
2556         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);   // Course context
2557         $systemcontext   = get_system_context();
2558         $currentuser = ($USER->id == $userid);
2560         if ($currentuser) {
2561             $user = $USER;
2562             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
2563         } else {
2564             if (!$user = $DB->get_record('user', array('id'=>$userid))) {
2565                 return false;
2566             }
2567             // Check that the user can view the profile
2568             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
2569             if ($course->id==SITEID) {
2570                 if ($CFG->forceloginforprofiles && !!has_coursemanager_role($user->id) && !has_capability('moodle/user:viewdetails', $usercontext)) {  // Reduce possibility of "browsing" userbase at site level
2571                     // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366)
2572                     return false;
2573                 }
2574             } else {
2575                 if ((!has_capability('moodle/user:viewdetails', $coursecontext) && !has_capability('moodle/user:viewdetails', $usercontext)) || !has_capability('moodle/course:participate', $coursecontext, $user->id, false)) {
2576                     return false;
2577                 }
2578                 if (groups_get_course_groupmode($course) == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $coursecontext)) {
2579                     // If groups are in use, make sure we can see that group
2580                     return false;
2581                 }
2582             }
2583         }
2585         $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $this->page->context));
2587         // Add a user setting branch
2588         $usersetting = $this->add(get_string($gstitle, 'moodle', $fullname));
2589         $usersetting->id = 'usersettings';
2591         // Check if the user has been deleted
2592         if ($user->deleted) {
2593             if (!has_capability('moodle/user:update', $coursecontext)) {
2594                 // We can't edit the user so just show the user deleted message
2595                 $usersetting->add(get_string('userdeleted'), null, self::TYPE_SETTING);
2596             } else {
2597                 // We can edit the user so show the user deleted message and link it to the profile
2598                 $profileurl = new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$course->id));
2599                 $usersetting->add(get_string('userdeleted'), $profileurl, self::TYPE_SETTING);
2600             }
2601             return true;
2602         }
2604         // Add the profile edit link
2605         if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
2606             if (($currentuser || !is_primary_admin($user->id)) && has_capability('moodle/user:update', $systemcontext)) {
2607                 $url = new moodle_url('/user/editadvanced.php', array('id'=>$user->id, 'course'=>$course->id));
2608                 $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
2609             } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_primary_admin($user->id)) || ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
2610                 $url = new moodle_url('/user/edit.php', array('id'=>$user->id, 'course'=>$course->id));
2611                 $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
2612             }
2613         }
2615         // Change password link
2616         if (!empty($user->auth)) {
2617             $userauth = get_auth_plugin($user->auth);
2618             if ($currentuser && !session_is_loggedinas() && $userauth->can_change_password() && !isguestuser() && has_capability('moodle/user:changeownpassword', $systemcontext)) {
2619                 $passwordchangeurl = $userauth->change_password_url();
2620                 if (!$passwordchangeurl) {
2621                     if (empty($CFG->loginhttps)) {
2622                         $wwwroot = $CFG->wwwroot;
2623                     } else {
2624                         $wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
2625                     }
2626                     $passwordchangeurl = new moodle_url('/login/change_password.php');
2627                 } else {
2628                     $urlbits = explode($passwordchangeurl. '?', 1);
2629                     $passwordchangeurl = new moodle_url($urlbits[0]);
2630                     if (count($urlbits)==2 && preg_match_all('#\&([^\=]*?)\=([^\&]*)#si', '&'.$urlbits[1], $matches)) {
2631                         foreach ($matches as $pair) {
2632                             $fullmeurl->param($pair[1],$pair[2]);
2633                         }
2634                     }
2635                 }
2636                 $passwordchangeurl->param('id', $course->id);
2637                 $usersetting->add(get_string("changepassword"), $passwordchangeurl, self::TYPE_SETTING);
2638             }
2639         }
2641         // View the roles settings
2642         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:manage'), $usercontext)) {
2643             $roles = $usersetting->add(get_string('roles'), null, self::TYPE_SETTING);
2645             $url = new moodle_url('/admin/roles/usersroles.php', array('userid'=>$user->id, 'courseid'=>$course->id));
2646             $roles->add(get_string('thisusersroles', 'role'), $url, self::TYPE_SETTING);
2648             $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH);
2650             if (!empty($assignableroles)) {
2651                 $url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
2652                 $roles->add(get_string('assignrolesrelativetothisuser', 'role'), $url, self::TYPE_SETTING);
2653             }
2655             if (has_capability('moodle/role:review', $usercontext) || count(get_overridable_roles($usercontext, ROLENAME_BOTH))>0) {
2656                 $url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
2657                 $roles->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
2658             }
2660             $url = new moodle_url('/admin/roles/check.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
2661             $roles->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
2662         }
2664         // Portfolio
2665         if ($currentuser && !empty($CFG->enableportfolios) && has_capability('moodle/portfolio:export', $systemcontext)) {
2666             require_once($CFG->libdir . '/portfoliolib.php');
2667             if (portfolio_instances(true, false)) {
2668                 $portfolio = $usersetting->add(get_string('portfolios', 'portfolio'), null, self::TYPE_SETTING);
2669                 $portfolio->add(get_string('configure', 'portfolio'), new moodle_url('/user/portfolio.php'), self::TYPE_SETTING);
2670                 $portfolio->add(get_string('logs', 'portfolio'), new moodle_url('/user/portfoliologs.php'), self::TYPE_SETTING);
2671             }
2672         }
2674         // Security keys
2675         if ($currentuser && !is_siteadmin($USER->id) && !empty($CFG->enablewebservices) && has_capability('moodle/webservice:createtoken', $systemcontext)) {
2676             $url = new moodle_url('/user/managetoken.php', array('sesskey'=>sesskey()));
2677             $usersetting->add(get_string('securitykeys', 'webservice'), $url, self::TYPE_SETTING);
2678         }
2680         // Repository
2681         if (!$currentuser) {
2682             require_once($CFG->dirroot . '/repository/lib.php');
2683             $editabletypes = repository::get_editable_types($usercontext);
2684             if ($usercontext->contextlevel == CONTEXT_USER && !empty($editabletypes)) {
2685                 $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$usercontext->id));
2686                 $usersetting->add(get_string('repositories', 'repository'), $url, self::TYPE_SETTING);
2687             }
2688         }
2690         // Messaging
2691         if (has_capability('moodle/user:editownmessageprofile', $systemcontext)) {
2692             $url = new moodle_url('/message/edit.php', array('id'=>$user->id, 'course'=>$course->id));
2693             $usersetting->add(get_string('editmymessage', 'message'), $url, self::TYPE_SETTING);
2694         }
2696         return $usersetting;
2697     }
2699     /**
2700      * Loads block specific settings in the navigation
2701      *
2702      * @return navigation_node
2703      */
2704     protected function load_block_settings() {
2705         global $CFG;
2707         $blocknode = $this->add(print_context_name($this->context));
2708         $blocknode->force_open();
2710         // Assign local roles
2711         $assignurl = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->context->id));
2712         $blocknode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING);
2714         // Override roles
2715         if (has_capability('moodle/role:review', $this->context) or  count(get_overridable_roles($this->context))>0) {
2716             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->context->id));
2717             $blocknode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
2718         }
2719         // Check role permissions
2720         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context)) {
2721             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->context->id));
2722             $blocknode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
2723         }
2725         return $blocknode;
2726     }
2728     /**
2729      * Loads category specific settings in the navigation
2730      *
2731      * @return navigation_node
2732      */
2733     protected function load_category_settings() {
2734         global $CFG;
2736         $categorynode = $this->add(print_context_name($this->context));
2737         $categorynode->force_open();
2739         if ($this->page->user_is_editing() && has_capability('moodle/category:manage', $this->context)) {
2740             $categorynode->add(get_string('editcategorythis'), new moodle_url('/course/editcategory.php', array('id' => $this->context->instanceid)));
2741             $categorynode->add(get_string('addsubcategory'), new moodle_url('/course/editcategory.php', array('parent' => $this->context->instanceid)));
2742         }
2744         // Assign local roles
2745         $assignurl = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->context->id));
2746         $categorynode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING);
2748         // Override roles
2749         if (has_capability('moodle/role:review', $this->context) or count(get_overridable_roles($this->context))>0) {
2750             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->context->id));
2751             $categorynode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
2752         }
2753         // Check role permissions
2754         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context)) {
2755             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->context->id));
2756             $categorynode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
2757         }
2758         // Manage filters
2759         if (has_capability('moodle/filter:manage', $this->context) && count(filter_get_available_in_context($this->context))>0) {
2760             $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->context->id));
2761             $categorynode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING);
2762         }
2764         return $categorynode;
2765     }
2767     /**
2768      * Determine whether the user is assuming another role
2769      *
2770      * This function checks to see if the user is assuming another role by means of
2771      * role switching. In doing this we compare each RSW key (context path) against
2772      * the current context path. This ensures that we can provide the switching
2773      * options against both the course and any page shown under the course.
2774      *
2775      * @return bool|int The role(int) if the user is in another role, false otherwise
2776      */
2777     protected function in_alternative_role() {
2778         global $USER;
2779         if (!empty($USER->access['rsw']) && is_array($USER->access['rsw'])) {
2780             if (!empty($this->page->context) && !empty($USER->access['rsw'][$this->page->context->path])) {
2781                 return $USER->access['rsw'][$this->page->context->path];
2782             }
2783             foreach ($USER->access['rsw'] as $key=>$role) {
2784                 if (strpos($this->context->path,$key)===0) {
2785                     return $role;
2786                 }
2787             }
2788         }
2789         return false;
2790     }
2792     /**
2793      * This function loads all of the front page settings into the settings navigation.
2794      * This function is called when the user is on the front page, or $COURSE==$SITE
2795      * @return navigation_node
2796      */
2797     protected function load_front_page_settings($forceopen = false) {
2798         global $SITE, $CFG;
2800         $course = clone($SITE);
2801         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);   // Course context
2803         $frontpage = $this->add(get_string('frontpagesettings'), null, self::TYPE_SETTING, null, 'frontpage');
2804         if ($forceopen) {
2805             $frontpage->force_open();
2806         }
2807         $frontpage->id = 'frontpagesettings';
2809         if (has_capability('moodle/course:update', $coursecontext)) {
2811             // Add the turn on/off settings
2812             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
2813             if ($this->page->user_is_editing()) {
2814                 $url->param('edit', 'off');
2815                 $editstring = get_string('turneditingoff');
2816             } else {
2817                 $url->param('edit', 'on');
2818                 $editstring = get_string('turneditingon');
2819             }
2820             $frontpage->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
2822             // Add the course settings link
2823             $url = new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings'));
2824             $frontpage->add(get_string('settings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
2825         }
2827         //Participants
2828         if (has_capability('moodle/site:viewparticipants', $coursecontext)) {
2829             $url = new moodle_url('/user/index.php', array('contextid'=>$coursecontext->id));
2830             $frontpage->add(get_string('participants'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/users', ''));
2831         }
2833         // Roles
2834         if (has_capability('moodle/role:assign', $coursecontext)) {
2835             // Add assign or override roles if allowed
2836             $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$coursecontext->id));
2837             $frontpage->add(get_string('assignroles', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2838             // Override roles
2839             if (has_capability('moodle/role:review', $coursecontext) or count(get_overridable_roles($coursecontext))>0) {
2840                 $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$coursecontext->id));
2841                 $frontpage->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2842             }
2843             // Check role permissions
2844             if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $coursecontext)) {
2845                 $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$coursecontext->id));
2846                 $frontpage->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/roles', ''));
2847             }
2848             // Manage filters
2849             if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
2850                 $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
2851                 $frontpage->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
2852             }
2853         }
2855         // Backup this course
2856         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
2857             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
2858             $frontpage->add(get_string('backup'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/backup', ''));
2859         }
2861         // Restore to this course
2862         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
2863             $url = new moodle_url('/files/index.php', array('id'=>$course->id, 'wdir'=>'/backupdata'));
2864             $frontpage->add(get_string('restore'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/restore', ''));
2865         }
2867         // Manage questions
2868         $questioncaps = array('moodle/question:add',
2869                               'moodle/question:editmine',
2870                               'moodle/question:editall',
2871                               'moodle/question:viewmine',
2872                               'moodle/question:viewall',
2873                               'moodle/question:movemine',
2874                               'moodle/question:moveall');
2875         if (has_any_capability($questioncaps, $this->context)) {
2876             $questionlink = $CFG->wwwroot.'/question/edit.php';
2877         } else if (has_capability('moodle/question:managecategory', $this->context)) {
2878             $questionlink = $CFG->wwwroot.'/question/category.php';
2879         }
2880         if (isset($questionlink)) {
2881             $url = new moodle_url($questionlink, array('courseid'=>$course->id));
2882             $frontpage->add(get_string('questions','quiz'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/questions', ''));
2883         }
2885         // Manage files
2886         if (has_capability('moodle/course:managefiles', $this->context)) {
2887             $url = new moodle_url('/files/index.php', array('id'=>$course->id));
2888             $frontpage->add(get_string('files'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/files', ''));
2889         }
2890         return $frontpage;
2891     }
2893     /**
2894      * This function marks the cache as volatile so it is cleared during shutdown
2895      */
2896     public function clear_cache() {
2897         $this->cache->volatile();
2898     }
2901 /**
2902  * Simple class used to output a navigation branch in XML
2903  *
2904  * @package moodlecore
2905  * @subpackage navigation
2906  * @copyright 2009 Sam Hemelryk
2907  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2908  */
2909 class navigation_json {
2910     /** @var array */
2911     protected $nodetype = array('node','branch');
2912     /** @var array */
2913     protected $expandable = array();
2914     /**
2915      * Turns a branch and all of its children into XML
2916      *
2917      * @param navigation_node $branch
2918      * @return string XML string
2919      */
2920     public function convert($branch) {
2921         $xml = $this->convert_child($branch);
2922         return $xml;
2923     }
2924     /**
2925      * Set the expandable items in the array so that we have enough information
2926      * to attach AJAX events
2927      * @param array $expandable
2928      */
2929     public function set_expandable($expandable) {
2930         foreach ($expandable as $node) {
2931             $this->expandable[(string)$node['branchid']] = $node;
2932         }
2933     }
2934     /**
2935      * Recusively converts a child node and its children to XML for output
2936      *
2937      * @param navigation_node $child The child to convert
2938      * @param int $depth Pointlessly used to track the depth of the XML structure
2939      * @return string JSON
2940      */
2941     protected function convert_child($child, $depth=1) {
2942         global $OUTPUT;
2944         if (!$child->display) {
2945             return '';
2946         }
2947         $attributes = array();
2948         $attributes['id'] = $child->id;
2949         $attributes['name'] = $child->text;
2950         $attributes['type'] = $child->type;
2951         $attributes['key'] = $child->key;
2952         $attributes['class'] = $child->get_css_type();
2954         if ($child->icon instanceof pix_icon) {
2955             $attributes['icon'] = array(
2956                 'component' => $child->icon->component,
2957                 'pix' => $child->icon->pix,
2958             );
2959             foreach ($child->icon->attributes as $key=>$value) {
2960                 if ($key == 'class') {
2961                     $attributes['icon']['classes'] = explode(' ', $value);
2962                 } else if (!array_key_exists($key, $attributes['icon'])) {
2963                     $attributes['icon'][$key] = $value;
2964                 }
2966             }
2967         } else if (!empty($child->icon)) {
2968             $attributes['icon'] = (string)$child->icon;
2969         }
2971         if ($child->forcetitle || $child->title !== $child->text) {
2972             $attributes['title'] = htmlentities($child->title);
2973         }
2974         if (array_key_exists((string)$child->key, $this->expandable)) {
2975             $attributes['expandable'] = $child->key;
2976             $child->add_class($this->expandable[$child->key]['id']);
2977         }
2979         if (count($child->classes)>0) {
2980             $attributes['class'] .= ' '.join(' ',$child->classes);
2981         }
2982         if (is_string($child->action)) {
2983             $attributes['link'] = $child->action;
2984         } else if ($child->action instanceof moodle_url) {
2985             $attributes['link'] = $child->action->out();
2986         }
2987         $attributes['hidden'] = ($child->hidden);
2988         $attributes['haschildren'] = ($child->children->count()>0 || $child->type == navigation_node::TYPE_CATEGORY);
2990         if (count($child->children)>0) {
2991             $attributes['children'] = array();
2992             foreach ($child->children as $subchild) {
2993                 $attributes['children'][] = $this->convert_child($subchild, $depth+1);
2994             }
2995         }
2997         if ($depth > 1) {
2998             return $attributes;
2999         } else {
3000             return json_encode($attributes);
3001         }
3002     }
3005 /**
3006  * The cache class used by global navigation and settings navigation to cache bits
3007  * and bobs that are used during their generation.
3008  *
3009  * It is basically an easy access point to session with a bit of smarts to make
3010  * sure that the information that is cached is valid still.
3011  *
3012  * Example use:
3013  * <code php>
3014  * if (!$cache->viewdiscussion()) {
3015  *     // Code to do stuff and produce cachable content
3016  *     $cache->viewdiscussion = has_capability('mod/forum:viewdiscussion', $coursecontext);
3017  * }
3018  * $content = $cache->viewdiscussion;
3019  * </code>
3020  *
3021  * @package moodlecore
3022  * @subpackage navigation
3023  * @copyright 2009 Sam Hemelryk
3024  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3025  */
3026 class navigation_cache {
3027     /** @var int */
3028     protected $creation;
3029     /** @var array */
3030     protected $session;
3031     /** @var string */
3032     protected $area;
3033     /** @var int */
3034     protected $timeout;
3035     /** @var stdClass */
3036     protected $currentcontext;
3037     /** @var int */
3038     const CACHETIME = 0;
3039     /** @var int */
3040     const CACHEUSERID = 1;
3041     /** @var int */
3042     const CACHEVALUE = 2;
3043     /** @var null|array An array of navigation cache areas to expire on shutdown */
3044     public static $volatilecaches;
3046     /**
3047      * Contructor for the cache. Requires two arguments
3048      *
3049      * @param string $area The string to use to segregate this particular cache
3050      *                it can either be unique to start a fresh cache or if you want
3051      *                to share a cache then make it the string used in the original
3052      *                cache
3053      * @param int $timeout The number of seconds to time the information out after
3054      */
3055     public function __construct($area, $timeout=60) {
3056         global $SESSION;
3057         $this->creation = time();
3058         $this->area = $area;
3060         if (!isset($SESSION->navcache)) {
3061             $SESSION->navcache = new stdClass;
3062         }
3064         if (!isset($SESSION->navcache->{$area})) {
3065             $SESSION->navcache->{$area} = array();
3066         }
3067         $this->session = &$SESSION->navcache->{$area};
3068         $this->timeout = time()-$timeout;
3069         if (rand(0,10)===0) {
3070             $this->garbage_collection();
3071         }
3072     }
3074     /**
3075      * Magic Method to retrieve something by simply calling using = cache->key
3076      *
3077      * @param mixed $key The identifier for the information you want out again
3078      * @return void|mixed Either void or what ever was put in
3079      */
3080     public function __get($key) {
3081         if (!$this->cached($key)) {
3082             return;
3083         }
3084         $information = $this->session[$key][self::CACHEVALUE];
3085         return unserialize($information);
3086     }
3088     /**
3089      * Magic method that simply uses {@link set();} to store something in the cache
3090      *
3091      * @param string|int $key
3092      * @param mixed $information
3093      */
3094     public function __set($key, $information) {
3095         $this->set($key, $information);
3096     }
3098     /**
3099      * Sets some information against the cache (session) for later retrieval
3100      *
3101      * @param string|int $key
3102      * @param mixed $information
3103      */
3104     public function set($key, $information) {
3105         global $USER;
3106         $information = serialize($information);
3107         $this->session[$key]= array(self::CACHETIME=>time(), self::CACHEUSERID=>$USER->id, self::CACHEVALUE=>$information);
3108     }
3109     /**
3110      * Check the existence of the identifier in the cache
3111      *
3112      * @param string|int $key
3113      * @return bool
3114      */
3115     public function cached($key) {
3116         global $USER;
3117         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) {
3118             return false;
3119         }
3120         return true;
3121     }
3122     /**
3123      * Compare something to it's equivilant in the cache
3124      *
3125      * @param string $key
3126      * @param mixed $value
3127      * @param bool $serialise Whether to serialise the value before comparison
3128      *              this should only be set to false if the value is already
3129      *              serialised
3130      * @return bool If the value is the same false if it is not set or doesn't match
3131      */
3132     public function compare($key, $value, $serialise=true) {
3133         if ($this->cached($key)) {
3134             if ($serialise) {
3135                 $value = serialize($value);
3136             }
3137             if ($this->session[$key][self::CACHEVALUE] === $value) {
3138                 return true;
3139             }
3140         }
3141         return false;
3142     }
3143     /**
3144      * Wipes the entire cache, good to force regeneration
3145      */
3146     public function clear() {
3147         $this->session = array();
3148     }
3149     /**
3150      * Checks all cache entries and removes any that have expired, good ole cleanup
3151      */
3152     protected function garbage_collection() {
3153         foreach ($this->session as $key=>$cachedinfo) {
3154             if (is_array($cachedinfo) && $cachedinfo[self::CACHETIME]<$this->timeout) {
3155                 unset($this->session[$key]);
3156             }
3157         }
3158     }
3160     /**
3161      * Marks the cache as being volatile (likely to change)
3162      *
3163      * Any caches marked as volatile will be destroyed at the on shutdown by
3164      * {@link navigation_node::destroy_volatile_caches()} which is registered
3165      * as a shutdown function if any caches are marked as volatile.
3166      *
3167      * @param bool $setting True to destroy the cache false not too
3168      */
3169     public function volatile($setting = true) {
3170         if (self::$volatilecaches===null) {
3171             self::$volatilecaches = array();
3172             register_shutdown_function(array('navigation_cache','destroy_volatile_caches'));
3173         }
3175         if ($setting) {
3176             self::$volatilecaches[$this->area] = $this->area;
3177         } else if (array_key_exists($this->area, self::$volatilecaches)) {
3178             unset(self::$volatilecaches[$this->area]);
3179         }
3180     }
3182     /**
3183      * Destroys all caches marked as volatile
3184      *
3185      * This function is static and works in conjunction with the static volatilecaches
3186      * property of navigation cache.
3187      * Because this function is static it manually resets the cached areas back to an
3188      * empty array.
3189      */
3190     public static function destroy_volatile_caches() {
3191         global $SESSION;
3192         if (is_array(self::$volatilecaches) && count(self::$volatilecaches)>0) {
3193             foreach (self::$volatilecaches as $area) {
3194                 $SESSION->navcache->{$area} = array();
3195             }
3196         }
3197     }