43dfe9eefb4036404f75c2b8172536214f7229a0
[moodle.git] / lib / navigationlib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains classes used to manage the navigation structures within Moodle.
19  *
20  * @since      2.0
21  * @package    core
22  * @copyright  2009 Sam Hemelryk
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 /**
29  * The name that will be used to separate the navigation cache within SESSION
30  */
31 define('NAVIGATION_CACHE_NAME', 'navigation');
33 /**
34  * This class is used to represent a node in a navigation tree
35  *
36  * This class is used to represent a node in a navigation tree within Moodle,
37  * the tree could be one of global navigation, settings navigation, or the navbar.
38  * Each node can be one of two types either a Leaf (default) or a branch.
39  * When a node is first created it is created as a leaf, when/if children are added
40  * the node then becomes a branch.
41  *
42  * @package   core
43  * @category  navigation
44  * @copyright 2009 Sam Hemelryk
45  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
46  */
47 class navigation_node implements renderable {
48     /** @var int Used to identify this node a leaf (default) 0 */
49     const NODETYPE_LEAF =   0;
50     /** @var int Used to identify this node a branch, happens with children  1 */
51     const NODETYPE_BRANCH = 1;
52     /** @var null Unknown node type null */
53     const TYPE_UNKNOWN =    null;
54     /** @var int System node type 0 */
55     const TYPE_ROOTNODE =   0;
56     /** @var int System node type 1 */
57     const TYPE_SYSTEM =     1;
58     /** @var int Category node type 10 */
59     const TYPE_CATEGORY =   10;
60     /** @var int Course node type 20 */
61     const TYPE_COURSE =     20;
62     /** @var int Course Structure node type 30 */
63     const TYPE_SECTION =    30;
64     /** @var int Activity node type, e.g. Forum, Quiz 40 */
65     const TYPE_ACTIVITY =   40;
66     /** @var int Resource node type, e.g. Link to a file, or label 50 */
67     const TYPE_RESOURCE =   50;
68     /** @var int A custom node type, default when adding without specifing type 60 */
69     const TYPE_CUSTOM =     60;
70     /** @var int Setting node type, used only within settings nav 70 */
71     const TYPE_SETTING =    70;
72     /** @var int Setting node type, used only within settings nav 80 */
73     const TYPE_USER =       80;
74     /** @var int Setting node type, used for containers of no importance 90 */
75     const TYPE_CONTAINER =  90;
77     /** @var int Parameter to aid the coder in tracking [optional] */
78     public $id = null;
79     /** @var string|int The identifier for the node, used to retrieve the node */
80     public $key = null;
81     /** @var string The text to use for the node */
82     public $text = null;
83     /** @var string Short text to use if requested [optional] */
84     public $shorttext = null;
85     /** @var string The title attribute for an action if one is defined */
86     public $title = null;
87     /** @var string A string that can be used to build a help button */
88     public $helpbutton = null;
89     /** @var moodle_url|action_link|null An action for the node (link) */
90     public $action = null;
91     /** @var pix_icon The path to an icon to use for this node */
92     public $icon = null;
93     /** @var int See TYPE_* constants defined for this class */
94     public $type = self::TYPE_UNKNOWN;
95     /** @var int See NODETYPE_* constants defined for this class */
96     public $nodetype = self::NODETYPE_LEAF;
97     /** @var bool If set to true the node will be collapsed by default */
98     public $collapse = false;
99     /** @var bool If set to true the node will be expanded by default */
100     public $forceopen = false;
101     /** @var array An array of CSS classes for the node */
102     public $classes = array();
103     /** @var navigation_node_collection An array of child nodes */
104     public $children = array();
105     /** @var bool If set to true the node will be recognised as active */
106     public $isactive = false;
107     /** @var bool If set to true the node will be dimmed */
108     public $hidden = false;
109     /** @var bool If set to false the node will not be displayed */
110     public $display = true;
111     /** @var bool If set to true then an HR will be printed before the node */
112     public $preceedwithhr = false;
113     /** @var bool If set to true the the navigation bar should ignore this node */
114     public $mainnavonly = false;
115     /** @var bool If set to true a title will be added to the action no matter what */
116     public $forcetitle = false;
117     /** @var navigation_node A reference to the node parent, you should never set this directly you should always call set_parent */
118     public $parent = null;
119     /** @var bool Override to not display the icon even if one is provided **/
120     public $hideicon = false;
121     /** @var array */
122     protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting', 80=>'user');
123     /** @var moodle_url */
124     protected static $fullmeurl = null;
125     /** @var bool toogles auto matching of active node */
126     public static $autofindactive = true;
127     /** @var mixed If set to an int, that section will be included even if it has no activities */
128     public $includesectionnum = false;
130     /**
131      * Constructs a new navigation_node
132      *
133      * @param array|string $properties Either an array of properties or a string to use
134      *                     as the text for the node
135      */
136     public function __construct($properties) {
137         if (is_array($properties)) {
138             // Check the array for each property that we allow to set at construction.
139             // text         - The main content for the node
140             // shorttext    - A short text if required for the node
141             // icon         - The icon to display for the node
142             // type         - The type of the node
143             // key          - The key to use to identify the node
144             // parent       - A reference to the nodes parent
145             // action       - The action to attribute to this node, usually a URL to link to
146             if (array_key_exists('text', $properties)) {
147                 $this->text = $properties['text'];
148             }
149             if (array_key_exists('shorttext', $properties)) {
150                 $this->shorttext = $properties['shorttext'];
151             }
152             if (!array_key_exists('icon', $properties)) {
153                 $properties['icon'] = new pix_icon('i/navigationitem', '');
154             }
155             $this->icon = $properties['icon'];
156             if ($this->icon instanceof pix_icon) {
157                 if (empty($this->icon->attributes['class'])) {
158                     $this->icon->attributes['class'] = 'navicon';
159                 } else {
160                     $this->icon->attributes['class'] .= ' navicon';
161                 }
162             }
163             if (array_key_exists('type', $properties)) {
164                 $this->type = $properties['type'];
165             } else {
166                 $this->type = self::TYPE_CUSTOM;
167             }
168             if (array_key_exists('key', $properties)) {
169                 $this->key = $properties['key'];
170             }
171             // This needs to happen last because of the check_if_active call that occurs
172             if (array_key_exists('action', $properties)) {
173                 $this->action = $properties['action'];
174                 if (is_string($this->action)) {
175                     $this->action = new moodle_url($this->action);
176                 }
177                 if (self::$autofindactive) {
178                     $this->check_if_active();
179                 }
180             }
181             if (array_key_exists('parent', $properties)) {
182                 $this->set_parent($properties['parent']);
183             }
184         } else if (is_string($properties)) {
185             $this->text = $properties;
186         }
187         if ($this->text === null) {
188             throw new coding_exception('You must set the text for the node when you create it.');
189         }
190         // Default the title to the text
191         $this->title = $this->text;
192         // Instantiate a new navigation node collection for this nodes children
193         $this->children = new navigation_node_collection();
194     }
196     /**
197      * Checks if this node is the active node.
198      *
199      * This is determined by comparing the action for the node against the
200      * defined URL for the page. A match will see this node marked as active.
201      *
202      * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
203      * @return bool
204      */
205     public function check_if_active($strength=URL_MATCH_EXACT) {
206         global $FULLME, $PAGE;
207         // Set fullmeurl if it hasn't already been set
208         if (self::$fullmeurl == null) {
209             if ($PAGE->has_set_url()) {
210                 self::override_active_url(new moodle_url($PAGE->url));
211             } else {
212                 self::override_active_url(new moodle_url($FULLME));
213             }
214         }
216         // Compare the action of this node against the fullmeurl
217         if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
218             $this->make_active();
219             return true;
220         }
221         return false;
222     }
224     /**
225      * This sets the URL that the URL of new nodes get compared to when locating
226      * the active node.
227      *
228      * The active node is the node that matches the URL set here. By default this
229      * is either $PAGE->url or if that hasn't been set $FULLME.
230      *
231      * @param moodle_url $url The url to use for the fullmeurl.
232      */
233     public static function override_active_url(moodle_url $url) {
234         // Clone the URL, in case the calling script changes their URL later.
235         self::$fullmeurl = new moodle_url($url);
236     }
238     /**
239      * Creates a navigation node, ready to add it as a child using add_node
240      * function. (The created node needs to be added before you can use it.)
241      * @param string $text
242      * @param moodle_url|action_link $action
243      * @param int $type
244      * @param string $shorttext
245      * @param string|int $key
246      * @param pix_icon $icon
247      * @return navigation_node
248      */
249     public static function create($text, $action=null, $type=self::TYPE_CUSTOM,
250             $shorttext=null, $key=null, pix_icon $icon=null) {
251         // Properties array used when creating the new navigation node
252         $itemarray = array(
253             'text' => $text,
254             'type' => $type
255         );
256         // Set the action if one was provided
257         if ($action!==null) {
258             $itemarray['action'] = $action;
259         }
260         // Set the shorttext if one was provided
261         if ($shorttext!==null) {
262             $itemarray['shorttext'] = $shorttext;
263         }
264         // Set the icon if one was provided
265         if ($icon!==null) {
266             $itemarray['icon'] = $icon;
267         }
268         // Set the key
269         $itemarray['key'] = $key;
270         // Construct and return
271         return new navigation_node($itemarray);
272     }
274     /**
275      * Adds a navigation node as a child of this node.
276      *
277      * @param string $text
278      * @param moodle_url|action_link $action
279      * @param int $type
280      * @param string $shorttext
281      * @param string|int $key
282      * @param pix_icon $icon
283      * @return navigation_node
284      */
285     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
286         // Create child node
287         $childnode = self::create($text, $action, $type, $shorttext, $key, $icon);
289         // Add the child to end and return
290         return $this->add_node($childnode);
291     }
293     /**
294      * Adds a navigation node as a child of this one, given a $node object
295      * created using the create function.
296      * @param navigation_node $childnode Node to add
297      * @param string $beforekey
298      * @return navigation_node The added node
299      */
300     public function add_node(navigation_node $childnode, $beforekey=null) {
301         // First convert the nodetype for this node to a branch as it will now have children
302         if ($this->nodetype !== self::NODETYPE_BRANCH) {
303             $this->nodetype = self::NODETYPE_BRANCH;
304         }
305         // Set the parent to this node
306         $childnode->set_parent($this);
308         // Default the key to the number of children if not provided
309         if ($childnode->key === null) {
310             $childnode->key = $this->children->count();
311         }
313         // Add the child using the navigation_node_collections add method
314         $node = $this->children->add($childnode, $beforekey);
316         // If added node is a category node or the user is logged in and it's a course
317         // then mark added node as a branch (makes it expandable by AJAX)
318         $type = $childnode->type;
319         if (($type==self::TYPE_CATEGORY) || (isloggedin() && $type==self::TYPE_COURSE)) {
320             $node->nodetype = self::NODETYPE_BRANCH;
321         }
322         // If this node is hidden mark it's children as hidden also
323         if ($this->hidden) {
324             $node->hidden = true;
325         }
326         // Return added node (reference returned by $this->children->add()
327         return $node;
328     }
330     /**
331      * Return a list of all the keys of all the child nodes.
332      * @return array the keys.
333      */
334     public function get_children_key_list() {
335         return $this->children->get_key_list();
336     }
338     /**
339      * Searches for a node of the given type with the given key.
340      *
341      * This searches this node plus all of its children, and their children....
342      * If you know the node you are looking for is a child of this node then please
343      * use the get method instead.
344      *
345      * @param int|string $key The key of the node we are looking for
346      * @param int $type One of navigation_node::TYPE_*
347      * @return navigation_node|false
348      */
349     public function find($key, $type) {
350         return $this->children->find($key, $type);
351     }
353     /**
354      * Get the child of this node that has the given key + (optional) type.
355      *
356      * If you are looking for a node and want to search all children + thier children
357      * then please use the find method instead.
358      *
359      * @param int|string $key The key of the node we are looking for
360      * @param int $type One of navigation_node::TYPE_*
361      * @return navigation_node|false
362      */
363     public function get($key, $type=null) {
364         return $this->children->get($key, $type);
365     }
367     /**
368      * Removes this node.
369      *
370      * @return bool
371      */
372     public function remove() {
373         return $this->parent->children->remove($this->key, $this->type);
374     }
376     /**
377      * Checks if this node has or could have any children
378      *
379      * @return bool Returns true if it has children or could have (by AJAX expansion)
380      */
381     public function has_children() {
382         return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0);
383     }
385     /**
386      * Marks this node as active and forces it open.
387      *
388      * Important: If you are here because you need to mark a node active to get
389      * the navigation to do what you want have you looked at {@link navigation_node::override_active_url()}?
390      * You can use it to specify a different URL to match the active navigation node on
391      * rather than having to locate and manually mark a node active.
392      */
393     public function make_active() {
394         $this->isactive = true;
395         $this->add_class('active_tree_node');
396         $this->force_open();
397         if ($this->parent !== null) {
398             $this->parent->make_inactive();
399         }
400     }
402     /**
403      * Marks a node as inactive and recusised back to the base of the tree
404      * doing the same to all parents.
405      */
406     public function make_inactive() {
407         $this->isactive = false;
408         $this->remove_class('active_tree_node');
409         if ($this->parent !== null) {
410             $this->parent->make_inactive();
411         }
412     }
414     /**
415      * Forces this node to be open and at the same time forces open all
416      * parents until the root node.
417      *
418      * Recursive.
419      */
420     public function force_open() {
421         $this->forceopen = true;
422         if ($this->parent !== null) {
423             $this->parent->force_open();
424         }
425     }
427     /**
428      * Adds a CSS class to this node.
429      *
430      * @param string $class
431      * @return bool
432      */
433     public function add_class($class) {
434         if (!in_array($class, $this->classes)) {
435             $this->classes[] = $class;
436         }
437         return true;
438     }
440     /**
441      * Removes a CSS class from this node.
442      *
443      * @param string $class
444      * @return bool True if the class was successfully removed.
445      */
446     public function remove_class($class) {
447         if (in_array($class, $this->classes)) {
448             $key = array_search($class,$this->classes);
449             if ($key!==false) {
450                 unset($this->classes[$key]);
451                 return true;
452             }
453         }
454         return false;
455     }
457     /**
458      * Sets the title for this node and forces Moodle to utilise it.
459      * @param string $title
460      */
461     public function title($title) {
462         $this->title = $title;
463         $this->forcetitle = true;
464     }
466     /**
467      * Resets the page specific information on this node if it is being unserialised.
468      */
469     public function __wakeup(){
470         $this->forceopen = false;
471         $this->isactive = false;
472         $this->remove_class('active_tree_node');
473     }
475     /**
476      * Checks if this node or any of its children contain the active node.
477      *
478      * Recursive.
479      *
480      * @return bool
481      */
482     public function contains_active_node() {
483         if ($this->isactive) {
484             return true;
485         } else {
486             foreach ($this->children as $child) {
487                 if ($child->isactive || $child->contains_active_node()) {
488                     return true;
489                 }
490             }
491         }
492         return false;
493     }
495     /**
496      * Finds the active node.
497      *
498      * Searches this nodes children plus all of the children for the active node
499      * and returns it if found.
500      *
501      * Recursive.
502      *
503      * @return navigation_node|false
504      */
505     public function find_active_node() {
506         if ($this->isactive) {
507             return $this;
508         } else {
509             foreach ($this->children as &$child) {
510                 $outcome = $child->find_active_node();
511                 if ($outcome !== false) {
512                     return $outcome;
513                 }
514             }
515         }
516         return false;
517     }
519     /**
520      * Searches all children for the best matching active node
521      * @return navigation_node|false
522      */
523     public function search_for_active_node() {
524         if ($this->check_if_active(URL_MATCH_BASE)) {
525             return $this;
526         } else {
527             foreach ($this->children as &$child) {
528                 $outcome = $child->search_for_active_node();
529                 if ($outcome !== false) {
530                     return $outcome;
531                 }
532             }
533         }
534         return false;
535     }
537     /**
538      * Gets the content for this node.
539      *
540      * @param bool $shorttext If true shorttext is used rather than the normal text
541      * @return string
542      */
543     public function get_content($shorttext=false) {
544         if ($shorttext && $this->shorttext!==null) {
545             return format_string($this->shorttext);
546         } else {
547             return format_string($this->text);
548         }
549     }
551     /**
552      * Gets the title to use for this node.
553      *
554      * @return string
555      */
556     public function get_title() {
557         if ($this->forcetitle || $this->action != null){
558             return $this->title;
559         } else {
560             return '';
561         }
562     }
564     /**
565      * Gets the CSS class to add to this node to describe its type
566      *
567      * @return string
568      */
569     public function get_css_type() {
570         if (array_key_exists($this->type, $this->namedtypes)) {
571             return 'type_'.$this->namedtypes[$this->type];
572         }
573         return 'type_unknown';
574     }
576     /**
577      * Finds all nodes that are expandable by AJAX
578      *
579      * @param array $expandable An array by reference to populate with expandable nodes.
580      */
581     public function find_expandable(array &$expandable) {
582         foreach ($this->children as &$child) {
583             if ($child->nodetype == self::NODETYPE_BRANCH && $child->children->count() == 0 && $child->display) {
584                 $child->id = 'expandable_branch_'.(count($expandable)+1);
585                 $this->add_class('canexpand');
586                 $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type);
587             }
588             $child->find_expandable($expandable);
589         }
590     }
592     /**
593      * Finds all nodes of a given type (recursive)
594      *
595      * @param int $type One of navigation_node::TYPE_*
596      * @return array
597      */
598     public function find_all_of_type($type) {
599         $nodes = $this->children->type($type);
600         foreach ($this->children as &$node) {
601             $childnodes = $node->find_all_of_type($type);
602             $nodes = array_merge($nodes, $childnodes);
603         }
604         return $nodes;
605     }
607     /**
608      * Removes this node if it is empty
609      */
610     public function trim_if_empty() {
611         if ($this->children->count() == 0) {
612             $this->remove();
613         }
614     }
616     /**
617      * Creates a tab representation of this nodes children that can be used
618      * with print_tabs to produce the tabs on a page.
619      *
620      * call_user_func_array('print_tabs', $node->get_tabs_array());
621      *
622      * @param array $inactive
623      * @param bool $return
624      * @return array Array (tabs, selected, inactive, activated, return)
625      */
626     public function get_tabs_array(array $inactive=array(), $return=false) {
627         $tabs = array();
628         $rows = array();
629         $selected = null;
630         $activated = array();
631         foreach ($this->children as $node) {
632             $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title());
633             if ($node->contains_active_node()) {
634                 if ($node->children->count() > 0) {
635                     $activated[] = $node->key;
636                     foreach ($node->children as $child) {
637                         if ($child->contains_active_node()) {
638                             $selected = $child->key;
639                         }
640                         $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title());
641                     }
642                 } else {
643                     $selected = $node->key;
644                 }
645             }
646         }
647         return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
648     }
650     /**
651      * Sets the parent for this node and if this node is active ensures that the tree is properly
652      * adjusted as well.
653      *
654      * @param navigation_node $parent
655      */
656     public function set_parent(navigation_node $parent) {
657         // Set the parent (thats the easy part)
658         $this->parent = $parent;
659         // Check if this node is active (this is checked during construction)
660         if ($this->isactive) {
661             // Force all of the parent nodes open so you can see this node
662             $this->parent->force_open();
663             // Make all parents inactive so that its clear where we are.
664             $this->parent->make_inactive();
665         }
666     }
669 /**
670  * Navigation node collection
671  *
672  * This class is responsible for managing a collection of navigation nodes.
673  * It is required because a node's unique identifier is a combination of both its
674  * key and its type.
675  *
676  * Originally an array was used with a string key that was a combination of the two
677  * however it was decided that a better solution would be to use a class that
678  * implements the standard IteratorAggregate interface.
679  *
680  * @package   core
681  * @category  navigation
682  * @copyright 2010 Sam Hemelryk
683  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
684  */
685 class navigation_node_collection implements IteratorAggregate {
686     /**
687      * A multidimensional array to where the first key is the type and the second
688      * key is the nodes key.
689      * @var array
690      */
691     protected $collection = array();
692     /**
693      * An array that contains references to nodes in the same order they were added.
694      * This is maintained as a progressive array.
695      * @var array
696      */
697     protected $orderedcollection = array();
698     /**
699      * A reference to the last node that was added to the collection
700      * @var navigation_node
701      */
702     protected $last = null;
703     /**
704      * The total number of items added to this array.
705      * @var int
706      */
707     protected $count = 0;
709     /**
710      * Adds a navigation node to the collection
711      *
712      * @param navigation_node $node Node to add
713      * @param string $beforekey If specified, adds before a node with this key,
714      *   otherwise adds at end
715      * @return navigation_node Added node
716      */
717     public function add(navigation_node $node, $beforekey=null) {
718         global $CFG;
719         $key = $node->key;
720         $type = $node->type;
722         // First check we have a 2nd dimension for this type
723         if (!array_key_exists($type, $this->orderedcollection)) {
724             $this->orderedcollection[$type] = array();
725         }
726         // Check for a collision and report if debugging is turned on
727         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
728             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
729         }
731         // Find the key to add before
732         $newindex = $this->count;
733         $last = true;
734         if ($beforekey !== null) {
735             foreach ($this->collection as $index => $othernode) {
736                 if ($othernode->key === $beforekey) {
737                     $newindex = $index;
738                     $last = false;
739                     break;
740                 }
741             }
742             if ($newindex === $this->count) {
743                 debugging('Navigation node add_before: Reference node not found ' . $beforekey .
744                         ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER);
745             }
746         }
748         // Add the node to the appropriate place in the by-type structure (which
749         // is not ordered, despite the variable name)
750         $this->orderedcollection[$type][$key] = $node;
751         if (!$last) {
752             // Update existing references in the ordered collection (which is the
753             // one that isn't called 'ordered') to shuffle them along if required
754             for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) {
755                 $this->collection[$oldindex] = $this->collection[$oldindex - 1];
756             }
757         }
758         // Add a reference to the node to the progressive collection.
759         $this->collection[$newindex] = $this->orderedcollection[$type][$key];
760         // Update the last property to a reference to this new node.
761         $this->last = $this->orderedcollection[$type][$key];
763         // Reorder the array by index if needed
764         if (!$last) {
765             ksort($this->collection);
766         }
767         $this->count++;
768         // Return the reference to the now added node
769         return $node;
770     }
772     /**
773      * Return a list of all the keys of all the nodes.
774      * @return array the keys.
775      */
776     public function get_key_list() {
777         $keys = array();
778         foreach ($this->collection as $node) {
779             $keys[] = $node->key;
780         }
781         return $keys;
782     }
784     /**
785      * Fetches a node from this collection.
786      *
787      * @param string|int $key The key of the node we want to find.
788      * @param int $type One of navigation_node::TYPE_*.
789      * @return navigation_node|null
790      */
791     public function get($key, $type=null) {
792         if ($type !== null) {
793             // If the type is known then we can simply check and fetch
794             if (!empty($this->orderedcollection[$type][$key])) {
795                 return $this->orderedcollection[$type][$key];
796             }
797         } else {
798             // Because we don't know the type we look in the progressive array
799             foreach ($this->collection as $node) {
800                 if ($node->key === $key) {
801                     return $node;
802                 }
803             }
804         }
805         return false;
806     }
808     /**
809      * Searches for a node with matching key and type.
810      *
811      * This function searches both the nodes in this collection and all of
812      * the nodes in each collection belonging to the nodes in this collection.
813      *
814      * Recursive.
815      *
816      * @param string|int $key  The key of the node we want to find.
817      * @param int $type  One of navigation_node::TYPE_*.
818      * @return navigation_node|null
819      */
820     public function find($key, $type=null) {
821         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
822             return $this->orderedcollection[$type][$key];
823         } else {
824             $nodes = $this->getIterator();
825             // Search immediate children first
826             foreach ($nodes as &$node) {
827                 if ($node->key === $key && ($type === null || $type === $node->type)) {
828                     return $node;
829                 }
830             }
831             // Now search each childs children
832             foreach ($nodes as &$node) {
833                 $result = $node->children->find($key, $type);
834                 if ($result !== false) {
835                     return $result;
836                 }
837             }
838         }
839         return false;
840     }
842     /**
843      * Fetches the last node that was added to this collection
844      *
845      * @return navigation_node
846      */
847     public function last() {
848         return $this->last;
849     }
851     /**
852      * Fetches all nodes of a given type from this collection
853      *
854      * @param string|int $type  node type being searched for.
855      * @return array ordered collection
856      */
857     public function type($type) {
858         if (!array_key_exists($type, $this->orderedcollection)) {
859             $this->orderedcollection[$type] = array();
860         }
861         return $this->orderedcollection[$type];
862     }
863     /**
864      * Removes the node with the given key and type from the collection
865      *
866      * @param string|int $key The key of the node we want to find.
867      * @param int $type
868      * @return bool
869      */
870     public function remove($key, $type=null) {
871         $child = $this->get($key, $type);
872         if ($child !== false) {
873             foreach ($this->collection as $colkey => $node) {
874                 if ($node->key == $key && $node->type == $type) {
875                     unset($this->collection[$colkey]);
876                     break;
877                 }
878             }
879             unset($this->orderedcollection[$child->type][$child->key]);
880             $this->count--;
881             return true;
882         }
883         return false;
884     }
886     /**
887      * Gets the number of nodes in this collection
888      *
889      * This option uses an internal count rather than counting the actual options to avoid
890      * a performance hit through the count function.
891      *
892      * @return int
893      */
894     public function count() {
895         return $this->count;
896     }
897     /**
898      * Gets an array iterator for the collection.
899      *
900      * This is required by the IteratorAggregator interface and is used by routines
901      * such as the foreach loop.
902      *
903      * @return ArrayIterator
904      */
905     public function getIterator() {
906         return new ArrayIterator($this->collection);
907     }
910 /**
911  * The global navigation class used for... the global navigation
912  *
913  * This class is used by PAGE to store the global navigation for the site
914  * and is then used by the settings nav and navbar to save on processing and DB calls
915  *
916  * See
917  * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()}
918  * {@link lib/ajax/getnavbranch.php} Called by ajax
919  *
920  * @package   core
921  * @category  navigation
922  * @copyright 2009 Sam Hemelryk
923  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
924  */
925 class global_navigation extends navigation_node {
926     /** @var moodle_page The Moodle page this navigation object belongs to. */
927     protected $page;
928     /** @var bool switch to let us know if the navigation object is initialised*/
929     protected $initialised = false;
930     /** @var array An array of course information */
931     protected $mycourses = array();
932     /** @var array An array for containing  root navigation nodes */
933     protected $rootnodes = array();
934     /** @var bool A switch for whether to show empty sections in the navigation */
935     protected $showemptysections = true;
936     /** @var bool A switch for whether courses should be shown within categories on the navigation. */
937     protected $showcategories = null;
938     /** @var array An array of stdClasses for users that the navigation is extended for */
939     protected $extendforuser = array();
940     /** @var navigation_cache */
941     protected $cache;
942     /** @var array An array of course ids that are present in the navigation */
943     protected $addedcourses = array();
944     /** @var bool */
945     protected $allcategoriesloaded = false;
946     /** @var array An array of category ids that are included in the navigation */
947     protected $addedcategories = array();
948     /** @var int expansion limit */
949     protected $expansionlimit = 0;
950     /** @var int userid to allow parent to see child's profile page navigation */
951     protected $useridtouseforparentchecks = 0;
953     /** Used when loading categories to load all top level categories [parent = 0] **/
954     const LOAD_ROOT_CATEGORIES = 0;
955     /** Used when loading categories to load all categories **/
956     const LOAD_ALL_CATEGORIES = -1;
958     /**
959      * Constructs a new global navigation
960      *
961      * @param moodle_page $page The page this navigation object belongs to
962      */
963     public function __construct(moodle_page $page) {
964         global $CFG, $SITE, $USER;
966         if (during_initial_install()) {
967             return;
968         }
970         if (get_home_page() == HOMEPAGE_SITE) {
971             // We are using the site home for the root element
972             $properties = array(
973                 'key' => 'home',
974                 'type' => navigation_node::TYPE_SYSTEM,
975                 'text' => get_string('home'),
976                 'action' => new moodle_url('/')
977             );
978         } else {
979             // We are using the users my moodle for the root element
980             $properties = array(
981                 'key' => 'myhome',
982                 'type' => navigation_node::TYPE_SYSTEM,
983                 'text' => get_string('myhome'),
984                 'action' => new moodle_url('/my/')
985             );
986         }
988         // Use the parents constructor.... good good reuse
989         parent::__construct($properties);
991         // Initalise and set defaults
992         $this->page = $page;
993         $this->forceopen = true;
994         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
995     }
997     /**
998      * Mutator to set userid to allow parent to see child's profile
999      * page navigation. See MDL-25805 for initial issue. Linked to it
1000      * is an issue explaining why this is a REALLY UGLY HACK thats not
1001      * for you to use!
1002      *
1003      * @param int $userid userid of profile page that parent wants to navigate around.
1004      */
1005     public function set_userid_for_parent_checks($userid) {
1006         $this->useridtouseforparentchecks = $userid;
1007     }
1010     /**
1011      * Initialises the navigation object.
1012      *
1013      * This causes the navigation object to look at the current state of the page
1014      * that it is associated with and then load the appropriate content.
1015      *
1016      * This should only occur the first time that the navigation structure is utilised
1017      * which will normally be either when the navbar is called to be displayed or
1018      * when a block makes use of it.
1019      *
1020      * @return bool
1021      */
1022     public function initialise() {
1023         global $CFG, $SITE, $USER, $DB;
1024         // Check if it has alread been initialised
1025         if ($this->initialised || during_initial_install()) {
1026             return true;
1027         }
1028         $this->initialised = true;
1030         // Set up the five base root nodes. These are nodes where we will put our
1031         // content and are as follows:
1032         // site:        Navigation for the front page.
1033         // myprofile:     User profile information goes here.
1034         // mycourses:   The users courses get added here.
1035         // courses:     Additional courses are added here.
1036         // users:       Other users information loaded here.
1037         $this->rootnodes = array();
1038         if (get_home_page() == HOMEPAGE_SITE) {
1039             // The home element should be my moodle because the root element is the site
1040             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
1041                 $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
1042             }
1043         } else {
1044             // The home element should be the site because the root node is my moodle
1045             $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
1046             if (!empty($CFG->defaulthomepage) && ($CFG->defaulthomepage == HOMEPAGE_MY)) {
1047                 // We need to stop automatic redirection
1048                 $this->rootnodes['home']->action->param('redirect', '0');
1049             }
1050         }
1051         $this->rootnodes['site']      = $this->add_course($SITE);
1052         $this->rootnodes['myprofile'] = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
1053         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses');
1054         $this->rootnodes['courses']   = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self::TYPE_ROOTNODE, null, 'courses');
1055         $this->rootnodes['users']     = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
1057         // We always load the frontpage course to ensure it is available without
1058         // JavaScript enabled.
1059         $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE);
1060         $this->load_course_sections($SITE, $this->rootnodes['site']);
1062         // Fetch all of the users courses.
1063         $mycourses = enrol_get_my_courses();
1064         // We need to show categories if we can show categories and the user isn't enrolled in any courses or we're not showing all courses
1065         $showcategories = ($this->show_categories() && (count($mycourses) == 0 || !empty($CFG->navshowallcourses)));
1066         // $issite gets set to true if the current pages course is the sites frontpage course
1067         $issite = ($this->page->course->id == $SITE->id);
1068         // $ismycourse gets set to true if the user is enrolled in the current pages course.
1069         $ismycourse = !$issite && (array_key_exists($this->page->course->id, $mycourses));
1071         // Check if any courses were returned.
1072         if (count($mycourses) > 0) {
1074             // Check if categories should be displayed within the my courses branch
1075             if (!empty($CFG->navshowmycoursecategories)) {
1077                 // Find the category of each mycourse
1078                 $categories = array();
1079                 foreach ($mycourses as $course) {
1080                     $categories[] = $course->category;
1081                 }
1083                 // Do a single DB query to get the categories immediately associated with
1084                 // courses the user is enrolled in.
1085                 $categories = $DB->get_records_list('course_categories', 'id', array_unique($categories), 'depth ASC, sortorder ASC');
1086                 // Work out the parent categories that we need to load that we havn't
1087                 // already got.
1088                 $categoryids = array();
1089                 foreach ($categories as $category) {
1090                     $categoryids = array_merge($categoryids, explode('/', trim($category->path, '/')));
1091                 }
1092                 $categoryids = array_unique($categoryids);
1093                 $categoryids = array_diff($categoryids, array_keys($categories));
1095                 if (count($categoryids)) {
1096                     // Fetch any other categories we need.
1097                     $allcategories = $DB->get_records_list('course_categories', 'id', $categoryids, 'depth ASC, sortorder ASC');
1098                     if (is_array($allcategories) && count($allcategories) > 0) {
1099                         $categories = array_merge($categories, $allcategories);
1100                     }
1101                 }
1103                 // We ONLY want the categories, we need to get rid of the keys
1104                 $categories = array_values($categories);
1105                 $addedcategories = array();
1106                 while (($category = array_shift($categories)) !== null) {
1107                     if ($category->parent == '0') {
1108                         $categoryparent = $this->rootnodes['mycourses'];
1109                     } else if (array_key_exists($category->parent, $addedcategories)) {
1110                         $categoryparent = $addedcategories[$category->parent];
1111                     } else {
1112                         // Prepare to count iterations. We don't want to loop forever
1113                         // accidentally if for some reason a category can't be placed.
1114                         if (!isset($category->loopcount)) {
1115                             $category->loopcount = 0;
1116                         }
1117                         $category->loopcount++;
1118                         if ($category->loopcount > 5) {
1119                             // This is a pretty serious problem and this should never happen.
1120                             // If it does then for some reason a category has been loaded but
1121                             // its parents have now. It could be data corruption.
1122                             debugging('Category '.$category->id.' could not be placed within the navigation', DEBUG_DEVELOPER);
1123                         } else {
1124                             // Add it back to the end of the categories array
1125                             array_push($categories, $category);
1126                         }
1127                         continue;
1128                     }
1130                     $url = new moodle_url('/course/category.php', array('id' => $category->id));
1131                     $addedcategories[$category->id] = $categoryparent->add($category->name, $url, self::TYPE_CATEGORY, $category->name, $category->id);
1133                     if (!$category->visible) {
1134                         if (!has_capability('moodle/category:viewhiddencategories', context_coursecat::instance($category->parent))) {
1135                             $addedcategories[$category->id]->display = false;
1136                         } else {
1137                             $addedcategories[$category->id]->hidden = true;
1138                         }
1139                     }
1140                 }
1141             }
1143             // Add all of the users courses to the navigation.
1144             // First up we need to add to the mycourses section.
1145             foreach ($mycourses as $course) {
1146                 $course->coursenode = $this->add_course($course, false, true);
1147             }
1149             if (!empty($CFG->navshowallcourses)) {
1150                 // Load all courses
1151                 $this->load_all_courses();
1152             }
1154             // Next if nasvshowallcourses is enabled then we need to add courses
1155             // to the courses branch as well.
1156             if (!empty($CFG->navshowallcourses)) {
1157                 foreach ($mycourses as $course) {
1158                     if (!empty($course->category) && !$this->can_add_more_courses_to_category($course->category)) {
1159                         continue;
1160                     }
1161                     $genericcoursenode = $this->add_course($course, true);
1162                     if ($genericcoursenode->isactive) {
1163                         // We don't want this node to be active because we want the
1164                         // node in the mycourses branch to be active.
1165                         $genericcoursenode->make_inactive();
1166                         $genericcoursenode->collapse = true;
1167                         if ($genericcoursenode->parent && $genericcoursenode->parent->type == self::TYPE_CATEGORY) {
1168                             $parent = $genericcoursenode->parent;
1169                             while ($parent && $parent->type == self::TYPE_CATEGORY) {
1170                                 $parent->collapse = true;
1171                                 $parent = $parent->parent;
1172                             }
1173                         }
1174                     }
1175                 }
1176             }
1177         } else if (!empty($CFG->navshowallcourses) || !$this->show_categories()) {
1178             // Load all courses
1179             $this->load_all_courses();
1180         }
1182         $canviewcourseprofile = true;
1184         // Next load context specific content into the navigation
1185         switch ($this->page->context->contextlevel) {
1186             case CONTEXT_SYSTEM :
1187                 // This has already been loaded we just need to map the variable
1188                 if ($showcategories) {
1189                     $this->load_all_categories(self::LOAD_ROOT_CATEGORIES, true);
1190                 }
1191                 break;
1192             case CONTEXT_COURSECAT :
1193                 // This has already been loaded we just need to map the variable
1194                 if ($showcategories) {
1195                     $this->load_all_categories($this->page->context->instanceid, true);
1196                 }
1197                 break;
1198             case CONTEXT_BLOCK :
1199             case CONTEXT_COURSE :
1200                 if ($issite) {
1201                     // If it is the front page course, or a block on it then
1202                     // all we need to do is load the root categories if required
1203                     if ($showcategories) {
1204                         $this->load_all_categories(self::LOAD_ROOT_CATEGORIES, true);
1205                     }
1206                     break;
1207                 }
1208                 // Load the course associated with the page into the navigation
1209                 $course = $this->page->course;
1210                 if ($this->show_categories() && !$ismycourse) {
1211                     // The user isn't enrolled in the course and we need to show categories in which case we need
1212                     // to load the category relating to the course and depending up $showcategories all of the root categories as well.
1213                     $this->load_all_categories($course->category, $showcategories);
1214                 }
1215                 $coursenode = $this->load_course($course);
1217                 // If the course wasn't added then don't try going any further.
1218                 if (!$coursenode) {
1219                     $canviewcourseprofile = false;
1220                     break;
1221                 }
1223                 // If the user is not enrolled then we only want to show the
1224                 // course node and not populate it.
1226                 // Not enrolled, can't view, and hasn't switched roles
1227                 if (!can_access_course($course)) {
1228                     // TODO: very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1229                     // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1230                     $isparent = false;
1231                     if ($this->useridtouseforparentchecks) {
1232                         if ($this->useridtouseforparentchecks != $USER->id) {
1233                             $usercontext   = context_user::instance($this->useridtouseforparentchecks, MUST_EXIST);
1234                             if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))
1235                                     and has_capability('moodle/user:viewdetails', $usercontext)) {
1236                                 $isparent = true;
1237                             }
1238                         }
1239                     }
1241                     if (!$isparent) {
1242                         $coursenode->make_active();
1243                         $canviewcourseprofile = false;
1244                         break;
1245                     }
1246                 }
1247                 // Add the essentials such as reports etc...
1248                 $this->add_course_essentials($coursenode, $course);
1249                 if ($this->format_display_course_content($course->format)) {
1250                     // Load the course sections
1251                     $sections = $this->load_course_sections($course, $coursenode);
1252                 }
1253                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1254                     $coursenode->make_active();
1255                 }
1256                 break;
1257             case CONTEXT_MODULE :
1258                 if ($issite) {
1259                     // If this is the site course then most information will have
1260                     // already been loaded.
1261                     // However we need to check if there is more content that can
1262                     // yet be loaded for the specific module instance.
1263                     $activitynode = $this->rootnodes['site']->get($this->page->cm->id, navigation_node::TYPE_ACTIVITY);
1264                     if ($activitynode) {
1265                         $this->load_activity($this->page->cm, $this->page->course, $activitynode);
1266                     }
1267                     break;
1268                 }
1270                 $course = $this->page->course;
1271                 $cm = $this->page->cm;
1273                 if ($this->show_categories() && !$ismycourse) {
1274                     $this->load_all_categories($course->category, $showcategories);
1275                 }
1277                 // Load the course associated with the page into the navigation
1278                 $coursenode = $this->load_course($course);
1280                 // If the course wasn't added then don't try going any further.
1281                 if (!$coursenode) {
1282                     $canviewcourseprofile = false;
1283                     break;
1284                 }
1286                 // If the user is not enrolled then we only want to show the
1287                 // course node and not populate it.
1288                 if (!can_access_course($course)) {
1289                     $coursenode->make_active();
1290                     $canviewcourseprofile = false;
1291                     break;
1292                 }
1294                 $this->add_course_essentials($coursenode, $course);
1296                 // Get section number from $cm (if provided) - we need this
1297                 // before loading sections in order to tell it to load this section
1298                 // even if it would not normally display (=> it contains only
1299                 // a label, which we are now editing)
1300                 $sectionnum = isset($cm->sectionnum) ? $cm->sectionnum : 0;
1301                 if ($sectionnum) {
1302                     // This value has to be stored in a member variable because
1303                     // otherwise we would have to pass it through a public API
1304                     // to course formats and they would need to change their
1305                     // functions to pass it along again...
1306                     $this->includesectionnum = $sectionnum;
1307                 } else {
1308                     $this->includesectionnum = false;
1309                 }
1311                 // Load the course sections into the page
1312                 $sections = $this->load_course_sections($course, $coursenode);
1313                 if ($course->id != $SITE->id) {
1314                     // Find the section for the $CM associated with the page and collect
1315                     // its section number.
1316                     if ($sectionnum) {
1317                         $cm->sectionnumber = $sectionnum;
1318                     } else {
1319                         foreach ($sections as $section) {
1320                             if ($section->id == $cm->section) {
1321                                 $cm->sectionnumber = $section->section;
1322                                 break;
1323                             }
1324                         }
1325                     }
1327                     // Load all of the section activities for the section the cm belongs to.
1328                     if (isset($cm->sectionnumber) and !empty($sections[$cm->sectionnumber])) {
1329                         list($sectionarray, $activityarray) = $this->generate_sections_and_activities($course);
1330                         $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, $activityarray);
1331                     } else {
1332                         $activities = array();
1333                         if ($activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course))) {
1334                             // "stealth" activity from unavailable section
1335                             $activities[$cm->id] = $activity;
1336                         }
1337                     }
1338                 } else {
1339                     $activities = array();
1340                     $activities[$cm->id] = $coursenode->get($cm->id, navigation_node::TYPE_ACTIVITY);
1341                 }
1342                 if (!empty($activities[$cm->id])) {
1343                     // Finally load the cm specific navigaton information
1344                     $this->load_activity($cm, $course, $activities[$cm->id]);
1345                     // Check if we have an active ndoe
1346                     if (!$activities[$cm->id]->contains_active_node() && !$activities[$cm->id]->search_for_active_node()) {
1347                         // And make the activity node active.
1348                         $activities[$cm->id]->make_active();
1349                     }
1350                 } else {
1351                     //TODO: something is wrong, what to do? (Skodak)
1352                 }
1353                 break;
1354             case CONTEXT_USER :
1355                 if ($issite) {
1356                     // The users profile information etc is already loaded
1357                     // for the front page.
1358                     break;
1359                 }
1360                 $course = $this->page->course;
1361                 if ($this->show_categories() && !$ismycourse) {
1362                     $this->load_all_categories($course->category, $showcategories);
1363                 }
1364                 // Load the course associated with the user into the navigation
1365                 $coursenode = $this->load_course($course);
1367                 // If the course wasn't added then don't try going any further.
1368                 if (!$coursenode) {
1369                     $canviewcourseprofile = false;
1370                     break;
1371                 }
1373                 // If the user is not enrolled then we only want to show the
1374                 // course node and not populate it.
1375                 if (!can_access_course($course)) {
1376                     $coursenode->make_active();
1377                     $canviewcourseprofile = false;
1378                     break;
1379                 }
1380                 $this->add_course_essentials($coursenode, $course);
1381                 $sections = $this->load_course_sections($course, $coursenode);
1382                 break;
1383         }
1385         // Look for all categories which have been loaded
1386         if ($showcategories) {
1387             $categories = $this->find_all_of_type(self::TYPE_CATEGORY);
1388             if (count($categories) !== 0) {
1389                 $categoryids = array();
1390                 foreach ($categories as $category) {
1391                     $categoryids[] = $category->key;
1392                 }
1393                 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED);
1394                 $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20;
1395                 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1396                           FROM {course_categories} cc
1397                           JOIN {course} c ON c.category = cc.id
1398                          WHERE cc.id {$categoriessql}
1399                       GROUP BY cc.id
1400                         HAVING COUNT(c.id) > :limit";
1401                 $excessivecategories = $DB->get_records_sql($sql, $params);
1402                 foreach ($categories as &$category) {
1403                     if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1404                         $url = new moodle_url('/course/category.php', array('id'=>$category->key));
1405                         $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1406                     }
1407                 }
1408             }
1409         } else if ((!empty($CFG->navshowallcourses) || empty($mycourses)) && !$this->can_add_more_courses_to_category($this->rootnodes['courses'])) {
1410             $this->rootnodes['courses']->add(get_string('viewallcoursescategories'), new moodle_url('/course/index.php'), self::TYPE_SETTING);
1411         }
1413         // Load for the current user
1414         $this->load_for_user();
1415         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) {
1416             $this->load_for_user(null, true);
1417         }
1418         // Load each extending user into the navigation.
1419         foreach ($this->extendforuser as $user) {
1420             if ($user->id != $USER->id) {
1421                 $this->load_for_user($user);
1422             }
1423         }
1425         // Give the local plugins a chance to include some navigation if they want.
1426         foreach (get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $file) {
1427             $function = "local_{$plugin}_extends_navigation";
1428             $oldfunction = "{$plugin}_extends_navigation";
1429             if (function_exists($function)) {
1430                 // This is the preferred function name as there is less chance of conflicts
1431                 $function($this);
1432             } else if (function_exists($oldfunction)) {
1433                 // We continue to support the old function name to ensure backwards compatability
1434                 debugging("Deprecated local plugin navigation callback: Please rename '{$oldfunction}' to '{$function}'. Support for the old callback will be dropped after the release of 2.4", DEBUG_DEVELOPER);
1435                 $oldfunction($this);
1436             }
1437         }
1439         // Remove any empty root nodes
1440         foreach ($this->rootnodes as $node) {
1441             // Dont remove the home node
1442             if ($node->key !== 'home' && !$node->has_children()) {
1443                 $node->remove();
1444             }
1445         }
1447         if (!$this->contains_active_node()) {
1448             $this->search_for_active_node();
1449         }
1451         // If the user is not logged in modify the navigation structure as detailed
1452         // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1453         if (!isloggedin()) {
1454             $activities = clone($this->rootnodes['site']->children);
1455             $this->rootnodes['site']->remove();
1456             $children = clone($this->children);
1457             $this->children = new navigation_node_collection();
1458             foreach ($activities as $child) {
1459                 $this->children->add($child);
1460             }
1461             foreach ($children as $child) {
1462                 $this->children->add($child);
1463             }
1464         }
1465         return true;
1466     }
1468     /**
1469      * Returns true if courses should be shown within categories on the navigation.
1470      *
1471      * @return bool
1472      */
1473     protected function show_categories() {
1474         global $CFG, $DB;
1475         if ($this->showcategories === null) {
1476             $show = $this->page->context->contextlevel == CONTEXT_COURSECAT;
1477             $show = $show || (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1);
1478             $this->showcategories = $show;
1479         }
1480         return $this->showcategories;
1481     }
1483     /**
1484      * Checks the course format to see whether it wants the navigation to load
1485      * additional information for the course.
1486      *
1487      * This function utilises a callback that can exist within the course format lib.php file
1488      * The callback should be a function called:
1489      * callback_{formatname}_display_content()
1490      * It doesn't get any arguments and should return true if additional content is
1491      * desired. If the callback doesn't exist we assume additional content is wanted.
1492      *
1493      * @param string $format The course format
1494      * @return bool
1495      */
1496     protected function format_display_course_content($format) {
1497         global $CFG;
1498         $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
1499         if (file_exists($formatlib)) {
1500             require_once($formatlib);
1501             $displayfunc = 'callback_'.$format.'_display_content';
1502             if (function_exists($displayfunc) && !$displayfunc()) {
1503                 return $displayfunc();
1504             }
1505         }
1506         return true;
1507     }
1509     /**
1510      * Loads the courses in Moodle into the navigation.
1511      *
1512      * @global moodle_database $DB
1513      * @param string|array $categoryids An array containing categories to load courses
1514      *                     for, OR null to load courses for all categories.
1515      * @return array An array of navigation_nodes one for each course
1516      */
1517     protected function load_all_courses($categoryids = null) {
1518         global $CFG, $DB, $SITE;
1520         // Work out the limit of courses.
1521         $limit = 20;
1522         if (!empty($CFG->navcourselimit)) {
1523             $limit = $CFG->navcourselimit;
1524         }
1526         $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES;
1528         // If we are going to show all courses AND we are showing categories then
1529         // to save us repeated DB calls load all of the categories now
1530         if ($this->show_categories()) {
1531             $this->load_all_categories($toload);
1532         }
1534         // Will be the return of our efforts
1535         $coursenodes = array();
1537         // Check if we need to show categories.
1538         if ($this->show_categories()) {
1539             // Hmmm we need to show categories... this is going to be painful.
1540             // We now need to fetch up to $limit courses for each category to
1541             // be displayed.
1542             if ($categoryids !== null) {
1543                 if (!is_array($categoryids)) {
1544                     $categoryids = array($categoryids);
1545                 }
1546                 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc');
1547                 $categorywhere = 'WHERE cc.id '.$categorywhere;
1548             } else if ($toload == self::LOAD_ROOT_CATEGORIES) {
1549                 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1550                 $categoryparams = array();
1551             } else {
1552                 $categorywhere = '';
1553                 $categoryparams = array();
1554             }
1556             // First up we are going to get the categories that we are going to
1557             // need so that we can determine how best to load the courses from them.
1558             $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1559                         FROM {course_categories} cc
1560                     LEFT JOIN {course} c ON c.category = cc.id
1561                             {$categorywhere}
1562                     GROUP BY cc.id";
1563             $categories = $DB->get_recordset_sql($sql, $categoryparams);
1564             $fullfetch = array();
1565             $partfetch = array();
1566             foreach ($categories as $category) {
1567                 if (!$this->can_add_more_courses_to_category($category->id)) {
1568                     continue;
1569                 }
1570                 if ($category->coursecount > $limit * 5) {
1571                     $partfetch[] = $category->id;
1572                 } else if ($category->coursecount > 0) {
1573                     $fullfetch[] = $category->id;
1574                 }
1575             }
1576             $categories->close();
1578             if (count($fullfetch)) {
1579                 // First up fetch all of the courses in categories where we know that we are going to
1580                 // need the majority of courses.
1581                 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1582                 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory');
1583                 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1584                             FROM {course} c
1585                                 $ccjoin
1586                             WHERE c.category {$categoryids}
1587                         ORDER BY c.sortorder ASC";
1588                 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1589                 foreach ($coursesrs as $course) {
1590                     if ($course->id == $SITE->id) {
1591                         // This should not be necessary, frontpage is not in any category.
1592                         continue;
1593                     }
1594                     if (array_key_exists($course->id, $this->addedcourses)) {
1595                         // It is probably better to not include the already loaded courses
1596                         // directly in SQL because inequalities may confuse query optimisers
1597                         // and may interfere with query caching.
1598                         continue;
1599                     }
1600                     if (!$this->can_add_more_courses_to_category($course->category)) {
1601                         continue;
1602                     }
1603                     context_instance_preload($course);
1604                     if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1605                         continue;
1606                     }
1607                     $coursenodes[$course->id] = $this->add_course($course);
1608                 }
1609                 $coursesrs->close();
1610             }
1612             if (count($partfetch)) {
1613                 // Next we will work our way through the categories where we will likely only need a small
1614                 // proportion of the courses.
1615                 foreach ($partfetch as $categoryid) {
1616                     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1617                     $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1618                                 FROM {course} c
1619                                     $ccjoin
1620                                 WHERE c.category = :categoryid
1621                             ORDER BY c.sortorder ASC";
1622                     $courseparams = array('categoryid' => $categoryid);
1623                     $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1624                     foreach ($coursesrs as $course) {
1625                         if ($course->id == $SITE->id) {
1626                             // This should not be necessary, frontpage is not in any category.
1627                             continue;
1628                         }
1629                         if (array_key_exists($course->id, $this->addedcourses)) {
1630                             // It is probably better to not include the already loaded courses
1631                             // directly in SQL because inequalities may confuse query optimisers
1632                             // and may interfere with query caching.
1633                             // This also helps to respect expected $limit on repeated executions.
1634                             continue;
1635                         }
1636                         if (!$this->can_add_more_courses_to_category($course->category)) {
1637                             break;
1638                         }
1639                         context_instance_preload($course);
1640                         if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1641                             continue;
1642                         }
1643                         $coursenodes[$course->id] = $this->add_course($course);
1644                     }
1645                     $coursesrs->close();
1646                 }
1647             }
1648         } else {
1649             // Prepare the SQL to load the courses and their contexts
1650             list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1651             list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false);
1652             $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1653                         FROM {course} c
1654                             $ccjoin
1655                         WHERE c.id {$courseids}
1656                     ORDER BY c.sortorder ASC";
1657             $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1658             foreach ($coursesrs as $course) {
1659                 if ($course->id == $SITE->id) {
1660                     // frotpage is not wanted here
1661                     continue;
1662                 }
1663                 context_instance_preload($course);
1664                 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1665                     continue;
1666                 }
1667                 $coursenodes[$course->id] = $this->add_course($course);
1668                 if (count($coursenodes) >= $limit) {
1669                     break;
1670                 }
1671             }
1672             $coursesrs->close();
1673         }
1675         return $coursenodes;
1676     }
1678     /**
1679      * Returns true if more courses can be added to the provided category.
1680      *
1681      * @param int|navigation_node|stdClass $category
1682      * @return bool
1683      */
1684     protected function can_add_more_courses_to_category($category) {
1685         global $CFG;
1686         $limit = 20;
1687         if (!empty($CFG->navcourselimit)) {
1688             $limit = (int)$CFG->navcourselimit;
1689         }
1690         if (is_numeric($category)) {
1691             if (!array_key_exists($category, $this->addedcategories)) {
1692                 return true;
1693             }
1694             $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE));
1695         } else if ($category instanceof navigation_node) {
1696             if ($category->type != self::TYPE_CATEGORY) {
1697                 return false;
1698             }
1699             $coursecount = count($category->children->type(self::TYPE_COURSE));
1700         } else if (is_object($category) && property_exists($category,'id')) {
1701             $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE));
1702         }
1703         return ($coursecount <= $limit);
1704     }
1706     /**
1707      * Loads all categories (top level or if an id is specified for that category)
1708      *
1709      * @param int $categoryid The category id to load or null/0 to load all base level categories
1710      * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1711      *        as the requested category and any parent categories.
1712      * @return navigation_node|void returns a navigation node if a category has been loaded.
1713      */
1714     protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) {
1715         global $DB;
1717         // Check if this category has already been loaded
1718         if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1719             return true;
1720         }
1722         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
1723         $sqlselect = "SELECT cc.*, $catcontextsql
1724                       FROM {course_categories} cc
1725                       JOIN {context} ctx ON cc.id = ctx.instanceid";
1726         $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT;
1727         $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1728         $params = array();
1730         $categoriestoload = array();
1731         if ($categoryid == self::LOAD_ALL_CATEGORIES) {
1732             // We are going to load all categories regardless... prepare to fire
1733             // on the database server!
1734         } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0
1735             // We are going to load all of the first level categories (categories without parents)
1736             $sqlwhere .= " AND cc.parent = 0";
1737         } else if (array_key_exists($categoryid, $this->addedcategories)) {
1738             // The category itself has been loaded already so we just need to ensure its subcategories
1739             // have been loaded
1740             list($sql, $params) = $DB->get_in_or_equal(array_keys($this->addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1741             if ($showbasecategories) {
1742                 // We need to include categories with parent = 0 as well
1743                 $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1744             } else {
1745                 // All we need is categories that match the parent
1746                 $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1747             }
1748             $params['categoryid'] = $categoryid;
1749         } else {
1750             // This category hasn't been loaded yet so we need to fetch it, work out its category path
1751             // and load this category plus all its parents and subcategories
1752             $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
1753             $categoriestoload = explode('/', trim($category->path, '/'));
1754             list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1755             // We are going to use select twice so double the params
1756             $params = array_merge($params, $params);
1757             $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':'';
1758             $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1759         }
1761         $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1762         $categories = array();
1763         foreach ($categoriesrs as $category) {
1764             // Preload the context.. we'll need it when adding the category in order
1765             // to format the category name.
1766             context_helper::preload_from_record($category);
1767             if (array_key_exists($category->id, $this->addedcategories)) {
1768                 // Do nothing, its already been added.
1769             } else if ($category->parent == '0') {
1770                 // This is a root category lets add it immediately
1771                 $this->add_category($category, $this->rootnodes['courses']);
1772             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1773                 // This categories parent has already been added we can add this immediately
1774                 $this->add_category($category, $this->addedcategories[$category->parent]);
1775             } else {
1776                 $categories[] = $category;
1777             }
1778         }
1779         $categoriesrs->close();
1781         // Now we have an array of categories we need to add them to the navigation.
1782         while (!empty($categories)) {
1783             $category = reset($categories);
1784             if (array_key_exists($category->id, $this->addedcategories)) {
1785                 // Do nothing
1786             } else if ($category->parent == '0') {
1787                 $this->add_category($category, $this->rootnodes['courses']);
1788             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1789                 $this->add_category($category, $this->addedcategories[$category->parent]);
1790             } else {
1791                 // This category isn't in the navigation and niether is it's parent (yet).
1792                 // We need to go through the category path and add all of its components in order.
1793                 $path = explode('/', trim($category->path, '/'));
1794                 foreach ($path as $catid) {
1795                     if (!array_key_exists($catid, $this->addedcategories)) {
1796                         // This category isn't in the navigation yet so add it.
1797                         $subcategory = $categories[$catid];
1798                         if ($subcategory->parent == '0') {
1799                             // Yay we have a root category - this likely means we will now be able
1800                             // to add categories without problems.
1801                             $this->add_category($subcategory, $this->rootnodes['courses']);
1802                         } else if (array_key_exists($subcategory->parent, $this->addedcategories)) {
1803                             // The parent is in the category (as we'd expect) so add it now.
1804                             $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1805                             // Remove the category from the categories array.
1806                             unset($categories[$catid]);
1807                         } else {
1808                             // We should never ever arrive here - if we have then there is a bigger
1809                             // problem at hand.
1810                             throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1811                         }
1812                     }
1813                 }
1814             }
1815             // Remove the category from the categories array now that we know it has been added.
1816             unset($categories[$category->id]);
1817         }
1818         if ($categoryid === self::LOAD_ALL_CATEGORIES) {
1819             $this->allcategoriesloaded = true;
1820         }
1821         // Check if there are any categories to load.
1822         if (count($categoriestoload) > 0) {
1823             $readytoloadcourses = array();
1824             foreach ($categoriestoload as $category) {
1825                 if ($this->can_add_more_courses_to_category($category)) {
1826                     $readytoloadcourses[] = $category;
1827                 }
1828             }
1829             if (count($readytoloadcourses)) {
1830                 $this->load_all_courses($readytoloadcourses);
1831             }
1832         }
1833     }
1835     /**
1836      * Adds a structured category to the navigation in the correct order/place
1837      *
1838      * @param stdClass $category
1839      * @param navigation_node $parent
1840      */
1841     protected function add_category(stdClass $category, navigation_node $parent) {
1842         if (array_key_exists($category->id, $this->addedcategories)) {
1843             return;
1844         }
1845         $url = new moodle_url('/course/category.php', array('id' => $category->id));
1846         $context = context_coursecat::instance($category->id);
1847         $categoryname = format_string($category->name, true, array('context' => $context));
1848         $categorynode = $parent->add($categoryname, $url, self::TYPE_CATEGORY, $categoryname, $category->id);
1849         if (empty($category->visible)) {
1850             if (has_capability('moodle/category:viewhiddencategories', get_system_context())) {
1851                 $categorynode->hidden = true;
1852             } else {
1853                 $categorynode->display = false;
1854             }
1855         }
1856         $this->addedcategories[$category->id] = $categorynode;
1857     }
1859     /**
1860      * Loads the given course into the navigation
1861      *
1862      * @param stdClass $course
1863      * @return navigation_node
1864      */
1865     protected function load_course(stdClass $course) {
1866         global $SITE;
1867         if ($course->id == $SITE->id) {
1868             // This is always loaded during initialisation
1869             return $this->rootnodes['site'];
1870         } else if (array_key_exists($course->id, $this->addedcourses)) {
1871             // The course has already been loaded so return a reference
1872             return $this->addedcourses[$course->id];
1873         } else {
1874             // Add the course
1875             return $this->add_course($course);
1876         }
1877     }
1879     /**
1880      * Loads all of the courses section into the navigation.
1881      *
1882      * This function utilisies a callback that can be implemented within the course
1883      * formats lib.php file to customise the navigation that is generated at this
1884      * point for the course.
1885      *
1886      * By default (if not defined) the method {@link global_navigation::load_generic_course_sections()} is
1887      * called instead.
1888      *
1889      * @param stdClass $course Database record for the course
1890      * @param navigation_node $coursenode The course node within the navigation
1891      * @return array Array of navigation nodes for the section with key = section id
1892      */
1893     protected function load_course_sections(stdClass $course, navigation_node $coursenode) {
1894         global $CFG;
1895         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
1896         $structurefunc = 'callback_'.$course->format.'_load_content';
1897         if (function_exists($structurefunc)) {
1898             return $structurefunc($this, $course, $coursenode);
1899         } else if (file_exists($structurefile)) {
1900             require_once $structurefile;
1901             if (function_exists($structurefunc)) {
1902                 return $structurefunc($this, $course, $coursenode);
1903             } else {
1904                 return $this->load_generic_course_sections($course, $coursenode);
1905             }
1906         } else {
1907             return $this->load_generic_course_sections($course, $coursenode);
1908         }
1909     }
1911     /**
1912      * Generates an array of sections and an array of activities for the given course.
1913      *
1914      * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1915      *
1916      * @param stdClass $course
1917      * @return array Array($sections, $activities)
1918      */
1919     protected function generate_sections_and_activities(stdClass $course) {
1920         global $CFG;
1921         require_once($CFG->dirroot.'/course/lib.php');
1923         $modinfo = get_fast_modinfo($course);
1924         $sections = array_slice($modinfo->get_section_info_all(), 0, $course->numsections+1, true);
1925         $activities = array();
1927         foreach ($sections as $key => $section) {
1928             // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1929             $sections[$key] = clone($section);
1930             unset($sections[$key]->summary);
1931             $sections[$key]->hasactivites = false;
1932             if (!array_key_exists($section->section, $modinfo->sections)) {
1933                 continue;
1934             }
1935             foreach ($modinfo->sections[$section->section] as $cmid) {
1936                 $cm = $modinfo->cms[$cmid];
1937                 if (!$cm->uservisible) {
1938                     continue;
1939                 }
1940                 $activity = new stdClass;
1941                 $activity->id = $cm->id;
1942                 $activity->course = $course->id;
1943                 $activity->section = $section->section;
1944                 $activity->name = $cm->name;
1945                 $activity->icon = $cm->icon;
1946                 $activity->iconcomponent = $cm->iconcomponent;
1947                 $activity->hidden = (!$cm->visible);
1948                 $activity->modname = $cm->modname;
1949                 $activity->nodetype = navigation_node::NODETYPE_LEAF;
1950                 $activity->onclick = $cm->get_on_click();
1951                 $url = $cm->get_url();
1952                 if (!$url) {
1953                     $activity->url = null;
1954                     $activity->display = false;
1955                 } else {
1956                     $activity->url = $cm->get_url()->out();
1957                     $activity->display = true;
1958                     if (self::module_extends_navigation($cm->modname)) {
1959                         $activity->nodetype = navigation_node::NODETYPE_BRANCH;
1960                     }
1961                 }
1962                 $activities[$cmid] = $activity;
1963                 if ($activity->display) {
1964                     $sections[$key]->hasactivites = true;
1965                 }
1966             }
1967         }
1969         return array($sections, $activities);
1970     }
1972     /**
1973      * Generically loads the course sections into the course's navigation.
1974      *
1975      * @param stdClass $course
1976      * @param navigation_node $coursenode
1977      * @param string $courseformat The course format
1978      * @return array An array of course section nodes
1979      */
1980     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $courseformat='unknown') {
1981         global $CFG, $DB, $USER, $SITE;
1982         require_once($CFG->dirroot.'/course/lib.php');
1984         list($sections, $activities) = $this->generate_sections_and_activities($course);
1986         $namingfunction = 'callback_'.$courseformat.'_get_section_name';
1987         $namingfunctionexists = (function_exists($namingfunction));
1989         $urlfunction = 'callback_'.$courseformat.'_get_section_url';
1990         if (function_exists($urlfunction)) {
1991             // This code path is deprecated but we decided not to warn developers as
1992             // major changes are likely to follow in 2.4. See MDL-32504.
1993         } else {
1994             $urlfunction = null;
1995         }
1997         $key = 0;
1998         if (defined('AJAX_SCRIPT') && AJAX_SCRIPT == '0' && $this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
1999             $key = optional_param('section', $key, PARAM_INT);
2000         }
2002         $navigationsections = array();
2003         foreach ($sections as $sectionid => $section) {
2004             $section = clone($section);
2005             if ($course->id == $SITE->id) {
2006                 $this->load_section_activities($coursenode, $section->section, $activities);
2007             } else {
2008                 if (!$section->uservisible || (!$this->showemptysections &&
2009                         !$section->hasactivites && $this->includesectionnum !== $section->section)) {
2010                     continue;
2011                 }
2013                 if ($namingfunctionexists) {
2014                     $sectionname = $namingfunction($course, $section, $sections);
2015                 } else {
2016                     $sectionname = get_string('section').' '.$section->section;
2017                 }
2019                 $url = null;
2020                 if ($urlfunction) {
2021                     // pre 2.3 style format url
2022                     $url = $urlfunction($course->id, $section->section);
2023                 }else{
2024                     if ($course->coursedisplay == COURSE_DISPLAY_MULTIPAGE) {
2025                         $url = course_get_url($course, $section->section);
2026                     }
2027                 }
2028                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
2029                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
2030                 $sectionnode->hidden = (!$section->visible || !$section->available);
2031                 if ($key != '0' && $section->section != '0' && $section->section == $key && $this->page->context->contextlevel != CONTEXT_MODULE && $section->hasactivites) {
2032                     $sectionnode->make_active();
2033                     $this->load_section_activities($sectionnode, $section->section, $activities);
2034                 }
2035                 $section->sectionnode = $sectionnode;
2036                 $navigationsections[$sectionid] = $section;
2037             }
2038         }
2039         return $navigationsections;
2040     }
2041     /**
2042      * Loads all of the activities for a section into the navigation structure.
2043      *
2044      * @param navigation_node $sectionnode
2045      * @param int $sectionnumber
2046      * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
2047      * @param stdClass $course The course object the section and activities relate to.
2048      * @return array Array of activity nodes
2049      */
2050     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) {
2051         global $CFG, $SITE;
2052         // A static counter for JS function naming
2053         static $legacyonclickcounter = 0;
2055         $activitynodes = array();
2056         if (empty($activities)) {
2057             return $activitynodes;
2058         }
2060         if (!is_object($course)) {
2061             $activity = reset($activities);
2062             $courseid = $activity->course;
2063         } else {
2064             $courseid = $course->id;
2065         }
2066         $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods));
2068         foreach ($activities as $activity) {
2069             if ($activity->section != $sectionnumber) {
2070                 continue;
2071             }
2072             if ($activity->icon) {
2073                 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
2074             } else {
2075                 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
2076             }
2078             // Prepare the default name and url for the node
2079             $activityname = format_string($activity->name, true, array('context' => context_module::instance($activity->id)));
2080             $action = new moodle_url($activity->url);
2082             // Check if the onclick property is set (puke!)
2083             if (!empty($activity->onclick)) {
2084                 // Increment the counter so that we have a unique number.
2085                 $legacyonclickcounter++;
2086                 // Generate the function name we will use
2087                 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
2088                 $propogrationhandler = '';
2089                 // Check if we need to cancel propogation. Remember inline onclick
2090                 // events would return false if they wanted to prevent propogation and the
2091                 // default action.
2092                 if (strpos($activity->onclick, 'return false')) {
2093                     $propogrationhandler = 'e.halt();';
2094                 }
2095                 // Decode the onclick - it has already been encoded for display (puke)
2096                 $onclick = htmlspecialchars_decode($activity->onclick);
2097                 // Build the JS function the click event will call
2098                 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2099                 $this->page->requires->js_init_code($jscode);
2100                 // Override the default url with the new action link
2101                 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2102             }
2104             $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
2105             $activitynode->title(get_string('modulename', $activity->modname));
2106             $activitynode->hidden = $activity->hidden;
2107             $activitynode->display = $showactivities && $activity->display;
2108             $activitynode->nodetype = $activity->nodetype;
2109             $activitynodes[$activity->id] = $activitynode;
2110         }
2112         return $activitynodes;
2113     }
2114     /**
2115      * Loads a stealth module from unavailable section
2116      * @param navigation_node $coursenode
2117      * @param stdClass $modinfo
2118      * @return navigation_node or null if not accessible
2119      */
2120     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
2121         if (empty($modinfo->cms[$this->page->cm->id])) {
2122             return null;
2123         }
2124         $cm = $modinfo->cms[$this->page->cm->id];
2125         if (!$cm->uservisible) {
2126             return null;
2127         }
2128         if ($cm->icon) {
2129             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
2130         } else {
2131             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
2132         }
2133         $url = $cm->get_url();
2134         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
2135         $activitynode->title(get_string('modulename', $cm->modname));
2136         $activitynode->hidden = (!$cm->visible);
2137         if (!$url) {
2138             // Don't show activities that don't have links!
2139             $activitynode->display = false;
2140         } else if (self::module_extends_navigation($cm->modname)) {
2141             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
2142         }
2143         return $activitynode;
2144     }
2145     /**
2146      * Loads the navigation structure for the given activity into the activities node.
2147      *
2148      * This method utilises a callback within the modules lib.php file to load the
2149      * content specific to activity given.
2150      *
2151      * The callback is a method: {modulename}_extend_navigation()
2152      * Examples:
2153      *  * {@link forum_extend_navigation()}
2154      *  * {@link workshop_extend_navigation()}
2155      *
2156      * @param cm_info|stdClass $cm
2157      * @param stdClass $course
2158      * @param navigation_node $activity
2159      * @return bool
2160      */
2161     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
2162         global $CFG, $DB;
2164         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2165         if (!($cm instanceof cm_info)) {
2166             $modinfo = get_fast_modinfo($course);
2167             $cm = $modinfo->get_cm($cm->id);
2168         }
2170         $activity->nodetype = navigation_node::NODETYPE_LEAF;
2171         $activity->make_active();
2172         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
2173         $function = $cm->modname.'_extend_navigation';
2175         if (file_exists($file)) {
2176             require_once($file);
2177             if (function_exists($function)) {
2178                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
2179                 $function($activity, $course, $activtyrecord, $cm);
2180             }
2181         }
2183         // Allow the active advanced grading method plugin to append module navigation
2184         $featuresfunc = $cm->modname.'_supports';
2185         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) {
2186             require_once($CFG->dirroot.'/grade/grading/lib.php');
2187             $gradingman = get_grading_manager($cm->context, $cm->modname);
2188             $gradingman->extend_navigation($this, $activity);
2189         }
2191         return $activity->has_children();
2192     }
2193     /**
2194      * Loads user specific information into the navigation in the appropriate place.
2195      *
2196      * If no user is provided the current user is assumed.
2197      *
2198      * @param stdClass $user
2199      * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2200      * @return bool
2201      */
2202     protected function load_for_user($user=null, $forceforcontext=false) {
2203         global $DB, $CFG, $USER, $SITE;
2205         if ($user === null) {
2206             // We can't require login here but if the user isn't logged in we don't
2207             // want to show anything
2208             if (!isloggedin() || isguestuser()) {
2209                 return false;
2210             }
2211             $user = $USER;
2212         } else if (!is_object($user)) {
2213             // If the user is not an object then get them from the database
2214             $select = context_helper::get_preload_record_columns_sql('ctx');
2215             $sql = "SELECT u.*, $select
2216                       FROM {user} u
2217                       JOIN {context} ctx ON u.id = ctx.instanceid
2218                      WHERE u.id = :userid AND
2219                            ctx.contextlevel = :contextlevel";
2220             $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST);
2221             context_helper::preload_from_record($user);
2222         }
2224         $iscurrentuser = ($user->id == $USER->id);
2226         $usercontext = context_user::instance($user->id);
2228         // Get the course set against the page, by default this will be the site
2229         $course = $this->page->course;
2230         $baseargs = array('id'=>$user->id);
2231         if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) {
2232             $coursenode = $this->load_course($course);
2233             $baseargs['course'] = $course->id;
2234             $coursecontext = context_course::instance($course->id);
2235             $issitecourse = false;
2236         } else {
2237             // Load all categories and get the context for the system
2238             $coursecontext = context_system::instance();
2239             $issitecourse = true;
2240         }
2242         // Create a node to add user information under.
2243         if ($iscurrentuser && !$forceforcontext) {
2244             // If it's the current user the information will go under the profile root node
2245             $usernode = $this->rootnodes['myprofile'];
2246             $course = get_site();
2247             $coursecontext = context_course::instance($course->id);
2248             $issitecourse = true;
2249         } else {
2250             if (!$issitecourse) {
2251                 // Not the current user so add it to the participants node for the current course
2252                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
2253                 $userviewurl = new moodle_url('/user/view.php', $baseargs);
2254             } else {
2255                 // This is the site so add a users node to the root branch
2256                 $usersnode = $this->rootnodes['users'];
2257                 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2258                     $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
2259                 }
2260                 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2261             }
2262             if (!$usersnode) {
2263                 // We should NEVER get here, if the course hasn't been populated
2264                 // with a participants node then the navigaiton either wasn't generated
2265                 // for it (you are missing a require_login or set_context call) or
2266                 // you don't have access.... in the interests of no leaking informatin
2267                 // we simply quit...
2268                 return false;
2269             }
2270             // Add a branch for the current user
2271             $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2272             $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, $user->id);
2274             if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
2275                 $usernode->make_active();
2276             }
2277         }
2279         // If the user is the current user or has permission to view the details of the requested
2280         // user than add a view profile link.
2281         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
2282             if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
2283                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
2284             } else {
2285                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
2286             }
2287         }
2289         if (!empty($CFG->navadduserpostslinks)) {
2290             // Add nodes for forum posts and discussions if the user can view either or both
2291             // There are no capability checks here as the content of the page is based
2292             // purely on the forums the current user has access too.
2293             $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2294             $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2295             $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
2296         }
2298         // Add blog nodes
2299         if (!empty($CFG->enableblogs)) {
2300             if (!$this->cache->cached('userblogoptions'.$user->id)) {
2301                 require_once($CFG->dirroot.'/blog/lib.php');
2302                 // Get all options for the user
2303                 $options = blog_get_options_for_user($user);
2304                 $this->cache->set('userblogoptions'.$user->id, $options);
2305             } else {
2306                 $options = $this->cache->{'userblogoptions'.$user->id};
2307             }
2309             if (count($options) > 0) {
2310                 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
2311                 foreach ($options as $type => $option) {
2312                     if ($type == "rss") {
2313                         $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2314                     } else {
2315                         $blogs->add($option['string'], $option['link']);
2316                     }
2317                 }
2318             }
2319         }
2321         if (!empty($CFG->messaging)) {
2322             $messageargs = null;
2323             if ($USER->id!=$user->id) {
2324                 $messageargs = array('id'=>$user->id);
2325             }
2326             $url = new moodle_url('/message/index.php',$messageargs);
2327             $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
2328         }
2330         $context = context_user::instance($USER->id);
2331         if ($iscurrentuser && has_capability('moodle/user:manageownfiles', $context)) {
2332             $url = new moodle_url('/user/files.php');
2333             $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
2334         }
2336         // Add a node to view the users notes if permitted
2337         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2338             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
2339             if ($coursecontext->instanceid) {
2340                 $url->param('course', $coursecontext->instanceid);
2341             }
2342             $usernode->add(get_string('notes', 'notes'), $url);
2343         }
2345         // Add reports node
2346         $reporttab = $usernode->add(get_string('activityreports'));
2347         $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2348         foreach ($reports as $reportfunction) {
2349             $reportfunction($reporttab, $user, $course);
2350         }
2351         $anyreport = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
2352         if ($anyreport || ($course->showreports && $iscurrentuser && $forceforcontext)) {
2353             // Add grade hardcoded grade report if necessary
2354             $gradeaccess = false;
2355             if (has_capability('moodle/grade:viewall', $coursecontext)) {
2356                 //ok - can view all course grades
2357                 $gradeaccess = true;
2358             } else if ($course->showgrades) {
2359                 if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) {
2360                     //ok - can view own grades
2361                     $gradeaccess = true;
2362                 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
2363                     // ok - can view grades of this user - parent most probably
2364                     $gradeaccess = true;
2365                 } else if ($anyreport) {
2366                     // ok - can view grades of this user - parent most probably
2367                     $gradeaccess = true;
2368                 }
2369             }
2370             if ($gradeaccess) {
2371                 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array('mode'=>'grade', 'id'=>$course->id, 'user'=>$usercontext->instanceid)));
2372             }
2373         }
2374         // Check the number of nodes in the report node... if there are none remove the node
2375         $reporttab->trim_if_empty();
2377         // If the user is the current user add the repositories for the current user
2378         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
2379         if ($iscurrentuser) {
2380             if (!$this->cache->cached('contexthasrepos'.$usercontext->id)) {
2381                 require_once($CFG->dirroot . '/repository/lib.php');
2382                 $editabletypes = repository::get_editable_types($usercontext);
2383                 $haseditabletypes = !empty($editabletypes);
2384                 unset($editabletypes);
2385                 $this->cache->set('contexthasrepos'.$usercontext->id, $haseditabletypes);
2386             } else {
2387                 $haseditabletypes = $this->cache->{'contexthasrepos'.$usercontext->id};
2388             }
2389             if ($haseditabletypes) {
2390                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
2391             }
2392         } else if ($course->id == $SITE->id && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2394             // Add view grade report is permitted
2395             $reports = get_plugin_list('gradereport');
2396             arsort($reports); // user is last, we want to test it first
2398             $userscourses = enrol_get_users_courses($user->id);
2399             $userscoursesnode = $usernode->add(get_string('courses'));
2401             foreach ($userscourses as $usercourse) {
2402                 $usercoursecontext = context_course::instance($usercourse->id);
2403                 $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext));
2404                 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
2406                 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2407                 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
2408                     foreach ($reports as $plugin => $plugindir) {
2409                         if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2410                             //stop when the first visible plugin is found
2411                             $gradeavailable = true;
2412                             break;
2413                         }
2414                     }
2415                 }
2417                 if ($gradeavailable) {
2418                     $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
2419                     $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
2420                 }
2422                 // Add a node to view the users notes if permitted
2423                 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2424                     $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
2425                     $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2426                 }
2428                 if (can_access_course($usercourse, $user->id)) {
2429                     $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', ''));
2430                 }
2432                 $reporttab = $usercoursenode->add(get_string('activityreports'));
2434                 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2435                 foreach ($reports as $reportfunction) {
2436                     $reportfunction($reporttab, $user, $usercourse);
2437                 }
2439                 $reporttab->trim_if_empty();
2440             }
2441         }
2442         return true;
2443     }
2445     /**
2446      * This method simply checks to see if a given module can extend the navigation.
2447      *
2448      * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2449      *
2450      * @param string $modname
2451      * @return bool
2452      */
2453     protected static function module_extends_navigation($modname) {
2454         global $CFG;
2455         static $extendingmodules = array();
2456         if (!array_key_exists($modname, $extendingmodules)) {
2457             $extendingmodules[$modname] = false;
2458             $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2459             if (file_exists($file)) {
2460                 $function = $modname.'_extend_navigation';
2461                 require_once($file);
2462                 $extendingmodules[$modname] = (function_exists($function));
2463             }
2464         }
2465         return $extendingmodules[$modname];
2466     }
2467     /**
2468      * Extends the navigation for the given user.
2469      *
2470      * @param stdClass $user A user from the database
2471      */
2472     public function extend_for_user($user) {
2473         $this->extendforuser[] = $user;
2474     }
2476     /**
2477      * Returns all of the users the navigation is being extended for
2478      *
2479      * @return array An array of extending users.
2480      */
2481     public function get_extending_users() {
2482         return $this->extendforuser;
2483     }
2484     /**
2485      * Adds the given course to the navigation structure.
2486      *
2487      * @param stdClass $course
2488      * @param bool $forcegeneric
2489      * @param bool $ismycourse
2490      * @return navigation_node
2491      */
2492     public function add_course(stdClass $course, $forcegeneric = false, $ismycourse = false) {
2493         global $CFG, $SITE;
2495         // We found the course... we can return it now :)
2496         if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2497             return $this->addedcourses[$course->id];
2498         }
2500         $coursecontext = context_course::instance($course->id);
2502         if ($course->id != $SITE->id && !$course->visible) {
2503             if (is_role_switched($course->id)) {
2504                 // user has to be able to access course in order to switch, let's skip the visibility test here
2505             } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2506                 return false;
2507             }
2508         }
2510         $issite = ($course->id == $SITE->id);
2511         $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
2513         if ($issite) {
2514             $parent = $this;
2515             $url = null;
2516             if (empty($CFG->usesitenameforsitepages)) {
2517                 $shortname = get_string('sitepages');
2518             }
2519         } else if ($ismycourse && !$forcegeneric) {
2520             if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_CATEGORY))) {
2521                 // Nothing to do here the above statement set $parent to the category within mycourses.
2522             } else {
2523                 $parent = $this->rootnodes['mycourses'];
2524             }
2525             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2526         } else {
2527             $parent = $this->rootnodes['courses'];
2528             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2529             if (!empty($course->category) && $this->show_categories()) {
2530                 if ($this->show_categories() && !$this->is_category_fully_loaded($course->category)) {
2531                     // We need to load the category structure for this course
2532                     $this->load_all_categories($course->category, false);
2533                 }
2534                 if (array_key_exists($course->category, $this->addedcategories)) {
2535                     $parent = $this->addedcategories[$course->category];
2536                     // This could lead to the course being created so we should check whether it is the case again
2537                     if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2538                         return $this->addedcourses[$course->id];
2539                     }
2540                 }
2541             }
2542         }
2544         $coursenode = $parent->add($shortname, $url, self::TYPE_COURSE, $shortname, $course->id);
2545         $coursenode->nodetype = self::NODETYPE_BRANCH;
2546         $coursenode->hidden = (!$course->visible);
2547         $coursenode->title(format_string($course->fullname, true, array('context' => context_course::instance($course->id))));
2548         if (!$forcegeneric) {
2549             $this->addedcourses[$course->id] = $coursenode;
2550         }
2552         return $coursenode;
2553     }
2555     /**
2556      * Returns true if the category has already been loaded as have any child categories
2557      *
2558      * @param int $categoryid
2559      * @return bool
2560      */
2561     protected function is_category_fully_loaded($categoryid) {
2562         return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0));
2563     }
2565     /**
2566      * Adds essential course nodes to the navigation for the given course.
2567      *
2568      * This method adds nodes such as reports, blogs and participants
2569      *
2570      * @param navigation_node $coursenode
2571      * @param stdClass $course
2572      * @return bool returns true on successful addition of a node.
2573      */
2574     public function add_course_essentials($coursenode, stdClass $course) {
2575         global $CFG, $SITE;
2577         if ($course->id == $SITE->id) {
2578             return $this->add_front_page_course_essentials($coursenode, $course);
2579         }
2581         if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2582             return true;
2583         }
2585         //Participants
2586         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
2587             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
2588             $currentgroup = groups_get_course_group($course, true);
2589             if ($course->id == $SITE->id) {
2590                 $filterselect = '';
2591             } else if ($course->id && !$currentgroup) {
2592                 $filterselect = $course->id;
2593             } else {
2594                 $filterselect = $currentgroup;
2595             }
2596             $filterselect = clean_param($filterselect, PARAM_INT);
2597             if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2598                and has_capability('moodle/blog:view', context_system::instance())) {
2599                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2600                 $participants->add(get_string('blogscourse','blog'), $blogsurls->out());
2601             }
2602             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2603                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id)));
2604             }
2605         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2606             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2607         }
2609         // View course reports
2610         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
2611             $reportnav = $coursenode->add(get_string('reports'), null, self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2612             $coursereports = get_plugin_list('coursereport'); // deprecated
2613             foreach ($coursereports as $report=>$dir) {
2614                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2615                 if (file_exists($libfile)) {
2616                     require_once($libfile);
2617                     $reportfunction = $report.'_report_extend_navigation';
2618                     if (function_exists($report.'_report_extend_navigation')) {
2619                         $reportfunction($reportnav, $course, $this->page->context);
2620                     }
2621                 }
2622             }
2624             $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
2625             foreach ($reports as $reportfunction) {
2626                 $reportfunction($reportnav, $course, $this->page->context);
2627             }
2628         }
2629         return true;
2630     }
2631     /**
2632      * This generates the structure of the course that won't be generated when
2633      * the modules and sections are added.
2634      *
2635      * Things such as the reports branch, the participants branch, blogs... get
2636      * added to the course node by this method.
2637      *
2638      * @param navigation_node $coursenode
2639      * @param stdClass $course
2640      * @return bool True for successfull generation
2641      */
2642     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2643         global $CFG;
2645         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2646             return true;
2647         }
2649         // Hidden node that we use to determine if the front page navigation is loaded.
2650         // This required as there are not other guaranteed nodes that may be loaded.
2651         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2653         //Participants
2654         if (has_capability('moodle/course:viewparticipants',  get_system_context())) {
2655             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2656         }
2658         $filterselect = 0;
2660         // Blogs
2661         if (!empty($CFG->enableblogs)
2662           and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2663           and has_capability('moodle/blog:view', context_system::instance())) {
2664             $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2665             $coursenode->add(get_string('blogssite','blog'), $blogsurls->out());
2666         }
2668         // Notes
2669         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2670             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2671         }
2673         // Tags
2674         if (!empty($CFG->usetags) && isloggedin()) {
2675             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2676         }
2678         if (isloggedin()) {
2679             // Calendar
2680             $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2681             $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self::TYPE_CUSTOM, null, 'calendar');
2682         }
2684         // View course reports
2685         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
2686             $reportnav = $coursenode->add(get_string('reports'), null, self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2687             $coursereports = get_plugin_list('coursereport'); // deprecated
2688             foreach ($coursereports as $report=>$dir) {
2689                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2690                 if (file_exists($libfile)) {
2691                     require_once($libfile);
2692                     $reportfunction = $report.'_report_extend_navigation';
2693                     if (function_exists($report.'_report_extend_navigation')) {
2694                         $reportfunction($reportnav, $course, $this->page->context);
2695                     }
2696                 }
2697             }
2699             $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
2700             foreach ($reports as $reportfunction) {
2701                 $reportfunction($reportnav, $course, $this->page->context);
2702             }
2703         }
2704         return true;
2705     }
2707     /**
2708      * Clears the navigation cache
2709      */
2710     public function clear_cache() {
2711         $this->cache->clear();
2712     }
2714     /**
2715      * Sets an expansion limit for the navigation
2716      *
2717      * The expansion limit is used to prevent the display of content that has a type
2718      * greater than the provided $type.
2719      *
2720      * Can be used to ensure things such as activities or activity content don't get
2721      * shown on the navigation.
2722      * They are still generated in order to ensure the navbar still makes sense.
2723      *
2724      * @param int $type One of navigation_node::TYPE_*
2725      * @return bool true when complete.
2726      */
2727     public function set_expansion_limit($type) {
2728         global $SITE;
2729         $nodes = $this->find_all_of_type($type);
2730         foreach ($nodes as &$node) {
2731             // We need to generate the full site node
2732             if ($type == self::TYPE_COURSE && $node->key == $SITE->id) {
2733                 continue;
2734             }
2735             foreach ($node->children as &$child) {
2736                 // We still want to show course reports and participants containers
2737                 // or there will be navigation missing.
2738                 if ($type == self::TYPE_COURSE && $child->type === self::TYPE_CONTAINER) {
2739                     continue;
2740                 }
2741                 $child->display = false;
2742             }
2743         }
2744         return true;
2745     }
2746     /**
2747      * Attempts to get the navigation with the given key from this nodes children.
2748      *
2749      * This function only looks at this nodes children, it does NOT look recursivily.
2750      * If the node can't be found then false is returned.
2751      *
2752      * If you need to search recursivily then use the {@link global_navigation::find()} method.
2753      *
2754      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2755      * may be of more use to you.
2756      *
2757      * @param string|int $key The key of the node you wish to receive.
2758      * @param int $type One of navigation_node::TYPE_*
2759      * @return navigation_node|false
2760      */
2761     public function get($key, $type = null) {
2762         if (!$this->initialised) {
2763             $this->initialise();
2764         }
2765         return parent::get($key, $type);
2766     }
2768     /**
2769      * Searches this nodes children and their children to find a navigation node
2770      * with the matching key and type.
2771      *
2772      * This method is recursive and searches children so until either a node is
2773      * found or there are no more nodes to search.
2774      *
2775      * If you know that the node being searched for is a child of this node
2776      * then use the {@link global_navigation::get()} method instead.
2777      *
2778      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2779      * may be of more use to you.
2780      *
2781      * @param string|int $key The key of the node you wish to receive.
2782      * @param int $type One of navigation_node::TYPE_*
2783      * @return navigation_node|false
2784      */
2785     public function find($key, $type) {
2786         if (!$this->initialised) {
2787             $this->initialise();
2788         }
2789         return parent::find($key, $type);
2790     }
2793 /**
2794  * The global navigation class used especially for AJAX requests.
2795  *
2796  * The primary methods that are used in the global navigation class have been overriden
2797  * to ensure that only the relevant branch is generated at the root of the tree.
2798  * This can be done because AJAX is only used when the backwards structure for the
2799  * requested branch exists.
2800  * This has been done only because it shortens the amounts of information that is generated
2801  * which of course will speed up the response time.. because no one likes laggy AJAX.
2802  *
2803  * @package   core
2804  * @category  navigation
2805  * @copyright 2009 Sam Hemelryk
2806  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2807  */
2808 class global_navigation_for_ajax extends global_navigation {
2810     /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2811     protected $branchtype;
2813     /** @var int the instance id */
2814     protected $instanceid;
2816     /** @var array Holds an array of expandable nodes */
2817     protected $expandable = array();
2819     /**
2820      * Constructs the navigation for use in an AJAX request
2821      *
2822      * @param moodle_page $page moodle_page object
2823      * @param int $branchtype
2824      * @param int $id
2825      */
2826     public function __construct($page, $branchtype, $id) {
2827         $this->page = $page;
2828         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2829         $this->children = new navigation_node_collection();
2830         $this->branchtype = $branchtype;
2831         $this->instanceid = $id;
2832         $this->initialise();
2833     }
2834     /**
2835      * Initialise the navigation given the type and id for the branch to expand.
2836      *
2837      * @return array An array of the expandable nodes
2838      */
2839     public function initialise() {
2840         global $CFG, $DB, $SITE;
2842         if ($this->initialised || during_initial_install()) {
2843             return $this->expandable;
2844         }
2845         $this->initialised = true;
2847         $this->rootnodes = array();
2848         $this->rootnodes['site']    = $this->add_course($SITE);
2849         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2851         // Branchtype will be one of navigation_node::TYPE_*
2852         switch ($this->branchtype) {
2853             case self::TYPE_CATEGORY :
2854                 $this->load_category($this->instanceid);
2855                 break;
2856             case self::TYPE_COURSE :
2857                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
2858                 require_course_login($course, true, null, false, true);
2859                 $this->page->set_context(context_course::instance($course->id));
2860                 $coursenode = $this->add_course($course);
2861                 $this->add_course_essentials($coursenode, $course);
2862                 if ($this->format_display_course_content($course->format)) {
2863                     $this->load_course_sections($course, $coursenode);
2864                 }
2865                 break;
2866             case self::TYPE_SECTION :
2867                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2868                         FROM {course} c
2869                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2870                         WHERE cs.id = ?';
2871                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
2872                 require_course_login($course, true, null, false, true);
2873                 $this->page->set_context(context_course::instance($course->id));
2874                 $coursenode = $this->add_course($course);
2875                 $this->add_course_essentials($coursenode, $course);
2876                 $sections = $this->load_course_sections($course, $coursenode);
2877                 list($sectionarray, $activities) = $this->generate_sections_and_activities($course);
2878                 $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, $activities);
2879                 break;
2880             case self::TYPE_ACTIVITY :
2881                 $sql = "SELECT c.*
2882                           FROM {course} c
2883                           JOIN {course_modules} cm ON cm.course = c.id
2884                          WHERE cm.id = :cmid";
2885                 $params = array('cmid' => $this->instanceid);
2886                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
2887                 $modinfo = get_fast_modinfo($course);
2888                 $cm = $modinfo->get_cm($this->instanceid);
2889                 require_course_login($course, true, $cm, false, true);
2890                 $this->page->set_context(context_module::instance($cm->id));
2891                 $coursenode = $this->load_course($course);
2892                 if ($course->id == $SITE->id) {
2893                     $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY));
2894                 } else {
2895                     $sections   = $this->load_course_sections($course, $coursenode);
2896                     list($sectionarray, $activities) = $this->generate_sections_and_activities($course);
2897                     $activities = $this->load_section_activities($sections[$cm->sectionnum]->sectionnode, $cm->sectionnum, $activities);
2898                     $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]);
2899                 }
2900                 break;
2901             default:
2902                 throw new Exception('Unknown type');
2903                 return $this->expandable;
2904         }
2906         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) {
2907             $this->load_for_user(null, true);
2908         }
2910         $this->find_expandable($this->expandable);
2911         return $this->expandable;
2912     }
2914     /**
2915      * Loads a single category into the AJAX navigation.
2916      *
2917      * This function is special in that it doesn't concern itself with the parent of
2918      * the requested category or its siblings.
2919      * This is because with the AJAX navigation we know exactly what is wanted and only need to
2920      * request that.
2921      *
2922      * @global moodle_database $DB
2923      * @param int $categoryid
2924      */
2925     protected function load_category($categoryid) {
2926         global $CFG, $DB;
2928         $limit = 20;
2929         if (!empty($CFG->navcourselimit)) {
2930             $limit = (int)$CFG->navcourselimit;
2931         }
2933         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
2934         $sql = "SELECT cc.*, $catcontextsql
2935                   FROM {course_categories} cc
2936                   JOIN {context} ctx ON cc.id = ctx.instanceid
2937                  WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND
2938                        (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2939               ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2940         $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2941         $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2942         $subcategories = array();
2943         $basecategory = null;
2944         foreach ($categories as $category) {
2945             context_helper::preload_from_record($category);
2946             if ($category->id == $categoryid) {
2947                 $this->add_category($category, $this);
2948                 $basecategory = $this->addedcategories[$category->id];
2949             } else {
2950                 $subcategories[] = $category;
2951             }
2952         }
2953         $categories->close();
2955         if (!is_null($basecategory)) {
2956             //echo "<pre>".print_r($subcategories, true).'</pre>';
2957             foreach ($subcategories as $category) {
2958                 $this->add_category($category, $basecategory);
2959             }
2960         }
2962         $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
2963         foreach ($courses as $course) {
2964             $this->add_course($course);
2965         }
2966         $courses->close();
2967     }
2969     /**
2970      * Returns an array of expandable nodes
2971      * @return array
2972      */
2973     public function get_expandable() {
2974         return $this->expandable;
2975     }
2978 /**
2979  * Navbar class
2980  *
2981  * This class is used to manage the navbar, which is initialised from the navigation
2982  * object held by PAGE
2983  *
2984  * @package   core
2985  * @category  navigation
2986  * @copyright 2009 Sam Hemelryk
2987  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2988  */
2989 class navbar extends navigation_node {
2990     /** @var bool A switch for whether the navbar is initialised or not */
2991     protected $initialised = false;
2992     /** @var mixed keys used to reference the nodes on the navbar */
2993     protected $keys = array();
2994     /** @var null|string content of the navbar */
2995     protected $content = null;
2996     /** @var moodle_page object the moodle page that this navbar belongs to */
2997     protected $page;
2998     /** @var bool A switch for whether to ignore the active navigation information */
2999     protected $ignoreactive = false;
3000     /** @var bool A switch to let us know if we are in the middle of an install */
3001     protected $duringinstall = false;
3002     /** @var bool A switch for whether the navbar has items */
3003     protected $hasitems = false;
3004     /** @var array An array of navigation nodes for the navbar */
3005     protected $items;
3006     /** @var array An array of child node objects */
3007     public $children = array();
3008     /** @var bool A switch for whether we want to include the root node in the navbar */
3009     public $includesettingsbase = false;
3010     /**
3011      * The almighty constructor
3012      *
3013      * @param moodle_page $page
3014      */
3015     public function __construct(moodle_page $page) {
3016         global $CFG;
3017         if (during_initial_install()) {
3018             $this->duringinstall = true;
3019             return false;
3020         }
3021         $this->page = $page;
3022         $this->text = get_string('home');
3023         $this->shorttext = get_string('home');
3024         $this->action = new moodle_url($CFG->wwwroot);
3025         $this->nodetype = self::NODETYPE_BRANCH;
3026         $this->type = self::TYPE_SYSTEM;
3027     }
3029     /**
3030      * Quick check to see if the navbar will have items in.
3031      *
3032      * @return bool Returns true if the navbar will have items, false otherwise
3033      */
3034     public function has_items() {
3035         if ($this->duringinstall) {
3036             return false;
3037         } else if ($this->hasitems !== false) {
3038             return true;
3039         }
3040         $this->page->navigation->initialise($this->page);
3042         $activenodefound = ($this->page->navigation->contains_active_node() ||
3043                             $this->page->settingsnav->contains_active_node());
3045         $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
3046         $this->hasitems = $outcome;
3047         return $outcome;
3048     }
3050     /**
3051      * Turn on/off ignore active
3052      *
3053      * @param bool $setting
3054      */
3055     public function ignore_active($setting=true) {
3056         $this->ignoreactive = ($setting);
3057     }
3059     /**
3060      * Gets a navigation node
3061      *
3062      * @param string|int $key for referencing the navbar nodes
3063      * @param int $type navigation_node::TYPE_*
3064      * @return navigation_node|bool
3065      */
3066     public function get($key, $type = null) {
3067         foreach ($this->children as &$child) {
3068             if ($child->key === $key && ($type == null || $type == $child->type)) {
3069                 return $child;
3070             }
3071         }
3072         return false;
3073     }
3074     /**
3075      * Returns an array of navigation_node's that make up the navbar.
3076      *
3077      * @return array
3078      */
3079     public function get_items() {
3080         $items = array();
3081         // Make sure that navigation is initialised
3082         if (!$this->has_items()) {
3083             return $items;
3084         }
3085         if ($this->items !== null) {
3086             return $this->items;
3087         }
3089         if (count($this->children) > 0) {
3090             // Add the custom children
3091             $items = array_reverse($this->children);
3092         }
3094         $navigationactivenode = $this->page->navigation->find_active_node();
3095         $settingsactivenode = $this->page->settingsnav->find_active_node();
3097         // Check if navigation contains the active node
3098         if (!$this->ignoreactive) {
3100             if ($navigationactivenode && $settingsactivenode) {
3101                 // Parse a combined navigation tree
3102                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3103                     if (!$settingsactivenode->mainnavonly) {
3104                         $items[] = $settingsactivenode;
3105                     }
3106                     $settingsactivenode = $settingsactivenode->parent;
3107                 }
3108                 if (!$this->includesettingsbase) {
3109                     // Removes the first node from the settings (root node) from the list
3110                     array_pop($items);
3111                 }
3112                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3113                     if (!$navigationactivenode->mainnavonly) {
3114                         $items[] = $navigationactivenode;
3115                     }
3116                     $navigationactivenode = $navigationactivenode->parent;
3117                 }
3118             } else if ($navigationactivenode) {
3119                 // Parse the navigation tree to get the active node
3120                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3121                     if (!$navigationactivenode->mainnavonly) {
3122                         $items[] = $navigationactivenode;
3123                     }
3124                     $navigationactivenode = $navigationactivenode->parent;
3125                 }
3126             } else if ($settingsactivenode) {
3127                 // Parse the settings navigation to get the active node
3128                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3129                     if (!$settingsactivenode->mainnavonly) {
3130                         $items[] = $settingsactivenode;
3131                     }
3132                     $settingsactivenode = $settingsactivenode->parent;
3133                 }
3134             }
3135         }
3137         $items[] = new navigation_node(array(
3138             'text'=>$this->page->navigation->text,
3139             'shorttext'=>$this->page->navigation->shorttext,
3140             'key'=>$this->page->navigation->key,
3141             'action'=>$this->page->navigation->action
3142         ));
3144         $this->items = array_reverse($items);
3145         return $this->items;
3146     }
3148     /**
3149      * Add a new navigation_node to the navbar, overrides parent::add
3150      *
3151      * This function overrides {@link navigation_node::add()} so that we can change
3152      * the way nodes get added to allow us to simply call add and have the node added to the
3153      * end of the navbar
3154      *
3155      * @param string $text
3156      * @param string|moodle_url|action_link $action An action to associate with this node.
3157      * @param int $type One of navigation_node::TYPE_*
3158      * @param string $shorttext
3159      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3160      * @param pix_icon $icon An optional icon to use for this node.
3161      * @return navigation_node
3162      */
3163     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3164         if ($this->content !== null) {
3165             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3166         }
3168         // Properties array used when creating the new navigation node
3169         $itemarray = array(
3170             'text' => $text,
3171             'type' => $type
3172         );
3173         // Set the action if one was provided
3174         if ($action!==null) {
3175             $itemarray['action'] = $action;
3176         }
3177         // Set the shorttext if one was provided
3178         if ($shorttext!==null) {
3179             $itemarray['shorttext'] = $shorttext;
3180         }
3181         // Set the icon if one was provided
3182         if ($icon!==null) {
3183             $itemarray['icon'] = $icon;
3184         }
3185         // Default the key to the number of children if not provided
3186         if ($key === null) {
3187             $key = count($this->children);
3188         }
3189         // Set the key
3190         $itemarray['key'] = $key;
3191         // Set the parent to this node
3192         $itemarray['parent'] = $this;
3193         // Add the child using the navigation_node_collections add method
3194         $this->children[] = new navigation_node($itemarray);
3195         return $this;
3196     }
3199 /**
3200  * Class used to manage the settings option for the current page
3201  *
3202  * This class is used to manage the settings options in a tree format (recursively)
3203  * and was created initially for use with the settings blocks.
3204  *
3205  * @package   core
3206  * @category  navigation
3207  * @copyright 2009 Sam Hemelryk
3208  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3209  */
3210 class settings_navigation extends navigation_node {
3211     /** @var stdClass the current context */
3212     protected $context;
3213     /** @var moodle_page the moodle page that the navigation belongs to */
3214     protected $page;
3215     /** @var string contains administration section navigation_nodes */
3216     protected $adminsection;
3217     /** @var bool A switch to see if the navigation node is initialised */
3218     protected $initialised = false;
3219     /** @var array An array of users that the nodes can extend for. */
3220     protected $userstoextendfor = array();
3221     /** @var navigation_cache **/
3222     protected $cache;
3224     /**
3225      * Sets up the object with basic settings and preparse it for use
3226      *
3227      * @param moodle_page $page
3228      */
3229     public function __construct(moodle_page &$page) {
3230         if (during_initial_install()) {
3231             return false;
3232         }
3233         $this->page = $page;
3234         // Initialise the main navigation. It is most important that this is done
3235         // before we try anything
3236         $this->page->navigation->initialise();
3237         // Initialise the navigation cache
3238         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
3239         $this->children = new navigation_node_collection();
3240     }
3241     /**
3242      * Initialise the settings navigation based on the current context
3243      *
3244      * This function initialises the settings navigation tree for a given context
3245      * by calling supporting functions to generate major parts of the tree.
3246      *
3247      */
3248     public function initialise() {
3249         global $DB, $SESSION, $SITE;
3251         if (during_initial_install()) {
3252             return false;
3253         } else if ($this->initialised) {
3254             return true;
3255         }
3256         $this->id = 'settingsnav';
3257         $this->context = $this->page->context;
3259         $context = $this->context;
3260         if ($context->contextlevel == CONTEXT_BLOCK) {
3261             $this->load_block_settings();
3262             $context = $context->get_parent_context();
3263         }
3265         switch ($context->contextlevel) {
3266             case CONTEXT_SYSTEM:
3267