13feb3bbc0d541469387af76a2bf3410beff55dc
[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, 'myhome', 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         if (!core_course_category::user_top()) {
1302             $this->rootnodes['courses']->hide();
1303         }
1304         $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
1306         // We always load the frontpage course to ensure it is available without
1307         // JavaScript enabled.
1308         $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE);
1309         $this->load_course_sections($SITE, $this->rootnodes['site']);
1311         $course = $this->page->course;
1312         $this->load_courses_enrolled();
1314         // $issite gets set to true if the current pages course is the sites frontpage course
1315         $issite = ($this->page->course->id == $SITE->id);
1317         // Determine if the user is enrolled in any course.
1318         $enrolledinanycourse = enrol_user_sees_own_courses();
1320         $this->rootnodes['currentcourse']->mainnavonly = true;
1321         if ($enrolledinanycourse) {
1322             $this->rootnodes['mycourses']->isexpandable = true;
1323             $this->rootnodes['mycourses']->showinflatnavigation = true;
1324             if ($CFG->navshowallcourses) {
1325                 // When we show all courses we need to show both the my courses and the regular courses branch.
1326                 $this->rootnodes['courses']->isexpandable = true;
1327             }
1328         } else {
1329             $this->rootnodes['courses']->isexpandable = true;
1330         }
1331         $this->rootnodes['mycourses']->forceopen = true;
1333         $canviewcourseprofile = true;
1335         // Next load context specific content into the navigation
1336         switch ($this->page->context->contextlevel) {
1337             case CONTEXT_SYSTEM :
1338                 // Nothing left to do here I feel.
1339                 break;
1340             case CONTEXT_COURSECAT :
1341                 // This is essential, we must load categories.
1342                 $this->load_all_categories($this->page->context->instanceid, true);
1343                 break;
1344             case CONTEXT_BLOCK :
1345             case CONTEXT_COURSE :
1346                 if ($issite) {
1347                     // Nothing left to do here.
1348                     break;
1349                 }
1351                 // Load the course associated with the current page into the navigation.
1352                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1353                 // If the course wasn't added then don't try going any further.
1354                 if (!$coursenode) {
1355                     $canviewcourseprofile = false;
1356                     break;
1357                 }
1359                 // If the user is not enrolled then we only want to show the
1360                 // course node and not populate it.
1362                 // Not enrolled, can't view, and hasn't switched roles
1363                 if (!can_access_course($course, null, '', true)) {
1364                     if ($coursenode->isexpandable === true) {
1365                         // Obviously the situation has changed, update the cache and adjust the node.
1366                         // This occurs if the user access to a course has been revoked (one way or another) after
1367                         // initially logging in for this session.
1368                         $this->get_expand_course_cache()->set($course->id, 1);
1369                         $coursenode->isexpandable = true;
1370                         $coursenode->nodetype = self::NODETYPE_BRANCH;
1371                     }
1372                     // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1373                     // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1374                     if (!$this->current_user_is_parent_role()) {
1375                         $coursenode->make_active();
1376                         $canviewcourseprofile = false;
1377                         break;
1378                     }
1379                 } else if ($coursenode->isexpandable === false) {
1380                     // Obviously the situation has changed, update the cache and adjust the node.
1381                     // This occurs if the user has been granted access to a course (one way or another) after initially
1382                     // logging in for this session.
1383                     $this->get_expand_course_cache()->set($course->id, 1);
1384                     $coursenode->isexpandable = true;
1385                     $coursenode->nodetype = self::NODETYPE_BRANCH;
1386                 }
1388                 // Add the essentials such as reports etc...
1389                 $this->add_course_essentials($coursenode, $course);
1390                 // Extend course navigation with it's sections/activities
1391                 $this->load_course_sections($course, $coursenode);
1392                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1393                     $coursenode->make_active();
1394                 }
1396                 break;
1397             case CONTEXT_MODULE :
1398                 if ($issite) {
1399                     // If this is the site course then most information will have
1400                     // already been loaded.
1401                     // However we need to check if there is more content that can
1402                     // yet be loaded for the specific module instance.
1403                     $activitynode = $this->rootnodes['site']->find($this->page->cm->id, navigation_node::TYPE_ACTIVITY);
1404                     if ($activitynode) {
1405                         $this->load_activity($this->page->cm, $this->page->course, $activitynode);
1406                     }
1407                     break;
1408                 }
1410                 $course = $this->page->course;
1411                 $cm = $this->page->cm;
1413                 // Load the course associated with the page into the navigation
1414                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1416                 // If the course wasn't added then don't try going any further.
1417                 if (!$coursenode) {
1418                     $canviewcourseprofile = false;
1419                     break;
1420                 }
1422                 // If the user is not enrolled then we only want to show the
1423                 // course node and not populate it.
1424                 if (!can_access_course($course, null, '', true)) {
1425                     $coursenode->make_active();
1426                     $canviewcourseprofile = false;
1427                     break;
1428                 }
1430                 $this->add_course_essentials($coursenode, $course);
1432                 // Load the course sections into the page
1433                 $this->load_course_sections($course, $coursenode, null, $cm);
1434                 $activity = $coursenode->find($cm->id, navigation_node::TYPE_ACTIVITY);
1435                 if (!empty($activity)) {
1436                     // Finally load the cm specific navigaton information
1437                     $this->load_activity($cm, $course, $activity);
1438                     // Check if we have an active ndoe
1439                     if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1440                         // And make the activity node active.
1441                         $activity->make_active();
1442                     }
1443                 }
1444                 break;
1445             case CONTEXT_USER :
1446                 if ($issite) {
1447                     // The users profile information etc is already loaded
1448                     // for the front page.
1449                     break;
1450                 }
1451                 $course = $this->page->course;
1452                 // Load the course associated with the user into the navigation
1453                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1455                 // If the course wasn't added then don't try going any further.
1456                 if (!$coursenode) {
1457                     $canviewcourseprofile = false;
1458                     break;
1459                 }
1461                 // If the user is not enrolled then we only want to show the
1462                 // course node and not populate it.
1463                 if (!can_access_course($course, null, '', true)) {
1464                     $coursenode->make_active();
1465                     $canviewcourseprofile = false;
1466                     break;
1467                 }
1468                 $this->add_course_essentials($coursenode, $course);
1469                 $this->load_course_sections($course, $coursenode);
1470                 break;
1471         }
1473         // Load for the current user
1474         $this->load_for_user();
1475         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) {
1476             $this->load_for_user(null, true);
1477         }
1478         // Load each extending user into the navigation.
1479         foreach ($this->extendforuser as $user) {
1480             if ($user->id != $USER->id) {
1481                 $this->load_for_user($user);
1482             }
1483         }
1485         // Give the local plugins a chance to include some navigation if they want.
1486         $this->load_local_plugin_navigation();
1488         // Remove any empty root nodes
1489         foreach ($this->rootnodes as $node) {
1490             // Dont remove the home node
1491             /** @var navigation_node $node */
1492             if (!in_array($node->key, ['home', 'myhome']) && !$node->has_children() && !$node->isactive) {
1493                 $node->remove();
1494             }
1495         }
1497         if (!$this->contains_active_node()) {
1498             $this->search_for_active_node();
1499         }
1501         // If the user is not logged in modify the navigation structure as detailed
1502         // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1503         if (!isloggedin()) {
1504             $activities = clone($this->rootnodes['site']->children);
1505             $this->rootnodes['site']->remove();
1506             $children = clone($this->children);
1507             $this->children = new navigation_node_collection();
1508             foreach ($activities as $child) {
1509                 $this->children->add($child);
1510             }
1511             foreach ($children as $child) {
1512                 $this->children->add($child);
1513             }
1514         }
1515         return true;
1516     }
1518     /**
1519      * This function gives local plugins an opportunity to modify navigation.
1520      */
1521     protected function load_local_plugin_navigation() {
1522         foreach (get_plugin_list_with_function('local', 'extend_navigation') as $function) {
1523             $function($this);
1524         }
1525     }
1527     /**
1528      * Returns true if the current user is a parent of the user being currently viewed.
1529      *
1530      * If the current user is not viewing another user, or if the current user does not hold any parent roles over the
1531      * other user being viewed this function returns false.
1532      * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()}
1533      *
1534      * @since Moodle 2.4
1535      * @return bool
1536      */
1537     protected function current_user_is_parent_role() {
1538         global $USER, $DB;
1539         if ($this->useridtouseforparentchecks && $this->useridtouseforparentchecks != $USER->id) {
1540             $usercontext = context_user::instance($this->useridtouseforparentchecks, MUST_EXIST);
1541             if (!has_capability('moodle/user:viewdetails', $usercontext)) {
1542                 return false;
1543             }
1544             if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))) {
1545                 return true;
1546             }
1547         }
1548         return false;
1549     }
1551     /**
1552      * Returns true if courses should be shown within categories on the navigation.
1553      *
1554      * @param bool $ismycourse Set to true if you are calculating this for a course.
1555      * @return bool
1556      */
1557     protected function show_categories($ismycourse = false) {
1558         global $CFG, $DB;
1559         if ($ismycourse) {
1560             return $this->show_my_categories();
1561         }
1562         if ($this->showcategories === null) {
1563             $show = false;
1564             if ($this->page->context->contextlevel == CONTEXT_COURSECAT) {
1565                 $show = true;
1566             } else if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1) {
1567                 $show = true;
1568             }
1569             $this->showcategories = $show;
1570         }
1571         return $this->showcategories;
1572     }
1574     /**
1575      * Returns true if we should show categories in the My Courses branch.
1576      * @return bool
1577      */
1578     protected function show_my_categories() {
1579         global $CFG;
1580         if ($this->showmycategories === null) {
1581             $this->showmycategories = !empty($CFG->navshowmycoursecategories) && !core_course_category::is_simple_site();
1582         }
1583         return $this->showmycategories;
1584     }
1586     /**
1587      * Loads the courses in Moodle into the navigation.
1588      *
1589      * @global moodle_database $DB
1590      * @param string|array $categoryids An array containing categories to load courses
1591      *                     for, OR null to load courses for all categories.
1592      * @return array An array of navigation_nodes one for each course
1593      */
1594     protected function load_all_courses($categoryids = null) {
1595         global $CFG, $DB, $SITE;
1597         // Work out the limit of courses.
1598         $limit = 20;
1599         if (!empty($CFG->navcourselimit)) {
1600             $limit = $CFG->navcourselimit;
1601         }
1603         $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES;
1605         // If we are going to show all courses AND we are showing categories then
1606         // to save us repeated DB calls load all of the categories now
1607         if ($this->show_categories()) {
1608             $this->load_all_categories($toload);
1609         }
1611         // Will be the return of our efforts
1612         $coursenodes = array();
1614         // Check if we need to show categories.
1615         if ($this->show_categories()) {
1616             // Hmmm we need to show categories... this is going to be painful.
1617             // We now need to fetch up to $limit courses for each category to
1618             // be displayed.
1619             if ($categoryids !== null) {
1620                 if (!is_array($categoryids)) {
1621                     $categoryids = array($categoryids);
1622                 }
1623                 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc');
1624                 $categorywhere = 'WHERE cc.id '.$categorywhere;
1625             } else if ($toload == self::LOAD_ROOT_CATEGORIES) {
1626                 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1627                 $categoryparams = array();
1628             } else {
1629                 $categorywhere = '';
1630                 $categoryparams = array();
1631             }
1633             // First up we are going to get the categories that we are going to
1634             // need so that we can determine how best to load the courses from them.
1635             $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1636                         FROM {course_categories} cc
1637                     LEFT JOIN {course} c ON c.category = cc.id
1638                             {$categorywhere}
1639                     GROUP BY cc.id";
1640             $categories = $DB->get_recordset_sql($sql, $categoryparams);
1641             $fullfetch = array();
1642             $partfetch = array();
1643             foreach ($categories as $category) {
1644                 if (!$this->can_add_more_courses_to_category($category->id)) {
1645                     continue;
1646                 }
1647                 if ($category->coursecount > $limit * 5) {
1648                     $partfetch[] = $category->id;
1649                 } else if ($category->coursecount > 0) {
1650                     $fullfetch[] = $category->id;
1651                 }
1652             }
1653             $categories->close();
1655             if (count($fullfetch)) {
1656                 // First up fetch all of the courses in categories where we know that we are going to
1657                 // need the majority of courses.
1658                 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory');
1659                 $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1660                 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1661                 $categoryparams['contextlevel'] = CONTEXT_COURSE;
1662                 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1663                             FROM {course} c
1664                                 $ccjoin
1665                             WHERE c.category {$categoryids}
1666                         ORDER BY c.sortorder ASC";
1667                 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1668                 foreach ($coursesrs as $course) {
1669                     if ($course->id == $SITE->id) {
1670                         // This should not be necessary, frontpage is not in any category.
1671                         continue;
1672                     }
1673                     if (array_key_exists($course->id, $this->addedcourses)) {
1674                         // It is probably better to not include the already loaded courses
1675                         // directly in SQL because inequalities may confuse query optimisers
1676                         // and may interfere with query caching.
1677                         continue;
1678                     }
1679                     if (!$this->can_add_more_courses_to_category($course->category)) {
1680                         continue;
1681                     }
1682                     context_helper::preload_from_record($course);
1683                     if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1684                         continue;
1685                     }
1686                     $coursenodes[$course->id] = $this->add_course($course);
1687                 }
1688                 $coursesrs->close();
1689             }
1691             if (count($partfetch)) {
1692                 // Next we will work our way through the categories where we will likely only need a small
1693                 // proportion of the courses.
1694                 foreach ($partfetch as $categoryid) {
1695                     $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1696                     $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1697                     $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1698                                 FROM {course} c
1699                                     $ccjoin
1700                                 WHERE c.category = :categoryid
1701                             ORDER BY c.sortorder ASC";
1702                     $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE);
1703                     $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1704                     foreach ($coursesrs as $course) {
1705                         if ($course->id == $SITE->id) {
1706                             // This should not be necessary, frontpage is not in any category.
1707                             continue;
1708                         }
1709                         if (array_key_exists($course->id, $this->addedcourses)) {
1710                             // It is probably better to not include the already loaded courses
1711                             // directly in SQL because inequalities may confuse query optimisers
1712                             // and may interfere with query caching.
1713                             // This also helps to respect expected $limit on repeated executions.
1714                             continue;
1715                         }
1716                         if (!$this->can_add_more_courses_to_category($course->category)) {
1717                             break;
1718                         }
1719                         context_helper::preload_from_record($course);
1720                         if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1721                             continue;
1722                         }
1723                         $coursenodes[$course->id] = $this->add_course($course);
1724                     }
1725                     $coursesrs->close();
1726                 }
1727             }
1728         } else {
1729             // Prepare the SQL to load the courses and their contexts
1730             list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false);
1731             $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1732             $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1733             $courseparams['contextlevel'] = CONTEXT_COURSE;
1734             $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1735                         FROM {course} c
1736                             $ccjoin
1737                         WHERE c.id {$courseids}
1738                     ORDER BY c.sortorder ASC";
1739             $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1740             foreach ($coursesrs as $course) {
1741                 if ($course->id == $SITE->id) {
1742                     // frotpage is not wanted here
1743                     continue;
1744                 }
1745                 if ($this->page->course && ($this->page->course->id == $course->id)) {
1746                     // Don't include the currentcourse in this nodelist - it's displayed in the Current course node
1747                     continue;
1748                 }
1749                 context_helper::preload_from_record($course);
1750                 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1751                     continue;
1752                 }
1753                 $coursenodes[$course->id] = $this->add_course($course);
1754                 if (count($coursenodes) >= $limit) {
1755                     break;
1756                 }
1757             }
1758             $coursesrs->close();
1759         }
1761         return $coursenodes;
1762     }
1764     /**
1765      * Returns true if more courses can be added to the provided category.
1766      *
1767      * @param int|navigation_node|stdClass $category
1768      * @return bool
1769      */
1770     protected function can_add_more_courses_to_category($category) {
1771         global $CFG;
1772         $limit = 20;
1773         if (!empty($CFG->navcourselimit)) {
1774             $limit = (int)$CFG->navcourselimit;
1775         }
1776         if (is_numeric($category)) {
1777             if (!array_key_exists($category, $this->addedcategories)) {
1778                 return true;
1779             }
1780             $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE));
1781         } else if ($category instanceof navigation_node) {
1782             if (($category->type != self::TYPE_CATEGORY) || ($category->type != self::TYPE_MY_CATEGORY)) {
1783                 return false;
1784             }
1785             $coursecount = count($category->children->type(self::TYPE_COURSE));
1786         } else if (is_object($category) && property_exists($category,'id')) {
1787             $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE));
1788         }
1789         return ($coursecount <= $limit);
1790     }
1792     /**
1793      * Loads all categories (top level or if an id is specified for that category)
1794      *
1795      * @param int $categoryid The category id to load or null/0 to load all base level categories
1796      * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1797      *        as the requested category and any parent categories.
1798      * @return navigation_node|void returns a navigation node if a category has been loaded.
1799      */
1800     protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) {
1801         global $CFG, $DB;
1803         // Check if this category has already been loaded
1804         if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1805             return true;
1806         }
1808         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
1809         $sqlselect = "SELECT cc.*, $catcontextsql
1810                       FROM {course_categories} cc
1811                       JOIN {context} ctx ON cc.id = ctx.instanceid";
1812         $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT;
1813         $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1814         $params = array();
1816         $categoriestoload = array();
1817         if ($categoryid == self::LOAD_ALL_CATEGORIES) {
1818             // We are going to load all categories regardless... prepare to fire
1819             // on the database server!
1820         } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0
1821             // We are going to load all of the first level categories (categories without parents)
1822             $sqlwhere .= " AND cc.parent = 0";
1823         } else if (array_key_exists($categoryid, $this->addedcategories)) {
1824             // The category itself has been loaded already so we just need to ensure its subcategories
1825             // have been loaded
1826             $addedcategories = $this->addedcategories;
1827             unset($addedcategories[$categoryid]);
1828             if (count($addedcategories) > 0) {
1829                 list($sql, $params) = $DB->get_in_or_equal(array_keys($addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1830                 if ($showbasecategories) {
1831                     // We need to include categories with parent = 0 as well
1832                     $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1833                 } else {
1834                     // All we need is categories that match the parent
1835                     $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1836                 }
1837             }
1838             $params['categoryid'] = $categoryid;
1839         } else {
1840             // This category hasn't been loaded yet so we need to fetch it, work out its category path
1841             // and load this category plus all its parents and subcategories
1842             $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
1843             $categoriestoload = explode('/', trim($category->path, '/'));
1844             list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1845             // We are going to use select twice so double the params
1846             $params = array_merge($params, $params);
1847             $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':'';
1848             $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1849         }
1851         $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1852         $categories = array();
1853         foreach ($categoriesrs as $category) {
1854             // Preload the context.. we'll need it when adding the category in order
1855             // to format the category name.
1856             context_helper::preload_from_record($category);
1857             if (array_key_exists($category->id, $this->addedcategories)) {
1858                 // Do nothing, its already been added.
1859             } else if ($category->parent == '0') {
1860                 // This is a root category lets add it immediately
1861                 $this->add_category($category, $this->rootnodes['courses']);
1862             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1863                 // This categories parent has already been added we can add this immediately
1864                 $this->add_category($category, $this->addedcategories[$category->parent]);
1865             } else {
1866                 $categories[] = $category;
1867             }
1868         }
1869         $categoriesrs->close();
1871         // Now we have an array of categories we need to add them to the navigation.
1872         while (!empty($categories)) {
1873             $category = reset($categories);
1874             if (array_key_exists($category->id, $this->addedcategories)) {
1875                 // Do nothing
1876             } else if ($category->parent == '0') {
1877                 $this->add_category($category, $this->rootnodes['courses']);
1878             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1879                 $this->add_category($category, $this->addedcategories[$category->parent]);
1880             } else {
1881                 // This category isn't in the navigation and niether is it's parent (yet).
1882                 // We need to go through the category path and add all of its components in order.
1883                 $path = explode('/', trim($category->path, '/'));
1884                 foreach ($path as $catid) {
1885                     if (!array_key_exists($catid, $this->addedcategories)) {
1886                         // This category isn't in the navigation yet so add it.
1887                         $subcategory = $categories[$catid];
1888                         if ($subcategory->parent == '0') {
1889                             // Yay we have a root category - this likely means we will now be able
1890                             // to add categories without problems.
1891                             $this->add_category($subcategory, $this->rootnodes['courses']);
1892                         } else if (array_key_exists($subcategory->parent, $this->addedcategories)) {
1893                             // The parent is in the category (as we'd expect) so add it now.
1894                             $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1895                             // Remove the category from the categories array.
1896                             unset($categories[$catid]);
1897                         } else {
1898                             // We should never ever arrive here - if we have then there is a bigger
1899                             // problem at hand.
1900                             throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1901                         }
1902                     }
1903                 }
1904             }
1905             // Remove the category from the categories array now that we know it has been added.
1906             unset($categories[$category->id]);
1907         }
1908         if ($categoryid === self::LOAD_ALL_CATEGORIES) {
1909             $this->allcategoriesloaded = true;
1910         }
1911         // Check if there are any categories to load.
1912         if (count($categoriestoload) > 0) {
1913             $readytoloadcourses = array();
1914             foreach ($categoriestoload as $category) {
1915                 if ($this->can_add_more_courses_to_category($category)) {
1916                     $readytoloadcourses[] = $category;
1917                 }
1918             }
1919             if (count($readytoloadcourses)) {
1920                 $this->load_all_courses($readytoloadcourses);
1921             }
1922         }
1924         // Look for all categories which have been loaded
1925         if (!empty($this->addedcategories)) {
1926             $categoryids = array();
1927             foreach ($this->addedcategories as $category) {
1928                 if ($this->can_add_more_courses_to_category($category)) {
1929                     $categoryids[] = $category->key;
1930                 }
1931             }
1932             if ($categoryids) {
1933                 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED);
1934                 $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20;
1935                 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1936                           FROM {course_categories} cc
1937                           JOIN {course} c ON c.category = cc.id
1938                          WHERE cc.id {$categoriessql}
1939                       GROUP BY cc.id
1940                         HAVING COUNT(c.id) > :limit";
1941                 $excessivecategories = $DB->get_records_sql($sql, $params);
1942                 foreach ($categories as &$category) {
1943                     if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1944                         $url = new moodle_url('/course/index.php', array('categoryid' => $category->key));
1945                         $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1946                     }
1947                 }
1948             }
1949         }
1950     }
1952     /**
1953      * Adds a structured category to the navigation in the correct order/place
1954      *
1955      * @param stdClass $category category to be added in navigation.
1956      * @param navigation_node $parent parent navigation node
1957      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1958      * @return void.
1959      */
1960     protected function add_category(stdClass $category, navigation_node $parent, $nodetype = self::TYPE_CATEGORY) {
1961         if (array_key_exists($category->id, $this->addedcategories)) {
1962             return;
1963         }
1964         $canview = core_course_category::can_view_category($category);
1965         $url = $canview ? new moodle_url('/course/index.php', array('categoryid' => $category->id)) : null;
1966         $context = context_coursecat::instance($category->id);
1967         $categoryname = $canview ? format_string($category->name, true, array('context' => $context)) :
1968             get_string('categoryhidden');
1969         $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id);
1970         if (!$canview) {
1971             // User does not have required capabilities to view category.
1972             $categorynode->display = false;
1973         } else if (!$category->visible) {
1974             // Category is hidden but user has capability to view hidden categories.
1975             $categorynode->hidden = true;
1976         }
1977         $this->addedcategories[$category->id] = $categorynode;
1978     }
1980     /**
1981      * Loads the given course into the navigation
1982      *
1983      * @param stdClass $course
1984      * @return navigation_node
1985      */
1986     protected function load_course(stdClass $course) {
1987         global $SITE;
1988         if ($course->id == $SITE->id) {
1989             // This is always loaded during initialisation
1990             return $this->rootnodes['site'];
1991         } else if (array_key_exists($course->id, $this->addedcourses)) {
1992             // The course has already been loaded so return a reference
1993             return $this->addedcourses[$course->id];
1994         } else {
1995             // Add the course
1996             return $this->add_course($course);
1997         }
1998     }
2000     /**
2001      * Loads all of the courses section into the navigation.
2002      *
2003      * This function calls method from current course format, see
2004      * {@link format_base::extend_course_navigation()}
2005      * If course module ($cm) is specified but course format failed to create the node,
2006      * the activity node is created anyway.
2007      *
2008      * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
2009      *
2010      * @param stdClass $course Database record for the course
2011      * @param navigation_node $coursenode The course node within the navigation
2012      * @param null|int $sectionnum If specified load the contents of section with this relative number
2013      * @param null|cm_info $cm If specified make sure that activity node is created (either
2014      *    in containg section or by calling load_stealth_activity() )
2015      */
2016     protected function load_course_sections(stdClass $course, navigation_node $coursenode, $sectionnum = null, $cm = null) {
2017         global $CFG, $SITE;
2018         require_once($CFG->dirroot.'/course/lib.php');
2019         if (isset($cm->sectionnum)) {
2020             $sectionnum = $cm->sectionnum;
2021         }
2022         if ($sectionnum !== null) {
2023             $this->includesectionnum = $sectionnum;
2024         }
2025         course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
2026         if (isset($cm->id)) {
2027             $activity = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
2028             if (empty($activity)) {
2029                 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
2030             }
2031         }
2032    }
2034     /**
2035      * Generates an array of sections and an array of activities for the given course.
2036      *
2037      * This method uses the cache to improve performance and avoid the get_fast_modinfo call
2038      *
2039      * @param stdClass $course
2040      * @return array Array($sections, $activities)
2041      */
2042     protected function generate_sections_and_activities(stdClass $course) {
2043         global $CFG;
2044         require_once($CFG->dirroot.'/course/lib.php');
2046         $modinfo = get_fast_modinfo($course);
2047         $sections = $modinfo->get_section_info_all();
2049         // For course formats using 'numsections' trim the sections list
2050         $courseformatoptions = course_get_format($course)->get_format_options();
2051         if (isset($courseformatoptions['numsections'])) {
2052             $sections = array_slice($sections, 0, $courseformatoptions['numsections']+1, true);
2053         }
2055         $activities = array();
2057         foreach ($sections as $key => $section) {
2058             // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
2059             $sections[$key] = clone($section);
2060             unset($sections[$key]->summary);
2061             $sections[$key]->hasactivites = false;
2062             if (!array_key_exists($section->section, $modinfo->sections)) {
2063                 continue;
2064             }
2065             foreach ($modinfo->sections[$section->section] as $cmid) {
2066                 $cm = $modinfo->cms[$cmid];
2067                 $activity = new stdClass;
2068                 $activity->id = $cm->id;
2069                 $activity->course = $course->id;
2070                 $activity->section = $section->section;
2071                 $activity->name = $cm->name;
2072                 $activity->icon = $cm->icon;
2073                 $activity->iconcomponent = $cm->iconcomponent;
2074                 $activity->hidden = (!$cm->visible);
2075                 $activity->modname = $cm->modname;
2076                 $activity->nodetype = navigation_node::NODETYPE_LEAF;
2077                 $activity->onclick = $cm->onclick;
2078                 $url = $cm->url;
2079                 if (!$url) {
2080                     $activity->url = null;
2081                     $activity->display = false;
2082                 } else {
2083                     $activity->url = $url->out();
2084                     $activity->display = $cm->is_visible_on_course_page() ? true : false;
2085                     if (self::module_extends_navigation($cm->modname)) {
2086                         $activity->nodetype = navigation_node::NODETYPE_BRANCH;
2087                     }
2088                 }
2089                 $activities[$cmid] = $activity;
2090                 if ($activity->display) {
2091                     $sections[$key]->hasactivites = true;
2092                 }
2093             }
2094         }
2096         return array($sections, $activities);
2097     }
2099     /**
2100      * Generically loads the course sections into the course's navigation.
2101      *
2102      * @param stdClass $course
2103      * @param navigation_node $coursenode
2104      * @return array An array of course section nodes
2105      */
2106     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode) {
2107         global $CFG, $DB, $USER, $SITE;
2108         require_once($CFG->dirroot.'/course/lib.php');
2110         list($sections, $activities) = $this->generate_sections_and_activities($course);
2112         $navigationsections = array();
2113         foreach ($sections as $sectionid => $section) {
2114             $section = clone($section);
2115             if ($course->id == $SITE->id) {
2116                 $this->load_section_activities($coursenode, $section->section, $activities);
2117             } else {
2118                 if (!$section->uservisible || (!$this->showemptysections &&
2119                         !$section->hasactivites && $this->includesectionnum !== $section->section)) {
2120                     continue;
2121                 }
2123                 $sectionname = get_section_name($course, $section);
2124                 $url = course_get_url($course, $section->section, array('navigation' => true));
2126                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION,
2127                     null, $section->id, new pix_icon('i/section', ''));
2128                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
2129                 $sectionnode->hidden = (!$section->visible || !$section->available);
2130                 if ($this->includesectionnum !== false && $this->includesectionnum == $section->section) {
2131                     $this->load_section_activities($sectionnode, $section->section, $activities);
2132                 }
2133                 $section->sectionnode = $sectionnode;
2134                 $navigationsections[$sectionid] = $section;
2135             }
2136         }
2137         return $navigationsections;
2138     }
2140     /**
2141      * Loads all of the activities for a section into the navigation structure.
2142      *
2143      * @param navigation_node $sectionnode
2144      * @param int $sectionnumber
2145      * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
2146      * @param stdClass $course The course object the section and activities relate to.
2147      * @return array Array of activity nodes
2148      */
2149     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) {
2150         global $CFG, $SITE;
2151         // A static counter for JS function naming
2152         static $legacyonclickcounter = 0;
2154         $activitynodes = array();
2155         if (empty($activities)) {
2156             return $activitynodes;
2157         }
2159         if (!is_object($course)) {
2160             $activity = reset($activities);
2161             $courseid = $activity->course;
2162         } else {
2163             $courseid = $course->id;
2164         }
2165         $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods));
2167         foreach ($activities as $activity) {
2168             if ($activity->section != $sectionnumber) {
2169                 continue;
2170             }
2171             if ($activity->icon) {
2172                 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
2173             } else {
2174                 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
2175             }
2177             // Prepare the default name and url for the node
2178             $activityname = format_string($activity->name, true, array('context' => context_module::instance($activity->id)));
2179             $action = new moodle_url($activity->url);
2181             // Check if the onclick property is set (puke!)
2182             if (!empty($activity->onclick)) {
2183                 // Increment the counter so that we have a unique number.
2184                 $legacyonclickcounter++;
2185                 // Generate the function name we will use
2186                 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
2187                 $propogrationhandler = '';
2188                 // Check if we need to cancel propogation. Remember inline onclick
2189                 // events would return false if they wanted to prevent propogation and the
2190                 // default action.
2191                 if (strpos($activity->onclick, 'return false')) {
2192                     $propogrationhandler = 'e.halt();';
2193                 }
2194                 // Decode the onclick - it has already been encoded for display (puke)
2195                 $onclick = htmlspecialchars_decode($activity->onclick, ENT_QUOTES);
2196                 // Build the JS function the click event will call
2197                 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2198                 $this->page->requires->js_amd_inline($jscode);
2199                 // Override the default url with the new action link
2200                 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2201             }
2203             $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
2204             $activitynode->title(get_string('modulename', $activity->modname));
2205             $activitynode->hidden = $activity->hidden;
2206             $activitynode->display = $showactivities && $activity->display;
2207             $activitynode->nodetype = $activity->nodetype;
2208             $activitynodes[$activity->id] = $activitynode;
2209         }
2211         return $activitynodes;
2212     }
2213     /**
2214      * Loads a stealth module from unavailable section
2215      * @param navigation_node $coursenode
2216      * @param stdClass $modinfo
2217      * @return navigation_node or null if not accessible
2218      */
2219     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
2220         if (empty($modinfo->cms[$this->page->cm->id])) {
2221             return null;
2222         }
2223         $cm = $modinfo->cms[$this->page->cm->id];
2224         if ($cm->icon) {
2225             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
2226         } else {
2227             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
2228         }
2229         $url = $cm->url;
2230         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
2231         $activitynode->title(get_string('modulename', $cm->modname));
2232         $activitynode->hidden = (!$cm->visible);
2233         if (!$cm->is_visible_on_course_page()) {
2234             // Do not show any error here, let the page handle exception that activity is not visible for the current user.
2235             // Also there may be no exception at all in case when teacher is logged in as student.
2236             $activitynode->display = false;
2237         } else if (!$url) {
2238             // Don't show activities that don't have links!
2239             $activitynode->display = false;
2240         } else if (self::module_extends_navigation($cm->modname)) {
2241             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
2242         }
2243         return $activitynode;
2244     }
2245     /**
2246      * Loads the navigation structure for the given activity into the activities node.
2247      *
2248      * This method utilises a callback within the modules lib.php file to load the
2249      * content specific to activity given.
2250      *
2251      * The callback is a method: {modulename}_extend_navigation()
2252      * Examples:
2253      *  * {@link forum_extend_navigation()}
2254      *  * {@link workshop_extend_navigation()}
2255      *
2256      * @param cm_info|stdClass $cm
2257      * @param stdClass $course
2258      * @param navigation_node $activity
2259      * @return bool
2260      */
2261     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
2262         global $CFG, $DB;
2264         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2265         if (!($cm instanceof cm_info)) {
2266             $modinfo = get_fast_modinfo($course);
2267             $cm = $modinfo->get_cm($cm->id);
2268         }
2269         $activity->nodetype = navigation_node::NODETYPE_LEAF;
2270         $activity->make_active();
2271         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
2272         $function = $cm->modname.'_extend_navigation';
2274         if (file_exists($file)) {
2275             require_once($file);
2276             if (function_exists($function)) {
2277                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
2278                 $function($activity, $course, $activtyrecord, $cm);
2279             }
2280         }
2282         // Allow the active advanced grading method plugin to append module navigation
2283         $featuresfunc = $cm->modname.'_supports';
2284         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) {
2285             require_once($CFG->dirroot.'/grade/grading/lib.php');
2286             $gradingman = get_grading_manager($cm->context,  'mod_'.$cm->modname);
2287             $gradingman->extend_navigation($this, $activity);
2288         }
2290         return $activity->has_children();
2291     }
2292     /**
2293      * Loads user specific information into the navigation in the appropriate place.
2294      *
2295      * If no user is provided the current user is assumed.
2296      *
2297      * @param stdClass $user
2298      * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2299      * @return bool
2300      */
2301     protected function load_for_user($user=null, $forceforcontext=false) {
2302         global $DB, $CFG, $USER, $SITE;
2304         require_once($CFG->dirroot . '/course/lib.php');
2306         if ($user === null) {
2307             // We can't require login here but if the user isn't logged in we don't
2308             // want to show anything
2309             if (!isloggedin() || isguestuser()) {
2310                 return false;
2311             }
2312             $user = $USER;
2313         } else if (!is_object($user)) {
2314             // If the user is not an object then get them from the database
2315             $select = context_helper::get_preload_record_columns_sql('ctx');
2316             $sql = "SELECT u.*, $select
2317                       FROM {user} u
2318                       JOIN {context} ctx ON u.id = ctx.instanceid
2319                      WHERE u.id = :userid AND
2320                            ctx.contextlevel = :contextlevel";
2321             $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST);
2322             context_helper::preload_from_record($user);
2323         }
2325         $iscurrentuser = ($user->id == $USER->id);
2327         $usercontext = context_user::instance($user->id);
2329         // Get the course set against the page, by default this will be the site
2330         $course = $this->page->course;
2331         $baseargs = array('id'=>$user->id);
2332         if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) {
2333             $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
2334             $baseargs['course'] = $course->id;
2335             $coursecontext = context_course::instance($course->id);
2336             $issitecourse = false;
2337         } else {
2338             // Load all categories and get the context for the system
2339             $coursecontext = context_system::instance();
2340             $issitecourse = true;
2341         }
2343         // Create a node to add user information under.
2344         $usersnode = null;
2345         if (!$issitecourse) {
2346             // Not the current user so add it to the participants node for the current course.
2347             $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
2348             $userviewurl = new moodle_url('/user/view.php', $baseargs);
2349         } else if ($USER->id != $user->id) {
2350             // This is the site so add a users node to the root branch.
2351             $usersnode = $this->rootnodes['users'];
2352             if (course_can_view_participants($coursecontext)) {
2353                 $usersnode->action = new moodle_url('/user/index.php', array('id' => $course->id));
2354             }
2355             $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2356         }
2357         if (!$usersnode) {
2358             // We should NEVER get here, if the course hasn't been populated
2359             // with a participants node then the navigaiton either wasn't generated
2360             // for it (you are missing a require_login or set_context call) or
2361             // you don't have access.... in the interests of no leaking informatin
2362             // we simply quit...
2363             return false;
2364         }
2365         // Add a branch for the current user.
2366         // Only reveal user details if $user is the current user, or a user to which the current user has access.
2367         $viewprofile = true;
2368         if (!$iscurrentuser) {
2369             require_once($CFG->dirroot . '/user/lib.php');
2370             if ($this->page->context->contextlevel == CONTEXT_USER && !has_capability('moodle/user:viewdetails', $usercontext) ) {
2371                 $viewprofile = false;
2372             } else if ($this->page->context->contextlevel != CONTEXT_USER && !user_can_view_profile($user, $course, $usercontext)) {
2373                 $viewprofile = false;
2374             }
2375             if (!$viewprofile) {
2376                 $viewprofile = user_can_view_profile($user, null, $usercontext);
2377             }
2378         }
2380         // Now, conditionally add the user node.
2381         if ($viewprofile) {
2382             $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2383             $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, 'user' . $user->id);
2384         } else {
2385             $usernode = $usersnode->add(get_string('user'));
2386         }
2388         if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
2389             $usernode->make_active();
2390         }
2392         // Add user information to the participants or user node.
2393         if ($issitecourse) {
2395             // If the user is the current user or has permission to view the details of the requested
2396             // user than add a view profile link.
2397             if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) ||
2398                     has_capability('moodle/user:viewdetails', $usercontext)) {
2399                 if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
2400                     $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php', $baseargs));
2401                 } else {
2402                     $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php', $baseargs));
2403                 }
2404             }
2406             if (!empty($CFG->navadduserpostslinks)) {
2407                 // Add nodes for forum posts and discussions if the user can view either or both
2408                 // There are no capability checks here as the content of the page is based
2409                 // purely on the forums the current user has access too.
2410                 $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2411                 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2412                 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php',
2413                         array_merge($baseargs, array('mode' => 'discussions'))));
2414             }
2416             // Add blog nodes.
2417             if (!empty($CFG->enableblogs)) {
2418                 if (!$this->cache->cached('userblogoptions'.$user->id)) {
2419                     require_once($CFG->dirroot.'/blog/lib.php');
2420                     // Get all options for the user.
2421                     $options = blog_get_options_for_user($user);
2422                     $this->cache->set('userblogoptions'.$user->id, $options);
2423                 } else {
2424                     $options = $this->cache->{'userblogoptions'.$user->id};
2425                 }
2427                 if (count($options) > 0) {
2428                     $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
2429                     foreach ($options as $type => $option) {
2430                         if ($type == "rss") {
2431                             $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null,
2432                                     new pix_icon('i/rss', ''));
2433                         } else {
2434                             $blogs->add($option['string'], $option['link']);
2435                         }
2436                     }
2437                 }
2438             }
2440             // Add the messages link.
2441             // It is context based so can appear in the user's profile and in course participants information.
2442             if (!empty($CFG->messaging)) {
2443                 $messageargs = array('user1' => $USER->id);
2444                 if ($USER->id != $user->id) {
2445                     $messageargs['user2'] = $user->id;
2446                 }
2447                 $url = new moodle_url('/message/index.php', $messageargs);
2448                 $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
2449             }
2451             // Add the "My private files" link.
2452             // This link doesn't have a unique display for course context so only display it under the user's profile.
2453             if ($issitecourse && $iscurrentuser && has_capability('moodle/user:manageownfiles', $usercontext)) {
2454                 $url = new moodle_url('/user/files.php');
2455                 $usernode->add(get_string('privatefiles'), $url, self::TYPE_SETTING, null, 'privatefiles');
2456             }
2458             // Add a node to view the users notes if permitted.
2459             if (!empty($CFG->enablenotes) &&
2460                     has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2461                 $url = new moodle_url('/notes/index.php', array('user' => $user->id));
2462                 if ($coursecontext->instanceid != SITEID) {
2463                     $url->param('course', $coursecontext->instanceid);
2464                 }
2465                 $usernode->add(get_string('notes', 'notes'), $url);
2466             }
2468             // Show the grades node.
2469             if (($issitecourse && $iscurrentuser) || has_capability('moodle/user:viewdetails', $usercontext)) {
2470                 require_once($CFG->dirroot . '/user/lib.php');
2471                 // Set the grades node to link to the "Grades" page.
2472                 if ($course->id == SITEID) {
2473                     $url = user_mygrades_url($user->id, $course->id);
2474                 } else { // Otherwise we are in a course and should redirect to the user grade report (Activity report version).
2475                     $url = new moodle_url('/course/user.php', array('mode' => 'grade', 'id' => $course->id, 'user' => $user->id));
2476                 }
2477                 if ($USER->id != $user->id) {
2478                     $usernode->add(get_string('grades', 'grades'), $url, self::TYPE_SETTING, null, 'usergrades');
2479                 } else {
2480                     $usernode->add(get_string('grades', 'grades'), $url);
2481                 }
2482             }
2484             // If the user is the current user add the repositories for the current user.
2485             $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
2486             if (!$iscurrentuser &&
2487                     $course->id == $SITE->id &&
2488                     has_capability('moodle/user:viewdetails', $usercontext) &&
2489                     (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2491                 // Add view grade report is permitted.
2492                 $reports = core_component::get_plugin_list('gradereport');
2493                 arsort($reports); // User is last, we want to test it first.
2495                 $userscourses = enrol_get_users_courses($user->id, false, '*');
2496                 $userscoursesnode = $usernode->add(get_string('courses'));
2498                 $count = 0;
2499                 foreach ($userscourses as $usercourse) {
2500                     if ($count === (int)$CFG->navcourselimit) {
2501                         $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1));
2502                         $userscoursesnode->add(get_string('showallcourses'), $url);
2503                         break;
2504                     }
2505                     $count++;
2506                     $usercoursecontext = context_course::instance($usercourse->id);
2507                     $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext));
2508                     $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php',
2509                             array('id' => $user->id, 'course' => $usercourse->id)), self::TYPE_CONTAINER);
2511                     $gradeavailable = has_capability('moodle/grade:view', $usercoursecontext);
2512                     if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
2513                         foreach ($reports as $plugin => $plugindir) {
2514                             if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2515                                 // Stop when the first visible plugin is found.
2516                                 $gradeavailable = true;
2517                                 break;
2518                             }
2519                         }
2520                     }
2522                     if ($gradeavailable) {
2523                         $url = new moodle_url('/grade/report/index.php', array('id' => $usercourse->id));
2524                         $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null,
2525                                 new pix_icon('i/grades', ''));
2526                     }
2528                     // Add a node to view the users notes if permitted.
2529                     if (!empty($CFG->enablenotes) &&
2530                             has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2531                         $url = new moodle_url('/notes/index.php', array('user' => $user->id, 'course' => $usercourse->id));
2532                         $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2533                     }
2535                     if (can_access_course($usercourse, $user->id, '', true)) {
2536                         $usercoursenode->add(get_string('entercourse'), new moodle_url('/course/view.php',
2537                                 array('id' => $usercourse->id)), self::TYPE_SETTING, null, null, new pix_icon('i/course', ''));
2538                     }
2540                     $reporttab = $usercoursenode->add(get_string('activityreports'));
2542                     $reportfunctions = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2543                     foreach ($reportfunctions as $reportfunction) {
2544                         $reportfunction($reporttab, $user, $usercourse);
2545                     }
2547                     $reporttab->trim_if_empty();
2548                 }
2549             }
2551             // Let plugins hook into user navigation.
2552             $pluginsfunction = get_plugins_with_function('extend_navigation_user', 'lib.php');
2553             foreach ($pluginsfunction as $plugintype => $plugins) {
2554                 if ($plugintype != 'report') {
2555                     foreach ($plugins as $pluginfunction) {
2556                         $pluginfunction($usernode, $user, $usercontext, $course, $coursecontext);
2557                     }
2558                 }
2559             }
2560         }
2561         return true;
2562     }
2564     /**
2565      * This method simply checks to see if a given module can extend the navigation.
2566      *
2567      * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2568      *
2569      * @param string $modname
2570      * @return bool
2571      */
2572     public static function module_extends_navigation($modname) {
2573         global $CFG;
2574         static $extendingmodules = array();
2575         if (!array_key_exists($modname, $extendingmodules)) {
2576             $extendingmodules[$modname] = false;
2577             $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2578             if (file_exists($file)) {
2579                 $function = $modname.'_extend_navigation';
2580                 require_once($file);
2581                 $extendingmodules[$modname] = (function_exists($function));
2582             }
2583         }
2584         return $extendingmodules[$modname];
2585     }
2586     /**
2587      * Extends the navigation for the given user.
2588      *
2589      * @param stdClass $user A user from the database
2590      */
2591     public function extend_for_user($user) {
2592         $this->extendforuser[] = $user;
2593     }
2595     /**
2596      * Returns all of the users the navigation is being extended for
2597      *
2598      * @return array An array of extending users.
2599      */
2600     public function get_extending_users() {
2601         return $this->extendforuser;
2602     }
2603     /**
2604      * Adds the given course to the navigation structure.
2605      *
2606      * @param stdClass $course
2607      * @param bool $forcegeneric
2608      * @param bool $ismycourse
2609      * @return navigation_node
2610      */
2611     public function add_course(stdClass $course, $forcegeneric = false, $coursetype = self::COURSE_OTHER) {
2612         global $CFG, $SITE;
2614         // We found the course... we can return it now :)
2615         if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2616             return $this->addedcourses[$course->id];
2617         }
2619         $coursecontext = context_course::instance($course->id);
2621         if ($coursetype != self::COURSE_MY && $coursetype != self::COURSE_CURRENT && $course->id != $SITE->id) {
2622             if (is_role_switched($course->id)) {
2623                 // user has to be able to access course in order to switch, let's skip the visibility test here
2624             } else if (!core_course_category::can_view_course_info($course)) {
2625                 return false;
2626             }
2627         }
2629         $issite = ($course->id == $SITE->id);
2630         $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
2631         $fullname = format_string($course->fullname, true, array('context' => $coursecontext));
2632         // This is the name that will be shown for the course.
2633         $coursename = empty($CFG->navshowfullcoursenames) ? $shortname : $fullname;
2635         if ($coursetype == self::COURSE_CURRENT) {
2636             if ($coursenode = $this->rootnodes['mycourses']->find($course->id, self::TYPE_COURSE)) {
2637                 return $coursenode;
2638             } else {
2639                 $coursetype = self::COURSE_OTHER;
2640             }
2641         }
2643         // Can the user expand the course to see its content.
2644         $canexpandcourse = true;
2645         if ($issite) {
2646             $parent = $this;
2647             $url = null;
2648             if (empty($CFG->usesitenameforsitepages)) {
2649                 $coursename = get_string('sitepages');
2650             }
2651         } else if ($coursetype == self::COURSE_CURRENT) {
2652             $parent = $this->rootnodes['currentcourse'];
2653             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2654             $canexpandcourse = $this->can_expand_course($course);
2655         } else if ($coursetype == self::COURSE_MY && !$forcegeneric) {
2656             if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_MY_CATEGORY))) {
2657                 // Nothing to do here the above statement set $parent to the category within mycourses.
2658             } else {
2659                 $parent = $this->rootnodes['mycourses'];
2660             }
2661             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2662         } else {
2663             $parent = $this->rootnodes['courses'];
2664             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2665             // They can only expand the course if they can access it.
2666             $canexpandcourse = $this->can_expand_course($course);
2667             if (!empty($course->category) && $this->show_categories($coursetype == self::COURSE_MY)) {
2668                 if (!$this->is_category_fully_loaded($course->category)) {
2669                     // We need to load the category structure for this course
2670                     $this->load_all_categories($course->category, false);
2671                 }
2672                 if (array_key_exists($course->category, $this->addedcategories)) {
2673                     $parent = $this->addedcategories[$course->category];
2674                     // This could lead to the course being created so we should check whether it is the case again
2675                     if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2676                         return $this->addedcourses[$course->id];
2677                     }
2678                 }
2679             }
2680         }
2682         $coursenode = $parent->add($coursename, $url, self::TYPE_COURSE, $shortname, $course->id, new pix_icon('i/course', ''));
2683         $coursenode->showinflatnavigation = $coursetype == self::COURSE_MY;
2685         $coursenode->hidden = (!$course->visible);
2686         $coursenode->title(format_string($course->fullname, true, array('context' => $coursecontext, 'escape' => false)));
2687         if ($canexpandcourse) {
2688             // This course can be expanded by the user, make it a branch to make the system aware that its expandable by ajax.
2689             $coursenode->nodetype = self::NODETYPE_BRANCH;
2690             $coursenode->isexpandable = true;
2691         } else {
2692             $coursenode->nodetype = self::NODETYPE_LEAF;
2693             $coursenode->isexpandable = false;
2694         }
2695         if (!$forcegeneric) {
2696             $this->addedcourses[$course->id] = $coursenode;
2697         }
2699         return $coursenode;
2700     }
2702     /**
2703      * Returns a cache instance to use for the expand course cache.
2704      * @return cache_session
2705      */
2706     protected function get_expand_course_cache() {
2707         if ($this->cacheexpandcourse === null) {
2708             $this->cacheexpandcourse = cache::make('core', 'navigation_expandcourse');
2709         }
2710         return $this->cacheexpandcourse;
2711     }
2713     /**
2714      * Checks if a user can expand a course in the navigation.
2715      *
2716      * We use a cache here because in order to be accurate we need to call can_access_course which is a costly function.
2717      * Because this functionality is basic + non-essential and because we lack good event triggering this cache
2718      * permits stale data.
2719      * In the situation the user is granted access to a course after we've initialised this session cache the cache
2720      * will be stale.
2721      * It is brought up to date in only one of two ways.
2722      *   1. The user logs out and in again.
2723      *   2. The user browses to the course they've just being given access to.
2724      *
2725      * Really all this controls is whether the node is shown as expandable or not. It is uber un-important.
2726      *
2727      * @param stdClass $course
2728      * @return bool
2729      */
2730     protected function can_expand_course($course) {
2731         $cache = $this->get_expand_course_cache();
2732         $canexpand = $cache->get($course->id);
2733         if ($canexpand === false) {
2734             $canexpand = isloggedin() && can_access_course($course, null, '', true);
2735             $canexpand = (int)$canexpand;
2736             $cache->set($course->id, $canexpand);
2737         }
2738         return ($canexpand === 1);
2739     }
2741     /**
2742      * Returns true if the category has already been loaded as have any child categories
2743      *
2744      * @param int $categoryid
2745      * @return bool
2746      */
2747     protected function is_category_fully_loaded($categoryid) {
2748         return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0));
2749     }
2751     /**
2752      * Adds essential course nodes to the navigation for the given course.
2753      *
2754      * This method adds nodes such as reports, blogs and participants
2755      *
2756      * @param navigation_node $coursenode
2757      * @param stdClass $course
2758      * @return bool returns true on successful addition of a node.
2759      */
2760     public function add_course_essentials($coursenode, stdClass $course) {
2761         global $CFG, $SITE;
2762         require_once($CFG->dirroot . '/course/lib.php');
2764         if ($course->id == $SITE->id) {
2765             return $this->add_front_page_course_essentials($coursenode, $course);
2766         }
2768         if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2769             return true;
2770         }
2772         $navoptions = course_get_user_navigation_options($this->page->context, $course);
2774         //Participants
2775         if ($navoptions->participants) {
2776             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id),
2777                 self::TYPE_CONTAINER, get_string('participants'), 'participants', new pix_icon('i/users', ''));
2779             if ($navoptions->blogs) {
2780                 $blogsurls = new moodle_url('/blog/index.php');
2781                 if ($currentgroup = groups_get_course_group($course, true)) {
2782                     $blogsurls->param('groupid', $currentgroup);
2783                 } else {
2784                     $blogsurls->param('courseid', $course->id);
2785                 }
2786                 $participants->add(get_string('blogscourse', 'blog'), $blogsurls->out(), self::TYPE_SETTING, null, 'courseblogs');
2787             }
2789             if ($navoptions->notes) {
2790                 $participants->add(get_string('notes', 'notes'), new moodle_url('/notes/index.php', array('filtertype' => 'course', 'filterselect' => $course->id)), self::TYPE_SETTING, null, 'currentcoursenotes');
2791             }
2792         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2793             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2794         }
2796         // Badges.
2797         if ($navoptions->badges) {
2798             $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id));
2800             $coursenode->add(get_string('coursebadges', 'badges'), $url,
2801                     navigation_node::TYPE_SETTING, null, 'badgesview',
2802                     new pix_icon('i/badge', get_string('coursebadges', 'badges')));
2803         }
2805         // Check access to the course and competencies page.
2806         if ($navoptions->competencies) {
2807             // Just a link to course competency.
2808             $title = get_string('competencies', 'core_competency');
2809             $path = new moodle_url("/admin/tool/lp/coursecompetencies.php", array('courseid' => $course->id));
2810             $coursenode->add($title, $path, navigation_node::TYPE_SETTING, null, 'competencies',
2811                     new pix_icon('i/competencies', ''));
2812         }
2813         if ($navoptions->grades) {
2814             $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id));
2815             $gradenode = $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null,
2816                 'grades', new pix_icon('i/grades', ''));
2817             // If the page type matches the grade part, then make the nav drawer grade node (incl. all sub pages) active.
2818             if ($this->page->context->contextlevel < CONTEXT_MODULE && strpos($this->page->pagetype, 'grade-') === 0) {
2819                 $gradenode->make_active();
2820             }
2821         }
2823         return true;
2824     }
2825     /**
2826      * This generates the structure of the course that won't be generated when
2827      * the modules and sections are added.
2828      *
2829      * Things such as the reports branch, the participants branch, blogs... get
2830      * added to the course node by this method.
2831      *
2832      * @param navigation_node $coursenode
2833      * @param stdClass $course
2834      * @return bool True for successfull generation
2835      */
2836     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2837         global $CFG, $USER, $COURSE, $SITE;
2838         require_once($CFG->dirroot . '/course/lib.php');
2840         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2841             return true;
2842         }
2844         $sitecontext = context_system::instance();
2845         $navoptions = course_get_user_navigation_options($sitecontext, $course);
2847         // Hidden node that we use to determine if the front page navigation is loaded.
2848         // This required as there are not other guaranteed nodes that may be loaded.
2849         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2851         // Participants.
2852         if ($navoptions->participants) {
2853             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2854         }
2856         // Blogs.
2857         if ($navoptions->blogs) {
2858             $blogsurls = new moodle_url('/blog/index.php');
2859             $coursenode->add(get_string('blogssite', 'blog'), $blogsurls->out(), self::TYPE_SYSTEM, null, 'siteblog');
2860         }
2862         $filterselect = 0;
2864         // Badges.
2865         if ($navoptions->badges) {
2866             $url = new moodle_url($CFG->wwwroot . '/badges/view.php', array('type' => 1));
2867             $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node::TYPE_CUSTOM);
2868         }
2870         // Notes.
2871         if ($navoptions->notes) {
2872             $coursenode->add(get_string('notes', 'notes'), new moodle_url('/notes/index.php',
2873                 array('filtertype' => 'course', 'filterselect' => $filterselect)), self::TYPE_SETTING, null, 'notes');
2874         }
2876         // Tags
2877         if ($navoptions->tags) {
2878             $node = $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'),
2879                     self::TYPE_SETTING, null, 'tags');
2880         }
2882         // Search.
2883         if ($navoptions->search) {
2884             $node = $coursenode->add(get_string('search', 'search'), new moodle_url('/search/index.php'),
2885                     self::TYPE_SETTING, null, 'search');
2886         }
2888         if ($navoptions->calendar) {
2889             $courseid = $COURSE->id;
2890             $params = array('view' => 'month');
2891             if ($courseid != $SITE->id) {
2892                 $params['course'] = $courseid;
2893             }
2895             // Calendar
2896             $calendarurl = new moodle_url('/calendar/view.php', $params);
2897             $node = $coursenode->add(get_string('calendar', 'calendar'), $calendarurl,
2898                 self::TYPE_CUSTOM, null, 'calendar', new pix_icon('i/calendar', ''));
2899             $node->showinflatnavigation = true;
2900         }
2902         if (isloggedin()) {
2903             $usercontext = context_user::instance($USER->id);
2904             if (has_capability('moodle/user:manageownfiles', $usercontext)) {
2905                 $url = new moodle_url('/user/files.php');
2906                 $node = $coursenode->add(get_string('privatefiles'), $url,
2907                     self::TYPE_SETTING, null, 'privatefiles', new pix_icon('i/privatefiles', ''));
2908                 $node->display = false;
2909                 $node->showinflatnavigation = true;
2910             }
2911         }
2913         return true;
2914     }
2916     /**
2917      * Clears the navigation cache
2918      */
2919     public function clear_cache() {
2920         $this->cache->clear();
2921     }
2923     /**
2924      * Sets an expansion limit for the navigation
2925      *
2926      * The expansion limit is used to prevent the display of content that has a type
2927      * greater than the provided $type.
2928      *
2929      * Can be used to ensure things such as activities or activity content don't get
2930      * shown on the navigation.
2931      * They are still generated in order to ensure the navbar still makes sense.
2932      *
2933      * @param int $type One of navigation_node::TYPE_*
2934      * @return bool true when complete.
2935      */
2936     public function set_expansion_limit($type) {
2937         global $SITE;
2938         $nodes = $this->find_all_of_type($type);
2940         // We only want to hide specific types of nodes.
2941         // Only nodes that represent "structure" in the navigation tree should be hidden.
2942         // If we hide all nodes then we risk hiding vital information.
2943         $typestohide = array(
2944             self::TYPE_CATEGORY,
2945             self::TYPE_COURSE,
2946             self::TYPE_SECTION,
2947             self::TYPE_ACTIVITY
2948         );
2950         foreach ($nodes as $node) {
2951             // We need to generate the full site node
2952             if ($type == self::TYPE_COURSE && $node->key == $SITE->id) {
2953                 continue;
2954             }
2955             foreach ($node->children as $child) {
2956                 $child->hide($typestohide);
2957             }
2958         }
2959         return true;
2960     }
2961     /**
2962      * Attempts to get the navigation with the given key from this nodes children.
2963      *
2964      * This function only looks at this nodes children, it does NOT look recursivily.
2965      * If the node can't be found then false is returned.
2966      *
2967      * If you need to search recursivily then use the {@link global_navigation::find()} method.
2968      *
2969      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2970      * may be of more use to you.
2971      *
2972      * @param string|int $key The key of the node you wish to receive.
2973      * @param int $type One of navigation_node::TYPE_*
2974      * @return navigation_node|false
2975      */
2976     public function get($key, $type = null) {
2977         if (!$this->initialised) {
2978             $this->initialise();
2979         }
2980         return parent::get($key, $type);
2981     }
2983     /**
2984      * Searches this nodes children and their children to find a navigation node
2985      * with the matching key and type.
2986      *
2987      * This method is recursive and searches children so until either a node is
2988      * found or there are no more nodes to search.
2989      *
2990      * If you know that the node being searched for is a child of this node
2991      * then use the {@link global_navigation::get()} method instead.
2992      *
2993      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2994      * may be of more use to you.
2995      *
2996      * @param string|int $key The key of the node you wish to receive.
2997      * @param int $type One of navigation_node::TYPE_*
2998      * @return navigation_node|false
2999      */
3000     public function find($key, $type) {
3001         if (!$this->initialised) {
3002             $this->initialise();
3003         }
3004         if ($type == self::TYPE_ROOTNODE && array_key_exists($key, $this->rootnodes)) {
3005             return $this->rootnodes[$key];
3006         }
3007         return parent::find($key, $type);
3008     }
3010     /**
3011      * They've expanded the 'my courses' branch.
3012      */
3013     protected function load_courses_enrolled() {
3014         global $CFG;
3016         $limit = (int) $CFG->navcourselimit;
3018         $courses = enrol_get_my_courses('*');
3019         $flatnavcourses = [];
3021         // Go through the courses and see which ones we want to display in the flatnav.
3022         foreach ($courses as $course) {
3023             $classify = course_classify_for_timeline($course);
3025             if ($classify == COURSE_TIMELINE_INPROGRESS) {
3026                 $flatnavcourses[$course->id] = $course;
3027             }
3028         }
3030         // Get the number of courses that can be displayed in the nav block and in the flatnav.
3031         $numtotalcourses = count($courses);
3032         $numtotalflatnavcourses = count($flatnavcourses);
3034         // Reduce the size of the arrays to abide by the 'navcourselimit' setting.
3035         $courses = array_slice($courses, 0, $limit, true);
3036         $flatnavcourses = array_slice($flatnavcourses, 0, $limit, true);
3038         // Get the number of courses we are going to show for each.
3039         $numshowncourses = count($courses);
3040         $numshownflatnavcourses = count($flatnavcourses);
3041         if ($numshowncourses && $this->show_my_categories()) {
3042             // Generate an array containing unique values of all the courses' categories.
3043             $categoryids = array();
3044             foreach ($courses as $course) {
3045                 if (in_array($course->category, $categoryids)) {
3046                     continue;
3047                 }
3048                 $categoryids[] = $course->category;
3049             }
3051             // Array of category IDs that include the categories of the user's courses and the related course categories.
3052             $fullpathcategoryids = [];
3053             // Get the course categories for the enrolled courses' category IDs.
3054             $mycoursecategories = core_course_category::get_many($categoryids);
3055             // Loop over each of these categories and build the category tree using each category's path.
3056             foreach ($mycoursecategories as $mycoursecat) {
3057                 $pathcategoryids = explode('/', $mycoursecat->path);
3058                 // First element of the exploded path is empty since paths begin with '/'.
3059                 array_shift($pathcategoryids);
3060                 // Merge the exploded category IDs into the full list of category IDs that we will fetch.
3061                 $fullpathcategoryids = array_merge($fullpathcategoryids, $pathcategoryids);
3062             }
3064             // Fetch all of the categories related to the user's courses.
3065             $pathcategories = core_course_category::get_many($fullpathcategoryids);
3066             // Loop over each of these categories and build the category tree.
3067             foreach ($pathcategories as $coursecat) {
3068                 // No need to process categories that have already been added.
3069                 if (isset($this->addedcategories[$coursecat->id])) {
3070                     continue;
3071                 }
3072                 // Skip categories that are not visible.
3073                 if (!$coursecat->is_uservisible()) {
3074                     continue;
3075                 }
3077                 // Get this course category's parent node.
3078                 $parent = null;
3079                 if ($coursecat->parent && isset($this->addedcategories[$coursecat->parent])) {
3080                     $parent = $this->addedcategories[$coursecat->parent];
3081                 }
3082                 if (!$parent) {
3083                     // If it has no parent, then it should be right under the My courses node.
3084                     $parent = $this->rootnodes['mycourses'];
3085                 }
3087                 // Build the category object based from the coursecat object.
3088                 $mycategory = new stdClass();
3089                 $mycategory->id = $coursecat->id;
3090                 $mycategory->name = $coursecat->name;
3091                 $mycategory->visible = $coursecat->visible;
3093                 // Add this category to the nav tree.
3094                 $this->add_category($mycategory, $parent, self::TYPE_MY_CATEGORY);
3095             }
3096         }
3098         // Go through each course now and add it to the nav block, and the flatnav if applicable.
3099         foreach ($courses as $course) {
3100             $node = $this->add_course($course, false, self::COURSE_MY);
3101             if ($node) {
3102                 $node->showinflatnavigation = false;
3103                 // Check if we should also add this to the flat nav as well.
3104                 if (isset($flatnavcourses[$course->id])) {
3105                     $node->showinflatnavigation = true;
3106                 }
3107             }
3108         }
3110         // Go through each course in the flatnav now.
3111         foreach ($flatnavcourses as $course) {
3112             // Check if we haven't already added it.
3113             if (!isset($courses[$course->id])) {
3114                 // Ok, add it to the flatnav only.
3115                 $node = $this->add_course($course, false, self::COURSE_MY);
3116                 $node->display = false;
3117                 $node->showinflatnavigation = true;
3118             }
3119         }
3121         $showmorelinkinnav = $numtotalcourses > $numshowncourses;
3122         $showmorelinkinflatnav = $numtotalflatnavcourses > $numshownflatnavcourses;
3123         // Show a link to the course page if there are more courses the user is enrolled in.
3124         if ($showmorelinkinnav || $showmorelinkinflatnav) {
3125             // Adding hash to URL so the link is not highlighted in the navigation when clicked.
3126             $url = new moodle_url('/my/');
3127             $parent = $this->rootnodes['mycourses'];
3128             $coursenode = $parent->add(get_string('morenavigationlinks'), $url, self::TYPE_CUSTOM, null, self::COURSE_INDEX_PAGE);
3130             if ($showmorelinkinnav) {
3131                 $coursenode->display = true;
3132             }
3134             if ($showmorelinkinflatnav) {
3135                 $coursenode->showinflatnavigation = true;
3136             }
3137         }
3138     }
3141 /**
3142  * The global navigation class used especially for AJAX requests.
3143  *
3144  * The primary methods that are used in the global navigation class have been overriden
3145  * to ensure that only the relevant branch is generated at the root of the tree.
3146  * This can be done because AJAX is only used when the backwards structure for the
3147  * requested branch exists.
3148  * This has been done only because it shortens the amounts of information that is generated
3149  * which of course will speed up the response time.. because no one likes laggy AJAX.
3150  *
3151  * @package   core
3152  * @category  navigation
3153  * @copyright 2009 Sam Hemelryk
3154  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3155  */
3156 class global_navigation_for_ajax extends global_navigation {
3158     /** @var int used for determining what type of navigation_node::TYPE_* is being used */
3159     protected $branchtype;
3161     /** @var int the instance id */
3162     protected $instanceid;
3164     /** @var array Holds an array of expandable nodes */
3165     protected $expandable = array();
3167     /**
3168      * Constructs the navigation for use in an AJAX request
3169      *
3170      * @param moodle_page $page moodle_page object
3171      * @param int $branchtype
3172      * @param int $id
3173      */
3174     public function __construct($page, $branchtype, $id) {
3175         $this->page = $page;
3176         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
3177         $this->children = new navigation_node_collection();
3178         $this->branchtype = $branchtype;
3179         $this->instanceid = $id;
3180         $this->initialise();
3181     }
3182     /**
3183      * Initialise the navigation given the type and id for the branch to expand.
3184      *
3185      * @return array An array of the expandable nodes
3186      */
3187     public function initialise() {
3188         global $DB, $SITE;
3190         if ($this->initialised || during_initial_install()) {
3191             return $this->expandable;
3192         }
3193         $this->initialised = true;
3195         $this->rootnodes = array();
3196         $this->rootnodes['site']    = $this->add_course($SITE);
3197         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self::TYPE_ROOTNODE, null, 'mycourses');
3198         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
3199         // The courses branch is always displayed, and is always expandable (although may be empty).
3200         // This mimicks what is done during {@link global_navigation::initialise()}.
3201         $this->rootnodes['courses']->isexpandable = true;
3203         // Branchtype will be one of navigation_node::TYPE_*
3204         switch ($this->branchtype) {
3205             case 0:
3206                 if ($this->instanceid === 'mycourses') {
3207                     $this->load_courses_enrolled();
3208                 } else if ($this->instanceid === 'courses') {
3209                     $this->load_courses_other();
3210                 }
3211                 break;
3212             case self::TYPE_CATEGORY :
3213                 $this->load_category($this->instanceid);
3214                 break;
3215             case self::TYPE_MY_CATEGORY :
3216                 $this->load_category($this->instanceid, self::TYPE_MY_CATEGORY);
3217                 break;
3218             case self::TYPE_COURSE :
3219                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
3220                 if (!can_access_course($course, null, '', true)) {
3221                     // Thats OK all courses are expandable by default. We don't need to actually expand it we can just
3222                     // add the course node and break. This leads to an empty node.
3223                     $this->add_course($course);
3224                     break;
3225                 }
3226                 require_course_login($course, true, null, false, true);
3227                 $this->page->set_context(context_course::instance($course->id));
3228                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
3229                 $this->add_course_essentials($coursenode, $course);
3230                 $this->load_course_sections($course, $coursenode);
3231                 break;
3232             case self::TYPE_SECTION :
3233                 $sql = 'SELECT c.*, cs.section AS sectionnumber
3234                         FROM {course} c
3235                         LEFT JOIN {course_sections} cs ON cs.course = c.id
3236                         WHERE cs.id = ?';
3237                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
3238                 require_course_login($course, true, null, false, true);
3239                 $this->page->set_context(context_course::instance($course->id));
3240                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
3241                 $this->add_course_essentials($coursenode, $course);
3242                 $this->load_course_sections($course, $coursenode, $course->sectionnumber);
3243                 break;
3244             case self::TYPE_ACTIVITY :
3245                 $sql = "SELECT c.*
3246                           FROM {course} c
3247                           JOIN {course_modules} cm ON cm.course = c.id
3248                          WHERE cm.id = :cmid";
3249                 $params = array('cmid' => $this->instanceid);
3250                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
3251                 $modinfo = get_fast_modinfo($course);
3252                 $cm = $modinfo->get_cm($this->instanceid);
3253                 require_course_login($course, true, $cm, false, true);
3254                 $this->page->set_context(context_module::instance($cm->id));
3255                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
3256                 $this->load_course_sections($course, $coursenode, null, $cm);
3257                 $activitynode = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
3258                 if ($activitynode) {
3259                     $modulenode = $this->load_activity($cm, $course, $activitynode);
3260                 }
3261                 break;
3262             default:
3263                 throw new Exception('Unknown type');
3264                 return $this->expandable;
3265         }
3267         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) {
3268             $this->load_for_user(null, true);
3269         }
3271         // Give the local plugins a chance to include some navigation if they want.
3272         $this->load_local_plugin_navigation();
3274         $this->find_expandable($this->expandable);
3275         return $this->expandable;
3276     }
3278     /**
3279      * They've expanded the general 'courses' branch.
3280      */
3281     protected function load_courses_other() {
3282         $this->load_all_courses();
3283     }
3285     /**
3286      * Loads a single category into the AJAX navigation.
3287      *
3288      * This function is special in that it doesn't concern itself with the parent of
3289      * the requested category or its siblings.
3290      * This is because with the AJAX navigation we know exactly what is wanted and only need to
3291      * request that.
3292      *
3293      * @global moodle_database $DB
3294      * @param int $categoryid id of category to load in navigation.
3295      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
3296      * @return void.
3297      */
3298     protected function load_category($categoryid, $nodetype = self::TYPE_CATEGORY) {
3299         global $CFG, $DB;
3301         $limit = 20;
3302         if (!empty($CFG->navcourselimit)) {
3303             $limit = (int)$CFG->navcourselimit;
3304         }
3306         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
3307         $sql = "SELECT cc.*, $catcontextsql
3308                   FROM {course_categories} cc
3309                   JOIN {context} ctx ON cc.id = ctx.instanceid
3310                  WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND
3311                        (cc.id = :categoryid1 OR cc.parent = :categoryid2)
3312               ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
3313         $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
3314         $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
3315         $categorylist = array();
3316         $subcategories = array();
3317         $basecategory = null;
3318         foreach ($categories as $category) {
3319             $categorylist[] = $category->id;
3320             context_helper::preload_from_record($category);
3321             if ($category->id == $categoryid) {
3322                 $this->add_category($category, $this, $nodetype);
3323                 $basecategory = $this->addedcategories[$category->id];
3324             } else {
3325                 $subcategories[$category->id] = $category;
3326             }
3327         }
3328         $categories->close();
3331         // If category is shown in MyHome then only show enrolled courses and hide empty subcategories,
3332         // else show all courses.
3333         if ($nodetype === self::TYPE_MY_CATEGORY) {
3334             $courses = enrol_get_my_courses('*');
3335             $categoryids = array();
3337             // Only search for categories if basecategory was found.
3338             if (!is_null($basecategory)) {
3339                 // Get course parent category ids.
3340                 foreach ($courses as $course) {
3341                     $categoryids[] = $course->category;
3342                 }
3344                 // Get a unique list of category ids which a part of the path
3345                 // to user's courses.
3346                 $coursesubcategories = array();
3347                 $addedsubcategories = array();
3349                 list($sql, $params) = $DB->get_in_or_equal($categoryids);
3350                 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path');
3352                 foreach ($categories as $category){
3353                     $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path, "/")));
3354                 }
3355                 $categories->close();
3356                 $coursesubcategories = array_unique($coursesubcategories);
3358                 // Only add a subcategory if it is part of the path to user's course and
3359                 // wasn't already added.
3360                 foreach ($subcategories as $subid => $subcategory) {
3361                     if (in_array($subid, $coursesubcategories) &&
3362                             !in_array($subid, $addedsubcategories)) {
3363                             $this->add_category($subcategory, $basecategory, $nodetype);
3364                             $addedsubcategories[] = $subid;
3365                     }
3366                 }
3367             }
3369             foreach ($courses as $course) {
3370                 // Add course if it's in category.
3371                 if (in_array($course->category, $categorylist)) {
3372                     $this->add_course($course, true, self::COURSE_MY);
3373                 }
3374             }
3375         } else {
3376             if (!is_null($basecategory)) {
3377                 foreach ($subcategories as $key=>$category) {
3378                     $this->add_category($category, $basecategory, $nodetype);
3379                 }
3380             }
3381             $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
3382             foreach ($courses as $course) {
3383                 $this->add_course($course);
3384             }
3385             $courses->close();
3386         }
3387     }
3389     /**
3390      * Returns an array of expandable nodes
3391      * @return array
3392      */
3393     public function get_expandable() {
3394         return $this->expandable;
3395     }
3398 /**
3399  * Navbar class
3400  *
3401  * This class is used to manage the navbar, which is initialised from the navigation
3402  * object held by PAGE
3403  *
3404  * @package   core
3405  * @category  navigation
3406  * @copyright 2009 Sam Hemelryk
3407  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3408  */
3409 class navbar extends navigation_node {
3410     /** @var bool A switch for whether the navbar is initialised or not */
3411     protected $initialised = false;
3412     /** @var mixed keys used to reference the nodes on the navbar */
3413     protected $keys = array();
3414     /** @var null|string content of the navbar */
3415     protected $content = null;
3416     /** @var moodle_page object the moodle page that this navbar belongs to */
3417     protected $page;
3418     /** @var bool A switch for whether to ignore the active navigation information */
3419     protected $ignoreactive = false;
3420     /** @var bool A switch to let us know if we are in the middle of an install */
3421     protected $duringinstall = false;
3422     /** @var bool A switch for whether the navbar has items */
3423     protected $hasitems = false;
3424     /** @var array An array of navigation nodes for the navbar */
3425     protected $items;
3426     /** @var array An array of child node objects */
3427     public $children = array();
3428     /** @var bool A switch for whether we want to include the root node in the navbar */
3429     public $includesettingsbase = false;
3430     /** @var breadcrumb_navigation_node[] $prependchildren */
3431     protected $prependchildren = array();
3433     /**
3434      * The almighty constructor
3435      *
3436      * @param moodle_page $page
3437      */
3438     public function __construct(moodle_page $page) {
3439         global $CFG;
3440         if (during_initial_install()) {
3441             $this->duringinstall = true;
3442             return false;
3443         }
3444         $this->page = $page;
3445         $this->text = get_string('home');
3446         $this->shorttext = get_string('home');
3447         $this->action = new moodle_url($CFG->wwwroot);
3448         $this->nodetype = self::NODETYPE_BRANCH;
3449         $this->type = self::TYPE_SYSTEM;
3450     }
3452     /**
3453      * Quick check to see if the navbar will have items in.
3454      *
3455      * @return bool Returns true if the navbar will have items, false otherwise
3456      */
3457     public function has_items() {
3458         if ($this->duringinstall) {
3459             return false;
3460         } else if ($this->hasitems !== false) {
3461             return true;
3462         }
3463         if (count($this->children) > 0 || count($this->prependchildren) > 0) {
3464             // There have been manually added items - there are definitely items.
3465             $outcome = true;
3466         } else if (!$this->ignoreactive) {
3467             // We will need to initialise the navigation structure to check if there are active items.
3468             $this->page->navigation->initialise($this->page);
3469             $outcome = ($this->page->navigation->contains_active_node() || $this->page->settingsnav->contains_active_node());
3470         }
3471         $this->hasitems = $outcome;
3472         return $outcome;
3473     }
3475     /**
3476      * Turn on/off ignore active
3477      *
3478      * @param bool $setting
3479      */
3480     public function ignore_active($setting=true) {
3481         $this->ignoreactive = ($setting);
3482     }
3484     /**
3485      * Gets a navigation node
3486      *
3487      * @param string|int $key for referencing the navbar nodes
3488      * @param int $type breadcrumb_navigation_node::TYPE_*
3489      * @return breadcrumb_navigation_node|bool
3490      */
3491     public function get($key, $type = null) {
3492         foreach ($this->children as &$child) {
3493             if ($child->key === $key && ($type == null || $type == $child->type)) {
3494                 return $child;
3495             }
3496         }
3497         foreach ($this->prependchildren as &$child) {
3498             if ($child->key === $key && ($type == null || $type == $child->type)) {
3499                 return $child;
3500             }
3501         }
3502         return false;
3503     }
3504     /**
3505      * Returns an array of breadcrumb_navigation_nodes that make up the navbar.
3506      *
3507      * @return array
3508      */
3509     public function get_items() {
3510         global $CFG;
3511         $items = array();
3512         // Make sure that navigation is initialised
3513         if (!$this->has_items()) {
3514             return $items;
3515         }
3516         if ($this->items !== null) {
3517             return $this->items;
3518         }
3520         if (count($this->children) > 0) {
3521             // Add the custom children.
3522             $items = array_reverse($this->children);
3523         }
3525         // Check if navigation contains the active node
3526         if (!$this->ignoreactive) {
3527             // We will need to ensure the navigation has been initialised.
3528             $this->page->navigation->initialise($this->page);
3529             // Now find the active nodes on both the navigation and settings.
3530             $navigationactivenode = $this->page->navigation->find_active_node();
3531             $settingsactivenode = $this->page->settingsnav->find_active_node();
3533             if ($navigationactivenode && $settingsactivenode) {
3534                 // Parse a combined navigation tree
3535                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3536                     if (!$settingsactivenode->mainnavonly) {
3537                         $items[] = new breadcrumb_navigation_node($settingsactivenode);
3538                     }
3539                     $settingsactivenode = $settingsactivenode->parent;
3540                 }
3541                 if (!$this->includesettingsbase) {
3542                     // Removes the first node from the settings (root node) from the list
3543                     array_pop($items);
3544                 }
3545                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3546                     if (!$navigationactivenode->mainnavonly) {
3547                         $items[] = new breadcrumb_navigation_node($navigationactivenode);
3548                     }
3549                     if (!empty($CFG->navshowcategories) &&
3550                             $navigationactivenode->type === self::TYPE_COURSE &&
3551                             $navigationactivenode->parent->key === 'currentcourse') {
3552                         foreach ($this->get_course_categories() as $item) {
3553                             $items[] = new breadcrumb_navigation_node($item);
3554                         }
3555                     }
3556                     $navigationactivenode = $navigationactivenode->parent;
3557                 }
3558             } else if ($navigationactivenode) {
3559                 // Parse the navigation tree to get the active node
3560                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3561                     if (!$navigationactivenode->mainnavonly) {
3562                         $items[] = new breadcrumb_navigation_node($navigationactivenode);
3563                     }
3564                     if (!empty($CFG->navshowcategories) &&
3565                             $navigationactivenode->type === self::TYPE_COURSE &&
3566                             $navigationactivenode->parent->key === 'currentcourse') {
3567                         foreach ($this->get_course_categories() as $item) {
3568                             $items[] = new breadcrumb_navigation_node($item);
3569                         }
3570                     }
3571                     $navigationactivenode = $navigationactivenode->parent;
3572                 }
3573             } else if ($settingsactivenode) {
3574                 // Parse the settings navigation to get the active node
3575                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3576                     if (!$settingsactivenode->mainnavonly) {
3577                         $items[] = new breadcrumb_navigation_node($settingsactivenode);
3578                     }
3579                     $settingsactivenode = $settingsactivenode->parent;
3580                 }
3581             }
3582         }
3584         $items[] = new breadcrumb_navigation_node(array(
3585             'text' => $this->page->navigation->text,
3586             'shorttext' => $this->page->navigation->shorttext,
3587             'key' => $this->page->navigation->key,
3588             'action' => $this->page->navigation->action
3589         ));
3591         if (count($this->prependchildren) > 0) {
3592             // Add the custom children
3593             $items = array_merge($items, array_reverse($this->prependchildren));
3594         }
3596         $last = reset($items);
3597         if ($last) {
3598             $last->set_last(true);
3599         }
3600         $this->items = array_reverse($items);
3601         return $this->items;
3602     }
3604     /**
3605      * Get the list of categories leading to this course.
3606      *
3607      * This function is used by {@link navbar::get_items()} to add back the "courses"
3608      * node and category chain leading to the current course.  Note that this is only ever
3609      * called for the current course, so we don't need to bother taking in any parameters.
3610      *
3611      * @return array
3612      */
3613     private function get_course_categories() {
3614         global $CFG;
3615         require_once($CFG->dirroot.'/course/lib.php');
3617         $categories = array();
3618         $cap = 'moodle/category:viewhiddencategories';
3619         $showcategories = !core_course_category::is_simple_site();
3621         if ($showcategories) {
3622             foreach ($this->page->categories as $category) {
3623                 $context = context_coursecat::instance($category->id);
3624                 if (!core_course_category::can_view_category($category)) {
3625                     continue;
3626                 }
3627                 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
3628                 $name = format_string($category->name, true, array('context' => $context));
3629                 $categorynode = breadcrumb_navigation_node::create($name, $url, self::TYPE_CATEGORY, null, $category->id);
3630                 if (!$category->visible) {
3631                     $categorynode->hidden = true;
3632                 }
3633                 $categories[] = $categorynode;
3634             }
3635         }
3637         // Don't show the 'course' node if enrolled in this course.
3638         if (!is_enrolled(context_course::instance($this->page->course->id, null, '', true))) {
3639             $courses = $this->page->navigation->get('courses');
3640             if (!$courses) {
3641                 // Courses node may not be present.
3642                 $courses = breadcrumb_navigation_node::create(
3643                     get_string('courses'),
3644                     new moodle_url('/course/index.php'),
3645                     self::TYPE_CONTAINER
3646                 );
3647             }
3648             $categories[] = $courses;
3649         }
3651         return $categories;
3652     }
3654     /**
3655      * Add a new breadcrumb_navigation_node to the navbar, overrides parent::add
3656      *
3657      * This function overrides {@link breadcrumb_navigation_node::add()} so that we can change
3658      * the way nodes get added to allow us to simply call add and have the node added to the
3659      * end of the navbar
3660      *
3661      * @param string $text
3662      * @param string|moodle_url|action_link $action An action to associate with this node.
3663      * @param int $type One of navigation_node::TYPE_*
3664      * @param string $shorttext
3665      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3666      * @param pix_icon $icon An optional icon to use for this node.
3667      * @return navigation_node
3668      */
3669     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3670         if ($this->content !== null) {
3671             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3672         }
3674         // Properties array used when creating the new navigation node
3675         $itemarray = array(
3676             'text' => $text,
3677             'type' => $type
3678         );
3679         // Set the action if one was provided
3680         if ($action!==null) {
3681             $itemarray['action'] = $action;
3682         }
3683         // Set the shorttext if one was provided
3684         if ($shorttext!==null) {
3685             $itemarray['shorttext'] = $shorttext;
3686         }
3687         // Set the icon if one was provided
3688         if ($icon!==null) {
3689             $itemarray['icon'] = $icon;
3690         }
3691         // Default the key to the number of children if not provided
3692         if ($key === null) {
3693             $key = count($this->children);
3694         }
3695         // Set the key
3696         $itemarray['key'] = $key;
3697         // Set the parent to this node
3698         $itemarray['parent'] = $this;
3699         // Add the child using the navigation_node_collections add method
3700         $this->children[] = new breadcrumb_navigation_node($itemarray);
3701         return $this;
3702     }
3704     /**
3705      * Prepends a new navigation_node to the start of the navbar
3706      *
3707      * @param string $text
3708      * @param string|moodle_url|action_link $action An action to associate with this node.
3709      * @param int $type One of navigation_node::TYPE_*
3710      * @param string $shorttext
3711      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3712      * @param pix_icon $icon An optional icon to use for this node.
3713      * @return navigation_node
3714      */
3715     public function prepend($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3716         if ($this->content !== null) {
3717             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3718         }
3719         // Properties array used when creating the new navigation node.
3720         $itemarray = array(
3721             'text' => $text,
3722             'type' => $type
3723         );
3724         // Set the action if one was provided.
3725         if ($action!==null) {
3726             $itemarray['action'] = $action;
3727         }
3728         // Set the shorttext if one was provided.
3729         if ($shorttext!==null) {
3730             $itemarray['shorttext'] = $shorttext;
3731         }
3732         // Set the icon if one was provided.
3733         if ($icon!==null) {
3734             $itemarray['icon'] = $icon;
3735         }
3736         // Default the key to the number of children if not provided.
3737         if ($key === null) {
3738             $key = count($this->children);
3739         }
3740         // Set the key.
3741         $itemarray['key'] = $key;
3742         // Set the parent to this node.
3743         $itemarray['parent'] = $this;
3744         // Add the child node to the prepend list.
3745         $this->prependchildren[] = new breadcrumb_navigation_node($itemarray);
3746         return $this;
3747     }
3750 /**
3751  * Subclass of navigation_node allowing different rendering for the breadcrumbs
3752  * in particular adding extra metadata for search engine robots to leverage.
3753  *
3754  * @package   core
3755  * @category  navigation
3756  * @copyright 2015 Brendan Heywood
3757  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3758  */
3759 class breadcrumb_navigation_node extends navigation_node {
3761     /** @var $last boolean A flag indicating this is the last item in the list of breadcrumbs. */
3762     private $last = false;
3764     /**
3765      * A proxy constructor
3766      *
3767      * @param mixed $navnode A navigation_node or an array
3768      */
3769     public function __construct($navnode) {
3770         if (is_array($navnode)) {
3771             parent::__construct($navnode);
3772         } else if ($navnode instanceof navigation_node) {
3774             // Just clone everything.
3775             $objvalues = get_object_vars($navnode);
3776             foreach ($objvalues as $key => $value) {
3777                  $this->$key = $value;
3778             }
3779         } else {
3780             throw new coding_exception('Not a valid breadcrumb_navigation_node');
3781         }
3782     }
3784     /**
3785      * Getter for "last"
3786      * @return boolean
3787      */
3788     public function is_last() {
3789         return $this->last;
3790     }
3792     /**
3793      * Setter for "last"
3794      * @param $val boolean
3795      */
3796     public function set_last($val) {
3797         $this->last = $val;
3798     }
3801 /**
3802  * Subclass of navigation_node allowing different rendering for the flat navigation
3803  * in particular allowing dividers and indents.
3804  *
3805  * @package   core
3806  * @category  navigation
3807  * @copyright 2016 Damyon Wiese
3808  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3809  */
3810 class flat_navigation_node extends navigation_node {
3812     /** @var $indent integer The indent level */
3813     private $indent = 0;
3815     /** @var $showdivider bool Show a divider before this element */
3816     private $showdivider = false;
3818     /** @var $collectionlabel string Label for a group of nodes */
3819     private $collectionlabel = '';
3821     /**
3822      * A proxy constructor
3823      *
3824      * @param mixed $navnode A navigation_node or an array
3825      */
3826     public function __construct($navnode, $indent) {
3827         if (is_array($navnode)) {
3828             parent::__construct($navnode);
3829         } else if ($navnode instanceof navigation_node) {