9877811453516f6c3d9bc480ffc26c31438cc919
[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    core
24  * @subpackage navigation
25  * @copyright  2009 Sam Hemelryk
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * The name that will be used to separate the navigation cache within SESSION
33  */
34 define('NAVIGATION_CACHE_NAME', 'navigation');
36 /**
37  * This class is used to represent a node in a navigation tree
38  *
39  * This class is used to represent a node in a navigation tree within Moodle,
40  * the tree could be one of global navigation, settings navigation, or the navbar.
41  * Each node can be one of two types either a Leaf (default) or a branch.
42  * When a node is first created it is created as a leaf, when/if children are added
43  * the node then becomes a branch.
44  *
45  * @package moodlecore
46  * @subpackage navigation
47  * @copyright 2009 Sam Hemelryk
48  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  */
50 class navigation_node implements renderable {
51     /** @var int Used to identify this node a leaf (default) 0 */
52     const NODETYPE_LEAF =   0;
53     /** @var int Used to identify this node a branch, happens with children  1 */
54     const NODETYPE_BRANCH = 1;
55     /** @var null Unknown node type null */
56     const TYPE_UNKNOWN =    null;
57     /** @var int System node type 0 */
58     const TYPE_ROOTNODE =   0;
59     /** @var int System node type 1 */
60     const TYPE_SYSTEM =     1;
61     /** @var int Category node type 10 */
62     const TYPE_CATEGORY =   10;
63     /** @var int Course node type 20 */
64     const TYPE_COURSE =     20;
65     /** @var int Course Structure node type 30 */
66     const TYPE_SECTION =    30;
67     /** @var int Activity node type, e.g. Forum, Quiz 40 */
68     const TYPE_ACTIVITY =   40;
69     /** @var int Resource node type, e.g. Link to a file, or label 50 */
70     const TYPE_RESOURCE =   50;
71     /** @var int A custom node type, default when adding without specifing type 60 */
72     const TYPE_CUSTOM =     60;
73     /** @var int Setting node type, used only within settings nav 70 */
74     const TYPE_SETTING =    70;
75     /** @var int Setting node type, used only within settings nav 80 */
76     const TYPE_USER =       80;
77     /** @var int Setting node type, used for containers of no importance 90 */
78     const TYPE_CONTAINER =  90;
80     /** @var int Parameter to aid the coder in tracking [optional] */
81     public $id = null;
82     /** @var string|int The identifier for the node, used to retrieve the node */
83     public $key = null;
84     /** @var string The text to use for the node */
85     public $text = null;
86     /** @var string Short text to use if requested [optional] */
87     public $shorttext = null;
88     /** @var string The title attribute for an action if one is defined */
89     public $title = null;
90     /** @var string A string that can be used to build a help button */
91     public $helpbutton = null;
92     /** @var moodle_url|action_link|null An action for the node (link) */
93     public $action = null;
94     /** @var pix_icon The path to an icon to use for this node */
95     public $icon = null;
96     /** @var int See TYPE_* constants defined for this class */
97     public $type = self::TYPE_UNKNOWN;
98     /** @var int See NODETYPE_* constants defined for this class */
99     public $nodetype = self::NODETYPE_LEAF;
100     /** @var bool If set to true the node will be collapsed by default */
101     public $collapse = false;
102     /** @var bool If set to true the node will be expanded by default */
103     public $forceopen = false;
104     /** @var array An array of CSS classes for the node */
105     public $classes = array();
106     /** @var navigation_node_collection An array of child nodes */
107     public $children = array();
108     /** @var bool If set to true the node will be recognised as active */
109     public $isactive = false;
110     /** @var bool If set to true the node will be dimmed */
111     public $hidden = false;
112     /** @var bool If set to false the node will not be displayed */
113     public $display = true;
114     /** @var bool If set to true then an HR will be printed before the node */
115     public $preceedwithhr = false;
116     /** @var bool If set to true the the navigation bar should ignore this node */
117     public $mainnavonly = false;
118     /** @var bool If set to true a title will be added to the action no matter what */
119     public $forcetitle = false;
120     /** @var navigation_node A reference to the node parent */
121     public $parent = null;
122     /** @var bool Override to not display the icon even if one is provided **/
123     public $hideicon = false;
124     /** @var array */
125     protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting', 80=>'user');
126     /** @var moodle_url */
127     protected static $fullmeurl = null;
128     /** @var bool toogles auto matching of active node */
129     public static $autofindactive = true;
131     /**
132      * Constructs a new navigation_node
133      *
134      * @param array|string $properties Either an array of properties or a string to use
135      *                     as the text for the node
136      */
137     public function __construct($properties) {
138         if (is_array($properties)) {
139             // Check the array for each property that we allow to set at construction.
140             // text         - The main content for the node
141             // shorttext    - A short text if required for the node
142             // icon         - The icon to display for the node
143             // type         - The type of the node
144             // key          - The key to use to identify the node
145             // parent       - A reference to the nodes parent
146             // action       - The action to attribute to this node, usually a URL to link to
147             if (array_key_exists('text', $properties)) {
148                 $this->text = $properties['text'];
149             }
150             if (array_key_exists('shorttext', $properties)) {
151                 $this->shorttext = $properties['shorttext'];
152             }
153             if (!array_key_exists('icon', $properties)) {
154                 $properties['icon'] = new pix_icon('i/navigationitem', 'moodle');
155             }
156             $this->icon = $properties['icon'];
157             if ($this->icon instanceof pix_icon) {
158                 if (empty($this->icon->attributes['class'])) {
159                     $this->icon->attributes['class'] = 'navicon';
160                 } else {
161                     $this->icon->attributes['class'] .= ' navicon';
162                 }
163             }
164             if (array_key_exists('type', $properties)) {
165                 $this->type = $properties['type'];
166             } else {
167                 $this->type = self::TYPE_CUSTOM;
168             }
169             if (array_key_exists('key', $properties)) {
170                 $this->key = $properties['key'];
171             }
172             if (array_key_exists('parent', $properties)) {
173                 $this->parent = $properties['parent'];
174             }
175             // This needs to happen last because of the check_if_active call that occurs
176             if (array_key_exists('action', $properties)) {
177                 $this->action = $properties['action'];
178                 if (is_string($this->action)) {
179                     $this->action = new moodle_url($this->action);
180                 }
181                 if (self::$autofindactive) {
182                     $this->check_if_active();
183                 }
184             }
185         } else if (is_string($properties)) {
186             $this->text = $properties;
187         }
188         if ($this->text === null) {
189             throw new coding_exception('You must set the text for the node when you create it.');
190         }
191         // Default the title to the text
192         $this->title = $this->text;
193         // Instantiate a new navigation node collection for this nodes children
194         $this->children = new navigation_node_collection();
195     }
197     /**
198      * Checks if this node is the active node.
199      *
200      * This is determined by comparing the action for the node against the
201      * defined URL for the page. A match will see this node marked as active.
202      *
203      * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
204      * @return bool
205      */
206     public function check_if_active($strength=URL_MATCH_EXACT) {
207         global $FULLME, $PAGE;
208         // Set fullmeurl if it hasn't already been set
209         if (self::$fullmeurl == null) {
210             if ($PAGE->has_set_url()) {
211                 self::override_active_url(new moodle_url($PAGE->url));
212             } else {
213                 self::override_active_url(new moodle_url($FULLME));
214             }
215         }
217         // Compare the action of this node against the fullmeurl
218         if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
219             $this->make_active();
220             return true;
221         }
222         return false;
223     }
225     /**
226      * This sets the URL that the URL of new nodes get compared to when locating
227      * the active node.
228      *
229      * The active node is the node that matches the URL set here. By default this
230      * is either $PAGE->url or if that hasn't been set $FULLME.
231      *
232      * @param moodle_url $url The url to use for the fullmeurl.
233      */
234     public static function override_active_url(moodle_url $url) {
235         // Clone the URL, in case the calling script changes their URL later.
236         self::$fullmeurl = new moodle_url($url);
237     }
239     /**
240      * Adds a navigation node as a child of this node.
241      *
242      * @param string $text
243      * @param moodle_url|action_link $action
244      * @param int $type
245      * @param string $shorttext
246      * @param string|int $key
247      * @param pix_icon $icon
248      * @return navigation_node
249      */
250     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
251         // First convert the nodetype for this node to a branch as it will now have children
252         if ($this->nodetype !== self::NODETYPE_BRANCH) {
253             $this->nodetype = self::NODETYPE_BRANCH;
254         }
255         // Properties array used when creating the new navigation node
256         $itemarray = array(
257             'text' => $text,
258             'type' => $type
259         );
260         // Set the action if one was provided
261         if ($action!==null) {
262             $itemarray['action'] = $action;
263         }
264         // Set the shorttext if one was provided
265         if ($shorttext!==null) {
266             $itemarray['shorttext'] = $shorttext;
267         }
268         // Set the icon if one was provided
269         if ($icon!==null) {
270             $itemarray['icon'] = $icon;
271         }
272         // Default the key to the number of children if not provided
273         if ($key === null) {
274             $key = $this->children->count();
275         }
276         // Set the key
277         $itemarray['key'] = $key;
278         // Set the parent to this node
279         $itemarray['parent'] = $this;
280         // Add the child using the navigation_node_collections add method
281         $node = $this->children->add(new navigation_node($itemarray));
282         // If the node is a category node or the user is logged in and its a course
283         // then mark this node as a branch (makes it expandable by AJAX)
284         if (($type==self::TYPE_CATEGORY) || (isloggedin() && $type==self::TYPE_COURSE)) {
285             $node->nodetype = self::NODETYPE_BRANCH;
286         }
287         // If this node is hidden mark it's children as hidden also
288         if ($this->hidden) {
289             $node->hidden = true;
290         }
291         // Return the node (reference returned by $this->children->add()
292         return $node;
293     }
295     /**
296      * Searches for a node of the given type with the given key.
297      *
298      * This searches this node plus all of its children, and their children....
299      * If you know the node you are looking for is a child of this node then please
300      * use the get method instead.
301      *
302      * @param int|string $key The key of the node we are looking for
303      * @param int $type One of navigation_node::TYPE_*
304      * @return navigation_node|false
305      */
306     public function find($key, $type) {
307         return $this->children->find($key, $type);
308     }
310     /**
311      * Get ths child of this node that has the given key + (optional) type.
312      *
313      * If you are looking for a node and want to search all children + thier children
314      * then please use the find method instead.
315      *
316      * @param int|string $key The key of the node we are looking for
317      * @param int $type One of navigation_node::TYPE_*
318      * @return navigation_node|false
319      */
320     public function get($key, $type=null) {
321         return $this->children->get($key, $type);
322     }
324     /**
325      * Removes this node.
326      *
327      * @return bool
328      */
329     public function remove() {
330         return $this->parent->children->remove($this->key, $this->type);
331     }
333     /**
334      * Checks if this node has or could have any children
335      *
336      * @return bool Returns true if it has children or could have (by AJAX expansion)
337      */
338     public function has_children() {
339         return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0);
340     }
342     /**
343      * Marks this node as active and forces it open.
344      *
345      * Important: If you are here because you need to mark a node active to get
346      * the navigation to do what you want have you looked at {@see navigation_node::override_active_url()}?
347      * You can use it to specify a different URL to match the active navigation node on
348      * rather than having to locate and manually mark a node active.
349      */
350     public function make_active() {
351         $this->isactive = true;
352         $this->add_class('active_tree_node');
353         $this->force_open();
354         if ($this->parent !== null) {
355             $this->parent->make_inactive();
356         }
357     }
359     /**
360      * Marks a node as inactive and recusised back to the base of the tree
361      * doing the same to all parents.
362      */
363     public function make_inactive() {
364         $this->isactive = false;
365         $this->remove_class('active_tree_node');
366         if ($this->parent !== null) {
367             $this->parent->make_inactive();
368         }
369     }
371     /**
372      * Forces this node to be open and at the same time forces open all
373      * parents until the root node.
374      *
375      * Recursive.
376      */
377     public function force_open() {
378         $this->forceopen = true;
379         if ($this->parent !== null) {
380             $this->parent->force_open();
381         }
382     }
384     /**
385      * Adds a CSS class to this node.
386      *
387      * @param string $class
388      * @return bool
389      */
390     public function add_class($class) {
391         if (!in_array($class, $this->classes)) {
392             $this->classes[] = $class;
393         }
394         return true;
395     }
397     /**
398      * Removes a CSS class from this node.
399      *
400      * @param string $class
401      * @return bool True if the class was successfully removed.
402      */
403     public function remove_class($class) {
404         if (in_array($class, $this->classes)) {
405             $key = array_search($class,$this->classes);
406             if ($key!==false) {
407                 unset($this->classes[$key]);
408                 return true;
409             }
410         }
411         return false;
412     }
414     /**
415      * Sets the title for this node and forces Moodle to utilise it.
416      * @param string $title
417      */
418     public function title($title) {
419         $this->title = $title;
420         $this->forcetitle = true;
421     }
423     /**
424      * Resets the page specific information on this node if it is being unserialised.
425      */
426     public function __wakeup(){
427         $this->forceopen = false;
428         $this->isactive = false;
429         $this->remove_class('active_tree_node');
430     }
432     /**
433      * Checks if this node or any of its children contain the active node.
434      *
435      * Recursive.
436      *
437      * @return bool
438      */
439     public function contains_active_node() {
440         if ($this->isactive) {
441             return true;
442         } else {
443             foreach ($this->children as $child) {
444                 if ($child->isactive || $child->contains_active_node()) {
445                     return true;
446                 }
447             }
448         }
449         return false;
450     }
452     /**
453      * Finds the active node.
454      *
455      * Searches this nodes children plus all of the children for the active node
456      * and returns it if found.
457      *
458      * Recursive.
459      *
460      * @return navigation_node|false
461      */
462     public function find_active_node() {
463         if ($this->isactive) {
464             return $this;
465         } else {
466             foreach ($this->children as &$child) {
467                 $outcome = $child->find_active_node();
468                 if ($outcome !== false) {
469                     return $outcome;
470                 }
471             }
472         }
473         return false;
474     }
476     /**
477      * Searches all children for the best matching active node
478      * @return navigation_node|false
479      */
480     public function search_for_active_node() {
481         if ($this->check_if_active(URL_MATCH_BASE)) {
482             return $this;
483         } else {
484             foreach ($this->children as &$child) {
485                 $outcome = $child->search_for_active_node();
486                 if ($outcome !== false) {
487                     return $outcome;
488                 }
489             }
490         }
491         return false;
492     }
494     /**
495      * Gets the content for this node.
496      *
497      * @param bool $shorttext If true shorttext is used rather than the normal text
498      * @return string
499      */
500     public function get_content($shorttext=false) {
501         if ($shorttext && $this->shorttext!==null) {
502             return format_string($this->shorttext);
503         } else {
504             return format_string($this->text);
505         }
506     }
508     /**
509      * Gets the title to use for this node.
510      *
511      * @return string
512      */
513     public function get_title() {
514         if ($this->forcetitle || $this->action != null){
515             return $this->title;
516         } else {
517             return '';
518         }
519     }
521     /**
522      * Gets the CSS class to add to this node to describe its type
523      *
524      * @return string
525      */
526     public function get_css_type() {
527         if (array_key_exists($this->type, $this->namedtypes)) {
528             return 'type_'.$this->namedtypes[$this->type];
529         }
530         return 'type_unknown';
531     }
533     /**
534      * Finds all nodes that are expandable by AJAX
535      *
536      * @param array $expandable An array by reference to populate with expandable nodes.
537      */
538     public function find_expandable(array &$expandable) {
539         $isloggedin = (isloggedin() && !isguestuser());
540         if (!$isloggedin && $this->type > self::TYPE_CATEGORY) {
541             return;
542         }
543         foreach ($this->children as &$child) {
544             if (!$isloggedin && $child->type > self::TYPE_CATEGORY) {
545                 continue;
546             }
547             if ($child->nodetype == self::NODETYPE_BRANCH && $child->children->count()==0 && $child->display) {
548                 $child->id = 'expandable_branch_'.(count($expandable)+1);
549                 $this->add_class('canexpand');
550                 $expandable[] = array('id'=>$child->id,'branchid'=>$child->key,'type'=>$child->type);
551             }
552             $child->find_expandable($expandable);
553         }
554     }
556     /**
557      * Finds all nodes of a given type (recursive)
558      *
559      * @param int $type On of navigation_node::TYPE_*
560      * @return array
561      */
562     public function find_all_of_type($type) {
563         $nodes = $this->children->type($type);
564         foreach ($this->children as &$node) {
565             $childnodes = $node->find_all_of_type($type);
566             $nodes = array_merge($nodes, $childnodes);
567         }
568         return $nodes;
569     }
571     /**
572      * Removes this node if it is empty
573      */
574     public function trim_if_empty() {
575         if ($this->children->count() == 0) {
576             $this->remove();
577         }
578     }
580     /**
581      * Creates a tab representation of this nodes children that can be used
582      * with print_tabs to produce the tabs on a page.
583      *
584      * call_user_func_array('print_tabs', $node->get_tabs_array());
585      *
586      * @param array $inactive
587      * @param bool $return
588      * @return array Array (tabs, selected, inactive, activated, return)
589      */
590     public function get_tabs_array(array $inactive=array(), $return=false) {
591         $tabs = array();
592         $rows = array();
593         $selected = null;
594         $activated = array();
595         foreach ($this->children as $node) {
596             $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title());
597             if ($node->contains_active_node()) {
598                 if ($node->children->count() > 0) {
599                     $activated[] = $node->key;
600                     foreach ($node->children as $child) {
601                         if ($child->contains_active_node()) {
602                             $selected = $child->key;
603                         }
604                         $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title());
605                     }
606                 } else {
607                     $selected = $node->key;
608                 }
609             }
610         }
611         return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
612     }
615 /**
616  * Navigation node collection
617  *
618  * This class is responsible for managing a collection of navigation nodes.
619  * It is required because a node's unique identifier is a combination of both its
620  * key and its type.
621  *
622  * Originally an array was used with a string key that was a combination of the two
623  * however it was decided that a better solution would be to use a class that
624  * implements the standard IteratorAggregate interface.
625  *
626  * @package moodlecore
627  * @subpackage navigation
628  * @copyright 2010 Sam Hemelryk
629  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
630  */
631 class navigation_node_collection implements IteratorAggregate {
632     /**
633      * A multidimensional array to where the first key is the type and the second
634      * key is the nodes key.
635      * @var array
636      */
637     protected $collection = array();
638     /**
639      * An array that contains references to nodes in the same order they were added.
640      * This is maintained as a progressive array.
641      * @var array
642      */
643     protected $orderedcollection = array();
644     /**
645      * A reference to the last node that was added to the collection
646      * @var navigation_node
647      */
648     protected $last = null;
649     /**
650      * The total number of items added to this array.
651      * @var int
652      */
653     protected $count = 0;
654     /**
655      * Adds a navigation node to the collection
656      *
657      * @param navigation_node $node
658      * @return navigation_node
659      */
660     public function add(navigation_node $node) {
661         global $CFG;
662         $key = $node->key;
663         $type = $node->type;
664         // First check we have a 2nd dimension for this type
665         if (!array_key_exists($type, $this->orderedcollection)) {
666             $this->orderedcollection[$type] = array();
667         }
668         // Check for a collision and report if debugging is turned on
669         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
670             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
671         }
672         // Add the node to the appropriate place in the ordered structure.
673         $this->orderedcollection[$type][$key] = $node;
674         // Add a reference to the node to the progressive collection.
675         $this->collection[$this->count] = &$this->orderedcollection[$type][$key];
676         // Update the last property to a reference to this new node.
677         $this->last = &$this->orderedcollection[$type][$key];
678         $this->count++;
679         // Return the reference to the now added node
680         return $this->last;
681     }
683     /**
684      * Fetches a node from this collection.
685      *
686      * @param string|int $key The key of the node we want to find.
687      * @param int $type One of navigation_node::TYPE_*.
688      * @return navigation_node|null
689      */
690     public function get($key, $type=null) {
691         if ($type !== null) {
692             // If the type is known then we can simply check and fetch
693             if (!empty($this->orderedcollection[$type][$key])) {
694                 return $this->orderedcollection[$type][$key];
695             }
696         } else {
697             // Because we don't know the type we look in the progressive array
698             foreach ($this->collection as $node) {
699                 if ($node->key === $key) {
700                     return $node;
701                 }
702             }
703         }
704         return false;
705     }
706     /**
707      * Searches for a node with matching key and type.
708      *
709      * This function searches both the nodes in this collection and all of
710      * the nodes in each collection belonging to the nodes in this collection.
711      *
712      * Recursive.
713      *
714      * @param string|int $key  The key of the node we want to find.
715      * @param int $type  One of navigation_node::TYPE_*.
716      * @return navigation_node|null
717      */
718     public function find($key, $type=null) {
719         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
720             return $this->orderedcollection[$type][$key];
721         } else {
722             $nodes = $this->getIterator();
723             // Search immediate children first
724             foreach ($nodes as &$node) {
725                 if ($node->key === $key && ($type === null || $type === $node->type)) {
726                     return $node;
727                 }
728             }
729             // Now search each childs children
730             foreach ($nodes as &$node) {
731                 $result = $node->children->find($key, $type);
732                 if ($result !== false) {
733                     return $result;
734                 }
735             }
736         }
737         return false;
738     }
740     /**
741      * Fetches the last node that was added to this collection
742      *
743      * @return navigation_node
744      */
745     public function last() {
746         return $this->last;
747     }
748     /**
749      * Fetches all nodes of a given type from this collection
750      */
751     public function type($type) {
752         if (!array_key_exists($type, $this->orderedcollection)) {
753             $this->orderedcollection[$type] = array();
754         }
755         return $this->orderedcollection[$type];
756     }
757     /**
758      * Removes the node with the given key and type from the collection
759      *
760      * @param string|int $key
761      * @param int $type
762      * @return bool
763      */
764     public function remove($key, $type=null) {
765         $child = $this->get($key, $type);
766         if ($child !== false) {
767             foreach ($this->collection as $colkey => $node) {
768                 if ($node->key == $key && $node->type == $type) {
769                     unset($this->collection[$colkey]);
770                     break;
771                 }
772             }
773             unset($this->orderedcollection[$child->type][$child->key]);
774             $this->count--;
775             return true;
776         }
777         return false;
778     }
780     /**
781      * Gets the number of nodes in this collection
782      * @return int
783      */
784     public function count() {
785         return count($this->collection);
786     }
787     /**
788      * Gets an array iterator for the collection.
789      *
790      * This is required by the IteratorAggregator interface and is used by routines
791      * such as the foreach loop.
792      *
793      * @return ArrayIterator
794      */
795     public function getIterator() {
796         return new ArrayIterator($this->collection);
797     }
800 /**
801  * The global navigation class used for... the global navigation
802  *
803  * This class is used by PAGE to store the global navigation for the site
804  * and is then used by the settings nav and navbar to save on processing and DB calls
805  *
806  * See
807  * <ul>
808  * <li><b>{@link lib/pagelib.php}</b> {@link moodle_page::initialise_theme_and_output()}<li>
809  * <li><b>{@link lib/ajax/getnavbranch.php}</b> Called by ajax<li>
810  * </ul>
811  *
812  * @package moodlecore
813  * @subpackage navigation
814  * @copyright 2009 Sam Hemelryk
815  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
816  */
817 class global_navigation extends navigation_node {
818     /**
819      * The Moodle page this navigation object belongs to.
820      * @var moodle_page
821      */
822     protected $page;
823     /** @var bool */
824     protected $initialised = false;
825     /** @var array */
826     protected $mycourses = array();
827     /** @var array */
828     protected $rootnodes = array();
829     /** @var bool */
830     protected $showemptysections = false;
831     /** @var array */
832     protected $extendforuser = array();
833     /** @var navigation_cache */
834     protected $cache;
835     /** @var array */
836     protected $addedcourses = array();
837     /** @var int */
838     protected $expansionlimit = 0;
840     /**
841      * Constructs a new global navigation
842      *
843      * @param moodle_page $page The page this navigation object belongs to
844      */
845     public function __construct(moodle_page $page) {
846         global $CFG, $SITE, $USER;
848         if (during_initial_install()) {
849             return;
850         }
852         if (get_home_page() == HOMEPAGE_SITE) {
853             // We are using the site home for the root element
854             $properties = array(
855                 'key' => 'home',
856                 'type' => navigation_node::TYPE_SYSTEM,
857                 'text' => get_string('home'),
858                 'action' => new moodle_url('/')
859             );
860         } else {
861             // We are using the users my moodle for the root element
862             $properties = array(
863                 'key' => 'myhome',
864                 'type' => navigation_node::TYPE_SYSTEM,
865                 'text' => get_string('myhome'),
866                 'action' => new moodle_url('/my/')
867             );
868         }
870         // Use the parents consturctor.... good good reuse
871         parent::__construct($properties);
873         // Initalise and set defaults
874         $this->page = $page;
875         $this->forceopen = true;
876         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
878         // Check if we need to clear the cache
879         $regenerate = optional_param('regenerate', null, PARAM_TEXT);
880         if ($regenerate === 'navigation') {
881             $this->cache->clear();
882         }
883     }
885     /**
886      * Initialises the navigation object.
887      *
888      * This causes the navigation object to look at the current state of the page
889      * that it is associated with and then load the appropriate content.
890      *
891      * This should only occur the first time that the navigation structure is utilised
892      * which will normally be either when the navbar is called to be displayed or
893      * when a block makes use of it.
894      *
895      * @return bool
896      */
897     public function initialise() {
898         global $CFG, $SITE, $USER, $DB;
899         // Check if it has alread been initialised
900         if ($this->initialised || during_initial_install()) {
901             return true;
902         }
903         $this->initialised = true;
905         // Set up the five base root nodes. These are nodes where we will put our
906         // content and are as follows:
907         // site:        Navigation for the front page.
908         // myprofile:     User profile information goes here.
909         // mycourses:   The users courses get added here.
910         // courses:     Additional courses are added here.
911         // users:       Other users information loaded here.
912         $this->rootnodes = array();
913         if (get_home_page() == HOMEPAGE_SITE) {
914             // The home element should be my moodle because the root element is the site
915             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
916                 $this->rootnodes['home']      = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
917             }
918         } else {
919             // The home element should be the site because the root node is my moodle
920             $this->rootnodes['home']      = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
921             if ($CFG->defaulthomepage == HOMEPAGE_MY) {
922                 // We need to stop automatic redirection
923                 $this->rootnodes['home']->action->param('redirect', '0');
924             }
925         }
926         $this->rootnodes['site']      = $this->add_course($SITE);
927         $this->rootnodes['myprofile']   = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
928         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses');
929         $this->rootnodes['courses']   = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
930         $this->rootnodes['users']     = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
932         // Fetch all of the users courses.
933         $limit = 20;
934         if (!empty($CFG->navcourselimit)) {
935             $limit = $CFG->navcourselimit;
936         }
938         if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') == 1) {
939             // There is only one category so we don't want to show categories
940             $CFG->navshowcategories = false;
941         }
943         $this->mycourses = enrol_get_my_courses(NULL, 'visible DESC,sortorder ASC', $limit);
944         $showallcourses = (count($this->mycourses) == 0 || !empty($CFG->navshowallcourses));
945         $showcategories = ($showallcourses && !empty($CFG->navshowcategories));
947         // Check if any courses were returned.
948         if (count($this->mycourses) > 0) {
949             // Add all of the users courses to the navigation
950             foreach ($this->mycourses as &$course) {
951                 $course->coursenode = $this->add_course($course);
952             }
953         }
955         if ($showcategories) {
956             // Load all categories (ensures we get the base categories)
957             $this->load_all_categories();
958         } else if ($showallcourses) {
959             // Load all courses
960             $this->load_all_courses();
961         }
963         // We always load the frontpage course to ensure it is available without
964         // JavaScript enabled.
965         $frontpagecourse = $this->load_course($SITE);
966         $this->add_front_page_course_essentials($frontpagecourse, $SITE);
968         $canviewcourseprofile = true;
970         // Next load context specific content into the navigation
971         switch ($this->page->context->contextlevel) {
972             case CONTEXT_SYSTEM :
973             case CONTEXT_COURSECAT :
974                 // This has already been loaded we just need to map the variable
975                 $coursenode = $frontpagecourse;
976                 break;
977             case CONTEXT_BLOCK :
978             case CONTEXT_COURSE :
979                 // Load the course associated with the page into the navigation
980                 $course = $this->page->course;
981                 $coursenode = $this->load_course($course);
982                 // If the user is not enrolled then we only want to show the
983                 // course node and not populate it.
984                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
985                 if (!is_enrolled($coursecontext) && !has_capability('moodle/course:view', $coursecontext)) {
986                     $coursenode->make_active();
987                     $canviewcourseprofile = false;
988                     break;
989                 }
990                 // Add the essentials such as reports etc...
991                 $this->add_course_essentials($coursenode, $course);
992                 if ($this->format_display_course_content($course->format)) {
993                     // Load the course sections
994                     $sections = $this->load_course_sections($course, $coursenode);
995                 }
996                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
997                     $coursenode->make_active();
998                 }
999                 break;
1000             case CONTEXT_MODULE :
1001                 $course = $this->page->course;
1002                 $cm = $this->page->cm;
1003                 // Load the course associated with the page into the navigation
1004                 $coursenode = $this->load_course($course);
1006                 // If the user is not enrolled then we only want to show the
1007                 // course node and not populate it.
1008                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1009                 if (!is_enrolled($coursecontext) && !has_capability('moodle/course:view', $coursecontext)) {
1010                     $coursenode->make_active();
1011                     $canviewcourseprofile = false;
1012                     break;
1013                 }
1015                 $this->add_course_essentials($coursenode, $course);
1016                 // Load the course sections into the page
1017                 $sections = $this->load_course_sections($course, $coursenode);
1018                 if ($course->id !== SITEID) {
1019                     // Find the section for the $CM associated with the page and collect
1020                     // its section number.
1021                     foreach ($sections as $section) {
1022                         if ($section->id == $cm->section) {
1023                             $cm->sectionnumber = $section->section;
1024                             break;
1025                         }
1026                     }
1028                     // Load all of the section activities for the section the cm belongs to.
1029                     $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course));
1030                 } else {
1031                     $activities = array();
1032                     $activities[$cm->id] = $coursenode->get($cm->id, navigation_node::TYPE_ACTIVITY);
1033                 }
1034                 // Finally load the cm specific navigaton information
1035                 $this->load_activity($cm, $course, $activities[$cm->id]);
1036                 // Check if we have an active ndoe
1037                 if (!$activities[$cm->id]->contains_active_node() && !$activities[$cm->id]->search_for_active_node()) {
1038                     // And make the activity node active.
1039                     $activities[$cm->id]->make_active();
1040                 }
1041                 break;
1042             case CONTEXT_USER :
1043                 $course = $this->page->course;
1044                 if ($course->id != SITEID) {
1045                     // Load the course associated with the user into the navigation
1046                     $coursenode = $this->load_course($course);
1047                     // If the user is not enrolled then we only want to show the
1048                     // course node and not populate it.
1049                     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1050                     if (!is_enrolled($coursecontext) && !has_capability('moodle/course:view', $coursecontext)) {
1051                         $coursenode->make_active();
1052                         $canviewcourseprofile = false;
1053                         break;
1054                     }
1055                     $this->add_course_essentials($coursenode, $course);
1056                     $sections = $this->load_course_sections($course, $coursenode);
1057                 }
1058                 break;
1059         }
1061         $limit = 20;
1062         if (!empty($CFG->navcourselimit)) {
1063             $limit = $CFG->navcourselimit;
1064         }
1065         if ($showcategories) {
1066             $categories = $this->find_all_of_type(self::TYPE_CATEGORY);
1067             foreach ($categories as &$category) {
1068                 if ($category->children->count() >= $limit) {
1069                     $url = new moodle_url('/course/category.php', array('id'=>$category->key));
1070                     $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1071                 }
1072             }
1073         } else if ($this->rootnodes['courses']->children->count() >= $limit) {
1074             $this->rootnodes['courses']->add(get_string('viewallcoursescategories'), new moodle_url('/course/index.php'), self::TYPE_SETTING);
1075         }
1077         // Load for the current user
1078         $this->load_for_user();
1079         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != SITEID && $canviewcourseprofile) {
1080             $this->load_for_user(null, true);
1081         }
1082         // Load each extending user into the navigation.
1083         foreach ($this->extendforuser as $user) {
1084             if ($user->id !== $USER->id) {
1085                 $this->load_for_user($user);
1086             }
1087         }
1089         // Give the local plugins a chance to include some navigation if they want.
1090         foreach (get_list_of_plugins('local') as $plugin) {
1091             if (!file_exists($CFG->dirroot.'/local/'.$plugin.'/lib.php')) {
1092                 continue;
1093             }
1094             require_once($CFG->dirroot.'/local/'.$plugin.'/lib.php');
1095             $function = $plugin.'_extends_navigation';
1096             if (function_exists($function)) {
1097                 $function($this);
1098             }
1099         }
1101         // Remove any empty root nodes
1102         foreach ($this->rootnodes as $node) {
1103             // Dont remove the home node
1104             if ($node->key !== 'home' && !$node->has_children()) {
1105                 $node->remove();
1106             }
1107         }
1109         if (!$this->contains_active_node()) {
1110             $this->search_for_active_node();
1111         }
1113         // If the user is not logged in modify the navigation structure as detailed
1114         // in {@link http://docs.moodle.org/en/Development:Navigation_2.0_structure}
1115         if (!isloggedin()) {
1116             $activities = clone($this->rootnodes['site']->children);
1117             $this->rootnodes['site']->remove();
1118             $children = clone($this->children);
1119             $this->children = new navigation_node_collection();
1120             foreach ($activities as $child) {
1121                 $this->children->add($child);
1122             }
1123             foreach ($children as $child) {
1124                 $this->children->add($child);
1125             }
1126         }
1127         return true;
1128     }
1129     /**
1130      * Checks the course format to see whether it wants the navigation to load
1131      * additional information for the course.
1132      *
1133      * This function utilises a callback that can exist within the course format lib.php file
1134      * The callback should be a function called:
1135      * callback_{formatname}_display_content()
1136      * It doesn't get any arguments and should return true if additional content is
1137      * desired. If the callback doesn't exist we assume additional content is wanted.
1138      *
1139      * @param string $format The course format
1140      * @return bool
1141      */
1142     protected function format_display_course_content($format) {
1143         global $CFG;
1144         $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
1145         if (file_exists($formatlib)) {
1146             require_once($formatlib);
1147             $displayfunc = 'callback_'.$format.'_display_content';
1148             if (function_exists($displayfunc) && !$displayfunc()) {
1149                 return $displayfunc();
1150             }
1151         }
1152         return true;
1153     }
1155     /**
1156      * Loads of the the courses in Moodle into the navigation.
1157      *
1158      * @param string|array $categoryids Either a string or array of category ids to load courses for
1159      * @return array An array of navigation_node
1160      */
1161     protected function load_all_courses($categoryids=null) {
1162         global $CFG, $DB, $USER;
1164         if ($categoryids !== null) {
1165             if (is_array($categoryids)) {
1166                 list ($select, $params) = $DB->get_in_or_equal($categoryids);
1167             } else {
1168                 $select = '= ?';
1169                 $params = array($categoryids);
1170             }
1171             array_unshift($params, SITEID);
1172             $select = ' AND c.category '.$select;
1173         } else {
1174             $params = array(SITEID);
1175             $select = '';
1176         }
1178         list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1179         $sql = "SELECT c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.category,cat.path AS categorypath $ccselect
1180                 FROM {course} c
1181                 $ccjoin
1182                 LEFT JOIN {course_categories} cat ON cat.id=c.category
1183                 WHERE c.id <> ?$select
1184                 ORDER BY c.sortorder ASC";
1185         $limit = 20;
1186         if (!empty($CFG->navcourselimit)) {
1187             $limit = $CFG->navcourselimit;
1188         }
1189         $courses = $DB->get_records_sql($sql, $params, 0, $limit);
1191         $coursenodes = array();
1192         foreach ($courses as $course) {
1193             context_instance_preload($course);
1194             $coursenodes[$course->id] = $this->add_course($course);
1195         }
1196         return $coursenodes;
1197     }
1199     /**
1200      * Loads all categories (top level or if an id is specified for that category)
1201      *
1202      * @param int $categoryid
1203      * @return void
1204      */
1205     protected function load_all_categories($categoryid=null) {
1206         global $DB;
1207         if ($categoryid == null)  {
1208             $categories = $DB->get_records('course_categories', array('parent'=>'0'), 'sortorder');
1209         } else {
1210             $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST);
1211             $wantedids = explode('/', trim($category->path, '/'));
1212             list($select, $params) = $DB->get_in_or_equal($wantedids);
1213             $select = 'id '.$select.' OR parent '.$select;
1214             $params = array_merge($params, $params);
1215             $categories = $DB->get_records_select('course_categories', $select, $params, 'sortorder');
1216         }
1217         $structured = array();
1218         $categoriestoload = array();
1219         foreach ($categories as $category) {
1220             if ($category->parent == '0') {
1221                 $structured[$category->id] = array('category'=>$category, 'children'=>array());
1222             } else {
1223                 if ($category->parent == $categoryid) {
1224                     $categoriestoload[] = $category->id;
1225                 }
1226                 $parents = array();
1227                 $id = $category->parent;
1228                 while ($id != '0') {
1229                     $parents[] = $id;
1230                     if (!array_key_exists($id, $categories)) {
1231                         $categories[$id] = $DB->get_record('course_categories', array('id'=>$id), '*', MUST_EXIST);
1232                     }
1233                     $id = $categories[$id]->parent;
1234                 }
1235                 $parents = array_reverse($parents);
1236                 $parentref = &$structured[array_shift($parents)];
1237                 foreach ($parents as $parent) {
1238                     if (!array_key_exists($parent, $parentref['children'])) {
1239                         $parentref['children'][$parent] = array('category'=>$categories[$parent], 'children'=>array());
1240                     }
1241                     $parentref = &$parentref['children'][$parent];
1242                 }
1243                 if (!array_key_exists($category->id, $parentref['children'])) {
1244                     $parentref['children'][$category->id] = array('category'=>$category, 'children'=>array());
1245                 }
1246             }
1247         }
1249         foreach ($structured as $category) {
1250             $this->add_category($category, $this->rootnodes['courses']);
1251         }
1253         if ($categoryid !== null && count($wantedids)) {
1254             foreach ($wantedids as $catid) {
1255                 $this->load_all_courses($catid);
1256             }
1257         }
1258     }
1260     /**
1261      * Adds a structured category to the navigation in the correct order/place
1262      *
1263      * @param object $cat
1264      * @param navigation_node $parent
1265      */
1266     protected function add_category($cat, navigation_node $parent) {
1267         $category = $parent->get($cat['category']->id, navigation_node::TYPE_CATEGORY);
1268         if (!$category) {
1269             $category = $cat['category'];
1270             $url = new moodle_url('/course/category.php', array('id'=>$category->id));
1271             $category = $parent->add($category->name, null, self::TYPE_CATEGORY, $category->name, $category->id);
1272         }
1273         foreach ($cat['children'] as $child) {
1274             $this->add_category($child, $category);
1275         }
1276     }
1278     /**
1279      * Loads the given course into the navigation
1280      *
1281      * @param stdClass $course
1282      * @return navigation_node
1283      */
1284     protected function load_course(stdClass $course) {
1285         if ($course->id == SITEID) {
1286             $coursenode = $this->rootnodes['site'];
1287         } else if (array_key_exists($course->id, $this->mycourses)) {
1288             if (!isset($this->mycourses[$course->id]->coursenode)) {
1289                 $this->mycourses[$course->id]->coursenode = $this->add_course($course);
1290             }
1291             $coursenode = $this->mycourses[$course->id]->coursenode;
1292         } else {
1293             $coursenode = $this->add_course($course);
1294         }
1295         return $coursenode;
1296     }
1298     /**
1299      * Loads all of the courses section into the navigation.
1300      *
1301      * This function utilisies a callback that can be implemented within the course
1302      * formats lib.php file to customise the navigation that is generated at this
1303      * point for the course.
1304      *
1305      * By default (if not defined) the method {@see load_generic_course_sections} is
1306      * called instead.
1307      *
1308      * @param stdClass $course Database record for the course
1309      * @param navigation_node $coursenode The course node within the navigation
1310      * @return array Array of navigation nodes for the section with key = section id
1311      */
1312     protected function load_course_sections(stdClass $course, navigation_node $coursenode) {
1313         global $CFG;
1314         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
1315         $structurefunc = 'callback_'.$course->format.'_load_content';
1316         if (function_exists($structurefunc)) {
1317             return $structurefunc($this, $course, $coursenode);
1318         } else if (file_exists($structurefile)) {
1319             require_once $structurefile;
1320             if (function_exists($structurefunc)) {
1321                 return $structurefunc($this, $course, $coursenode);
1322             } else {
1323                 return $this->load_generic_course_sections($course, $coursenode);
1324             }
1325         } else {
1326             return $this->load_generic_course_sections($course, $coursenode);
1327         }
1328     }
1330     /**
1331      * Generically loads the course sections into the course's navigation.
1332      *
1333      * @param stdClass $course
1334      * @param navigation_node $coursenode
1335      * @param string $name The string that identifies each section. e.g Topic, or Week
1336      * @param string $activeparam The url used to identify the active section
1337      * @return array An array of course section nodes
1338      */
1339     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $courseformat='unknown') {
1340         global $CFG, $DB, $USER;
1342         require_once($CFG->dirroot.'/course/lib.php');
1344         $modinfo = get_fast_modinfo($course);
1345         $sections = array_slice(get_all_sections($course->id), 0, $course->numsections+1, true);
1346         $viewhiddensections = has_capability('moodle/course:viewhiddensections', $this->page->context);
1348         if (isloggedin() && !isguestuser()) {
1349             $activesection = $DB->get_field("course_display", "display", array("userid"=>$USER->id, "course"=>$course->id));
1350         } else {
1351             $activesection = null;
1352         }
1354         $namingfunction = 'callback_'.$courseformat.'_get_section_name';
1355         $namingfunctionexists = (function_exists($namingfunction));
1357         $activeparamfunction = 'callback_'.$courseformat.'_request_key';
1358         if (function_exists($activeparamfunction)) {
1359             $activeparam = $activeparamfunction();
1360         } else {
1361             $activeparam = 'section';
1362         }
1363         $navigationsections = array();
1364         foreach ($sections as $sectionid=>$section) {
1365             $section = clone($section);
1366             if ($course->id == SITEID) {
1367                 $this->load_section_activities($coursenode, $section->section, $modinfo);
1368             } else {
1369                 if ((!$viewhiddensections && !$section->visible) || (!$this->showemptysections && !array_key_exists($section->section, $modinfo->sections))) {
1370                     continue;
1371                 }
1372                 if ($namingfunctionexists) {
1373                     $sectionname = $namingfunction($course, $section, $sections);
1374                 } else {
1375                     $sectionname = get_string('section').' '.$section->section;
1376                 }
1377                 $url = new moodle_url('/course/view.php', array('id'=>$course->id, $activeparam=>$section->section));
1378                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1379                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1380                 $sectionnode->hidden = (!$section->visible);
1381                 if ($this->page->context->contextlevel != CONTEXT_MODULE && ($sectionnode->isactive || ($activesection != null && $section->section == $activesection))) {
1382                     $sectionnode->force_open();
1383                     $this->load_section_activities($sectionnode, $section->section, $modinfo);
1384                 }
1385                 $section->sectionnode = $sectionnode;
1386                 $navigationsections[$sectionid] = $section;
1387             }
1388         }
1389         return $navigationsections;
1390     }
1391     /**
1392      * Loads all of the activities for a section into the navigation structure.
1393      *
1394      * @param navigation_node $sectionnode
1395      * @param int $sectionnumber
1396      * @param stdClass $modinfo Object returned from {@see get_fast_modinfo()}
1397      * @return array Array of activity nodes
1398      */
1399     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, $modinfo) {
1400         if (!array_key_exists($sectionnumber, $modinfo->sections)) {
1401             return true;
1402         }
1404         $viewhiddenactivities = has_capability('moodle/course:viewhiddenactivities', $this->page->context);
1406         $activities = array();
1408         foreach ($modinfo->sections[$sectionnumber] as $cmid) {
1409             $cm = $modinfo->cms[$cmid];
1410             if (!$viewhiddenactivities && !$cm->visible) {
1411                 continue;
1412             }
1413             if ($cm->icon) {
1414                 $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
1415             } else {
1416                 $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
1417             }
1418             $url = new moodle_url('/mod/'.$cm->modname.'/view.php', array('id'=>$cm->id));
1419             $activitynode = $sectionnode->add($cm->name, $url, navigation_node::TYPE_ACTIVITY, $cm->name, $cm->id, $icon);
1420             $activitynode->title(get_string('modulename', $cm->modname));
1421             $activitynode->hidden = (!$cm->visible);
1422             if ($this->module_extends_navigation($cm->modname)) {
1423                 $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
1424             }
1425             $activities[$cmid] = $activitynode;
1426         }
1428         return $activities;
1429     }
1430     /**
1431      * Loads the navigation structure for the given activity into the activities node.
1432      *
1433      * This method utilises a callback within the modules lib.php file to load the
1434      * content specific to activity given.
1435      *
1436      * The callback is a method: {modulename}_extend_navigation()
1437      * Examples:
1438      *  * {@see forum_extend_navigation()}
1439      *  * {@see workshop_extend_navigation()}
1440      *
1441      * @param stdClass $cm
1442      * @param stdClass $course
1443      * @param navigation_node $activity
1444      * @return bool
1445      */
1446     protected function load_activity(stdClass $cm, stdClass $course, navigation_node $activity) {
1447         global $CFG, $DB;
1449         $activity->make_active();
1450         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
1451         $function = $cm->modname.'_extend_navigation';
1453         if (file_exists($file)) {
1454             require_once($file);
1455             if (function_exists($function)) {
1456                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
1457                 $function($activity, $course, $activtyrecord, $cm);
1458                 return true;
1459             }
1460         }
1461         $activity->nodetype = navigation_node::NODETYPE_LEAF;
1462         return false;
1463     }
1464     /**
1465      * Loads user specific information into the navigation in the appopriate place.
1466      *
1467      * If no user is provided the current user is assumed.
1468      *
1469      * @param stdClass $user
1470      * @return bool
1471      */
1472     protected function load_for_user($user=null, $forceforcontext=false) {
1473         global $DB, $CFG, $USER;
1475         $iscurrentuser = false;
1476         if ($user === null) {
1477             // We can't require login here but if the user isn't logged in we don't
1478             // want to show anything
1479             if (!isloggedin() || isguestuser()) {
1480                 return false;
1481             }
1482             $user = $USER;
1483             $iscurrentuser = true;
1484         } else if (!is_object($user)) {
1485             // If the user is not an object then get them from the database
1486             $user = $DB->get_record('user', array('id'=>(int)$user), '*', MUST_EXIST);
1487         }
1488         $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1490         // Get the course set against the page, by default this will be the site
1491         $course = $this->page->course;
1492         $baseargs = array('id'=>$user->id);
1493         if ($course->id !== SITEID && (!$iscurrentuser || $forceforcontext)) {
1494             if (array_key_exists($course->id, $this->mycourses)) {
1495                 $coursenode = $this->mycourses[$course->id]->coursenode;
1496             } else {
1497                 $coursenode = $this->rootnodes['courses']->find($course->id, navigation_node::TYPE_COURSE);
1498                 if (!$coursenode) {
1499                     $coursenode = $this->load_course($course);
1500                 }
1501             }
1502             $baseargs['course'] = $course->id;
1503             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1504             $issitecourse = false;
1505         } else {
1506             // Load all categories and get the context for the system
1507             $coursecontext = get_context_instance(CONTEXT_SYSTEM);
1508             $issitecourse = true;
1509         }
1511         // Create a node to add user information under.
1512         if ($iscurrentuser && !$forceforcontext) {
1513             // If it's the current user the information will go under the profile root node
1514             $usernode = $this->rootnodes['myprofile'];
1515         } else {
1516             if (!$issitecourse) {
1517                 // Not the current user so add it to the participants node for the current course
1518                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
1519             } else {
1520                 // This is the site so add a users node to the root branch
1521                 $usersnode = $this->rootnodes['users'];
1522                 $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
1523             }
1524             // Add a branch for the current user
1525             $usernode = $usersnode->add(fullname($user, true), null, self::TYPE_USER, null, $user->id);
1527             if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
1528                 $usernode->make_active();
1529             }
1530         }
1532         // If the user is the current user or has permission to view the details of the requested
1533         // user than add a view profile link.
1534         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
1535             if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
1536                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
1537             } else {
1538                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
1539             }
1540         }
1542         // Add nodes for forum posts and discussions if the user can view either or both
1543         $canviewposts = has_capability('moodle/user:readuserposts', $usercontext);
1544         $canviewdiscussions = has_capability('mod/forum:viewdiscussion', $coursecontext);
1545         if ($canviewposts || $canviewdiscussions) {
1546             $forumtab = $usernode->add(get_string('forumposts', 'forum'));
1547             if ($canviewposts) {
1548                 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
1549             }
1550             if ($canviewdiscussions) {
1551                 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions', 'course'=>$course->id))));
1552             }
1553         }
1555         // Add blog nodes
1556         if (!empty($CFG->bloglevel)) {
1557             require_once($CFG->dirroot.'/blog/lib.php');
1558             // Get all options for the user
1559             $options = blog_get_options_for_user($user);
1560             if (count($options) > 0) {
1561                 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
1562                 foreach ($options as $option) {
1563                     $blogs->add($option['string'], $option['link']);
1564                 }
1565             }
1566         }
1568         if (!empty($CFG->messaging)) {
1569             $messageargs = null;
1570             if ($USER->id!=$user->id) {
1571                 $messageargs = array('id'=>$user->id);
1572             }
1573             $url = new moodle_url('/message/index.php',$messageargs);
1574             $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
1575         }
1577         // TODO: Private file capability check
1578         if ($iscurrentuser) {
1579             $url = new moodle_url('/user/files.php');
1580             $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
1581         }
1583         // Add a node to view the users notes if permitted
1584         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
1585             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
1586             if ($coursecontext->instanceid) {
1587                 $url->param('course', $coursecontext->instanceid);
1588             }
1589             $usernode->add(get_string('notes', 'notes'), $url);
1590         }
1592         // Add a reports tab and then add reports the the user has permission to see.
1593         $anyreport  = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
1595         $viewreports = ($anyreport || ($course->showreports && $iscurrentuser && $forceforcontext));
1596         if ($viewreports) {
1597             $reporttab = $usernode->add(get_string('activityreports'));
1598             $reportargs = array('user'=>$user->id);
1599             if (!empty($course->id)) {
1600                 $reportargs['id'] = $course->id;
1601             } else {
1602                 $reportargs['id'] = SITEID;
1603             }
1604             if ($viewreports || has_capability('coursereport/outline:view', $coursecontext)) {
1605                 $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
1606                 $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
1607             }
1609             if ($viewreports || has_capability('coursereport/log:viewtoday', $coursecontext)) {
1610                 $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
1611             }
1613             if ($viewreports || has_capability('coursereport/log:view', $coursecontext)) {
1614                 $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
1615             }
1617             if (!empty($CFG->enablestats)) {
1618                 if ($viewreports || has_capability('coursereport/stats:view', $coursecontext)) {
1619                     $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
1620                 }
1621             }
1623             $gradeaccess = false;
1624             if (has_capability('moodle/grade:viewall', $coursecontext)) {
1625                 //ok - can view all course grades
1626                 $gradeaccess = true;
1627             } else if ($course->showgrades) {
1628                 if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) {
1629                     //ok - can view own grades
1630                     $gradeaccess = true;
1631                 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
1632                     // ok - can view grades of this user - parent most probably
1633                     $gradeaccess = true;
1634                 } else if ($anyreport) {
1635                     // ok - can view grades of this user - parent most probably
1636                     $gradeaccess = true;
1637                 }
1638             }
1639             if ($gradeaccess) {
1640                 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'grade'))));
1641             }
1643             // Check the number of nodes in the report node... if there are none remove
1644             // the node
1645             if (count($reporttab->children)===0) {
1646                 $usernode->remove_child($reporttab);
1647             }
1648         }
1650         // If the user is the current user add the repositories for the current user
1651         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
1652         if ($iscurrentuser) {
1653             require_once($CFG->dirroot . '/repository/lib.php');
1654             $editabletypes = repository::get_editable_types($usercontext);
1655             if (!empty($editabletypes)) {
1656                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
1657             }
1658         } else if ($course->id == SITEID && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
1660             // Add view grade report is permitted
1661             $reports = get_plugin_list('gradereport');
1662             arsort($reports); // user is last, we want to test it first
1664             $userscourses = enrol_get_users_courses($user->id);
1665             $userscoursesnode = $usernode->add(get_string('courses'));
1667             foreach ($userscourses as $usercourse) {
1668                 $usercoursecontext = get_context_instance(CONTEXT_COURSE, $usercourse->id);
1669                 $usercoursenode = $userscoursesnode->add($usercourse->shortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
1671                 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
1672                 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
1673                     foreach ($reports as $plugin => $plugindir) {
1674                         if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
1675                             //stop when the first visible plugin is found
1676                             $gradeavailable = true;
1677                             break;
1678                         }
1679                     }
1680                 }
1682                 if ($gradeavailable) {
1683                     $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
1684                     $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
1685                 }
1687                 // Add a node to view the users notes if permitted
1688                 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
1689                     $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
1690                     $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
1691                 }
1693                 if (has_capability('moodle/course:view', get_context_instance(CONTEXT_COURSE, $usercourse->id))) {
1694                     $usercoursenode->add(get_string('entercourse'), new moodle_url('/course/view.php', array('id'=>$usercourse->id)), self::TYPE_SETTING, null, null, new pix_icon('i/course', ''));
1695                 }
1697                 $outlinetreport = ($anyreport || has_capability('coursereport/outline:view', $usercoursecontext));
1698                 $logtodayreport = ($anyreport || has_capability('coursereport/log:viewtoday', $usercoursecontext));
1699                 $logreport =      ($anyreport || has_capability('coursereport/log:view', $usercoursecontext));
1700                 $statsreport =    ($anyreport || has_capability('coursereport/stats:view', $usercoursecontext));
1701                 if ($outlinetreport || $logtodayreport || $logreport || $statsreport) {
1702                     $reporttab = $usercoursenode->add(get_string('activityreports'));
1703                     $reportargs = array('user'=>$user->id, 'id'=>$usercourse->id);
1704                     if ($outlinetreport) {
1705                         $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
1706                         $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
1707                     }
1709                     if ($logtodayreport) {
1710                         $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
1711                     }
1713                     if ($logreport) {
1714                         $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
1715                     }
1717                     if (!empty($CFG->enablestats) && $statsreport) {
1718                         $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
1719                     }
1720                 }
1721             }
1722         }
1723         return true;
1724     }
1726     /**
1727      * This method simply checks to see if a given module can extend the navigation.
1728      *
1729      * @param string $modname
1730      * @return bool
1731      */
1732     protected function module_extends_navigation($modname) {
1733         global $CFG;
1734         if ($this->cache->cached($modname.'_extends_navigation')) {
1735             return $this->cache->{$modname.'_extends_navigation'};
1736         }
1737         $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
1738         $function = $modname.'_extend_navigation';
1739         if (function_exists($function)) {
1740             $this->cache->{$modname.'_extends_navigation'} = true;
1741             return true;
1742         } else if (file_exists($file)) {
1743             require_once($file);
1744             if (function_exists($function)) {
1745                 $this->cache->{$modname.'_extends_navigation'} = true;
1746                 return true;
1747             }
1748         }
1749         $this->cache->{$modname.'_extends_navigation'} = false;
1750         return false;
1751     }
1752     /**
1753      * Extends the navigation for the given user.
1754      *
1755      * @param stdClass $user A user from the database
1756      */
1757     public function extend_for_user($user) {
1758         $this->extendforuser[] = $user;
1759     }
1761     /**
1762      * Returns all of the users the navigation is being extended for
1763      *
1764      * @return array
1765      */
1766     public function get_extending_users() {
1767         return $this->extendforuser;
1768     }
1769     /**
1770      * Adds the given course to the navigation structure.
1771      *
1772      * @param stdClass $course
1773      * @return navigation_node
1774      */
1775     public function add_course(stdClass $course, $forcegeneric = false) {
1776         global $CFG;
1777         $canviewhidden = has_capability('moodle/course:viewhiddencourses', $this->page->context);
1778         if ($course->id !== SITEID && !$canviewhidden && !$course->visible) {
1779             return false;
1780         }
1782         $issite = ($course->id == SITEID);
1783         $ismycourse = (array_key_exists($course->id, $this->mycourses) && !$forcegeneric);
1784         $displaycategories = (!$ismycourse && !$issite && !empty($CFG->navshowcategories));
1785         $shortname = $course->shortname;
1787         if ($issite) {
1788             $parent = $this;
1789             $url = null;
1790             $shortname = get_string('sitepages');
1791         } else if ($ismycourse) {
1792             $parent = $this->rootnodes['mycourses'];
1793             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
1794         } else {
1795             $parent = $this->rootnodes['courses'];
1796             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
1797         }
1799         if ($displaycategories) {
1800             // We need to load the category structure for this course
1801             $categoryfound = false;
1802             if (!empty($course->categorypath)) {
1803                 $categories = explode('/', trim($course->categorypath, '/'));
1804                 $category = $parent;
1805                 while ($category && $categoryid = array_shift($categories)) {
1806                     $category = $category->get($categoryid, self::TYPE_CATEGORY);
1807                 }
1808                 if ($category instanceof navigation_node) {
1809                     $parent = $category;
1810                     $categoryfound = true;
1811                 }
1812                 if (!$categoryfound && $forcegeneric) {
1813                     $this->load_all_categories($course->category);
1814                     if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) {
1815                         $parent = $category;
1816                         $categoryfound = true;
1817                     }
1818                 }
1819             } else if (!empty($course->category)) {
1820                 $this->load_all_categories($course->category);
1821                 if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) {
1822                     $parent = $category;
1823                     $categoryfound = true;
1824                 }
1825                 if (!$categoryfound && !$forcegeneric) {
1826                     $this->load_all_categories($course->category);
1827                     if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) {
1828                         $parent = $category;
1829                         $categoryfound = true;
1830                     }
1831                 }
1832             }
1833         }
1835         // We found the course... we can return it now :)
1836         if ($coursenode = $parent->get($course->id, self::TYPE_COURSE)) {
1837             return $coursenode;
1838         }
1840         $coursenode = $parent->add($shortname, $url, self::TYPE_COURSE, $shortname, $course->id);
1841         $coursenode->nodetype = self::NODETYPE_BRANCH;
1842         $coursenode->hidden = (!$course->visible);
1843         $coursenode->title($course->fullname);
1844         $this->addedcourses[$course->id] = &$coursenode;
1845         if ($ismycourse && !empty($CFG->navshowallcourses)) {
1846             // We need to add this course to the general courses node as well as the
1847             // my courses node, rerun the function with the kill param
1848             $genericcourse = $this->add_course($course, true);
1849             if ($genericcourse->isactive) {
1850                 $genericcourse->make_inactive();
1851                 $genericcourse->collapse = true;
1852                 if ($genericcourse->parent && $genericcourse->parent->type == self::TYPE_CATEGORY) {
1853                     $parent = $genericcourse->parent;
1854                     while ($parent && $parent->type == self::TYPE_CATEGORY) {
1855                         $parent->collapse = true;
1856                         $parent = $parent->parent;
1857                     }
1858                 }
1859             }
1860         }
1861         return $coursenode;
1862     }
1863     /**
1864      * Adds essential course nodes to the navigation for the given course.
1865      *
1866      * This method adds nodes such as reports, blogs and participants
1867      *
1868      * @param navigation_node $coursenode
1869      * @param stdClass $course
1870      * @return bool
1871      */
1872     public function add_course_essentials(navigation_node $coursenode, stdClass $course) {
1873         global $CFG;
1875         if ($course->id == SITEID) {
1876             return $this->add_front_page_course_essentials($coursenode, $course);
1877         }
1879         if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
1880             return true;
1881         }
1883         //Participants
1884         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
1885             require_once($CFG->dirroot.'/blog/lib.php');
1886             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
1887             $currentgroup = groups_get_course_group($course, true);
1888             if ($course->id == SITEID) {
1889                 $filterselect = '';
1890             } else if ($course->id && !$currentgroup) {
1891                 $filterselect = $course->id;
1892             } else {
1893                 $filterselect = $currentgroup;
1894             }
1895             $filterselect = clean_param($filterselect, PARAM_INT);
1896             if ($CFG->bloglevel >= 3) {
1897                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
1898                 $participants->add(get_string('blogs','blog'), $blogsurls->out());
1899             }
1900             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
1901                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
1902             }
1903         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
1904             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
1905         }
1907         // View course reports
1908         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
1909             $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', ''));
1910             $coursereports = get_plugin_list('coursereport');
1911             foreach ($coursereports as $report=>$dir) {
1912                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
1913                 if (file_exists($libfile)) {
1914                     require_once($libfile);
1915                     $reportfunction = $report.'_report_extend_navigation';
1916                     if (function_exists($report.'_report_extend_navigation')) {
1917                         $reportfunction($reportnav, $course, $this->page->context);
1918                     }
1919                 }
1920             }
1921         }
1922         return true;
1923     }
1924     /**
1925      * This generates the the structure of the course that won't be generated when
1926      * the modules and sections are added.
1927      *
1928      * Things such as the reports branch, the participants branch, blogs... get
1929      * added to the course node by this method.
1930      *
1931      * @param navigation_node $coursenode
1932      * @param stdClass $course
1933      * @return bool True for successfull generation
1934      */
1935     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
1936         global $CFG;
1938         if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CUSTOM)) {
1939             return true;
1940         }
1942         //Participants
1943         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
1944             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
1945         }
1947         $currentgroup = groups_get_course_group($course, true);
1948         if ($course->id == SITEID) {
1949             $filterselect = '';
1950         } else if ($course->id && !$currentgroup) {
1951             $filterselect = $course->id;
1952         } else {
1953             $filterselect = $currentgroup;
1954         }
1955         $filterselect = clean_param($filterselect, PARAM_INT);
1957         // Blogs
1958         if (has_capability('moodle/blog:view', $this->page->context)) {
1959             require_once($CFG->dirroot.'/blog/lib.php');
1960             if (blog_is_enabled_for_user()) {
1961                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
1962                 $coursenode->add(get_string('blogs','blog'), $blogsurls->out());
1963             }
1964         }
1966         // Notes
1967         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
1968             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
1969         }
1971         // Tags
1972         if (!empty($CFG->usetags) && isloggedin()) {
1973             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
1974         }
1977         // View course reports
1978         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
1979             $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', ''));
1980             $coursereports = get_plugin_list('coursereport');
1981             foreach ($coursereports as $report=>$dir) {
1982                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
1983                 if (file_exists($libfile)) {
1984                     require_once($libfile);
1985                     $reportfunction = $report.'_report_extend_navigation';
1986                     if (function_exists($report.'_report_extend_navigation')) {
1987                         $reportfunction($reportnav, $course, $this->page->context);
1988                     }
1989                 }
1990             }
1991         }
1992         return true;
1993     }
1995     /**
1996      * Clears the navigation cache
1997      */
1998     public function clear_cache() {
1999         $this->cache->clear();
2000     }
2002     /**
2003      * Sets an expansion limit for the navigation
2004      *
2005      * The expansion limit is used to prevent the display of content that has a type
2006      * greater than the provided $type.
2007      *
2008      * Can be used to ensure things such as activities or activity content don't get
2009      * shown on the navigation.
2010      * They are still generated in order to ensure the navbar still makes sense.
2011      *
2012      * @param int $type One of navigation_node::TYPE_*
2013      * @return <type>
2014      */
2015     public function set_expansion_limit($type) {
2016         $nodes = $this->find_all_of_type($type);
2017         foreach ($nodes as &$node) {
2018             // We need to generate the full site node
2019             if ($type == self::TYPE_COURSE && $node->key == SITEID) {
2020                 continue;
2021             }
2022             foreach ($node->children as &$child) {
2023                 // We still want to show course reports and participants containers
2024                 // or there will be navigation missing.
2025                 if ($type == self::TYPE_COURSE && $child->type === self::TYPE_CONTAINER) {
2026                     continue;
2027                 }
2028                 $child->display = false;
2029             }
2030         }
2031         return true;
2032     }
2033     /**
2034      * Attempts to get the navigation with the given key from this nodes children.
2035      *
2036      * This function only looks at this nodes children, it does NOT look recursivily.
2037      * If the node can't be found then false is returned.
2038      *
2039      * If you need to search recursivily then use the {@see find()} method.
2040      *
2041      * Note: If you are trying to set the active node {@see navigation_node::override_active_url()}
2042      * may be of more use to you.
2043      *
2044      * @param string|int $key The key of the node you wish to receive.
2045      * @param int $type One of navigation_node::TYPE_*
2046      * @return navigation_node|false
2047      */
2048     public function get($key, $type = null) {
2049         if (!$this->initialised) {
2050             $this->initialise();
2051         }
2052         return parent::get($key, $type);
2053     }
2055     /**
2056      * Searches this nodes children and thier children to find a navigation node
2057      * with the matching key and type.
2058      *
2059      * This method is recursive and searches children so until either a node is
2060      * found of there are no more nodes to search.
2061      *
2062      * If you know that the node being searched for is a child of this node
2063      * then use the {@see get()} method instead.
2064      *
2065      * Note: If you are trying to set the active node {@see navigation_node::override_active_url()}
2066      * may be of more use to you.
2067      *
2068      * @param string|int $key The key of the node you wish to receive.
2069      * @param int $type One of navigation_node::TYPE_*
2070      * @return navigation_node|false
2071      */
2072     public function find($key, $type) {
2073         if (!$this->initialised) {
2074             $this->initialise();
2075         }
2076         return parent::find($key, $type);
2077     }
2080 /**
2081  * The limited global navigation class used for the AJAX extension of the global
2082  * navigation class.
2083  *
2084  * The primary methods that are used in the global navigation class have been overriden
2085  * to ensure that only the relevant branch is generated at the root of the tree.
2086  * This can be done because AJAX is only used when the backwards structure for the
2087  * requested branch exists.
2088  * This has been done only because it shortens the amounts of information that is generated
2089  * which of course will speed up the response time.. because no one likes laggy AJAX.
2090  *
2091  * @package moodlecore
2092  * @subpackage navigation
2093  * @copyright 2009 Sam Hemelryk
2094  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2095  */
2096 class global_navigation_for_ajax extends global_navigation {
2098     /** @var array */
2099     protected $expandable = array();
2101     /**
2102      * Constructs the navigation for use in AJAX request
2103      */
2104     public function __construct($page, $branchtype, $id) {
2105         $this->page = $page;
2106         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2107         $this->children = new navigation_node_collection();
2108         $this->initialise($branchtype, $id);
2109     }
2110     /**
2111      * Initialise the navigation given the type and id for the branch to expand.
2112      *
2113      * @param int $branchtype One of navigation_node::TYPE_*
2114      * @param int $id
2115      * @return array The expandable nodes
2116      */
2117     public function initialise($branchtype, $id) {
2118         global $CFG, $DB, $PAGE, $SITE, $USER;
2120         if ($this->initialised || during_initial_install()) {
2121             return $this->expandable;
2122         }
2123         $this->initialised = true;
2125         $this->rootnodes = array();
2126         $this->rootnodes['site']      = $this->add_course($SITE);
2127         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2129         // Branchtype will be one of navigation_node::TYPE_*
2130         switch ($branchtype) {
2131             case self::TYPE_CATEGORY :
2132                 $this->load_all_categories($id);
2133                 $limit = 20;
2134                 if (!empty($CFG->navcourselimit)) {
2135                     $limit = (int)$CFG->navcourselimit;
2136                 }
2137                 $courses = $DB->get_records('course', array('category' => $id), 'sortorder','*', 0, $limit);
2138                 foreach ($courses as $course) {
2139                     $this->add_course($course);
2140                 }
2141                 break;
2142             case self::TYPE_COURSE :
2143                 $course = $DB->get_record('course', array('id' => $id), '*', MUST_EXIST);
2144                 require_course_login($course);
2145                 $this->page = $PAGE;
2146                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2147                 $coursenode = $this->add_course($course);
2148                 $this->add_course_essentials($coursenode, $course);
2149                 if ($this->format_display_course_content($course->format)) {
2150                     $this->load_course_sections($course, $coursenode);
2151                 }
2152                 break;
2153             case self::TYPE_SECTION :
2154                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2155                         FROM {course} c
2156                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2157                         WHERE cs.id = ?';
2158                 $course = $DB->get_record_sql($sql, array($id), MUST_EXIST);
2159                 require_course_login($course);
2160                 $this->page = $PAGE;
2161                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2162                 $coursenode = $this->add_course($course);
2163                 $this->add_course_essentials($coursenode, $course);
2164                 $sections = $this->load_course_sections($course, $coursenode);
2165                 $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, get_fast_modinfo($course));
2166                 break;
2167             case self::TYPE_ACTIVITY :
2168                 $cm = get_coursemodule_from_id(false, $id, 0, false, MUST_EXIST);
2169                 $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
2170                 require_course_login($course, true, $cm);
2171                 $this->page = $PAGE;
2172                 $this->page->set_context(get_context_instance(CONTEXT_MODULE, $cm->id));
2173                 $coursenode = $this->load_course($course);
2174                 $sections = $this->load_course_sections($course, $coursenode);
2175                 foreach ($sections as $section) {
2176                     if ($section->id == $cm->section) {
2177                         $cm->sectionnumber = $section->section;
2178                         break;
2179                     }
2180                 }
2181                 if ($course->id == SITEID) {
2182                     $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY));
2183                 } else {
2184                     $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course));
2185                     $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]);
2186                 }
2187                 break;
2188             default:
2189                 throw new Exception('Unknown type');
2190                 return $this->expandable;
2191         }
2193         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != SITEID) {
2194             $this->load_for_user(null, true);
2195         }
2197         $this->find_expandable($this->expandable);
2198         return $this->expandable;
2199     }
2201     /**
2202      * Returns an array of expandable nodes
2203      * @return array
2204      */
2205     public function get_expandable() {
2206         return $this->expandable;
2207     }
2210 /**
2211  * Navbar class
2212  *
2213  * This class is used to manage the navbar, which is initialised from the navigation
2214  * object held by PAGE
2215  *
2216  * @package moodlecore
2217  * @subpackage navigation
2218  * @copyright 2009 Sam Hemelryk
2219  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2220  */
2221 class navbar extends navigation_node {
2222     /** @var bool */
2223     protected $initialised = false;
2224     /** @var mixed */
2225     protected $keys = array();
2226     /** @var null|string */
2227     protected $content = null;
2228     /** @var moodle_page object */
2229     protected $page;
2230     /** @var bool */
2231     protected $ignoreactive = false;
2232     /** @var bool */
2233     protected $duringinstall = false;
2234     /** @var bool */
2235     protected $hasitems = false;
2236     /** @var array */
2237     protected $items;
2238     /** @var array */
2239     public $children = array();
2240     /** @var bool */
2241     public $includesettingsbase = false;
2242     /**
2243      * The almighty constructor
2244      *
2245      * @param moodle_page $page
2246      */
2247     public function __construct(moodle_page $page) {
2248         global $CFG;
2249         if (during_initial_install()) {
2250             $this->duringinstall = true;
2251             return false;
2252         }
2253         $this->page = $page;
2254         $this->text = get_string('home');
2255         $this->shorttext = get_string('home');
2256         $this->action = new moodle_url($CFG->wwwroot);
2257         $this->nodetype = self::NODETYPE_BRANCH;
2258         $this->type = self::TYPE_SYSTEM;
2259     }
2261     /**
2262      * Quick check to see if the navbar will have items in.
2263      *
2264      * @return bool Returns true if the navbar will have items, false otherwise
2265      */
2266     public function has_items() {
2267         if ($this->duringinstall) {
2268             return false;
2269         } else if ($this->hasitems !== false) {
2270             return true;
2271         }
2272         $this->page->navigation->initialise($this->page);
2274         $activenodefound = ($this->page->navigation->contains_active_node() ||
2275                             $this->page->settingsnav->contains_active_node());
2277         $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
2278         $this->hasitems = $outcome;
2279         return $outcome;
2280     }
2282     /**
2283      * Turn on/off ignore active
2284      *
2285      * @param bool $setting
2286      */
2287     public function ignore_active($setting=true) {
2288         $this->ignoreactive = ($setting);
2289     }
2290     public function get($key, $type = null) {
2291         foreach ($this->children as &$child) {
2292             if ($child->key === $key && ($type == null || $type == $child->type)) {
2293                 return $child;
2294             }
2295         }
2296         return false;
2297     }
2298     /**
2299      * Returns an array of navigation_node's that make up the navbar.
2300      *
2301      * @return array
2302      */
2303     public function get_items() {
2304         $items = array();
2305         // Make sure that navigation is initialised
2306         if (!$this->has_items()) {
2307             return $items;
2308         }
2309         if ($this->items !== null) {
2310             return $this->items;
2311         }
2313         if (count($this->children) > 0) {
2314             // Add the custom children
2315             $items = array_reverse($this->children);
2316         }
2318         $navigationactivenode = $this->page->navigation->find_active_node();
2319         $settingsactivenode = $this->page->settingsnav->find_active_node();
2321         // Check if navigation contains the active node
2322         if (!$this->ignoreactive) {
2324             if ($navigationactivenode && $settingsactivenode) {
2325                 // Parse a combined navigation tree
2326                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
2327                     if (!$settingsactivenode->mainnavonly) {
2328                         $items[] = $settingsactivenode;
2329                     }
2330                     $settingsactivenode = $settingsactivenode->parent;
2331                 }
2332                 if (!$this->includesettingsbase) {
2333                     // Removes the first node from the settings (root node) from the list
2334                     array_pop($items);
2335                 }
2336                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
2337                     if (!$navigationactivenode->mainnavonly) {
2338                         $items[] = $navigationactivenode;
2339                     }
2340                     $navigationactivenode = $navigationactivenode->parent;
2341                 }
2342             } else if ($navigationactivenode) {
2343                 // Parse the navigation tree to get the active node
2344                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
2345                     if (!$navigationactivenode->mainnavonly) {
2346                         $items[] = $navigationactivenode;
2347                     }
2348                     $navigationactivenode = $navigationactivenode->parent;
2349                 }
2350             } else if ($settingsactivenode) {
2351                 // Parse the settings navigation to get the active node
2352                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
2353                     if (!$settingsactivenode->mainnavonly) {
2354                         $items[] = $settingsactivenode;
2355                     }
2356                     $settingsactivenode = $settingsactivenode->parent;
2357                 }
2358             }
2359         }
2361         $items[] = new navigation_node(array(
2362             'text'=>$this->page->navigation->text,
2363             'shorttext'=>$this->page->navigation->shorttext,
2364             'key'=>$this->page->navigation->key,
2365             'action'=>$this->page->navigation->action
2366         ));
2368         $this->items = array_reverse($items);
2369         return $this->items;
2370     }
2372     /**
2373      * Add a new navigation_node to the navbar, overrides parent::add
2374      *
2375      * This function overrides {@link navigation_node::add()} so that we can change
2376      * the way nodes get added to allow us to simply call add and have the node added to the
2377      * end of the navbar
2378      *
2379      * @param string $text
2380      * @param string|moodle_url $action
2381      * @param int $type
2382      * @param string|int $key
2383      * @param string $shorttext
2384      * @param string $icon
2385      * @return navigation_node
2386      */
2387     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
2388         if ($this->content !== null) {
2389             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
2390         }
2392         // Properties array used when creating the new navigation node
2393         $itemarray = array(
2394             'text' => $text,
2395             'type' => $type
2396         );
2397         // Set the action if one was provided
2398         if ($action!==null) {
2399             $itemarray['action'] = $action;
2400         }
2401         // Set the shorttext if one was provided
2402         if ($shorttext!==null) {
2403             $itemarray['shorttext'] = $shorttext;
2404         }
2405         // Set the icon if one was provided
2406         if ($icon!==null) {
2407             $itemarray['icon'] = $icon;
2408         }
2409         // Default the key to the number of children if not provided
2410         if ($key === null) {
2411             $key = count($this->children);
2412         }
2413         // Set the key
2414         $itemarray['key'] = $key;
2415         // Set the parent to this node
2416         $itemarray['parent'] = $this;
2417         // Add the child using the navigation_node_collections add method
2418         $this->children[] = new navigation_node($itemarray);
2419         return $this;
2420     }
2423 /**
2424  * Class used to manage the settings option for the current page
2425  *
2426  * This class is used to manage the settings options in a tree format (recursively)
2427  * and was created initially for use with the settings blocks.
2428  *
2429  * @package moodlecore
2430  * @subpackage navigation
2431  * @copyright 2009 Sam Hemelryk
2432  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2433  */
2434 class settings_navigation extends navigation_node {
2435     /** @var stdClass */
2436     protected $context;
2437     /** @var navigation_cache */
2438     protected $cache;
2439     /** @var moodle_page */
2440     protected $page;
2441     /** @var string */
2442     protected $adminsection;
2443     /** @var bool */
2444     protected $initialised = false;
2445     /** @var array */
2446     protected $userstoextendfor = array();
2448     /**
2449      * Sets up the object with basic settings and preparse it for use
2450      *
2451      * @param moodle_page $page
2452      */
2453     public function __construct(moodle_page &$page) {
2454         if (during_initial_install()) {
2455             return false;
2456         }
2457         $this->page = $page;
2458         // Initialise the main navigation. It is most important that this is done
2459         // before we try anything
2460         $this->page->navigation->initialise();
2461         // Initialise the navigation cache
2462         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2463         $this->children = new navigation_node_collection();
2464     }
2465     /**
2466      * Initialise the settings navigation based on the current context
2467      *
2468      * This function initialises the settings navigation tree for a given context
2469      * by calling supporting functions to generate major parts of the tree.
2470      *
2471      */
2472     public function initialise() {
2473         global $DB;
2475         if (during_initial_install()) {
2476             return false;
2477         } else if ($this->initialised) {
2478             return true;
2479         }
2480         $this->id = 'settingsnav';
2481         $this->context = $this->page->context;
2483         $context = $this->context;
2484         if ($context->contextlevel == CONTEXT_BLOCK) {
2485             $this->load_block_settings();
2486             $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));
2487         }
2489         switch ($context->contextlevel) {
2490             case CONTEXT_SYSTEM:
2491                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
2492                     $this->load_front_page_settings(($context->id == $this->context->id));
2493                 }
2494                 break;
2495             case CONTEXT_COURSECAT:
2496                 $this->load_category_settings();
2497                 break;
2498             case CONTEXT_COURSE:
2499                 if ($this->page->course->id != SITEID) {
2500                     $this->load_course_settings(($context->id == $this->context->id));
2501                 } else {
2502                     $this->load_front_page_settings(($context->id == $this->context->id));
2503                 }
2504                 break;
2505             case CONTEXT_MODULE:
2506                 $this->load_module_settings();
2507                 $this->load_course_settings();
2508                 break;
2509             case CONTEXT_USER:
2510                 if ($this->page->course->id != SITEID) {
2511                     $this->load_course_settings();
2512                 }
2513                 break;
2514         }
2516         $settings = $this->load_user_settings($this->page->course->id);
2517         $admin = $this->load_administration_settings();
2519         if ($context->contextlevel == CONTEXT_SYSTEM && $admin) {
2520             $admin->force_open();
2521         } else if ($context->contextlevel == CONTEXT_USER && $settings) {
2522             $settings->force_open();
2523         }
2525         // Check if the user is currently logged in as another user
2526         if (session_is_loggedinas()) {
2527             // Get the actual user, we need this so we can display an informative return link
2528             $realuser = session_get_realuser();
2529             // Add the informative return to original user link
2530             $url = new moodle_url('/course/loginas.php',array('id'=>$this->page->course->id, 'return'=>1,'sesskey'=>sesskey()));
2531             $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self::TYPE_SETTING, null, null, new pix_icon('t/left', ''));
2532         }
2534         // Make sure the first child doesnt have proceed with hr set to true
2536         foreach ($this->children as $key=>$node) {
2537             if ($node->nodetype != self::NODETYPE_BRANCH || $node->children->count()===0) {
2538                 $node->remove();
2539             }
2540         }
2541         $this->initialised = true;
2542     }
2543     /**
2544      * Override the parent function so that we can add preceeding hr's and set a
2545      * root node class against all first level element
2546      *
2547      * It does this by first calling the parent's add method {@link navigation_node::add()}
2548      * and then proceeds to use the key to set class and hr
2549      *
2550      * @param string $text
2551      * @param sting|moodle_url $url
2552      * @param string $shorttext
2553      * @param string|int $key
2554      * @param int $type
2555      * @param string $icon
2556      * @return navigation_node
2557      */
2558     public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
2559         $node = parent::add($text, $url, $type, $shorttext, $key, $icon);
2560         $node->add_class('root_node');
2561         return $node;
2562     }
2564     /**
2565      * This function allows the user to add something to the start of the settings
2566      * navigation, which means it will be at the top of the settings navigation block
2567      *
2568      * @param string $text
2569      * @param sting|moodle_url $url
2570      * @param string $shorttext
2571      * @param string|int $key
2572      * @param int $type
2573      * @param string $icon
2574      * @return navigation_node
2575      */
2576     public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
2577         $children = $this->children;
2578         $childrenclass = get_class($children);
2579         $this->children = new $childrenclass;
2580         $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
2581         foreach ($children as $child) {
2582             $this->children->add($child);
2583         }
2584         return $node;
2585     }
2586     /**
2587      * Load the site administration tree
2588      *
2589      * This function loads the site administration tree by using the lib/adminlib library functions
2590      *
2591      * @param navigation_node $referencebranch A reference to a branch in the settings
2592      *      navigation tree
2593      * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
2594      *      tree and start at the beginning
2595      * @return mixed A key to access the admin tree by
2596      */
2597     protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) {
2598         global $CFG;
2600         // Check if we are just starting to generate this navigation.
2601         if ($referencebranch === null) {
2603             // Require the admin lib then get an admin structure
2604             if (!function_exists('admin_get_root')) {
2605                 require_once($CFG->dirroot.'/lib/adminlib.php');
2606             }
2607             $adminroot = admin_get_root(false, false);
2608             // This is the active section identifier
2609             $this->adminsection = $this->page->url->param('section');
2611             // Disable the navigation from automatically finding the active node
2612             navigation_node::$autofindactive = false;
2613             $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SETTING, null, 'root');
2614             foreach ($adminroot->children as $adminbranch) {
2615                 $this->load_administration_settings($referencebranch, $adminbranch);
2616             }
2617             navigation_node::$autofindactive = true;
2619             // Use the admin structure to locate the active page
2620             if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) {
2621                 $currentnode = $this;
2622                 while (($pathkey = array_pop($current->path))!==null && $currentnode) {
2623                     $currentnode = $currentnode->get($pathkey);
2624                 }
2625                 if ($currentnode) {
2626                     $currentnode->make_active();
2627                 }
2628             } else {
2629                 $this->scan_for_active_node($referencebranch);
2630             }
2631             return $referencebranch;
2632         } else if ($adminbranch->check_access()) {
2633             // We have a reference branch that we can access and is not hidden `hurrah`
2634             // Now we need to display it and any children it may have
2635             $url = null;
2636             $icon = null;
2637             if ($adminbranch instanceof admin_settingpage) {
2638                 $url = new moodle_url('/admin/settings.php', array('section'=>$adminbranch->name));
2639             } else if ($adminbranch instanceof admin_externalpage) {
2640                 $url = $adminbranch->url;
2641             }
2643             // Add the branch
2644             $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon);
2646             if ($adminbranch->is_hidden()) {
2647                 if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) {
2648                     $reference->add_class('hidden');
2649                 } else {
2650                     $reference->display = false;
2651                 }
2652             }
2654             // Check if we are generating the admin notifications and whether notificiations exist
2655             if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) {
2656                 $reference->add_class('criticalnotification');
2657             }
2658             // Check if this branch has children
2659             if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) {
2660                 foreach ($adminbranch->children as $branch) {
2661                     // Generate the child branches as well now using this branch as the reference
2662                     $this->load_administration_settings($reference, $branch);
2663                 }
2664             } else {
2665                 $reference->icon = new pix_icon('i/settings', '');
2666             }
2667         }
2668     }
2670     /**
2671      * This function recursivily scans nodes until it finds the active node or there
2672      * are no more nodes.
2673      * @param navigation_node $node
2674      */
2675     protected function scan_for_active_node(navigation_node $node) {
2676         if (!$node->check_if_active() && $node->children->count()>0) {
2677             foreach ($node->children as &$child) {
2678                 $this->scan_for_active_node($child);
2679             }
2680         }
2681     }
2683     /**
2684      * Gets a navigation node given an array of keys that represent the path to
2685      * the desired node.
2686      *
2687      * @param array $path
2688      * @return navigation_node|false
2689      */
2690     protected function get_by_path(array $path) {
2691         $node = $this->get(array_shift($path));
2692         foreach ($path as $key) {
2693             $node->get($key);
2694         }
2695         return $node;
2696     }
2698     /**
2699      * Generate the list of modules for the given course.
2700      *
2701      * The array of resources and activities that can be added to a course is then
2702      * stored in the cache so that we can access it for anywhere.
2703      * It saves us generating it all the time
2704      *
2705      * <code php>
2706      * // To get resources:
2707      * $this->cache->{'course'.$courseid.'resources'}
2708      * // To get activities:
2709      * $this->cache->{'course'.$courseid.'activities'}
2710      * </code>
2711      *
2712      * @param stdClass $course The course to get modules for
2713      */
2714     protected function get_course_modules($course) {
2715         global $CFG;
2716         $mods = $modnames = $modnamesplural = $modnamesused = array();
2717         // This function is included when we include course/lib.php at the top
2718         // of this file
2719         get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused);
2720         $resources = array();
2721         $activities = array();
2722         foreach($modnames as $modname=>$modnamestr) {
2723             if (!course_allowed_module($course, $modname)) {
2724                 continue;
2725             }
2727             $libfile = "$CFG->dirroot/mod/$modname/lib.php";
2728             if (!file_exists($libfile)) {
2729                 continue;
2730             }
2731             include_once($libfile);
2732             $gettypesfunc =  $modname.'_get_types';
2733             if (function_exists($gettypesfunc)) {
2734                 $types = $gettypesfunc();
2735                 foreach($types as $type) {
2736                     if (!isset($type->modclass) || !isset($type->typestr)) {
2737                         debugging('Incorrect activity type in '.$modname);
2738                         continue;
2739                     }
2740                     if ($type->modclass == MOD_CLASS_RESOURCE) {
2741                         $resources[html_entity_decode($type->type)] = $type->typestr;
2742                     } else {
2743                         $activities[html_entity_decode($type->type)] = $type->typestr;
2744                     }
2745                 }
2746             } else {
2747                 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2748                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
2749                     $resources[$modname] = $modnamestr;
2750                 } else {
2751                     // all other archetypes are considered activity
2752                     $activities[$modname] = $modnamestr;
2753                 }
2754             }
2755         }
2756         $this->cache->{'course'.$course->id.'resources'} = $resources;
2757         $this->cache->{'course'.$course->id.'activities'} = $activities;
2758     }
2760     /**
2761      * This function loads the course settings that are available for the user
2762      *
2763      * @param bool $forceopen If set to true the course node will be forced open
2764      * @return navigation_node|false
2765      */
2766     protected function load_course_settings($forceopen = false) {
2767         global $CFG, $USER, $SESSION, $OUTPUT;
2769         $course = $this->page->course;
2770         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2772         // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
2774         $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin');
2775         if ($forceopen) {
2776             $coursenode->force_open();
2777         }
2779         if (has_capability('moodle/course:update', $coursecontext)) {
2780             // Add the turn on/off settings
2781             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
2782             if ($this->page->user_is_editing()) {
2783                 $url->param('edit', 'off');
2784                 $editstring = get_string('turneditingoff');
2785             } else {
2786                 $url->param('edit', 'on');
2787                 $editstring = get_string('turneditingon');
2788             }
2789             $coursenode->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
2791             if ($this->page->user_is_editing()) {
2792                 // Removed as per MDL-22732
2793                 // $this->add_course_editing_links($course);
2794             }
2796             // Add the course settings link
2797             $url = new moodle_url('/course/edit.php', array('id'=>$course->id));
2798             $coursenode->add(get_string('editsettings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
2800             // Add the course completion settings link
2801             if ($CFG->enablecompletion && $course->enablecompletion) {
2802                 $url = new moodle_url('/course/completion.php', array('id'=>$course->id));
2803                 $coursenode->add(get_string('completion', 'completion'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
2804             }
2805         }
2807         // add enrol nodes
2808         enrol_add_course_navigation($coursenode, $course);
2810         // Manage filters
2811         if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
2812             $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
2813             $coursenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
2814         }
2816         // Add view grade report is permitted
2817         $reportavailable = false;
2818         if (has_capability('moodle/grade:viewall', $coursecontext)) {
2819             $reportavailable = true;
2820         } else if (!empty($course->showgrades)) {
2821             $reports = get_plugin_list('gradereport');
2822             if (is_array($reports) && count($reports)>0) {     // Get all installed reports
2823                 arsort($reports); // user is last, we want to test it first
2824                 foreach ($reports as $plugin => $plugindir) {
2825                     if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
2826                         //stop when the first visible plugin is found
2827                         $reportavailable = true;
2828                         break;
2829                     }
2830                 }
2831             }
2832         }
2833         if ($reportavailable) {
2834             $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id));
2835             $gradenode = $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, 'grades', new pix_icon('i/grades', ''));
2836         }
2838         //  Add outcome if permitted
2839         if (!empty($CFG->enableoutcomes) && has_capability('moodle/course:update', $coursecontext)) {
2840             $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id));
2841             $coursenode->add(get_string('outcomes', 'grades'), $url, self::TYPE_SETTING, null, 'outcomes', new pix_icon('i/outcomes', ''));
2842         }
2844         // Backup this course
2845         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
2846             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
2847             $coursenode->add(get_string('backup'), $url, self::TYPE_SETTING, null, 'backup', new pix_icon('i/backup', ''));
2848         }
2850         // Restore to this course
2851         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
2852             $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id));
2853             $coursenode->add(get_string('restore'), $url, self::TYPE_SETTING, null, 'restore', new pix_icon('i/restore', ''));
2854         }
2856         // Import data from other courses
2857         if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
2858             $url = new moodle_url('/course/import.php', array('id'=>$course->id));
2859             $url = null; // Disabled until restore is implemented. MDL-21432
2860             $coursenode->add(get_string('import'), $url, self::TYPE_SETTING, null, 'import', new pix_icon('i/restore', ''));
2861         }
2863         // Publish course on a hub
2864         if (has_capability('moodle/course:publish', $coursecontext)) {
2865             $url = new moodle_url('/course/publish/index.php', array('id'=>$course->id));
2866             $coursenode->add(get_string('publish'), $url, self::TYPE_SETTING, null, 'publish', new pix_icon('i/publish', ''));
2867         }
2869         // Reset this course
2870         if (has_capability('moodle/course:reset', $coursecontext)) {
2871             $url = new moodle_url('/course/reset.php', array('id'=>$course->id));
2872             $coursenode->add(get_string('reset'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/return', ''));
2873         }
2875         // Questions
2876         require_once($CFG->dirroot.'/question/editlib.php');
2877         question_extend_settings_navigation($coursenode, $coursecontext)->trim_if_empty();
2879         // Repository Instances
2880         require_once($CFG->dirroot.'/repository/lib.php');
2881         $editabletypes = repository::get_editable_types($coursecontext);
2882         if (has_capability('moodle/course:update', $coursecontext) && !empty($editabletypes)) {
2883             $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$coursecontext->id));
2884             $coursenode->add(get_string('repositories'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/repository', ''));
2885         }
2887         // Manage files
2888         if ($course->legacyfiles == 2 and has_capability('moodle/course:managefiles', $coursecontext)) {
2889             // hidden in new courses and courses where legacy files were turned off
2890             $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id, 'itemid'=>0, 'component' => 'course', 'filearea'=>'legacy'));
2891             $coursenode->add(get_string('courselegacyfiles'), $url, self::TYPE_SETTING, null, 'coursefiles', new pix_icon('i/files', ''));
2892         }
2894         // Switch roles
2895         $roles = array();
2896         $assumedrole = $this->in_alternative_role();
2897         if ($assumedrole!==false) {
2898             $roles[0] = get_string('switchrolereturn');
2899         }
2900         if (has_capability('moodle/role:switchroles', $coursecontext)) {
2901             $availableroles = get_switchable_roles($coursecontext);
2902             if (is_array($availableroles)) {
2903                 foreach ($availableroles as $key=>$role) {
2904                     if ($key == $CFG->guestroleid || $assumedrole===(int)$key) {
2905                         continue;
2906                     }
2907                     $roles[$key] = $role;
2908                 }
2909             }
2910         }
2911         if (is_array($roles) && count($roles)>0) {
2912             $switchroles = $this->add(get_string('switchroleto'));
2913             if ((count($roles)==1 && array_key_exists(0, $roles))|| $assumedrole!==false) {
2914                 $switchroles->force_open();
2915             }
2916             $returnurl = $this->page->url;
2917             $returnurl->param('sesskey', sesskey());
2918             $SESSION->returnurl = serialize($returnurl);
2919             foreach ($roles as $key=>$name) {
2920                 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>'1'));
2921                 $switchroles->add($name, $url, self::TYPE_SETTING, null, $key, new pix_icon('i/roles', ''));
2922             }
2923         }
2924         // Return we are done
2925         return $coursenode;
2926     }
2928     /**
2929      * Adds branches and links to the settings navigation to add course activities
2930      * and resources.
2931      *
2932      * @param stdClass $course
2933      */
2934     protected function add_course_editing_links($course) {
2935         global $CFG;
2937         require_once($CFG->dirroot.'/course/lib.php');
2939         // Add `add` resources|activities branches
2940         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
2941         if (file_exists($structurefile)) {
2942             require_once($structurefile);
2943             $formatstring = call_user_func('callback_'.$course->format.'_definition');
2944             $formatidentifier = optional_param(call_user_func('callback_'.$course->format.'_request_key'), 0, PARAM_INT);
2945         } else {
2946             $formatstring = get_string('topic');
2947             $formatidentifier = optional_param('topic', 0, PARAM_INT);
2948         }
2950         $sections = get_all_sections($course->id);
2952         $addresource = $this->add(get_string('addresource'));
2953         $addactivity = $this->add(get_string('addactivity'));
2954         if ($formatidentifier!==0) {
2955             $addresource->force_open();
2956             $addactivity->force_open();
2957         }
2959         if (!$this->cache->cached('course'.$course->id.'resources')) {
2960             $this->get_course_modules($course);
2961         }
2962         $resources = $this->cache->{'course'.$course->id.'resources'};
2963         $activities = $this->cache->{'course'.$course->id.'activities'};
2965         $textlib = textlib_get_instance();
2967         foreach ($sections as $section) {
2968             if ($formatidentifier !== 0 && $section->section != $formatidentifier) {
2969                 continue;
2970             }
2971             $sectionurl = new moodle_url('/course/view.php', array('id'=>$course->id, $formatstring=>$section->section));
2972             if ($section->section == 0) {
2973                 $sectionresources = $addresource->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
2974                 $sectionactivities = $addactivity->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
2975             } else {
2976                 $sectionresources = $addresource->add($formatstring.' '.$section->section, $sectionurl, self::TYPE_SETTING);
2977                 $sectionactivities = $addactivity->add($formatstring.' '.$section->section, $sectionurl, self::TYPE_SETTING);
2978             }
2979             foreach ($resources as $value=>$resource) {
2980                 $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
2981                 $pos = strpos($value, '&type=');
2982                 if ($pos!==false) {
2983                     $url->param('add', $textlib->substr($value, 0,$pos));
2984                     $url->param('type', $textlib->substr($value, $pos+6));
2985                 } else {
2986                     $url->param('add', $value);
2987                 }
2988                 $sectionresources->add($resource, $url, self::TYPE_SETTING);
2989             }
2990             $subbranch = false;
2991             foreach ($activities as $activityname=>$activity) {
2992                 if ($activity==='--') {
2993                     $subbranch = false;
2994                     continue;
2995                 }
2996                 if (strpos($activity, '--')===0) {
2997                     $subbranch = $sectionactivities->add(trim($activity, '-'));
2998                     continue;
2999                 }
3000                 $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
3001                 $pos = strpos($activityname, '&type=');
3002                 if ($pos!==false) {
3003                     $url->param('add', $textlib->substr($activityname, 0,$pos));
3004                     $url->param('type', $textlib->substr($activityname, $pos+6));
3005                 } else {
3006                     $url->param('add', $activityname);
3007                 }
3008                 if ($subbranch !== false) {
3009                     $subbranch->add($activity, $url, self::TYPE_SETTING);
3010                 } else {
3011                     $sectionactivities->add($activity, $url, self::TYPE_SETTING);
3012                 }
3013             }
3014         }
3015     }
3017     /**
3018      * This function calls the module function to inject module settings into the
3019      * settings navigation tree.
3020      *
3021      * This only gets called if there is a corrosponding function in the modules
3022      * lib file.
3023      *
3024      * For examples mod/forum/lib.php ::: forum_extend_settings_navigation()
3025      *
3026      * @return navigation_node|false
3027      */
3028     protected function load_module_settings() {
3029         global $CFG;
3031         if (!$this->page->cm && $this->context->contextlevel == CONTEXT_MODULE && $this->context->instanceid) {
3032             $cm = get_coursemodule_from_id(false, $this->context->instanceid, 0, false, MUST_EXIST);
3033             $this->page->set_cm($cm, $this->page->course);
3034         }
3036         $file = $CFG->dirroot.'/mod/'.$this->page->activityname.'/lib.php';
3037         if (file_exists($file)) {
3038             require_once($file);
3039         }
3041         $modulenode = $this->add(get_string($this->page->activityname.'administration', $this->page->activityname));
3042         $modulenode->force_open();
3044         // Settings for the module
3045         if (has_capability('moodle/course:manageactivities', $this->page->cm->context)) {
3046             $url = new moodle_url('/course/modedit.php', array('update' => $this->page->cm->id, 'return' => true, 'sesskey' => sesskey()));
3047             $modulenode->add(get_string('editsettings'), $url, navigation_node::TYPE_SETTING);
3048         }
3049         // Assign local roles
3050         if (count(get_assignable_roles($this->page->cm->context))>0) {
3051             $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->page->cm->context->id));
3052             $modulenode->add(get_string('localroles', 'role'), $url, self::TYPE_SETTING);
3053         }
3054         // Override roles
3055         if (has_capability('moodle/role:review', $this->page->cm->context) or count(get_overridable_roles($this->page->cm->context))>0) {
3056             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->page->cm->context->id));
3057             $modulenode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
3058         }
3059         // Check role permissions
3060         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page->cm->context)) {
3061             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->page->cm->context->id));
3062             $modulenode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
3063         }
3064         // Manage filters
3065         if (has_capability('moodle/filter:manage', $this->page->cm->context) && count(filter_get_available_in_context($this->page->cm->context))>0) {
3066             $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page->cm->context->id));
3067             $modulenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING);
3068         }
3070         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $this->page->cm->course))) {
3071             $url = new moodle_url('/course/report/log/index.php', array('chooselog'=>'1','id'=>$this->page->cm->course,'modid'=>$this->page->cm->id));
3072             $modulenode->add(get_string('logs'), $url, self::TYPE_SETTING);
3073         }
3075         // Add a backup link
3076         $featuresfunc = $this->page->activityname.'_supports';
3077         if ($featuresfunc(FEATURE_BACKUP_MOODLE2) && has_capability('moodle/backup:backupactivity', $this->page->cm->context)) {
3078             $url = new moodle_url('/backup/backup.php', array('id'=>$this->page->cm->course, 'cm'=>$this->page->cm->id));
3079             $modulenode->add(get_string('backup'), $url, self::TYPE_SETTING);
3080         }
3082         $function = $this->page->activityname.'_extend_settings_navigation';
3083         if (!function_exists($function)) {
3084             return $modulenode;
3085         }
3087         $function($this, $modulenode);
3089         // Remove the module node if there are no children
3090         if (empty($modulenode->children)) {
3091             $modulenode->remove();
3092         }
3094         return $modulenode;
3095     }
3097     /**
3098      * Loads the user settings block of the settings nav
3099      *
3100      * This function is simply works out the userid and whether we need to load
3101      * just the current users profile settings, or the current user and the user the
3102      * current user is viewing.
3103      *
3104      * This function has some very ugly code to work out the user, if anyone has
3105      * any bright ideas please feel free to intervene.
3106      *
3107      * @param int $courseid The course id of the current course
3108      * @return navigation_node|false
3109      */
3110     protected function load_user_settings($courseid=SITEID) {
3111         global $USER, $FULLME, $CFG;
3113         if (isguestuser() || !isloggedin()) {
3114             return false;
3115         }
3117         $navusers = $this->page->navigation->get_extending_users();
3119         if (count($this->userstoextendfor) > 0 || count($navusers) > 0) {
3120             $usernode = null;
3121             foreach ($this->userstoextendfor as $userid) {
3122                 if ($userid == $USER->id) {
3123                     continue;
3124                 }
3125                 $node = $this->generate_user_settings($courseid, $userid, 'userviewingsettings');
3126                 if (is_null($usernode)) {
3127                     $usernode = $node;
3128                 }
3129             }
3130             foreach ($navusers as $user) {
3131                 if ($user->id == $USER->id) {
3132                     continue;
3133                 }
3134                 $node = $this->generate_user_settings($courseid, $user->id, 'userviewingsettings');
3135                 if (is_null($usernode)) {
3136                     $usernode = $node;
3137                 }
3138             }
3139             $this->generate_user_settings($courseid, $USER->id);
3140         } else {
3141             $usernode = $this->generate_user_settings($courseid, $USER->id);
3142         }
3143         return $usernode;
3144     }
3146     /**
3147      * Extends the settings navigation for the given user.
3148      *
3149      * Note: This method gets called automatically if you call
3150      * $PAGE->navigation->extend_for_user($userid)
3151      *
3152      * @param int $userid
3153      */
3154     public function extend_for_user($userid) {
3155         global $CFG;
3157         if (!in_array($userid, $this->userstoextendfor)) {
3158             $this->userstoextendfor[] = $userid;
3159             if ($this->initialised) {
3160                 $this->generate_user_settings($this->page->course->id, $userid, 'userviewingsettings');
3161                 $children = array();
3162                 foreach ($this->children as $child) {
3163                     $children[] = $child;
3164                 }
3165                 array_unshift($children, array_pop($children));
3166                 $this->children = new navigation_node_collection();
3167                 foreach ($children as $child) {
3168                     $this->children->add($child);
3169                 }
3170             }
3171         }
3172     }
3174     /**
3175      * This function gets called by {@link load_user_settings()} and actually works out
3176      * what can be shown/done
3177      *
3178      * @param int $courseid The current course' id
3179      * @param int $userid The user id to load for
3180      * @param string $gstitle The string to pass to get_string for the branch title
3181      * @return navigation_node|false
3182      */
3183     protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') {
3184         global $DB, $CFG, $USER, $SITE;
3186         if ($courseid != SITEID) {
3187             if (!empty($this->page->course->id) && $this->page->course->id == $courseid) {
3188                 $course = $this->page->course;
3189             } else {
3190                 $course = $DB->get_record("course", array("id"=>$courseid), '*', MUST_EXIST);
3191             }
3192         } else {
3193             $course = $SITE;
3194         }
3196         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);   // Course context
3197         $systemcontext   = get_system_context();
3198         $currentuser = ($USER->id == $userid);
3200         if ($currentuser) {
3201             $user = $USER;
3202             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
3203         } else {
3204             if (!$user = $DB->get_record('user', array('id'=>$userid))) {
3205                 return false;
3206             }
3207             // Check that the user can view the profile
3208             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
3209             if ($course->id==SITEID) {
3210                 if ($CFG->forceloginforprofiles && !has_coursecontact_role($user->id) && !has_capability('moodle/user:viewdetails', $usercontext)) {  // Reduce possibility of "browsing" userbase at site level
3211                     // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366)
3212                     return false;
3213                 }
3214             } else {
3215                 if ((!has_capability('moodle/user:viewdetails', $coursecontext) && !has_capability('moodle/user:viewdetails', $usercontext)) || !is_enrolled($coursecontext, $user->id)) {
3216                     return false;
3217                 }
3218                 if (groups_get_course_groupmode($course) == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $coursecontext)) {
3219                     // If groups are in use, make sure we can see that group
3220                     return false;
3221                 }
3222             }
3223         }
3225         $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $this->page->context));
3227         $key = $gstitle;
3228         if ($gstitle != 'usercurrentsettings') {
3229             $key .= $userid;
3230         }
3232         // Add a user setting branch
3233         $usersetting = $this->add(get_string($gstitle, 'moodle', $fullname), null, self::TYPE_CONTAINER, null, $key);
3234         $usersetting->id = 'usersettings';
3235         if ($this->page->context->contextlevel == CONTEXT_USER && $this->page->context->instanceid == $user->id) {
3236             // Automatically start by making it active
3237             $usersetting->make_active();
3238         }
3240         // Check if the user has been deleted
3241         if ($user->deleted) {
3242             if (!has_capability('moodle/user:update', $coursecontext)) {
3243                 // We can't edit the user so just show the user deleted message
3244                 $usersetting->add(get_string('userdeleted'), null, self::TYPE_SETTING);
3245             } else {
3246                 // We can edit the user so show the user deleted message and link it to the profile
3247                 if ($course->id == SITEID) {
3248                     $profileurl = new moodle_url('/user/profile.php', array('id'=>$user->id));
3249                 } else {
3250                     $profileurl = new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$course->id));
3251                 }
3252                 $usersetting->add(get_string('userdeleted'), $profileurl, self::TYPE_SETTING);
3253             }
3254             return true;
3255         }
3257         // Add the profile edit link
3258         if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
3259             if (($currentuser || is_siteadmin($USER) || !is_siteadmin($user)) && has_capability('moodle/user:update', $systemcontext)) {
3260                 $url = new moodle_url('/user/editadvanced.php', array('id'=>$user->id, 'course'=>$course->id));
3261                 $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
3262             } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) || ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
3263                 $url = new moodle_url('/user/edit.php', array('id'=>$user->id, 'course'=>$course->id));
3264                 $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
3265             }
3266         }
3268         // Change password link
3269         if (!empty($user->auth)) {
3270             $userauth = get_auth_plugin($user->auth);
3271             if ($currentuser && !session_is_loggedinas() && $userauth->can_change_password() && !isguestuser() && has_capability('moodle/user:changeownpassword', $systemcontext)) {
3272                 $passwordchangeurl = $userauth->change_password_url();
3273                 if (empty($passwordchangeurl)) {
3274                     $passwordchangeurl = new moodle_url('/login/change_password.php', array('id'=>$course->id));
3275                 }
3276                 $usersetting->add(get_string("changepassword"), $passwordchangeurl, self::TYPE_SETTING);
3277             }
3278         }
3280         // View the roles settings
3281         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:manage'), $usercontext)) {
3282             $roles = $usersetting->add(get_string('roles'), null, self::TYPE_SETTING);
3284             $url = new moodle_url('/admin/roles/usersroles.php', array('userid'=>$user->id, 'courseid'=>$course->id));
3285             $roles->add(get_string('thisusersroles', 'role'), $url, self::TYPE_SETTING);
3287             $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH);
3289             if (!empty($assignableroles)) {
3290                 $url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
3291                 $roles->add(get_string('assignrolesrelativetothisuser', 'role'), $url, self::TYPE_SETTING);
3292             }
3294             if (has_capability('moodle/role:review', $usercontext) || count(get_overridable_roles($usercontext, ROLENAME_BOTH))>0) {
3295                 $url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
3296                 $roles->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
3297             }
3299             $url = new moodle_url('/admin/roles/check.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
3300             $roles->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
3301         }
3303         // Portfolio
3304         if ($currentuser && !empty($CFG->enableportfolios) && has_capability('moodle/portfolio:export', $systemcontext)) {
3305             require_once($CFG->libdir . '/portfoliolib.php');
3306             if (portfolio_instances(true, false)) {
3307                 $portfolio = $usersetting->add(get_string('portfolios', 'portfolio'), null, self::TYPE_SETTING);
3309                 $config  = optional_param('config', 0, PARAM_INT);
3310                 $hide    = optional_param('hide', 0, PARAM_INT);
3311                 $url = new moodle_url('/user/portfolio.php', array('courseid'=>$course->id));
3312                 if ($hide !== 0) {
3313                     $url->param('hide', $hide);
3314                 }
3315                 if ($config !== 0) {
3316                     $url->param('config', $config);
3317                 }
3318                 $portfolio->add(get_string('configure', 'portfolio'), $url, self::TYPE_SETTING);
3320                 $page = optional_param('page', 0, PARAM_INT);
3321                 $perpage = optional_param('perpage', 10, PARAM_INT);
3322                 $url = new moodle_url('/user/portfoliologs.php', array('courseid'=>$course->id));
3323                 if ($page !== 0) {
3324                     $url->param('page', $page);
3325                 }
3326                 if ($perpage !== 0) {
3327                     $url->param('perpage', $perpage);
3328                 }
3329                 $portfolio->add(get_string('logs', 'portfolio'), $url, self::TYPE_SETTING);
3330             }
3331         }
3333         $enablemanagetokens = false;
3334         if (!empty($CFG->enablerssfeeds)) {
3335             $enablemanagetokens = true;
3336         } else if (!is_siteadmin($USER->id)
3337              && !empty($CFG->enablewebservices)
3338              && has_capability('moodle/webservice:createtoken', get_system_context()) ) {
3339             $enablemanagetokens = true;
3340         }
3341         // Security keys
3342         if ($currentuser && $enablemanagetokens) {
3343             $url = new moodle_url('/user/managetoken.php', array('sesskey'=>sesskey()));
3344             $usersetting->add(get_string('securitykeys', 'webservice'), $url, self::TYPE_SETTING);
3345         }
3347         // Repository
3348         if (!$currentuser) {
3349             require_once($CFG->dirroot . '/repository/lib.php');
3350             $editabletypes = repository::get_editable_types($usercontext);
3351             if ($usercontext->contextlevel == CONTEXT_USER && !empty($editabletypes)) {
3352                 $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$usercontext->id));
3353                 $usersetting->add(get_string('repositories', 'repository'), $url, self::TYPE_SETTING);
3354             }
3355         }
3357         // Messaging
3358         if (($currentuser && has_capability('moodle/user:editownmessageprofile', $systemcontext)) || (!isguestuser($user) && has_capability('moodle/user:editmessageprofile', $usercontext) && !is_primary_admin($user->id))) {
3359             $url = new moodle_url('/message/edit.php', array('id'=>$user->id, 'course'=>$course->id));
3360             // Hide the node if messaging disabled
3361             $usersetting->add(get_string('editmymessage', 'message'), $url, self::TYPE_SETTING)->display = !empty($CFG->messaging);
3362         }
3364         // Blogs
3365         if (!empty($CFG->bloglevel)) {
3366             $blog = $usersetting->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER, null, 'blogs');
3367             $blog->add(get_string('preferences', 'blog'), new moodle_url('/blog/preferences.php'), navigation_node::TYPE_SETTING);
3368             if (!empty($CFG->useexternalblogs) && $CFG->maxexternalblogsperuser > 0 && has_capability('moodle/blog:manageexternal', get_context_instance(CONTEXT_SYSTEM))) {
3369                 $blog->add(get_string('externalblogs', 'blog'), new moodle_url('/blog/external_blogs.php'), navigation_node::TYPE_SETTING);
3370                 $blog->add(get_string('addnewexternalblog', 'blog'), new moodle_url('/blog/external_blog_edit.php'), navigation_node::TYPE_SETTING);
3371             }
3372         }
3374         // Login as ...
3375         if (!$user->deleted and !$currentuser && !session_is_loggedinas() && has_capability('moodle/user:loginas', $coursecontext) && !is_siteadmin($user->id)) {
3376             $url = new moodle_url('/course/loginas.php', array('id'=>$course->id, 'user'=>$user->id, 'sesskey'=>sesskey()));
3377             $usersetting->add(get_string('loginas'), $url, self::TYPE_SETTING);
3378         }
3380         return $usersetting;
3381     }
3383     /**
3384      * Loads block specific settings in the navigation
3385      *
3386      * @return navigation_node
3387      */
3388     protected function load_block_settings() {
3389         global $CFG;
3391         $blocknode = $this->add(print_context_name($this->context));
3392         $blocknode->force_open();
3394         // Assign local roles
3395         $assignurl = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->context->id));
3396         $blocknode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING);
3398         // Override roles
3399         if (has_capability('moodle/role:review', $this->context) or  count(get_overridable_roles($this->context))>0) {
3400             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->context->id));
3401             $blocknode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
3402         }
3403         // Check role permissions
3404         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context)) {
3405             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->context->id));
3406             $blocknode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
3407         }
3409         return $blocknode;
3410     }
3412     /**
3413      * Loads category specific settings in the navigation
3414      *
3415      * @return navigation_node
3416      */
3417     protected function load_category_settings() {
3418         global $CFG;
3420         $categorynode = $this->add(print_context_name($this->context));
3421         $categorynode->force_open();
3423         if ($this->page->user_is_editing() && has_capability('moodle/category:manage', $this->context)) {
3424             $categorynode->add(get_string('editcategorythis'), new moodle_url('/course/editcategory.php', array('id' => $this->context->instanceid)));
3425             $categorynode->add(get_string('addsubcategory'), new moodle_url('/course/editcategory.php', array('parent' => $this->context->instanceid)));
3426         }
3428         // Assign local roles
3429         $assignurl = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->context->id));
3430         $categorynode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING);
3432         // Override roles
3433         if (has_capability('moodle/role:review', $this->context) or count(get_overridable_roles($this->context))>0) {
3434             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->context->id));
3435             $categorynode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
3436         }
3437         // Check role permissions
3438         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context)) {
3439             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->context->id));
3440             $categorynode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
3441         }
3442         // Manage filters
3443         if (has_capability('moodle/filter:manage', $this->context) && count(filter_get_available_in_context($this->context))>0) {
3444             $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->context->id));
3445             $categorynode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING);
3446         }
3448         return $categorynode;
3449     }
3451     /**
3452      * Determine whether the user is assuming another role
3453      *
3454      * This function checks to see if the user is assuming another role by means of
3455      * role switching. In doing this we compare each RSW key (context path) against
3456      * the current context path. This ensures that we can provide the switching
3457      * options against both the course and any page shown under the course.
3458      *
3459      * @return bool|int The role(int) if the user is in another role, false otherwise
3460      */
3461     protected function in_alternative_role() {
3462         global $USER;
3463         if (!empty($USER->access['rsw']) && is_array($USER->access['rsw'])) {
3464             if (!empty($this->page->context) && !empty($USER->access['rsw'][$this->page->context->path])) {
3465                 return $USER->access['rsw'][$this->page->context->path];
3466             }
3467             foreach ($USER->access['rsw'] as $key=>$role) {
3468                 if (strpos($this->context->path,$key)===0) {
3469                     return $role;
3470                 }
3471             }
3472         }
3473         return false;
3474     }
3476     /**
3477      * This function loads all of the front page settings into the settings navigation.
3478      * This function is called when the user is on the front page, or $COURSE==$SITE
3479      * @return navigation_node
3480      */
3481     protected function load_front_page_settings($forceopen = false) {
3482         global $SITE, $CFG;
3484         $course = clone($SITE);
3485         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);   // Course context
3487         $frontpage = $this->add(get_string('frontpagesettings'), null, self::TYPE_SETTING, null, 'frontpage');
3488         if ($forceopen) {
3489             $frontpage->force_open();
3490         }
3491         $frontpage->id = 'frontpagesettings';
3493         if (has_capability('moodle/course:update', $coursecontext)) {
3495             // Add the turn on/off settings
3496             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
3497             if ($this->page->user_is_editing()) {
3498                 $url->param('edit', 'off');
3499                 $editstring = get_string('turneditingoff');
3500             } else {
3501                 $url->param('edit', 'on');
3502                 $editstring = get_string('turneditingon');
3503             }
3504             $frontpage->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
3506             // Add the course settings link
3507             $url = new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings'));
3508             $frontpage->add(get_string('editsettings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
3509         }
3511         // add enrol nodes
3512         enrol_add_course_navigation($frontpage, $course);
3514         // Manage filters
3515         if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
3516             $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
3517             $frontpage->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
3518         }
3520         // Backup this course
3521         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
3522             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
3523             $frontpage->add(get_string('backup'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/backup', ''));
3524         }
3526         // Restore to this course
3527         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
3528             $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id, 'itemid'=>0, 'component' => 'backup', 'filearea'=>'course'));
3530             $url = null; // Disabled until restore is implemented. MDL-21432
3531             $frontpage->add(get_string('restore'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/restore', ''));
3532         }
3534         // Manage questions
3535         $questioncaps = array('moodle/question:add',
3536                               'moodle/question:editmine',
3537                               'moodle/question:editall',
3538                               'moodle/question:viewmine',
3539                               'moodle/question:viewall',
3540                               'moodle/question:movemine',
3541                               'moodle/question:moveall');
3542         if (has_any_capability($questioncaps, $this->context)) {
3543             $questionlink = $CFG->wwwroot.'/question/edit.php';
3544         } else if (has_capability('moodle/question:managecategory', $this->context)) {
3545             $questionlink = $CFG->wwwroot.'/question/category.php';
3546         }
3547         if (isset($questionlink)) {
3548             $url = new moodle_url($questionlink, array('courseid'=>$course->id));
3549             $frontpage->add(get_string('questions','quiz'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/questions', ''));
3550         }
3552         // Manage files
3553         if ($course->legacyfiles == 2 and has_capability('moodle/course:managefiles', $this->context)) {
3554             //hiden in new installs
3555             $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id, 'itemid'=>0, 'component' => 'course', 'filearea'=>'legacy'));
3556             $frontpage->add(get_string('sitelegacyfiles'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/files', ''));
3557         }
3558         return $frontpage;
3559     }
3561     /**
3562      * This function marks the cache as volatile so it is cleared during shutdown
3563      */
3564     public function clear_cache() {
3565         $this->cache->volatile();
3566     }
3569 /**
3570  * Simple class used to output a navigation branch in XML
3571  *
3572  * @package moodlecore
3573  * @subpackage navigation
3574  * @copyright 2009 Sam Hemelryk
3575  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3576  */
3577 class navigation_json {
3578     /** @var array */
3579     protected $nodetype = array('node','branch');
3580     /** @var array */
3581     protected $expandable = array();
3582     /**
3583      * Turns a branch and all of its children into XML
3584      *
3585      * @param navigation_node $branch
3586      * @return string XML string
3587      */
3588     public function convert($branch) {
3589         $xml = $this->convert_child($branch);
3590         return $xml;
3591     }
3592     /**
3593      * Set the expandable items in the array so that we have enough information
3594      * to attach AJAX events
3595      * @param array $expandable
3596      */
3597     public function set_expandable($expandable) {
3598         foreach ($expandable as $node) {
3599             $this->expandable[$node['branchid'].':'.$node['type']] = $node;
3600         }
3601     }
3602     /**
3603      * Recusively converts a child node and its children to XML for output
3604      *
3605      * @param navigation_node $child The child to convert
3606      * @param int $depth Pointlessly used to track the depth of the XML structure
3607      * @return string JSON
3608      */
3609     protected function convert_child($child, $depth=1) {
3610         global $OUTPUT;
3612         if (!$child->display) {
3613             return '';
3614         }
3615         $attributes = array();
3616         $attributes['id'] = $child->id;
3617         $attributes['name'] = $child->text;
3618         $attributes['type'] = $child->type;
3619         $attributes['key'] = $child->key;
3620         $attributes['class'] = $child->get_css_type();
3622         if ($child->icon instanceof pix_icon) {
3623             $attributes['icon'] = array(
3624                 'component' => $child->icon->component,
3625                 'pix' => $child->icon->pix,
3626             );
3627             foreach ($child->icon->attributes as $key=>$value) {
3628                 if ($key == 'class') {
3629                     $attributes['icon']['classes'] = explode(' ', $value);
3630                 } else if (!array_key_exists($key, $attributes['icon'])) {
3631                     $attributes['icon'][$key] = $value;
3632                 }
3634             }
3635         } else if (!empty($child->icon)) {
3636             $attributes['icon'] = (string)$child->icon;
3637         }
3639         if ($child->forcetitle || $child->title !== $child->text) {
3640             $attributes['title'] = htmlentities($child->title);
3641         }
3642         if (array_key_exists($child->key.':'.$child->type, $this->expandable)) {
3643             $attributes['expandable'] = $child->key;
3644             $child->add_class($this->expandable[$child->key.':'.$child->type]['id']);
3645         }
3647         if (count($child->classes)>0) {
3648             $attributes['class'] .= ' '.join(' ',$child->classes);
3649         }
3650         if (is_string($child->action)) {
3651             $attributes['link'] = $child->action;
3652         } else if ($child->action instanceof moodle_url) {
3653             $attributes['link'] = $child->action->out();
3654         }
3655         $attributes['hidden'] = ($child->hidden);
3656         $attributes['haschildren'] = ($child->children->count()>0 || $child->type == navigation_node::TYPE_CATEGORY);
3658         if (count($child->children)>0) {
3659             $attributes['children'] = array();
3660             foreach ($child->children as $subchild) {
3661                 $attributes['children'][] = $this->convert_child($subchild, $depth+1);
3662             }
3663         }
3665         if ($depth > 1) {
3666             return $attributes;
3667         } else {
3668             return json_encode($attributes);
3669         }
3670     }
3673 /**
3674  * The cache class used by global navigation and settings navigation to cache bits
3675  * and bobs that are used during their generation.
3676  *
3677  * It is basically an easy access point to session with a bit of smarts to make
3678  * sure that the information that is cached is valid still.
3679  *
3680  * Example use:
3681  * <code php>
3682  * if (!$cache->viewdiscussion()) {
3683  *     // Code to do stuff and produce cachable content
3684  *     $cache->viewdiscussion = has_capability('mod/forum:viewdiscussion', $coursecontext);
3685  * }
3686  * $content = $cache->viewdiscussion;
3687  * </code>
3688  *
3689  * @package moodlecore
3690  * @subpackage navigation
3691  * @copyright 2009 Sam Hemelryk
3692  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3693  */
3694 class navigation_cache {
3695     /** @var int */
3696     protected $creation;
3697     /** @var array */
3698     protected $session;
3699     /** @var string */
3700     protected $area;
3701     /** @var int */
3702     protected $timeout;
3703     /** @var stdClass */
3704     protected $currentcontext;
3705     /** @var int */
3706     const CACHETIME = 0;
3707     /** @var int */
3708     const CACHEUSERID = 1;
3709     /** @var int */
3710     const CACHEVALUE = 2;
3711     /** @var null|array An array of navigation cache areas to expire on shutdown */
3712     public static $volatilecaches;
3714     /**
3715      * Contructor for the cache. Requires two arguments
3716      *
3717      * @param string $area The string to use to segregate this particular cache
3718      *                it can either be unique to start a fresh cache or if you want
3719      *                to share a cache then make it the string used in the original
3720      *                cache
3721      * @param int $timeout The number of seconds to time the information out after
3722      */
3723     public function __construct($area, $timeout=60) {
3724         global $SESSION;
3725         $this->creation = time();
3726         $this->area = $area;
3728         if (!isset($SESSION->navcache)) {
3729             $SESSION->navcache = new stdClass;
3730         }
3732         if (!isset($SESSION->navcache->{$area})) {
3733             $SESSION->navcache->{$area} = array();
3734         }
3735         $this->session = &$SESSION->navcache->{$area};
3736         $this->timeout = time()-$timeout;
3737         if (rand(0,10)===0) {
3738             $this->garbage_collection();
3739         }
3740     }
3742     /**
3743      * Magic Method to retrieve something by simply calling using = cache->key
3744      *
3745      * @param mixed $key The identifier for the information you want out again
3746      * @return void|mixed Either void or what ever was put in
3747      */
3748     public function __get($key) {
3749         if (!$this->cached($key)) {
3750             return;
3751         }
3752         $information = $this->session[$key][self::CACHEVALUE];
3753         return unserialize($information);
3754     }
3756     /**
3757      * Magic method that simply uses {@link set();} to store something in the cache
3758      *
3759      * @param string|int $key
3760      * @param mixed $information
3761      */
3762     public function __set($key, $information) {
3763         $this->set($key, $information);
3764     }
3766     /**
3767      * Sets some information against the cache (session) for later retrieval
3768      *
3769      * @param string|int $key
3770      * @param mixed $information
3771      */
3772     public function set($key, $information) {
3773         global $USER;
3774         $information = serialize($information);
3775         $this->session[$key]= array(self::CACHETIME=>time(), self::CACHEUSERID=>$USER->id, self::CACHEVALUE=>$information);
3776     }
3777     /**
3778      * Check the existence of the identifier in the cache
3779      *
3780      * @param string|int $key
3781      * @return bool
3782      */
3783     public function cached($key) {
3784         global $USER;
3785         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) {
3786             return false;
3787         }
3788         return true;
3789     }
3790     /**
3791      * Compare something to it's equivilant in the cache
3792      *
3793      * @param string $key
3794      * @param mixed $value
3795      * @param bool $serialise Whether to serialise the value before comparison
3796      *              this should only be set to false if the value is already
3797      *              serialised
3798      * @return bool If the value is the same false if it is not set or doesn't match
3799      */
3800     public function compare($key, $value, $serialise=true) {
3801         if ($this->cached($key)) {
3802             if ($serialise) {
3803                 $value = serialize($value);
3804             }
3805             if ($this->session[$key][self::CACHEVALUE] === $value) {
3806                 return true;
3807             }
3808         }
3809         return false;
3810     }
3811     /**
3812      * Wipes the entire cache, good to force regeneration
3813      */
3814     public function clear() {
3815         $this->session = array();
3816     }
3817     /**
3818      * Checks all cache entries and removes any that have expired, good ole cleanup
3819      */
3820     protected function garbage_collection() {
3821         foreach ($this->session as $key=>$cachedinfo) {
3822             if (is_array($cachedinfo) && $cachedinfo[self::CACHETIME]<$this->timeout) {
3823                 unset($this->session[$key]);
3824             }
3825         }
3826     }
3828     /**
3829      * Marks the cache as being volatile (likely to change)
3830      *
3831      * Any caches marked as volatile will be destroyed at the on shutdown by
3832      * {@link navigation_node::destroy_volatile_caches()} which is registered
3833      * as a shutdown function if any caches are marked as volatile.
3834      *
3835      * @param bool $setting True to destroy the cache false not too
3836      */
3837     public function volatile($setting = true) {
3838         if (self::$volatilecaches===null) {
3839             self::$volatilecaches = array();
3840             register_shutdown_function(array('navigation_cache','destroy_volatile_caches'));
3841         }
3843         if ($setting) {
3844             self::$volatilecaches[$this->area] = $this->area;
3845         } else if (array_key_exists($this->area, self::$volatilecaches)) {
3846             unset(self::$volatilecaches[$this->area]);
3847         }
3848     }
3850     /**
3851      * Destroys all caches marked as volatile
3852      *
3853      * This function is static and works in conjunction with the static volatilecaches
3854      * property of navigation cache.
3855      * Because this function is static it manually resets the cached areas back to an
3856      * empty array.
3857      */
3858     public static function destroy_volatile_caches() {
3859         global $SESSION;
3860         if (is_array(self::$volatilecaches) && count(self::$volatilecaches)>0) {
3861             foreach (self::$volatilecaches as $area) {
3862                 $SESSION->navcache->{$area} = array();
3863             }
3864         }
3865     }