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