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