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