059e3a4738a38310623219dae6be28eb051a6a5d
[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', 'moodle');
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', get_context_instance(CONTEXT_COURSECAT, $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   = get_context_instance(CONTEXT_USER, $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_list_of_plugins('local') as $plugin) {
1427             if (!file_exists($CFG->dirroot.'/local/'.$plugin.'/lib.php')) {
1428                 continue;
1429             }
1430             require_once($CFG->dirroot.'/local/'.$plugin.'/lib.php');
1431             $function = $plugin.'_extends_navigation';
1432             if (function_exists($function)) {
1433                 $function($this);
1434             }
1435         }
1437         // Remove any empty root nodes
1438         foreach ($this->rootnodes as $node) {
1439             // Dont remove the home node
1440             if ($node->key !== 'home' && !$node->has_children()) {
1441                 $node->remove();
1442             }
1443         }
1445         if (!$this->contains_active_node()) {
1446             $this->search_for_active_node();
1447         }
1449         // If the user is not logged in modify the navigation structure as detailed
1450         // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1451         if (!isloggedin()) {
1452             $activities = clone($this->rootnodes['site']->children);
1453             $this->rootnodes['site']->remove();
1454             $children = clone($this->children);
1455             $this->children = new navigation_node_collection();
1456             foreach ($activities as $child) {
1457                 $this->children->add($child);
1458             }
1459             foreach ($children as $child) {
1460                 $this->children->add($child);
1461             }
1462         }
1463         return true;
1464     }
1466     /**
1467      * Returns true if courses should be shown within categories on the navigation.
1468      *
1469      * @return bool
1470      */
1471     protected function show_categories() {
1472         global $CFG, $DB;
1473         if ($this->showcategories === null) {
1474             $show = $this->page->context->contextlevel == CONTEXT_COURSECAT;
1475             $show = $show || (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1);
1476             $this->showcategories = $show;
1477         }
1478         return $this->showcategories;
1479     }
1481     /**
1482      * Checks the course format to see whether it wants the navigation to load
1483      * additional information for the course.
1484      *
1485      * This function utilises a callback that can exist within the course format lib.php file
1486      * The callback should be a function called:
1487      * callback_{formatname}_display_content()
1488      * It doesn't get any arguments and should return true if additional content is
1489      * desired. If the callback doesn't exist we assume additional content is wanted.
1490      *
1491      * @param string $format The course format
1492      * @return bool
1493      */
1494     protected function format_display_course_content($format) {
1495         global $CFG;
1496         $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
1497         if (file_exists($formatlib)) {
1498             require_once($formatlib);
1499             $displayfunc = 'callback_'.$format.'_display_content';
1500             if (function_exists($displayfunc) && !$displayfunc()) {
1501                 return $displayfunc();
1502             }
1503         }
1504         return true;
1505     }
1507     /**
1508      * Loads the courses in Moodle into the navigation.
1509      *
1510      * @global moodle_database $DB
1511      * @param string|array $categoryids An array containing categories to load courses
1512      *                     for, OR null to load courses for all categories.
1513      * @return array An array of navigation_nodes one for each course
1514      */
1515     protected function load_all_courses($categoryids = null) {
1516         global $CFG, $DB, $SITE;
1518         // Work out the limit of courses.
1519         $limit = 20;
1520         if (!empty($CFG->navcourselimit)) {
1521             $limit = $CFG->navcourselimit;
1522         }
1524         $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES;
1526         // If we are going to show all courses AND we are showing categories then
1527         // to save us repeated DB calls load all of the categories now
1528         if ($this->show_categories()) {
1529             $this->load_all_categories($toload);
1530         }
1532         // Will be the return of our efforts
1533         $coursenodes = array();
1535         // Check if we need to show categories.
1536         if ($this->show_categories()) {
1537             // Hmmm we need to show categories... this is going to be painful.
1538             // We now need to fetch up to $limit courses for each category to
1539             // be displayed.
1540             if ($categoryids !== null) {
1541                 if (!is_array($categoryids)) {
1542                     $categoryids = array($categoryids);
1543                 }
1544                 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc');
1545                 $categorywhere = 'WHERE cc.id '.$categorywhere;
1546             } else if ($toload == self::LOAD_ROOT_CATEGORIES) {
1547                 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1548                 $categoryparams = array();
1549             } else {
1550                 $categorywhere = '';
1551                 $categoryparams = array();
1552             }
1554             // First up we are going to get the categories that we are going to
1555             // need so that we can determine how best to load the courses from them.
1556             $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1557                         FROM {course_categories} cc
1558                     LEFT JOIN {course} c ON c.category = cc.id
1559                             {$categorywhere}
1560                     GROUP BY cc.id";
1561             $categories = $DB->get_recordset_sql($sql, $categoryparams);
1562             $fullfetch = array();
1563             $partfetch = array();
1564             foreach ($categories as $category) {
1565                 if (!$this->can_add_more_courses_to_category($category->id)) {
1566                     continue;
1567                 }
1568                 if ($category->coursecount > $limit * 5) {
1569                     $partfetch[] = $category->id;
1570                 } else if ($category->coursecount > 0) {
1571                     $fullfetch[] = $category->id;
1572                 }
1573             }
1574             $categories->close();
1576             if (count($fullfetch)) {
1577                 // First up fetch all of the courses in categories where we know that we are going to
1578                 // need the majority of courses.
1579                 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1580                 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory');
1581                 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1582                             FROM {course} c
1583                                 $ccjoin
1584                             WHERE c.category {$categoryids}
1585                         ORDER BY c.sortorder ASC";
1586                 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1587                 foreach ($coursesrs as $course) {
1588                     if ($course->id == $SITE->id) {
1589                         // This should not be necessary, frontpage is not in any category.
1590                         continue;
1591                     }
1592                     if (array_key_exists($course->id, $this->addedcourses)) {
1593                         // It is probably better to not include the already loaded courses
1594                         // directly in SQL because inequalities may confuse query optimisers
1595                         // and may interfere with query caching.
1596                         continue;
1597                     }
1598                     if (!$this->can_add_more_courses_to_category($course->category)) {
1599                         continue;
1600                     }
1601                     context_instance_preload($course);
1602                     if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1603                         continue;
1604                     }
1605                     $coursenodes[$course->id] = $this->add_course($course);
1606                 }
1607                 $coursesrs->close();
1608             }
1610             if (count($partfetch)) {
1611                 // Next we will work our way through the categories where we will likely only need a small
1612                 // proportion of the courses.
1613                 foreach ($partfetch as $categoryid) {
1614                     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1615                     $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1616                                 FROM {course} c
1617                                     $ccjoin
1618                                 WHERE c.category = :categoryid
1619                             ORDER BY c.sortorder ASC";
1620                     $courseparams = array('categoryid' => $categoryid);
1621                     $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1622                     foreach ($coursesrs as $course) {
1623                         if ($course->id == $SITE->id) {
1624                             // This should not be necessary, frontpage is not in any category.
1625                             continue;
1626                         }
1627                         if (array_key_exists($course->id, $this->addedcourses)) {
1628                             // It is probably better to not include the already loaded courses
1629                             // directly in SQL because inequalities may confuse query optimisers
1630                             // and may interfere with query caching.
1631                             // This also helps to respect expected $limit on repeated executions.
1632                             continue;
1633                         }
1634                         if (!$this->can_add_more_courses_to_category($course->category)) {
1635                             break;
1636                         }
1637                         context_instance_preload($course);
1638                         if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1639                             continue;
1640                         }
1641                         $coursenodes[$course->id] = $this->add_course($course);
1642                     }
1643                     $coursesrs->close();
1644                 }
1645             }
1646         } else {
1647             // Prepare the SQL to load the courses and their contexts
1648             list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1649             list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false);
1650             $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1651                         FROM {course} c
1652                             $ccjoin
1653                         WHERE c.id {$courseids}
1654                     ORDER BY c.sortorder ASC";
1655             $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1656             foreach ($coursesrs as $course) {
1657                 if ($course->id == $SITE->id) {
1658                     // frotpage is not wanted here
1659                     continue;
1660                 }
1661                 context_instance_preload($course);
1662                 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1663                     continue;
1664                 }
1665                 $coursenodes[$course->id] = $this->add_course($course);
1666                 if (count($coursenodes) >= $limit) {
1667                     break;
1668                 }
1669             }
1670             $coursesrs->close();
1671         }
1673         return $coursenodes;
1674     }
1676     /**
1677      * Returns true if more courses can be added to the provided category.
1678      *
1679      * @param int|navigation_node|stdClass $category
1680      * @return bool
1681      */
1682     protected function can_add_more_courses_to_category($category) {
1683         global $CFG;
1684         $limit = 20;
1685         if (!empty($CFG->navcourselimit)) {
1686             $limit = (int)$CFG->navcourselimit;
1687         }
1688         if (is_numeric($category)) {
1689             if (!array_key_exists($category, $this->addedcategories)) {
1690                 return true;
1691             }
1692             $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE));
1693         } else if ($category instanceof navigation_node) {
1694             if ($category->type != self::TYPE_CATEGORY) {
1695                 return false;
1696             }
1697             $coursecount = count($category->children->type(self::TYPE_COURSE));
1698         } else if (is_object($category) && property_exists($category,'id')) {
1699             $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE));
1700         }
1701         return ($coursecount <= $limit);
1702     }
1704     /**
1705      * Loads all categories (top level or if an id is specified for that category)
1706      *
1707      * @param int $categoryid The category id to load or null/0 to load all base level categories
1708      * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1709      *        as the requested category and any parent categories.
1710      * @return navigation_node|void returns a navigation node if a category has been loaded.
1711      */
1712     protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) {
1713         global $DB;
1715         // Check if this category has already been loaded
1716         if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1717             return true;
1718         }
1720         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
1721         $sqlselect = "SELECT cc.*, $catcontextsql
1722                       FROM {course_categories} cc
1723                       JOIN {context} ctx ON cc.id = ctx.instanceid";
1724         $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT;
1725         $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1726         $params = array();
1728         $categoriestoload = array();
1729         if ($categoryid == self::LOAD_ALL_CATEGORIES) {
1730             // We are going to load all categories regardless... prepare to fire
1731             // on the database server!
1732         } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0
1733             // We are going to load all of the first level categories (categories without parents)
1734             $sqlwhere .= " AND cc.parent = 0";
1735         } else if (array_key_exists($categoryid, $this->addedcategories)) {
1736             // The category itself has been loaded already so we just need to ensure its subcategories
1737             // have been loaded
1738             list($sql, $params) = $DB->get_in_or_equal(array_keys($this->addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1739             if ($showbasecategories) {
1740                 // We need to include categories with parent = 0 as well
1741                 $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1742             } else {
1743                 // All we need is categories that match the parent
1744                 $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1745             }
1746             $params['categoryid'] = $categoryid;
1747         } else {
1748             // This category hasn't been loaded yet so we need to fetch it, work out its category path
1749             // and load this category plus all its parents and subcategories
1750             $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
1751             $categoriestoload = explode('/', trim($category->path, '/'));
1752             list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1753             // We are going to use select twice so double the params
1754             $params = array_merge($params, $params);
1755             $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':'';
1756             $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1757         }
1759         $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1760         $categories = array();
1761         foreach ($categoriesrs as $category) {
1762             // Preload the context.. we'll need it when adding the category in order
1763             // to format the category name.
1764             context_helper::preload_from_record($category);
1765             if (array_key_exists($category->id, $this->addedcategories)) {
1766                 // Do nothing, its already been added.
1767             } else if ($category->parent == '0') {
1768                 // This is a root category lets add it immediately
1769                 $this->add_category($category, $this->rootnodes['courses']);
1770             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1771                 // This categories parent has already been added we can add this immediately
1772                 $this->add_category($category, $this->addedcategories[$category->parent]);
1773             } else {
1774                 $categories[] = $category;
1775             }
1776         }
1777         $categoriesrs->close();
1779         // Now we have an array of categories we need to add them to the navigation.
1780         while (!empty($categories)) {
1781             $category = reset($categories);
1782             if (array_key_exists($category->id, $this->addedcategories)) {
1783                 // Do nothing
1784             } else if ($category->parent == '0') {
1785                 $this->add_category($category, $this->rootnodes['courses']);
1786             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1787                 $this->add_category($category, $this->addedcategories[$category->parent]);
1788             } else {
1789                 // This category isn't in the navigation and niether is it's parent (yet).
1790                 // We need to go through the category path and add all of its components in order.
1791                 $path = explode('/', trim($category->path, '/'));
1792                 foreach ($path as $catid) {
1793                     if (!array_key_exists($catid, $this->addedcategories)) {
1794                         // This category isn't in the navigation yet so add it.
1795                         $subcategory = $categories[$catid];
1796                         if ($subcategory->parent == '0') {
1797                             // Yay we have a root category - this likely means we will now be able
1798                             // to add categories without problems.
1799                             $this->add_category($subcategory, $this->rootnodes['courses']);
1800                         } else if (array_key_exists($subcategory->parent, $this->addedcategories)) {
1801                             // The parent is in the category (as we'd expect) so add it now.
1802                             $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1803                             // Remove the category from the categories array.
1804                             unset($categories[$catid]);
1805                         } else {
1806                             // We should never ever arrive here - if we have then there is a bigger
1807                             // problem at hand.
1808                             throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1809                         }
1810                     }
1811                 }
1812             }
1813             // Remove the category from the categories array now that we know it has been added.
1814             unset($categories[$category->id]);
1815         }
1816         if ($categoryid === self::LOAD_ALL_CATEGORIES) {
1817             $this->allcategoriesloaded = true;
1818         }
1819         // Check if there are any categories to load.
1820         if (count($categoriestoload) > 0) {
1821             $readytoloadcourses = array();
1822             foreach ($categoriestoload as $category) {
1823                 if ($this->can_add_more_courses_to_category($category)) {
1824                     $readytoloadcourses[] = $category;
1825                 }
1826             }
1827             if (count($readytoloadcourses)) {
1828                 $this->load_all_courses($readytoloadcourses);
1829             }
1830         }
1831     }
1833     /**
1834      * Adds a structured category to the navigation in the correct order/place
1835      *
1836      * @param stdClass $category
1837      * @param navigation_node $parent
1838      */
1839     protected function add_category(stdClass $category, navigation_node $parent) {
1840         if (array_key_exists($category->id, $this->addedcategories)) {
1841             return;
1842         }
1843         $url = new moodle_url('/course/category.php', array('id' => $category->id));
1844         $context = get_context_instance(CONTEXT_COURSECAT, $category->id);
1845         $categoryname = format_string($category->name, true, array('context' => $context));
1846         $categorynode = $parent->add($categoryname, $url, self::TYPE_CATEGORY, $categoryname, $category->id);
1847         if (empty($category->visible)) {
1848             if (has_capability('moodle/category:viewhiddencategories', get_system_context())) {
1849                 $categorynode->hidden = true;
1850             } else {
1851                 $categorynode->display = false;
1852             }
1853         }
1854         $this->addedcategories[$category->id] = $categorynode;
1855     }
1857     /**
1858      * Loads the given course into the navigation
1859      *
1860      * @param stdClass $course
1861      * @return navigation_node
1862      */
1863     protected function load_course(stdClass $course) {
1864         global $SITE;
1865         if ($course->id == $SITE->id) {
1866             // This is always loaded during initialisation
1867             return $this->rootnodes['site'];
1868         } else if (array_key_exists($course->id, $this->addedcourses)) {
1869             // The course has already been loaded so return a reference
1870             return $this->addedcourses[$course->id];
1871         } else {
1872             // Add the course
1873             return $this->add_course($course);
1874         }
1875     }
1877     /**
1878      * Loads all of the courses section into the navigation.
1879      *
1880      * This function utilisies a callback that can be implemented within the course
1881      * formats lib.php file to customise the navigation that is generated at this
1882      * point for the course.
1883      *
1884      * By default (if not defined) the method {@link global_navigation::load_generic_course_sections()} is
1885      * called instead.
1886      *
1887      * @param stdClass $course Database record for the course
1888      * @param navigation_node $coursenode The course node within the navigation
1889      * @return array Array of navigation nodes for the section with key = section id
1890      */
1891     protected function load_course_sections(stdClass $course, navigation_node $coursenode) {
1892         global $CFG;
1893         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
1894         $structurefunc = 'callback_'.$course->format.'_load_content';
1895         if (function_exists($structurefunc)) {
1896             return $structurefunc($this, $course, $coursenode);
1897         } else if (file_exists($structurefile)) {
1898             require_once $structurefile;
1899             if (function_exists($structurefunc)) {
1900                 return $structurefunc($this, $course, $coursenode);
1901             } else {
1902                 return $this->load_generic_course_sections($course, $coursenode);
1903             }
1904         } else {
1905             return $this->load_generic_course_sections($course, $coursenode);
1906         }
1907     }
1909     /**
1910      * Generates an array of sections and an array of activities for the given course.
1911      *
1912      * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1913      *
1914      * @param stdClass $course
1915      * @return array Array($sections, $activities)
1916      */
1917     protected function generate_sections_and_activities(stdClass $course) {
1918         global $CFG;
1919         require_once($CFG->dirroot.'/course/lib.php');
1921         $modinfo = get_fast_modinfo($course);
1922         $sections = array_slice($modinfo->get_section_info_all(), 0, $course->numsections+1, true);
1923         $activities = array();
1925         foreach ($sections as $key => $section) {
1926             $sections[$key]->hasactivites = false;
1927             if (!array_key_exists($section->section, $modinfo->sections)) {
1928                 continue;
1929             }
1930             foreach ($modinfo->sections[$section->section] as $cmid) {
1931                 $cm = $modinfo->cms[$cmid];
1932                 if (!$cm->uservisible) {
1933                     continue;
1934                 }
1935                 $activity = new stdClass;
1936                 $activity->id = $cm->id;
1937                 $activity->course = $course->id;
1938                 $activity->section = $section->section;
1939                 $activity->name = $cm->name;
1940                 $activity->icon = $cm->icon;
1941                 $activity->iconcomponent = $cm->iconcomponent;
1942                 $activity->hidden = (!$cm->visible);
1943                 $activity->modname = $cm->modname;
1944                 $activity->nodetype = navigation_node::NODETYPE_LEAF;
1945                 $activity->onclick = $cm->get_on_click();
1946                 $url = $cm->get_url();
1947                 if (!$url) {
1948                     $activity->url = null;
1949                     $activity->display = false;
1950                 } else {
1951                     $activity->url = $cm->get_url()->out();
1952                     $activity->display = true;
1953                     if (self::module_extends_navigation($cm->modname)) {
1954                         $activity->nodetype = navigation_node::NODETYPE_BRANCH;
1955                     }
1956                 }
1957                 $activities[$cmid] = $activity;
1958                 if ($activity->display) {
1959                     $sections[$key]->hasactivites = true;
1960                 }
1961             }
1962         }
1964         return array($sections, $activities);
1965     }
1967     /**
1968      * Generically loads the course sections into the course's navigation.
1969      *
1970      * @param stdClass $course
1971      * @param navigation_node $coursenode
1972      * @param string $courseformat The course format
1973      * @return array An array of course section nodes
1974      */
1975     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $courseformat='unknown') {
1976         global $CFG, $DB, $USER, $SITE;
1977         require_once($CFG->dirroot.'/course/lib.php');
1979         list($sections, $activities) = $this->generate_sections_and_activities($course);
1981         $namingfunction = 'callback_'.$courseformat.'_get_section_name';
1982         $namingfunctionexists = (function_exists($namingfunction));
1984         $urlfunction = 'callback_'.$courseformat.'_get_section_url';
1985         if (function_exists($urlfunction)) {
1986             // This code path is deprecated but we decided not to warn developers as
1987             // major changes are likely to follow in 2.4. See MDL-32504.
1988         } else {
1989             $urlfunction = null;
1990         }
1992         $key = 0;
1993         if (defined('AJAX_SCRIPT') && AJAX_SCRIPT == '0' && $this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
1994             $key = optional_param('section', $key, PARAM_INT);
1995         }
1997         $navigationsections = array();
1998         foreach ($sections as $sectionid => $section) {
1999             $section = clone($section);
2000             if ($course->id == $SITE->id) {
2001                 $this->load_section_activities($coursenode, $section->section, $activities);
2002             } else {
2003                 if (!$section->uservisible || (!$this->showemptysections &&
2004                         !$section->hasactivites && $this->includesectionnum !== $section->section)) {
2005                     continue;
2006                 }
2008                 if ($namingfunctionexists) {
2009                     $sectionname = $namingfunction($course, $section, $sections);
2010                 } else {
2011                     $sectionname = get_string('section').' '.$section->section;
2012                 }
2014                 $url = null;
2015                 if ($urlfunction) {
2016                     // pre 2.3 style format url
2017                     $url = $urlfunction($course->id, $section->section);
2018                 }else{
2019                     if ($course->coursedisplay == COURSE_DISPLAY_MULTIPAGE) {
2020                         $url = course_get_url($course, $section->section);
2021                     }
2022                 }
2023                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
2024                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
2025                 $sectionnode->hidden = (!$section->visible || !$section->available);
2026                 if ($key != '0' && $section->section != '0' && $section->section == $key && $this->page->context->contextlevel != CONTEXT_MODULE && $section->hasactivites) {
2027                     $sectionnode->make_active();
2028                     $this->load_section_activities($sectionnode, $section->section, $activities);
2029                 }
2030                 $section->sectionnode = $sectionnode;
2031                 $navigationsections[$sectionid] = $section;
2032             }
2033         }
2034         return $navigationsections;
2035     }
2036     /**
2037      * Loads all of the activities for a section into the navigation structure.
2038      *
2039      * @param navigation_node $sectionnode
2040      * @param int $sectionnumber
2041      * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
2042      * @param stdClass $course The course object the section and activities relate to.
2043      * @return array Array of activity nodes
2044      */
2045     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) {
2046         global $CFG, $SITE;
2047         // A static counter for JS function naming
2048         static $legacyonclickcounter = 0;
2050         $activitynodes = array();
2051         if (empty($activities)) {
2052             return $activitynodes;
2053         }
2055         if (!is_object($course)) {
2056             $activity = reset($activities);
2057             $courseid = $activity->course;
2058         } else {
2059             $courseid = $course->id;
2060         }
2061         $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods));
2063         foreach ($activities as $activity) {
2064             if ($activity->section != $sectionnumber) {
2065                 continue;
2066             }
2067             if ($activity->icon) {
2068                 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
2069             } else {
2070                 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
2071             }
2073             // Prepare the default name and url for the node
2074             $activityname = format_string($activity->name, true, array('context' => get_context_instance(CONTEXT_MODULE, $activity->id)));
2075             $action = new moodle_url($activity->url);
2077             // Check if the onclick property is set (puke!)
2078             if (!empty($activity->onclick)) {
2079                 // Increment the counter so that we have a unique number.
2080                 $legacyonclickcounter++;
2081                 // Generate the function name we will use
2082                 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
2083                 $propogrationhandler = '';
2084                 // Check if we need to cancel propogation. Remember inline onclick
2085                 // events would return false if they wanted to prevent propogation and the
2086                 // default action.
2087                 if (strpos($activity->onclick, 'return false')) {
2088                     $propogrationhandler = 'e.halt();';
2089                 }
2090                 // Decode the onclick - it has already been encoded for display (puke)
2091                 $onclick = htmlspecialchars_decode($activity->onclick);
2092                 // Build the JS function the click event will call
2093                 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2094                 $this->page->requires->js_init_code($jscode);
2095                 // Override the default url with the new action link
2096                 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2097             }
2099             $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
2100             $activitynode->title(get_string('modulename', $activity->modname));
2101             $activitynode->hidden = $activity->hidden;
2102             $activitynode->display = $showactivities && $activity->display;
2103             $activitynode->nodetype = $activity->nodetype;
2104             $activitynodes[$activity->id] = $activitynode;
2105         }
2107         return $activitynodes;
2108     }
2109     /**
2110      * Loads a stealth module from unavailable section
2111      * @param navigation_node $coursenode
2112      * @param stdClass $modinfo
2113      * @return navigation_node or null if not accessible
2114      */
2115     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
2116         if (empty($modinfo->cms[$this->page->cm->id])) {
2117             return null;
2118         }
2119         $cm = $modinfo->cms[$this->page->cm->id];
2120         if (!$cm->uservisible) {
2121             return null;
2122         }
2123         if ($cm->icon) {
2124             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
2125         } else {
2126             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
2127         }
2128         $url = $cm->get_url();
2129         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
2130         $activitynode->title(get_string('modulename', $cm->modname));
2131         $activitynode->hidden = (!$cm->visible);
2132         if (!$url) {
2133             // Don't show activities that don't have links!
2134             $activitynode->display = false;
2135         } else if (self::module_extends_navigation($cm->modname)) {
2136             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
2137         }
2138         return $activitynode;
2139     }
2140     /**
2141      * Loads the navigation structure for the given activity into the activities node.
2142      *
2143      * This method utilises a callback within the modules lib.php file to load the
2144      * content specific to activity given.
2145      *
2146      * The callback is a method: {modulename}_extend_navigation()
2147      * Examples:
2148      *  * {@link forum_extend_navigation()}
2149      *  * {@link workshop_extend_navigation()}
2150      *
2151      * @param cm_info|stdClass $cm
2152      * @param stdClass $course
2153      * @param navigation_node $activity
2154      * @return bool
2155      */
2156     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
2157         global $CFG, $DB;
2159         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2160         if (!($cm instanceof cm_info)) {
2161             $modinfo = get_fast_modinfo($course);
2162             $cm = $modinfo->get_cm($cm->id);
2163         }
2165         $activity->nodetype = navigation_node::NODETYPE_LEAF;
2166         $activity->make_active();
2167         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
2168         $function = $cm->modname.'_extend_navigation';
2170         if (file_exists($file)) {
2171             require_once($file);
2172             if (function_exists($function)) {
2173                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
2174                 $function($activity, $course, $activtyrecord, $cm);
2175             }
2176         }
2178         // Allow the active advanced grading method plugin to append module navigation
2179         $featuresfunc = $cm->modname.'_supports';
2180         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) {
2181             require_once($CFG->dirroot.'/grade/grading/lib.php');
2182             $gradingman = get_grading_manager($cm->context, $cm->modname);
2183             $gradingman->extend_navigation($this, $activity);
2184         }
2186         return $activity->has_children();
2187     }
2188     /**
2189      * Loads user specific information into the navigation in the appropriate place.
2190      *
2191      * If no user is provided the current user is assumed.
2192      *
2193      * @param stdClass $user
2194      * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2195      * @return bool
2196      */
2197     protected function load_for_user($user=null, $forceforcontext=false) {
2198         global $DB, $CFG, $USER, $SITE;
2200         if ($user === null) {
2201             // We can't require login here but if the user isn't logged in we don't
2202             // want to show anything
2203             if (!isloggedin() || isguestuser()) {
2204                 return false;
2205             }
2206             $user = $USER;
2207         } else if (!is_object($user)) {
2208             // If the user is not an object then get them from the database
2209             $select = context_helper::get_preload_record_columns_sql('ctx');
2210             $sql = "SELECT u.*, $select
2211                       FROM {user} u
2212                       JOIN {context} ctx ON u.id = ctx.instanceid
2213                      WHERE u.id = :userid AND
2214                            ctx.contextlevel = :contextlevel";
2215             $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST);
2216             context_helper::preload_from_record($user);
2217         }
2219         $iscurrentuser = ($user->id == $USER->id);
2221         $usercontext = get_context_instance(CONTEXT_USER, $user->id);
2223         // Get the course set against the page, by default this will be the site
2224         $course = $this->page->course;
2225         $baseargs = array('id'=>$user->id);
2226         if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) {
2227             $coursenode = $this->load_course($course);
2228             $baseargs['course'] = $course->id;
2229             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2230             $issitecourse = false;
2231         } else {
2232             // Load all categories and get the context for the system
2233             $coursecontext = get_context_instance(CONTEXT_SYSTEM);
2234             $issitecourse = true;
2235         }
2237         // Create a node to add user information under.
2238         if ($iscurrentuser && !$forceforcontext) {
2239             // If it's the current user the information will go under the profile root node
2240             $usernode = $this->rootnodes['myprofile'];
2241             $course = get_site();
2242             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2243             $issitecourse = true;
2244         } else {
2245             if (!$issitecourse) {
2246                 // Not the current user so add it to the participants node for the current course
2247                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
2248                 $userviewurl = new moodle_url('/user/view.php', $baseargs);
2249             } else {
2250                 // This is the site so add a users node to the root branch
2251                 $usersnode = $this->rootnodes['users'];
2252                 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2253                     $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
2254                 }
2255                 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2256             }
2257             if (!$usersnode) {
2258                 // We should NEVER get here, if the course hasn't been populated
2259                 // with a participants node then the navigaiton either wasn't generated
2260                 // for it (you are missing a require_login or set_context call) or
2261                 // you don't have access.... in the interests of no leaking informatin
2262                 // we simply quit...
2263                 return false;
2264             }
2265             // Add a branch for the current user
2266             $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2267             $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, $user->id);
2269             if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
2270                 $usernode->make_active();
2271             }
2272         }
2274         // If the user is the current user or has permission to view the details of the requested
2275         // user than add a view profile link.
2276         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
2277             if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
2278                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
2279             } else {
2280                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
2281             }
2282         }
2284         if (!empty($CFG->navadduserpostslinks)) {
2285             // Add nodes for forum posts and discussions if the user can view either or both
2286             // There are no capability checks here as the content of the page is based
2287             // purely on the forums the current user has access too.
2288             $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2289             $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2290             $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
2291         }
2293         // Add blog nodes
2294         if (!empty($CFG->bloglevel)) {
2295             if (!$this->cache->cached('userblogoptions'.$user->id)) {
2296                 require_once($CFG->dirroot.'/blog/lib.php');
2297                 // Get all options for the user
2298                 $options = blog_get_options_for_user($user);
2299                 $this->cache->set('userblogoptions'.$user->id, $options);
2300             } else {
2301                 $options = $this->cache->{'userblogoptions'.$user->id};
2302             }
2304             if (count($options) > 0) {
2305                 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
2306                 foreach ($options as $type => $option) {
2307                     if ($type == "rss") {
2308                         $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2309                     } else {
2310                         $blogs->add($option['string'], $option['link']);
2311                     }
2312                 }
2313             }
2314         }
2316         if (!empty($CFG->messaging)) {
2317             $messageargs = null;
2318             if ($USER->id!=$user->id) {
2319                 $messageargs = array('id'=>$user->id);
2320             }
2321             $url = new moodle_url('/message/index.php',$messageargs);
2322             $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
2323         }
2325         $context = get_context_instance(CONTEXT_USER, $USER->id);
2326         if ($iscurrentuser && has_capability('moodle/user:manageownfiles', $context)) {
2327             $url = new moodle_url('/user/filesedit.php');
2328             $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
2329         }
2331         // Add a node to view the users notes if permitted
2332         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2333             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
2334             if ($coursecontext->instanceid) {
2335                 $url->param('course', $coursecontext->instanceid);
2336             }
2337             $usernode->add(get_string('notes', 'notes'), $url);
2338         }
2340         // Add reports node
2341         $reporttab = $usernode->add(get_string('activityreports'));
2342         $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2343         foreach ($reports as $reportfunction) {
2344             $reportfunction($reporttab, $user, $course);
2345         }
2346         $anyreport = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
2347         if ($anyreport || ($course->showreports && $iscurrentuser && $forceforcontext)) {
2348             // Add grade hardcoded grade report if necessary
2349             $gradeaccess = false;
2350             if (has_capability('moodle/grade:viewall', $coursecontext)) {
2351                 //ok - can view all course grades
2352                 $gradeaccess = true;
2353             } else if ($course->showgrades) {
2354                 if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) {
2355                     //ok - can view own grades
2356                     $gradeaccess = true;
2357                 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
2358                     // ok - can view grades of this user - parent most probably
2359                     $gradeaccess = true;
2360                 } else if ($anyreport) {
2361                     // ok - can view grades of this user - parent most probably
2362                     $gradeaccess = true;
2363                 }
2364             }
2365             if ($gradeaccess) {
2366                 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array('mode'=>'grade', 'id'=>$course->id, 'user'=>$usercontext->instanceid)));
2367             }
2368         }
2369         // Check the number of nodes in the report node... if there are none remove the node
2370         $reporttab->trim_if_empty();
2372         // If the user is the current user add the repositories for the current user
2373         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
2374         if ($iscurrentuser) {
2375             if (!$this->cache->cached('contexthasrepos'.$usercontext->id)) {
2376                 require_once($CFG->dirroot . '/repository/lib.php');
2377                 $editabletypes = repository::get_editable_types($usercontext);
2378                 $haseditabletypes = !empty($editabletypes);
2379                 unset($editabletypes);
2380                 $this->cache->set('contexthasrepos'.$usercontext->id, $haseditabletypes);
2381             } else {
2382                 $haseditabletypes = $this->cache->{'contexthasrepos'.$usercontext->id};
2383             }
2384             if ($haseditabletypes) {
2385                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
2386             }
2387         } else if ($course->id == $SITE->id && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2389             // Add view grade report is permitted
2390             $reports = get_plugin_list('gradereport');
2391             arsort($reports); // user is last, we want to test it first
2393             $userscourses = enrol_get_users_courses($user->id);
2394             $userscoursesnode = $usernode->add(get_string('courses'));
2396             foreach ($userscourses as $usercourse) {
2397                 $usercoursecontext = get_context_instance(CONTEXT_COURSE, $usercourse->id);
2398                 $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext));
2399                 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
2401                 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2402                 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
2403                     foreach ($reports as $plugin => $plugindir) {
2404                         if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2405                             //stop when the first visible plugin is found
2406                             $gradeavailable = true;
2407                             break;
2408                         }
2409                     }
2410                 }
2412                 if ($gradeavailable) {
2413                     $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
2414                     $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
2415                 }
2417                 // Add a node to view the users notes if permitted
2418                 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2419                     $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
2420                     $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2421                 }
2423                 if (can_access_course($usercourse, $user->id)) {
2424                     $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', ''));
2425                 }
2427                 $reporttab = $usercoursenode->add(get_string('activityreports'));
2429                 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2430                 foreach ($reports as $reportfunction) {
2431                     $reportfunction($reporttab, $user, $usercourse);
2432                 }
2434                 $reporttab->trim_if_empty();
2435             }
2436         }
2437         return true;
2438     }
2440     /**
2441      * This method simply checks to see if a given module can extend the navigation.
2442      *
2443      * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2444      *
2445      * @param string $modname
2446      * @return bool
2447      */
2448     protected static function module_extends_navigation($modname) {
2449         global $CFG;
2450         static $extendingmodules = array();
2451         if (!array_key_exists($modname, $extendingmodules)) {
2452             $extendingmodules[$modname] = false;
2453             $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2454             if (file_exists($file)) {
2455                 $function = $modname.'_extend_navigation';
2456                 require_once($file);
2457                 $extendingmodules[$modname] = (function_exists($function));
2458             }
2459         }
2460         return $extendingmodules[$modname];
2461     }
2462     /**
2463      * Extends the navigation for the given user.
2464      *
2465      * @param stdClass $user A user from the database
2466      */
2467     public function extend_for_user($user) {
2468         $this->extendforuser[] = $user;
2469     }
2471     /**
2472      * Returns all of the users the navigation is being extended for
2473      *
2474      * @return array An array of extending users.
2475      */
2476     public function get_extending_users() {
2477         return $this->extendforuser;
2478     }
2479     /**
2480      * Adds the given course to the navigation structure.
2481      *
2482      * @param stdClass $course
2483      * @param bool $forcegeneric
2484      * @param bool $ismycourse
2485      * @return navigation_node
2486      */
2487     public function add_course(stdClass $course, $forcegeneric = false, $ismycourse = false) {
2488         global $CFG, $SITE;
2490         // We found the course... we can return it now :)
2491         if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2492             return $this->addedcourses[$course->id];
2493         }
2495         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2497         if ($course->id != $SITE->id && !$course->visible) {
2498             if (is_role_switched($course->id)) {
2499                 // user has to be able to access course in order to switch, let's skip the visibility test here
2500             } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2501                 return false;
2502             }
2503         }
2505         $issite = ($course->id == $SITE->id);
2506         $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
2508         if ($issite) {
2509             $parent = $this;
2510             $url = null;
2511             if (empty($CFG->usesitenameforsitepages)) {
2512                 $shortname = get_string('sitepages');
2513             }
2514         } else if ($ismycourse && !$forcegeneric) {
2515             if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_CATEGORY))) {
2516                 // Nothing to do here the above statement set $parent to the category within mycourses.
2517             } else {
2518                 $parent = $this->rootnodes['mycourses'];
2519             }
2520             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2521         } else {
2522             $parent = $this->rootnodes['courses'];
2523             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2524             if (!empty($course->category) && $this->show_categories()) {
2525                 if ($this->show_categories() && !$this->is_category_fully_loaded($course->category)) {
2526                     // We need to load the category structure for this course
2527                     $this->load_all_categories($course->category, false);
2528                 }
2529                 if (array_key_exists($course->category, $this->addedcategories)) {
2530                     $parent = $this->addedcategories[$course->category];
2531                     // This could lead to the course being created so we should check whether it is the case again
2532                     if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2533                         return $this->addedcourses[$course->id];
2534                     }
2535                 }
2536             }
2537         }
2539         $coursenode = $parent->add($shortname, $url, self::TYPE_COURSE, $shortname, $course->id);
2540         $coursenode->nodetype = self::NODETYPE_BRANCH;
2541         $coursenode->hidden = (!$course->visible);
2542         $coursenode->title(format_string($course->fullname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id))));
2543         if (!$forcegeneric) {
2544             $this->addedcourses[$course->id] = $coursenode;
2545         }
2547         return $coursenode;
2548     }
2550     /**
2551      * Returns true if the category has already been loaded as have any child categories
2552      *
2553      * @param int $categoryid
2554      * @return bool
2555      */
2556     protected function is_category_fully_loaded($categoryid) {
2557         return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0));
2558     }
2560     /**
2561      * Adds essential course nodes to the navigation for the given course.
2562      *
2563      * This method adds nodes such as reports, blogs and participants
2564      *
2565      * @param navigation_node $coursenode
2566      * @param stdClass $course
2567      * @return bool returns true on successful addition of a node.
2568      */
2569     public function add_course_essentials($coursenode, stdClass $course) {
2570         global $CFG, $SITE;
2572         if ($course->id == $SITE->id) {
2573             return $this->add_front_page_course_essentials($coursenode, $course);
2574         }
2576         if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2577             return true;
2578         }
2580         //Participants
2581         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
2582             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
2583             $currentgroup = groups_get_course_group($course, true);
2584             if ($course->id == $SITE->id) {
2585                 $filterselect = '';
2586             } else if ($course->id && !$currentgroup) {
2587                 $filterselect = $course->id;
2588             } else {
2589                 $filterselect = $currentgroup;
2590             }
2591             $filterselect = clean_param($filterselect, PARAM_INT);
2592             if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2593                and has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
2594                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2595                 $participants->add(get_string('blogscourse','blog'), $blogsurls->out());
2596             }
2597             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2598                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id)));
2599             }
2600         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2601             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2602         }
2604         // View course reports
2605         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
2606             $reportnav = $coursenode->add(get_string('reports'), null, self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2607             $coursereports = get_plugin_list('coursereport'); // deprecated
2608             foreach ($coursereports as $report=>$dir) {
2609                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2610                 if (file_exists($libfile)) {
2611                     require_once($libfile);
2612                     $reportfunction = $report.'_report_extend_navigation';
2613                     if (function_exists($report.'_report_extend_navigation')) {
2614                         $reportfunction($reportnav, $course, $this->page->context);
2615                     }
2616                 }
2617             }
2619             $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
2620             foreach ($reports as $reportfunction) {
2621                 $reportfunction($reportnav, $course, $this->page->context);
2622             }
2623         }
2624         return true;
2625     }
2626     /**
2627      * This generates the structure of the course that won't be generated when
2628      * the modules and sections are added.
2629      *
2630      * Things such as the reports branch, the participants branch, blogs... get
2631      * added to the course node by this method.
2632      *
2633      * @param navigation_node $coursenode
2634      * @param stdClass $course
2635      * @return bool True for successfull generation
2636      */
2637     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2638         global $CFG;
2640         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2641             return true;
2642         }
2644         // Hidden node that we use to determine if the front page navigation is loaded.
2645         // This required as there are not other guaranteed nodes that may be loaded.
2646         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2648         //Participants
2649         if (has_capability('moodle/course:viewparticipants',  get_system_context())) {
2650             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2651         }
2653         $filterselect = 0;
2655         // Blogs
2656         if (!empty($CFG->bloglevel)
2657           and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2658           and has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
2659             $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2660             $coursenode->add(get_string('blogssite','blog'), $blogsurls->out());
2661         }
2663         // Notes
2664         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2665             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2666         }
2668         // Tags
2669         if (!empty($CFG->usetags) && isloggedin()) {
2670             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2671         }
2673         if (isloggedin()) {
2674             // Calendar
2675             $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2676             $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self::TYPE_CUSTOM, null, 'calendar');
2677         }
2679         // View course reports
2680         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
2681             $reportnav = $coursenode->add(get_string('reports'), null, self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2682             $coursereports = get_plugin_list('coursereport'); // deprecated
2683             foreach ($coursereports as $report=>$dir) {
2684                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2685                 if (file_exists($libfile)) {
2686                     require_once($libfile);
2687                     $reportfunction = $report.'_report_extend_navigation';
2688                     if (function_exists($report.'_report_extend_navigation')) {
2689                         $reportfunction($reportnav, $course, $this->page->context);
2690                     }
2691                 }
2692             }
2694             $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
2695             foreach ($reports as $reportfunction) {
2696                 $reportfunction($reportnav, $course, $this->page->context);
2697             }
2698         }
2699         return true;
2700     }
2702     /**
2703      * Clears the navigation cache
2704      */
2705     public function clear_cache() {
2706         $this->cache->clear();
2707     }
2709     /**
2710      * Sets an expansion limit for the navigation
2711      *
2712      * The expansion limit is used to prevent the display of content that has a type
2713      * greater than the provided $type.
2714      *
2715      * Can be used to ensure things such as activities or activity content don't get
2716      * shown on the navigation.
2717      * They are still generated in order to ensure the navbar still makes sense.
2718      *
2719      * @param int $type One of navigation_node::TYPE_*
2720      * @return bool true when complete.
2721      */
2722     public function set_expansion_limit($type) {
2723         global $SITE;
2724         $nodes = $this->find_all_of_type($type);
2725         foreach ($nodes as &$node) {
2726             // We need to generate the full site node
2727             if ($type == self::TYPE_COURSE && $node->key == $SITE->id) {
2728                 continue;
2729             }
2730             foreach ($node->children as &$child) {
2731                 // We still want to show course reports and participants containers
2732                 // or there will be navigation missing.
2733                 if ($type == self::TYPE_COURSE && $child->type === self::TYPE_CONTAINER) {
2734                     continue;
2735                 }
2736                 $child->display = false;
2737             }
2738         }
2739         return true;
2740     }
2741     /**
2742      * Attempts to get the navigation with the given key from this nodes children.
2743      *
2744      * This function only looks at this nodes children, it does NOT look recursivily.
2745      * If the node can't be found then false is returned.
2746      *
2747      * If you need to search recursivily then use the {@link global_navigation::find()} method.
2748      *
2749      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2750      * may be of more use to you.
2751      *
2752      * @param string|int $key The key of the node you wish to receive.
2753      * @param int $type One of navigation_node::TYPE_*
2754      * @return navigation_node|false
2755      */
2756     public function get($key, $type = null) {
2757         if (!$this->initialised) {
2758             $this->initialise();
2759         }
2760         return parent::get($key, $type);
2761     }
2763     /**
2764      * Searches this nodes children and their children to find a navigation node
2765      * with the matching key and type.
2766      *
2767      * This method is recursive and searches children so until either a node is
2768      * found or there are no more nodes to search.
2769      *
2770      * If you know that the node being searched for is a child of this node
2771      * then use the {@link global_navigation::get()} method instead.
2772      *
2773      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2774      * may be of more use to you.
2775      *
2776      * @param string|int $key The key of the node you wish to receive.
2777      * @param int $type One of navigation_node::TYPE_*
2778      * @return navigation_node|false
2779      */
2780     public function find($key, $type) {
2781         if (!$this->initialised) {
2782             $this->initialise();
2783         }
2784         return parent::find($key, $type);
2785     }
2788 /**
2789  * The global navigation class used especially for AJAX requests.
2790  *
2791  * The primary methods that are used in the global navigation class have been overriden
2792  * to ensure that only the relevant branch is generated at the root of the tree.
2793  * This can be done because AJAX is only used when the backwards structure for the
2794  * requested branch exists.
2795  * This has been done only because it shortens the amounts of information that is generated
2796  * which of course will speed up the response time.. because no one likes laggy AJAX.
2797  *
2798  * @package   core
2799  * @category  navigation
2800  * @copyright 2009 Sam Hemelryk
2801  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2802  */
2803 class global_navigation_for_ajax extends global_navigation {
2805     /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2806     protected $branchtype;
2808     /** @var int the instance id */
2809     protected $instanceid;
2811     /** @var array Holds an array of expandable nodes */
2812     protected $expandable = array();
2814     /**
2815      * Constructs the navigation for use in an AJAX request
2816      *
2817      * @param moodle_page $page moodle_page object
2818      * @param int $branchtype
2819      * @param int $id
2820      */
2821     public function __construct($page, $branchtype, $id) {
2822         $this->page = $page;
2823         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2824         $this->children = new navigation_node_collection();
2825         $this->branchtype = $branchtype;
2826         $this->instanceid = $id;
2827         $this->initialise();
2828     }
2829     /**
2830      * Initialise the navigation given the type and id for the branch to expand.
2831      *
2832      * @return array An array of the expandable nodes
2833      */
2834     public function initialise() {
2835         global $CFG, $DB, $SITE;
2837         if ($this->initialised || during_initial_install()) {
2838             return $this->expandable;
2839         }
2840         $this->initialised = true;
2842         $this->rootnodes = array();
2843         $this->rootnodes['site']    = $this->add_course($SITE);
2844         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2846         // Branchtype will be one of navigation_node::TYPE_*
2847         switch ($this->branchtype) {
2848             case self::TYPE_CATEGORY :
2849                 $this->load_category($this->instanceid);
2850                 break;
2851             case self::TYPE_COURSE :
2852                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
2853                 require_course_login($course, true, null, false, true);
2854                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2855                 $coursenode = $this->add_course($course);
2856                 $this->add_course_essentials($coursenode, $course);
2857                 if ($this->format_display_course_content($course->format)) {
2858                     $this->load_course_sections($course, $coursenode);
2859                 }
2860                 break;
2861             case self::TYPE_SECTION :
2862                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2863                         FROM {course} c
2864                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2865                         WHERE cs.id = ?';
2866                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
2867                 require_course_login($course, true, null, false, true);
2868                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2869                 $coursenode = $this->add_course($course);
2870                 $this->add_course_essentials($coursenode, $course);
2871                 $sections = $this->load_course_sections($course, $coursenode);
2872                 list($sectionarray, $activities) = $this->generate_sections_and_activities($course);
2873                 $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, $activities);
2874                 break;
2875             case self::TYPE_ACTIVITY :
2876                 $sql = "SELECT c.*
2877                           FROM {course} c
2878                           JOIN {course_modules} cm ON cm.course = c.id
2879                          WHERE cm.id = :cmid";
2880                 $params = array('cmid' => $this->instanceid);
2881                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
2882                 $modinfo = get_fast_modinfo($course);
2883                 $cm = $modinfo->get_cm($this->instanceid);
2884                 require_course_login($course, true, $cm, false, true);
2885                 $this->page->set_context(get_context_instance(CONTEXT_MODULE, $cm->id));
2886                 $coursenode = $this->load_course($course);
2887                 if ($course->id == $SITE->id) {
2888                     $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY));
2889                 } else {
2890                     $sections   = $this->load_course_sections($course, $coursenode);
2891                     list($sectionarray, $activities) = $this->generate_sections_and_activities($course);
2892                     $activities = $this->load_section_activities($sections[$cm->sectionnum]->sectionnode, $cm->sectionnum, $activities);
2893                     $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]);
2894                 }
2895                 break;
2896             default:
2897                 throw new Exception('Unknown type');
2898                 return $this->expandable;
2899         }
2901         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) {
2902             $this->load_for_user(null, true);
2903         }
2905         $this->find_expandable($this->expandable);
2906         return $this->expandable;
2907     }
2909     /**
2910      * Loads a single category into the AJAX navigation.
2911      *
2912      * This function is special in that it doesn't concern itself with the parent of
2913      * the requested category or its siblings.
2914      * This is because with the AJAX navigation we know exactly what is wanted and only need to
2915      * request that.
2916      *
2917      * @global moodle_database $DB
2918      * @param int $categoryid
2919      */
2920     protected function load_category($categoryid) {
2921         global $CFG, $DB;
2923         $limit = 20;
2924         if (!empty($CFG->navcourselimit)) {
2925             $limit = (int)$CFG->navcourselimit;
2926         }
2928         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
2929         $sql = "SELECT cc.*, $catcontextsql
2930                   FROM {course_categories} cc
2931                   JOIN {context} ctx ON cc.id = ctx.instanceid
2932                  WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND
2933                        (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2934               ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2935         $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2936         $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2937         $subcategories = array();
2938         $basecategory = null;
2939         foreach ($categories as $category) {
2940             context_helper::preload_from_record($category);
2941             if ($category->id == $categoryid) {
2942                 $this->add_category($category, $this);
2943                 $basecategory = $this->addedcategories[$category->id];
2944             } else {
2945                 $subcategories[] = $category;
2946             }
2947         }
2948         $categories->close();
2950         if (!is_null($basecategory)) {
2951             //echo "<pre>".print_r($subcategories, true).'</pre>';
2952             foreach ($subcategories as $category) {
2953                 $this->add_category($category, $basecategory);
2954             }
2955         }
2957         $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
2958         foreach ($courses as $course) {
2959             $this->add_course($course);
2960         }
2961         $courses->close();
2962     }
2964     /**
2965      * Returns an array of expandable nodes
2966      * @return array
2967      */
2968     public function get_expandable() {
2969         return $this->expandable;
2970     }
2973 /**
2974  * Navbar class
2975  *
2976  * This class is used to manage the navbar, which is initialised from the navigation
2977  * object held by PAGE
2978  *
2979  * @package   core
2980  * @category  navigation
2981  * @copyright 2009 Sam Hemelryk
2982  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2983  */
2984 class navbar extends navigation_node {
2985     /** @var bool A switch for whether the navbar is initialised or not */
2986     protected $initialised = false;
2987     /** @var mixed keys used to reference the nodes on the navbar */
2988     protected $keys = array();
2989     /** @var null|string content of the navbar */
2990     protected $content = null;
2991     /** @var moodle_page object the moodle page that this navbar belongs to */
2992     protected $page;
2993     /** @var bool A switch for whether to ignore the active navigation information */
2994     protected $ignoreactive = false;
2995     /** @var bool A switch to let us know if we are in the middle of an install */
2996     protected $duringinstall = false;
2997     /** @var bool A switch for whether the navbar has items */
2998     protected $hasitems = false;
2999     /** @var array An array of navigation nodes for the navbar */
3000     protected $items;
3001     /** @var array An array of child node objects */
3002     public $children = array();
3003     /** @var bool A switch for whether we want to include the root node in the navbar */
3004     public $includesettingsbase = false;
3005     /**
3006      * The almighty constructor
3007      *
3008      * @param moodle_page $page
3009      */
3010     public function __construct(moodle_page $page) {
3011         global $CFG;
3012         if (during_initial_install()) {
3013             $this->duringinstall = true;
3014             return false;
3015         }
3016         $this->page = $page;
3017         $this->text = get_string('home');
3018         $this->shorttext = get_string('home');
3019         $this->action = new moodle_url($CFG->wwwroot);
3020         $this->nodetype = self::NODETYPE_BRANCH;
3021         $this->type = self::TYPE_SYSTEM;
3022     }
3024     /**
3025      * Quick check to see if the navbar will have items in.
3026      *
3027      * @return bool Returns true if the navbar will have items, false otherwise
3028      */
3029     public function has_items() {
3030         if ($this->duringinstall) {
3031             return false;
3032         } else if ($this->hasitems !== false) {
3033             return true;
3034         }
3035         $this->page->navigation->initialise($this->page);
3037         $activenodefound = ($this->page->navigation->contains_active_node() ||
3038                             $this->page->settingsnav->contains_active_node());
3040         $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
3041         $this->hasitems = $outcome;
3042         return $outcome;
3043     }
3045     /**
3046      * Turn on/off ignore active
3047      *
3048      * @param bool $setting
3049      */
3050     public function ignore_active($setting=true) {
3051         $this->ignoreactive = ($setting);
3052     }
3054     /**
3055      * Gets a navigation node
3056      *
3057      * @param string|int $key for referencing the navbar nodes
3058      * @param int $type navigation_node::TYPE_*
3059      * @return navigation_node|bool
3060      */
3061     public function get($key, $type = null) {
3062         foreach ($this->children as &$child) {
3063             if ($child->key === $key && ($type == null || $type == $child->type)) {
3064                 return $child;
3065             }
3066         }
3067         return false;
3068     }
3069     /**
3070      * Returns an array of navigation_node's that make up the navbar.
3071      *
3072      * @return array
3073      */
3074     public function get_items() {
3075         $items = array();
3076         // Make sure that navigation is initialised
3077         if (!$this->has_items()) {
3078             return $items;
3079         }
3080         if ($this->items !== null) {
3081             return $this->items;
3082         }
3084         if (count($this->children) > 0) {
3085             // Add the custom children
3086             $items = array_reverse($this->children);
3087         }
3089         $navigationactivenode = $this->page->navigation->find_active_node();
3090         $settingsactivenode = $this->page->settingsnav->find_active_node();
3092         // Check if navigation contains the active node
3093         if (!$this->ignoreactive) {
3095             if ($navigationactivenode && $settingsactivenode) {
3096                 // Parse a combined navigation tree
3097                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3098                     if (!$settingsactivenode->mainnavonly) {
3099                         $items[] = $settingsactivenode;
3100                     }
3101                     $settingsactivenode = $settingsactivenode->parent;
3102                 }
3103                 if (!$this->includesettingsbase) {
3104                     // Removes the first node from the settings (root node) from the list
3105                     array_pop($items);
3106                 }
3107                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3108                     if (!$navigationactivenode->mainnavonly) {
3109                         $items[] = $navigationactivenode;
3110                     }
3111                     $navigationactivenode = $navigationactivenode->parent;
3112                 }
3113             } else if ($navigationactivenode) {
3114                 // Parse the navigation tree to get the active node
3115                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3116                     if (!$navigationactivenode->mainnavonly) {
3117                         $items[] = $navigationactivenode;
3118                     }
3119                     $navigationactivenode = $navigationactivenode->parent;
3120                 }
3121             } else if ($settingsactivenode) {
3122                 // Parse the settings navigation to get the active node
3123                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3124                     if (!$settingsactivenode->mainnavonly) {
3125                         $items[] = $settingsactivenode;
3126                     }
3127                     $settingsactivenode = $settingsactivenode->parent;
3128                 }
3129             }
3130         }
3132         $items[] = new navigation_node(array(
3133             'text'=>$this->page->navigation->text,
3134             'shorttext'=>$this->page->navigation->shorttext,
3135             'key'=>$this->page->navigation->key,
3136             'action'=>$this->page->navigation->action
3137         ));
3139         $this->items = array_reverse($items);
3140         return $this->items;
3141     }
3143     /**
3144      * Add a new navigation_node to the navbar, overrides parent::add
3145      *
3146      * This function overrides {@link navigation_node::add()} so that we can change
3147      * the way nodes get added to allow us to simply call add and have the node added to the
3148      * end of the navbar
3149      *
3150      * @param string $text
3151      * @param string|moodle_url|action_link $action An action to associate with this node.
3152      * @param int $type One of navigation_node::TYPE_*
3153      * @param string $shorttext
3154      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3155      * @param pix_icon $icon An optional icon to use for this node.
3156      * @return navigation_node
3157      */
3158     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3159         if ($this->content !== null) {
3160             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3161         }
3163         // Properties array used when creating the new navigation node
3164         $itemarray = array(
3165             'text' => $text,
3166             'type' => $type
3167         );
3168         // Set the action if one was provided
3169         if ($action!==null) {
3170             $itemarray['action'] = $action;
3171         }
3172         // Set the shorttext if one was provided
3173         if ($shorttext!==null) {
3174             $itemarray['shorttext'] = $shorttext;
3175         }
3176         // Set the icon if one was provided
3177         if ($icon!==null) {
3178             $itemarray['icon'] = $icon;
3179         }
3180         // Default the key to the number of children if not provided
3181         if ($key === null) {
3182             $key = count($this->children);
3183         }
3184         // Set the key
3185         $itemarray['key'] = $key;
3186         // Set the parent to this node
3187         $itemarray['parent'] = $this;
3188         // Add the child using the navigation_node_collections add method
3189         $this->children[] = new navigation_node($itemarray);
3190         return $this;
3191     }
3194 /**
3195  * Class used to manage the settings option for the current page
3196  *
3197  * This class is used to manage the settings options in a tree format (recursively)
3198  * and was created initially for use with the settings blocks.
3199  *
3200  * @package   core
3201  * @category  navigation
3202  * @copyright 2009 Sam Hemelryk
3203  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3204  */
3205 class settings_navigation extends navigation_node {
3206     /** @var stdClass the current context */
3207     protected $context;
3208     /** @var moodle_page the moodle page that the navigation belongs to */
3209     protected $page;
3210     /** @var string contains administration section navigation_nodes */
3211     protected $adminsection;
3212     /** @var bool A switch to see if the navigation node is initialised */
3213     protected $initialised = false;
3214     /** @var array An array of users that the nodes can extend for. */
3215     protected $userstoextendfor = array();
3216     /** @var navigation_cache **/
3217     protected $cache;
3219     /**
3220      * Sets up the object with basic settings and preparse it for use
3221      *
3222      * @param moodle_page $page
3223      */
3224     public function __construct(moodle_page &$page) {
3225         if (during_initial_install()) {
3226             return false;
3227         }
3228         $this->page = $page;
3229         // Initialise the main navigation. It is most important that this is done
3230         // before we try anything
3231         $this->page->navigation->initialise();
3232         // Initialise the navigation cache
3233         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
3234         $this->children = new navigation_node_collection();
3235     }
3236     /**
3237      * Initialise the settings navigation based on the current context
3238      *
3239      * This function initialises the settings navigation tree for a given context
3240      * by calling supporting functions to generate major parts of the tree.
3241      *
3242      */
3243     public function initialise() {
3244         global $DB, $SESSION, $SITE;
3246         if (during_initial_install()) {
3247             return false;
3248         } else if ($this->initialised) {
3249             return true;
3250         }
3251         $this->id = 'settingsnav';
3252         $this->context = $this->page->context;
3254         $context = $this->context;
3255         if ($context->contextlevel == CONTEXT_BLOCK) {
3256             $this->load_block_settings();
3257             $context = $context->get_parent_context();
3258         }
3260         switch ($context->contextlevel) {
3261             case CONTEXT_SYSTEM:
3262                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
3263                     $this->load_front_page_settings(($context->id == $this->context->id));
3264                 }
3265                 break;
3266             case CONTEXT_COURSECAT:
3267                 $this->load_category_settings();