b90b9a22c7db3cbe2ca23c0cd41f626fbcc68c37
[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      */
434     public function build_flat_navigation_list(flat_navigation $nodes, $showdivider = false) {
435         if ($this->showinflatnavigation) {
436             $indent = 0;
437             if ($this->type == self::TYPE_COURSE || $this->key === self::COURSE_INDEX_PAGE) {
438                 $indent = 1;
439             }
440             $flat = new flat_navigation_node($this, $indent);
441             $flat->set_showdivider($showdivider);
442             $nodes->add($flat);
443         }
444         foreach ($this->children as $child) {
445             $child->build_flat_navigation_list($nodes, false);
446         }
447     }
449     /**
450      * Get the child of this node that has the given key + (optional) type.
451      *
452      * If you are looking for a node and want to search all children + their children
453      * then please use the find method instead.
454      *
455      * @param int|string $key The key of the node we are looking for
456      * @param int $type One of navigation_node::TYPE_*
457      * @return navigation_node|false
458      */
459     public function get($key, $type=null) {
460         return $this->children->get($key, $type);
461     }
463     /**
464      * Removes this node.
465      *
466      * @return bool
467      */
468     public function remove() {
469         return $this->parent->children->remove($this->key, $this->type);
470     }
472     /**
473      * Checks if this node has or could have any children
474      *
475      * @return bool Returns true if it has children or could have (by AJAX expansion)
476      */
477     public function has_children() {
478         return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0 || $this->isexpandable);
479     }
481     /**
482      * Marks this node as active and forces it open.
483      *
484      * Important: If you are here because you need to mark a node active to get
485      * the navigation to do what you want have you looked at {@link navigation_node::override_active_url()}?
486      * You can use it to specify a different URL to match the active navigation node on
487      * rather than having to locate and manually mark a node active.
488      */
489     public function make_active() {
490         $this->isactive = true;
491         $this->add_class('active_tree_node');
492         $this->force_open();
493         if ($this->parent !== null) {
494             $this->parent->make_inactive();
495         }
496     }
498     /**
499      * Marks a node as inactive and recusised back to the base of the tree
500      * doing the same to all parents.
501      */
502     public function make_inactive() {
503         $this->isactive = false;
504         $this->remove_class('active_tree_node');
505         if ($this->parent !== null) {
506             $this->parent->make_inactive();
507         }
508     }
510     /**
511      * Forces this node to be open and at the same time forces open all
512      * parents until the root node.
513      *
514      * Recursive.
515      */
516     public function force_open() {
517         $this->forceopen = true;
518         if ($this->parent !== null) {
519             $this->parent->force_open();
520         }
521     }
523     /**
524      * Adds a CSS class to this node.
525      *
526      * @param string $class
527      * @return bool
528      */
529     public function add_class($class) {
530         if (!in_array($class, $this->classes)) {
531             $this->classes[] = $class;
532         }
533         return true;
534     }
536     /**
537      * Removes a CSS class from this node.
538      *
539      * @param string $class
540      * @return bool True if the class was successfully removed.
541      */
542     public function remove_class($class) {
543         if (in_array($class, $this->classes)) {
544             $key = array_search($class,$this->classes);
545             if ($key!==false) {
546                 unset($this->classes[$key]);
547                 return true;
548             }
549         }
550         return false;
551     }
553     /**
554      * Sets the title for this node and forces Moodle to utilise it.
555      * @param string $title
556      */
557     public function title($title) {
558         $this->title = $title;
559         $this->forcetitle = true;
560     }
562     /**
563      * Resets the page specific information on this node if it is being unserialised.
564      */
565     public function __wakeup(){
566         $this->forceopen = false;
567         $this->isactive = false;
568         $this->remove_class('active_tree_node');
569     }
571     /**
572      * Checks if this node or any of its children contain the active node.
573      *
574      * Recursive.
575      *
576      * @return bool
577      */
578     public function contains_active_node() {
579         if ($this->isactive) {
580             return true;
581         } else {
582             foreach ($this->children as $child) {
583                 if ($child->isactive || $child->contains_active_node()) {
584                     return true;
585                 }
586             }
587         }
588         return false;
589     }
591     /**
592      * To better balance the admin tree, we want to group all the short top branches together.
593      *
594      * This means < 8 nodes and no subtrees.
595      *
596      * @return bool
597      */
598     public function is_short_branch() {
599         $limit = 8;
600         if ($this->children->count() >= $limit) {
601             return false;
602         }
603         foreach ($this->children as $child) {
604             if ($child->has_children()) {
605                 return false;
606             }
607         }
608         return true;
609     }
611     /**
612      * Finds the active node.
613      *
614      * Searches this nodes children plus all of the children for the active node
615      * and returns it if found.
616      *
617      * Recursive.
618      *
619      * @return navigation_node|false
620      */
621     public function find_active_node() {
622         if ($this->isactive) {
623             return $this;
624         } else {
625             foreach ($this->children as &$child) {
626                 $outcome = $child->find_active_node();
627                 if ($outcome !== false) {
628                     return $outcome;
629                 }
630             }
631         }
632         return false;
633     }
635     /**
636      * Searches all children for the best matching active node
637      * @return navigation_node|false
638      */
639     public function search_for_active_node() {
640         if ($this->check_if_active(URL_MATCH_BASE)) {
641             return $this;
642         } else {
643             foreach ($this->children as &$child) {
644                 $outcome = $child->search_for_active_node();
645                 if ($outcome !== false) {
646                     return $outcome;
647                 }
648             }
649         }
650         return false;
651     }
653     /**
654      * Gets the content for this node.
655      *
656      * @param bool $shorttext If true shorttext is used rather than the normal text
657      * @return string
658      */
659     public function get_content($shorttext=false) {
660         if ($shorttext && $this->shorttext!==null) {
661             return format_string($this->shorttext);
662         } else {
663             return format_string($this->text);
664         }
665     }
667     /**
668      * Gets the title to use for this node.
669      *
670      * @return string
671      */
672     public function get_title() {
673         if ($this->forcetitle || $this->action != null){
674             return $this->title;
675         } else {
676             return '';
677         }
678     }
680     /**
681      * Used to easily determine if this link in the breadcrumbs has a valid action/url.
682      *
683      * @return boolean
684      */
685     public function has_action() {
686         return !empty($this->action);
687     }
689     /**
690      * Gets the CSS class to add to this node to describe its type
691      *
692      * @return string
693      */
694     public function get_css_type() {
695         if (array_key_exists($this->type, $this->namedtypes)) {
696             return 'type_'.$this->namedtypes[$this->type];
697         }
698         return 'type_unknown';
699     }
701     /**
702      * Finds all nodes that are expandable by AJAX
703      *
704      * @param array $expandable An array by reference to populate with expandable nodes.
705      */
706     public function find_expandable(array &$expandable) {
707         foreach ($this->children as &$child) {
708             if ($child->display && $child->has_children() && $child->children->count() == 0) {
709                 $child->id = 'expandable_branch_'.$child->type.'_'.clean_param($child->key, PARAM_ALPHANUMEXT);
710                 $this->add_class('canexpand');
711                 $child->requiresajaxloading = true;
712                 $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type);
713             }
714             $child->find_expandable($expandable);
715         }
716     }
718     /**
719      * Finds all nodes of a given type (recursive)
720      *
721      * @param int $type One of navigation_node::TYPE_*
722      * @return array
723      */
724     public function find_all_of_type($type) {
725         $nodes = $this->children->type($type);
726         foreach ($this->children as &$node) {
727             $childnodes = $node->find_all_of_type($type);
728             $nodes = array_merge($nodes, $childnodes);
729         }
730         return $nodes;
731     }
733     /**
734      * Removes this node if it is empty
735      */
736     public function trim_if_empty() {
737         if ($this->children->count() == 0) {
738             $this->remove();
739         }
740     }
742     /**
743      * Creates a tab representation of this nodes children that can be used
744      * with print_tabs to produce the tabs on a page.
745      *
746      * call_user_func_array('print_tabs', $node->get_tabs_array());
747      *
748      * @param array $inactive
749      * @param bool $return
750      * @return array Array (tabs, selected, inactive, activated, return)
751      */
752     public function get_tabs_array(array $inactive=array(), $return=false) {
753         $tabs = array();
754         $rows = array();
755         $selected = null;
756         $activated = array();
757         foreach ($this->children as $node) {
758             $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title());
759             if ($node->contains_active_node()) {
760                 if ($node->children->count() > 0) {
761                     $activated[] = $node->key;
762                     foreach ($node->children as $child) {
763                         if ($child->contains_active_node()) {
764                             $selected = $child->key;
765                         }
766                         $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title());
767                     }
768                 } else {
769                     $selected = $node->key;
770                 }
771             }
772         }
773         return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
774     }
776     /**
777      * Sets the parent for this node and if this node is active ensures that the tree is properly
778      * adjusted as well.
779      *
780      * @param navigation_node $parent
781      */
782     public function set_parent(navigation_node $parent) {
783         // Set the parent (thats the easy part)
784         $this->parent = $parent;
785         // Check if this node is active (this is checked during construction)
786         if ($this->isactive) {
787             // Force all of the parent nodes open so you can see this node
788             $this->parent->force_open();
789             // Make all parents inactive so that its clear where we are.
790             $this->parent->make_inactive();
791         }
792     }
794     /**
795      * Hides the node and any children it has.
796      *
797      * @since Moodle 2.5
798      * @param array $typestohide Optional. An array of node types that should be hidden.
799      *      If null all nodes will be hidden.
800      *      If an array is given then nodes will only be hidden if their type mtatches an element in the array.
801      *          e.g. array(navigation_node::TYPE_COURSE) would hide only course nodes.
802      */
803     public function hide(array $typestohide = null) {
804         if ($typestohide === null || in_array($this->type, $typestohide)) {
805             $this->display = false;
806             if ($this->has_children()) {
807                 foreach ($this->children as $child) {
808                     $child->hide($typestohide);
809                 }
810             }
811         }
812     }
814     /**
815      * Get the action url for this navigation node.
816      * Called from templates.
817      *
818      * @since Moodle 3.2
819      */
820     public function action() {
821         if ($this->action instanceof moodle_url) {
822             return $this->action;
823         } else if ($this->action instanceof action_link) {
824             return $this->action->url;
825         }
826         return $this->action;
827     }
830 /**
831  * Navigation node collection
832  *
833  * This class is responsible for managing a collection of navigation nodes.
834  * It is required because a node's unique identifier is a combination of both its
835  * key and its type.
836  *
837  * Originally an array was used with a string key that was a combination of the two
838  * however it was decided that a better solution would be to use a class that
839  * implements the standard IteratorAggregate interface.
840  *
841  * @package   core
842  * @category  navigation
843  * @copyright 2010 Sam Hemelryk
844  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
845  */
846 class navigation_node_collection implements IteratorAggregate, Countable {
847     /**
848      * A multidimensional array to where the first key is the type and the second
849      * key is the nodes key.
850      * @var array
851      */
852     protected $collection = array();
853     /**
854      * An array that contains references to nodes in the same order they were added.
855      * This is maintained as a progressive array.
856      * @var array
857      */
858     protected $orderedcollection = array();
859     /**
860      * A reference to the last node that was added to the collection
861      * @var navigation_node
862      */
863     protected $last = null;
864     /**
865      * The total number of items added to this array.
866      * @var int
867      */
868     protected $count = 0;
870     /**
871      * Adds a navigation node to the collection
872      *
873      * @param navigation_node $node Node to add
874      * @param string $beforekey If specified, adds before a node with this key,
875      *   otherwise adds at end
876      * @return navigation_node Added node
877      */
878     public function add(navigation_node $node, $beforekey=null) {
879         global $CFG;
880         $key = $node->key;
881         $type = $node->type;
883         // First check we have a 2nd dimension for this type
884         if (!array_key_exists($type, $this->orderedcollection)) {
885             $this->orderedcollection[$type] = array();
886         }
887         // Check for a collision and report if debugging is turned on
888         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
889             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
890         }
892         // Find the key to add before
893         $newindex = $this->count;
894         $last = true;
895         if ($beforekey !== null) {
896             foreach ($this->collection as $index => $othernode) {
897                 if ($othernode->key === $beforekey) {
898                     $newindex = $index;
899                     $last = false;
900                     break;
901                 }
902             }
903             if ($newindex === $this->count) {
904                 debugging('Navigation node add_before: Reference node not found ' . $beforekey .
905                         ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER);
906             }
907         }
909         // Add the node to the appropriate place in the by-type structure (which
910         // is not ordered, despite the variable name)
911         $this->orderedcollection[$type][$key] = $node;
912         if (!$last) {
913             // Update existing references in the ordered collection (which is the
914             // one that isn't called 'ordered') to shuffle them along if required
915             for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) {
916                 $this->collection[$oldindex] = $this->collection[$oldindex - 1];
917             }
918         }
919         // Add a reference to the node to the progressive collection.
920         $this->collection[$newindex] = $this->orderedcollection[$type][$key];
921         // Update the last property to a reference to this new node.
922         $this->last = $this->orderedcollection[$type][$key];
924         // Reorder the array by index if needed
925         if (!$last) {
926             ksort($this->collection);
927         }
928         $this->count++;
929         // Return the reference to the now added node
930         return $node;
931     }
933     /**
934      * Return a list of all the keys of all the nodes.
935      * @return array the keys.
936      */
937     public function get_key_list() {
938         $keys = array();
939         foreach ($this->collection as $node) {
940             $keys[] = $node->key;
941         }
942         return $keys;
943     }
945     /**
946      * Fetches a node from this collection.
947      *
948      * @param string|int $key The key of the node we want to find.
949      * @param int $type One of navigation_node::TYPE_*.
950      * @return navigation_node|null
951      */
952     public function get($key, $type=null) {
953         if ($type !== null) {
954             // If the type is known then we can simply check and fetch
955             if (!empty($this->orderedcollection[$type][$key])) {
956                 return $this->orderedcollection[$type][$key];
957             }
958         } else {
959             // Because we don't know the type we look in the progressive array
960             foreach ($this->collection as $node) {
961                 if ($node->key === $key) {
962                     return $node;
963                 }
964             }
965         }
966         return false;
967     }
969     /**
970      * Searches for a node with matching key and type.
971      *
972      * This function searches both the nodes in this collection and all of
973      * the nodes in each collection belonging to the nodes in this collection.
974      *
975      * Recursive.
976      *
977      * @param string|int $key  The key of the node we want to find.
978      * @param int $type  One of navigation_node::TYPE_*.
979      * @return navigation_node|null
980      */
981     public function find($key, $type=null) {
982         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
983             return $this->orderedcollection[$type][$key];
984         } else {
985             $nodes = $this->getIterator();
986             // Search immediate children first
987             foreach ($nodes as &$node) {
988                 if ($node->key === $key && ($type === null || $type === $node->type)) {
989                     return $node;
990                 }
991             }
992             // Now search each childs children
993             foreach ($nodes as &$node) {
994                 $result = $node->children->find($key, $type);
995                 if ($result !== false) {
996                     return $result;
997                 }
998             }
999         }
1000         return false;
1001     }
1003     /**
1004      * Fetches the last node that was added to this collection
1005      *
1006      * @return navigation_node
1007      */
1008     public function last() {
1009         return $this->last;
1010     }
1012     /**
1013      * Fetches all nodes of a given type from this collection
1014      *
1015      * @param string|int $type  node type being searched for.
1016      * @return array ordered collection
1017      */
1018     public function type($type) {
1019         if (!array_key_exists($type, $this->orderedcollection)) {
1020             $this->orderedcollection[$type] = array();
1021         }
1022         return $this->orderedcollection[$type];
1023     }
1024     /**
1025      * Removes the node with the given key and type from the collection
1026      *
1027      * @param string|int $key The key of the node we want to find.
1028      * @param int $type
1029      * @return bool
1030      */
1031     public function remove($key, $type=null) {
1032         $child = $this->get($key, $type);
1033         if ($child !== false) {
1034             foreach ($this->collection as $colkey => $node) {
1035                 if ($node->key === $key && (is_null($type) || $node->type == $type)) {
1036                     unset($this->collection[$colkey]);
1037                     $this->collection = array_values($this->collection);
1038                     break;
1039                 }
1040             }
1041             unset($this->orderedcollection[$child->type][$child->key]);
1042             $this->count--;
1043             return true;
1044         }
1045         return false;
1046     }
1048     /**
1049      * Gets the number of nodes in this collection
1050      *
1051      * This option uses an internal count rather than counting the actual options to avoid
1052      * a performance hit through the count function.
1053      *
1054      * @return int
1055      */
1056     public function count() {
1057         return $this->count;
1058     }
1059     /**
1060      * Gets an array iterator for the collection.
1061      *
1062      * This is required by the IteratorAggregator interface and is used by routines
1063      * such as the foreach loop.
1064      *
1065      * @return ArrayIterator
1066      */
1067     public function getIterator() {
1068         return new ArrayIterator($this->collection);
1069     }
1072 /**
1073  * The global navigation class used for... the global navigation
1074  *
1075  * This class is used by PAGE to store the global navigation for the site
1076  * and is then used by the settings nav and navbar to save on processing and DB calls
1077  *
1078  * See
1079  * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()}
1080  * {@link lib/ajax/getnavbranch.php} Called by ajax
1081  *
1082  * @package   core
1083  * @category  navigation
1084  * @copyright 2009 Sam Hemelryk
1085  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1086  */
1087 class global_navigation extends navigation_node {
1088     /** @var moodle_page The Moodle page this navigation object belongs to. */
1089     protected $page;
1090     /** @var bool switch to let us know if the navigation object is initialised*/
1091     protected $initialised = false;
1092     /** @var array An array of course information */
1093     protected $mycourses = array();
1094     /** @var navigation_node[] An array for containing  root navigation nodes */
1095     protected $rootnodes = array();
1096     /** @var bool A switch for whether to show empty sections in the navigation */
1097     protected $showemptysections = true;
1098     /** @var bool A switch for whether courses should be shown within categories on the navigation. */
1099     protected $showcategories = null;
1100     /** @var null@var bool A switch for whether or not to show categories in the my courses branch. */
1101     protected $showmycategories = null;
1102     /** @var array An array of stdClasses for users that the navigation is extended for */
1103     protected $extendforuser = array();
1104     /** @var navigation_cache */
1105     protected $cache;
1106     /** @var array An array of course ids that are present in the navigation */
1107     protected $addedcourses = array();
1108     /** @var bool */
1109     protected $allcategoriesloaded = false;
1110     /** @var array An array of category ids that are included in the navigation */
1111     protected $addedcategories = array();
1112     /** @var int expansion limit */
1113     protected $expansionlimit = 0;
1114     /** @var int userid to allow parent to see child's profile page navigation */
1115     protected $useridtouseforparentchecks = 0;
1116     /** @var cache_session A cache that stores information on expanded courses */
1117     protected $cacheexpandcourse = null;
1119     /** Used when loading categories to load all top level categories [parent = 0] **/
1120     const LOAD_ROOT_CATEGORIES = 0;
1121     /** Used when loading categories to load all categories **/
1122     const LOAD_ALL_CATEGORIES = -1;
1124     /**
1125      * Constructs a new global navigation
1126      *
1127      * @param moodle_page $page The page this navigation object belongs to
1128      */
1129     public function __construct(moodle_page $page) {
1130         global $CFG, $SITE, $USER;
1132         if (during_initial_install()) {
1133             return;
1134         }
1136         if (get_home_page() == HOMEPAGE_SITE) {
1137             // We are using the site home for the root element
1138             $properties = array(
1139                 'key' => 'home',
1140                 'type' => navigation_node::TYPE_SYSTEM,
1141                 'text' => get_string('home'),
1142                 'action' => new moodle_url('/'),
1143                 'icon' => new pix_icon('i/home', '')
1144             );
1145         } else {
1146             // We are using the users my moodle for the root element
1147             $properties = array(
1148                 'key' => 'myhome',
1149                 'type' => navigation_node::TYPE_SYSTEM,
1150                 'text' => get_string('myhome'),
1151                 'action' => new moodle_url('/my/'),
1152                 'icon' => new pix_icon('i/dashboard', '')
1153             );
1154         }
1156         // Use the parents constructor.... good good reuse
1157         parent::__construct($properties);
1158         $this->showinflatnavigation = true;
1160         // Initalise and set defaults
1161         $this->page = $page;
1162         $this->forceopen = true;
1163         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
1164     }
1166     /**
1167      * Mutator to set userid to allow parent to see child's profile
1168      * page navigation. See MDL-25805 for initial issue. Linked to it
1169      * is an issue explaining why this is a REALLY UGLY HACK thats not
1170      * for you to use!
1171      *
1172      * @param int $userid userid of profile page that parent wants to navigate around.
1173      */
1174     public function set_userid_for_parent_checks($userid) {
1175         $this->useridtouseforparentchecks = $userid;
1176     }
1179     /**
1180      * Initialises the navigation object.
1181      *
1182      * This causes the navigation object to look at the current state of the page
1183      * that it is associated with and then load the appropriate content.
1184      *
1185      * This should only occur the first time that the navigation structure is utilised
1186      * which will normally be either when the navbar is called to be displayed or
1187      * when a block makes use of it.
1188      *
1189      * @return bool
1190      */
1191     public function initialise() {
1192         global $CFG, $SITE, $USER;
1193         // Check if it has already been initialised
1194         if ($this->initialised || during_initial_install()) {
1195             return true;
1196         }
1197         $this->initialised = true;
1199         // Set up the five base root nodes. These are nodes where we will put our
1200         // content and are as follows:
1201         // site: Navigation for the front page.
1202         // myprofile: User profile information goes here.
1203         // currentcourse: The course being currently viewed.
1204         // mycourses: The users courses get added here.
1205         // courses: Additional courses are added here.
1206         // users: Other users information loaded here.
1207         $this->rootnodes = array();
1208         if (get_home_page() == HOMEPAGE_SITE) {
1209             // The home element should be my moodle because the root element is the site
1210             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
1211                 $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'),
1212                     self::TYPE_SETTING, null, 'home', new pix_icon('i/dashboard', ''));
1213                 $this->rootnodes['home']->showinflatnavigation = true;
1214             }
1215         } else {
1216             // The home element should be the site because the root node is my moodle
1217             $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'),
1218                 self::TYPE_SETTING, null, 'home', new pix_icon('i/home', ''));
1219             $this->rootnodes['home']->showinflatnavigation = true;
1220             if (!empty($CFG->defaulthomepage) && ($CFG->defaulthomepage == HOMEPAGE_MY)) {
1221                 // We need to stop automatic redirection
1222                 $this->rootnodes['home']->action->param('redirect', '0');
1223             }
1224         }
1225         $this->rootnodes['site'] = $this->add_course($SITE);
1226         $this->rootnodes['myprofile'] = $this->add(get_string('profile'), null, self::TYPE_USER, null, 'myprofile');
1227         $this->rootnodes['currentcourse'] = $this->add(get_string('currentcourse'), null, self::TYPE_ROOTNODE, null, 'currentcourse');
1228         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses', new pix_icon('i/course', ''));
1229         $this->rootnodes['courses'] = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self::TYPE_ROOTNODE, null, 'courses');
1230         $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
1232         // We always load the frontpage course to ensure it is available without
1233         // JavaScript enabled.
1234         $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE);
1235         $this->load_course_sections($SITE, $this->rootnodes['site']);
1237         $course = $this->page->course;
1238         $this->load_courses_enrolled();
1240         // $issite gets set to true if the current pages course is the sites frontpage course
1241         $issite = ($this->page->course->id == $SITE->id);
1243         // Determine if the user is enrolled in any course.
1244         $enrolledinanycourse = enrol_user_sees_own_courses();
1246         $this->rootnodes['currentcourse']->mainnavonly = true;
1247         if ($enrolledinanycourse) {
1248             $this->rootnodes['mycourses']->isexpandable = true;
1249             $this->rootnodes['mycourses']->showinflatnavigation = true;
1250             if ($CFG->navshowallcourses) {
1251                 // When we show all courses we need to show both the my courses and the regular courses branch.
1252                 $this->rootnodes['courses']->isexpandable = true;
1253             }
1254         } else {
1255             $this->rootnodes['courses']->isexpandable = true;
1256         }
1257         $this->rootnodes['mycourses']->forceopen = true;
1259         $canviewcourseprofile = true;
1261         // Next load context specific content into the navigation
1262         switch ($this->page->context->contextlevel) {
1263             case CONTEXT_SYSTEM :
1264                 // Nothing left to do here I feel.
1265                 break;
1266             case CONTEXT_COURSECAT :
1267                 // This is essential, we must load categories.
1268                 $this->load_all_categories($this->page->context->instanceid, true);
1269                 break;
1270             case CONTEXT_BLOCK :
1271             case CONTEXT_COURSE :
1272                 if ($issite) {
1273                     // Nothing left to do here.
1274                     break;
1275                 }
1277                 // Load the course associated with the current page into the navigation.
1278                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1279                 // If the course wasn't added then don't try going any further.
1280                 if (!$coursenode) {
1281                     $canviewcourseprofile = false;
1282                     break;
1283                 }
1285                 // If the user is not enrolled then we only want to show the
1286                 // course node and not populate it.
1288                 // Not enrolled, can't view, and hasn't switched roles
1289                 if (!can_access_course($course, null, '', true)) {
1290                     if ($coursenode->isexpandable === true) {
1291                         // Obviously the situation has changed, update the cache and adjust the node.
1292                         // This occurs if the user access to a course has been revoked (one way or another) after
1293                         // initially logging in for this session.
1294                         $this->get_expand_course_cache()->set($course->id, 1);
1295                         $coursenode->isexpandable = true;
1296                         $coursenode->nodetype = self::NODETYPE_BRANCH;
1297                     }
1298                     // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1299                     // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1300                     if (!$this->current_user_is_parent_role()) {
1301                         $coursenode->make_active();
1302                         $canviewcourseprofile = false;
1303                         break;
1304                     }
1305                 } else if ($coursenode->isexpandable === false) {
1306                     // Obviously the situation has changed, update the cache and adjust the node.
1307                     // This occurs if the user has been granted access to a course (one way or another) after initially
1308                     // logging in for this session.
1309                     $this->get_expand_course_cache()->set($course->id, 1);
1310                     $coursenode->isexpandable = true;
1311                     $coursenode->nodetype = self::NODETYPE_BRANCH;
1312                 }
1314                 // Add the essentials such as reports etc...
1315                 $this->add_course_essentials($coursenode, $course);
1316                 // Extend course navigation with it's sections/activities
1317                 $this->load_course_sections($course, $coursenode);
1318                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1319                     $coursenode->make_active();
1320                 }
1322                 break;
1323             case CONTEXT_MODULE :
1324                 if ($issite) {
1325                     // If this is the site course then most information will have
1326                     // already been loaded.
1327                     // However we need to check if there is more content that can
1328                     // yet be loaded for the specific module instance.
1329                     $activitynode = $this->rootnodes['site']->find($this->page->cm->id, navigation_node::TYPE_ACTIVITY);
1330                     if ($activitynode) {
1331                         $this->load_activity($this->page->cm, $this->page->course, $activitynode);
1332                     }
1333                     break;
1334                 }
1336                 $course = $this->page->course;
1337                 $cm = $this->page->cm;
1339                 // Load the course associated with the page into the navigation
1340                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1342                 // If the course wasn't added then don't try going any further.
1343                 if (!$coursenode) {
1344                     $canviewcourseprofile = false;
1345                     break;
1346                 }
1348                 // If the user is not enrolled then we only want to show the
1349                 // course node and not populate it.
1350                 if (!can_access_course($course, null, '', true)) {
1351                     $coursenode->make_active();
1352                     $canviewcourseprofile = false;
1353                     break;
1354                 }
1356                 $this->add_course_essentials($coursenode, $course);
1358                 // Load the course sections into the page
1359                 $this->load_course_sections($course, $coursenode, null, $cm);
1360                 $activity = $coursenode->find($cm->id, navigation_node::TYPE_ACTIVITY);
1361                 if (!empty($activity)) {
1362                     // Finally load the cm specific navigaton information
1363                     $this->load_activity($cm, $course, $activity);
1364                     // Check if we have an active ndoe
1365                     if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1366                         // And make the activity node active.
1367                         $activity->make_active();
1368                     }
1369                 }
1370                 break;
1371             case CONTEXT_USER :
1372                 if ($issite) {
1373                     // The users profile information etc is already loaded
1374                     // for the front page.
1375                     break;
1376                 }
1377                 $course = $this->page->course;
1378                 // Load the course associated with the user into the navigation
1379                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1381                 // If the course wasn't added then don't try going any further.
1382                 if (!$coursenode) {
1383                     $canviewcourseprofile = false;
1384                     break;
1385                 }
1387                 // If the user is not enrolled then we only want to show the
1388                 // course node and not populate it.
1389                 if (!can_access_course($course, null, '', true)) {
1390                     $coursenode->make_active();
1391                     $canviewcourseprofile = false;
1392                     break;
1393                 }
1394                 $this->add_course_essentials($coursenode, $course);
1395                 $this->load_course_sections($course, $coursenode);
1396                 break;
1397         }
1399         // Load for the current user
1400         $this->load_for_user();
1401         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) {
1402             $this->load_for_user(null, true);
1403         }
1404         // Load each extending user into the navigation.
1405         foreach ($this->extendforuser as $user) {
1406             if ($user->id != $USER->id) {
1407                 $this->load_for_user($user);
1408             }
1409         }
1411         // Give the local plugins a chance to include some navigation if they want.
1412         foreach (get_plugin_list_with_function('local', 'extend_navigation') as $function) {
1413             $function($this);
1414         }
1416         // Remove any empty root nodes
1417         foreach ($this->rootnodes as $node) {
1418             // Dont remove the home node
1419             /** @var navigation_node $node */
1420             if ($node->key !== 'home' && !$node->has_children() && !$node->isactive) {
1421                 $node->remove();
1422             }
1423         }
1425         if (!$this->contains_active_node()) {
1426             $this->search_for_active_node();
1427         }
1429         // If the user is not logged in modify the navigation structure as detailed
1430         // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1431         if (!isloggedin()) {
1432             $activities = clone($this->rootnodes['site']->children);
1433             $this->rootnodes['site']->remove();
1434             $children = clone($this->children);
1435             $this->children = new navigation_node_collection();
1436             foreach ($activities as $child) {
1437                 $this->children->add($child);
1438             }
1439             foreach ($children as $child) {
1440                 $this->children->add($child);
1441             }
1442         }
1443         return true;
1444     }
1446     /**
1447      * Returns true if the current user is a parent of the user being currently viewed.
1448      *
1449      * If the current user is not viewing another user, or if the current user does not hold any parent roles over the
1450      * other user being viewed this function returns false.
1451      * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()}
1452      *
1453      * @since Moodle 2.4
1454      * @return bool
1455      */
1456     protected function current_user_is_parent_role() {
1457         global $USER, $DB;
1458         if ($this->useridtouseforparentchecks && $this->useridtouseforparentchecks != $USER->id) {
1459             $usercontext = context_user::instance($this->useridtouseforparentchecks, MUST_EXIST);
1460             if (!has_capability('moodle/user:viewdetails', $usercontext)) {
1461                 return false;
1462             }
1463             if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))) {
1464                 return true;
1465             }
1466         }
1467         return false;
1468     }
1470     /**
1471      * Returns true if courses should be shown within categories on the navigation.
1472      *
1473      * @param bool $ismycourse Set to true if you are calculating this for a course.
1474      * @return bool
1475      */
1476     protected function show_categories($ismycourse = false) {
1477         global $CFG, $DB;
1478         if ($ismycourse) {
1479             return $this->show_my_categories();
1480         }
1481         if ($this->showcategories === null) {
1482             $show = false;
1483             if ($this->page->context->contextlevel == CONTEXT_COURSECAT) {
1484                 $show = true;
1485             } else if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1) {
1486                 $show = true;
1487             }
1488             $this->showcategories = $show;
1489         }
1490         return $this->showcategories;
1491     }
1493     /**
1494      * Returns true if we should show categories in the My Courses branch.
1495      * @return bool
1496      */
1497     protected function show_my_categories() {
1498         global $CFG;
1499         if ($this->showmycategories === null) {
1500             require_once('coursecatlib.php');
1501             $this->showmycategories = !empty($CFG->navshowmycoursecategories) && coursecat::count_all() > 1;
1502         }
1503         return $this->showmycategories;
1504     }
1506     /**
1507      * Loads the courses in Moodle into the navigation.
1508      *
1509      * @global moodle_database $DB
1510      * @param string|array $categoryids An array containing categories to load courses
1511      *                     for, OR null to load courses for all categories.
1512      * @return array An array of navigation_nodes one for each course
1513      */
1514     protected function load_all_courses($categoryids = null) {
1515         global $CFG, $DB, $SITE;
1517         // Work out the limit of courses.
1518         $limit = 20;
1519         if (!empty($CFG->navcourselimit)) {
1520             $limit = $CFG->navcourselimit;
1521         }
1523         $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES;
1525         // If we are going to show all courses AND we are showing categories then
1526         // to save us repeated DB calls load all of the categories now
1527         if ($this->show_categories()) {
1528             $this->load_all_categories($toload);
1529         }
1531         // Will be the return of our efforts
1532         $coursenodes = array();
1534         // Check if we need to show categories.
1535         if ($this->show_categories()) {
1536             // Hmmm we need to show categories... this is going to be painful.
1537             // We now need to fetch up to $limit courses for each category to
1538             // be displayed.
1539             if ($categoryids !== null) {
1540                 if (!is_array($categoryids)) {
1541                     $categoryids = array($categoryids);
1542                 }
1543                 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc');
1544                 $categorywhere = 'WHERE cc.id '.$categorywhere;
1545             } else if ($toload == self::LOAD_ROOT_CATEGORIES) {
1546                 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1547                 $categoryparams = array();
1548             } else {
1549                 $categorywhere = '';
1550                 $categoryparams = array();
1551             }
1553             // First up we are going to get the categories that we are going to
1554             // need so that we can determine how best to load the courses from them.
1555             $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1556                         FROM {course_categories} cc
1557                     LEFT JOIN {course} c ON c.category = cc.id
1558                             {$categorywhere}
1559                     GROUP BY cc.id";
1560             $categories = $DB->get_recordset_sql($sql, $categoryparams);
1561             $fullfetch = array();
1562             $partfetch = array();
1563             foreach ($categories as $category) {
1564                 if (!$this->can_add_more_courses_to_category($category->id)) {
1565                     continue;
1566                 }
1567                 if ($category->coursecount > $limit * 5) {
1568                     $partfetch[] = $category->id;
1569                 } else if ($category->coursecount > 0) {
1570                     $fullfetch[] = $category->id;
1571                 }
1572             }
1573             $categories->close();
1575             if (count($fullfetch)) {
1576                 // First up fetch all of the courses in categories where we know that we are going to
1577                 // need the majority of courses.
1578                 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory');
1579                 $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1580                 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1581                 $categoryparams['contextlevel'] = CONTEXT_COURSE;
1582                 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1583                             FROM {course} c
1584                                 $ccjoin
1585                             WHERE c.category {$categoryids}
1586                         ORDER BY c.sortorder ASC";
1587                 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1588                 foreach ($coursesrs as $course) {
1589                     if ($course->id == $SITE->id) {
1590                         // This should not be necessary, frontpage is not in any category.
1591                         continue;
1592                     }
1593                     if (array_key_exists($course->id, $this->addedcourses)) {
1594                         // It is probably better to not include the already loaded courses
1595                         // directly in SQL because inequalities may confuse query optimisers
1596                         // and may interfere with query caching.
1597                         continue;
1598                     }
1599                     if (!$this->can_add_more_courses_to_category($course->category)) {
1600                         continue;
1601                     }
1602                     context_helper::preload_from_record($course);
1603                     if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1604                         continue;
1605                     }
1606                     $coursenodes[$course->id] = $this->add_course($course);
1607                 }
1608                 $coursesrs->close();
1609             }
1611             if (count($partfetch)) {
1612                 // Next we will work our way through the categories where we will likely only need a small
1613                 // proportion of the courses.
1614                 foreach ($partfetch as $categoryid) {
1615                     $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1616                     $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1617                     $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1618                                 FROM {course} c
1619                                     $ccjoin
1620                                 WHERE c.category = :categoryid
1621                             ORDER BY c.sortorder ASC";
1622                     $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE);
1623                     $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1624                     foreach ($coursesrs as $course) {
1625                         if ($course->id == $SITE->id) {
1626                             // This should not be necessary, frontpage is not in any category.
1627                             continue;
1628                         }
1629                         if (array_key_exists($course->id, $this->addedcourses)) {
1630                             // It is probably better to not include the already loaded courses
1631                             // directly in SQL because inequalities may confuse query optimisers
1632                             // and may interfere with query caching.
1633                             // This also helps to respect expected $limit on repeated executions.
1634                             continue;
1635                         }
1636                         if (!$this->can_add_more_courses_to_category($course->category)) {
1637                             break;
1638                         }
1639                         context_helper::preload_from_record($course);
1640                         if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1641                             continue;
1642                         }
1643                         $coursenodes[$course->id] = $this->add_course($course);
1644                     }
1645                     $coursesrs->close();
1646                 }
1647             }
1648         } else {
1649             // Prepare the SQL to load the courses and their contexts
1650             list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false);
1651             $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1652             $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1653             $courseparams['contextlevel'] = CONTEXT_COURSE;
1654             $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1655                         FROM {course} c
1656                             $ccjoin
1657                         WHERE c.id {$courseids}
1658                     ORDER BY c.sortorder ASC";
1659             $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1660             foreach ($coursesrs as $course) {
1661                 if ($course->id == $SITE->id) {
1662                     // frotpage is not wanted here
1663                     continue;
1664                 }
1665                 if ($this->page->course && ($this->page->course->id == $course->id)) {
1666                     // Don't include the currentcourse in this nodelist - it's displayed in the Current course node
1667                     continue;
1668                 }
1669                 context_helper::preload_from_record($course);
1670                 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1671                     continue;
1672                 }
1673                 $coursenodes[$course->id] = $this->add_course($course);
1674                 if (count($coursenodes) >= $limit) {
1675                     break;
1676                 }
1677             }
1678             $coursesrs->close();
1679         }
1681         return $coursenodes;
1682     }
1684     /**
1685      * Returns true if more courses can be added to the provided category.
1686      *
1687      * @param int|navigation_node|stdClass $category
1688      * @return bool
1689      */
1690     protected function can_add_more_courses_to_category($category) {
1691         global $CFG;
1692         $limit = 20;
1693         if (!empty($CFG->navcourselimit)) {
1694             $limit = (int)$CFG->navcourselimit;
1695         }
1696         if (is_numeric($category)) {
1697             if (!array_key_exists($category, $this->addedcategories)) {
1698                 return true;
1699             }
1700             $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE));
1701         } else if ($category instanceof navigation_node) {
1702             if (($category->type != self::TYPE_CATEGORY) || ($category->type != self::TYPE_MY_CATEGORY)) {
1703                 return false;
1704             }
1705             $coursecount = count($category->children->type(self::TYPE_COURSE));
1706         } else if (is_object($category) && property_exists($category,'id')) {
1707             $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE));
1708         }
1709         return ($coursecount <= $limit);
1710     }
1712     /**
1713      * Loads all categories (top level or if an id is specified for that category)
1714      *
1715      * @param int $categoryid The category id to load or null/0 to load all base level categories
1716      * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1717      *        as the requested category and any parent categories.
1718      * @return navigation_node|void returns a navigation node if a category has been loaded.
1719      */
1720     protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) {
1721         global $CFG, $DB;
1723         // Check if this category has already been loaded
1724         if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1725             return true;
1726         }
1728         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
1729         $sqlselect = "SELECT cc.*, $catcontextsql
1730                       FROM {course_categories} cc
1731                       JOIN {context} ctx ON cc.id = ctx.instanceid";
1732         $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT;
1733         $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1734         $params = array();
1736         $categoriestoload = array();
1737         if ($categoryid == self::LOAD_ALL_CATEGORIES) {
1738             // We are going to load all categories regardless... prepare to fire
1739             // on the database server!
1740         } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0
1741             // We are going to load all of the first level categories (categories without parents)
1742             $sqlwhere .= " AND cc.parent = 0";
1743         } else if (array_key_exists($categoryid, $this->addedcategories)) {
1744             // The category itself has been loaded already so we just need to ensure its subcategories
1745             // have been loaded
1746             $addedcategories = $this->addedcategories;
1747             unset($addedcategories[$categoryid]);
1748             if (count($addedcategories) > 0) {
1749                 list($sql, $params) = $DB->get_in_or_equal(array_keys($addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1750                 if ($showbasecategories) {
1751                     // We need to include categories with parent = 0 as well
1752                     $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1753                 } else {
1754                     // All we need is categories that match the parent
1755                     $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1756                 }
1757             }
1758             $params['categoryid'] = $categoryid;
1759         } else {
1760             // This category hasn't been loaded yet so we need to fetch it, work out its category path
1761             // and load this category plus all its parents and subcategories
1762             $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
1763             $categoriestoload = explode('/', trim($category->path, '/'));
1764             list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1765             // We are going to use select twice so double the params
1766             $params = array_merge($params, $params);
1767             $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':'';
1768             $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1769         }
1771         $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1772         $categories = array();
1773         foreach ($categoriesrs as $category) {
1774             // Preload the context.. we'll need it when adding the category in order
1775             // to format the category name.
1776             context_helper::preload_from_record($category);
1777             if (array_key_exists($category->id, $this->addedcategories)) {
1778                 // Do nothing, its already been added.
1779             } else if ($category->parent == '0') {
1780                 // This is a root category lets add it immediately
1781                 $this->add_category($category, $this->rootnodes['courses']);
1782             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1783                 // This categories parent has already been added we can add this immediately
1784                 $this->add_category($category, $this->addedcategories[$category->parent]);
1785             } else {
1786                 $categories[] = $category;
1787             }
1788         }
1789         $categoriesrs->close();
1791         // Now we have an array of categories we need to add them to the navigation.
1792         while (!empty($categories)) {
1793             $category = reset($categories);
1794             if (array_key_exists($category->id, $this->addedcategories)) {
1795                 // Do nothing
1796             } else if ($category->parent == '0') {
1797                 $this->add_category($category, $this->rootnodes['courses']);
1798             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1799                 $this->add_category($category, $this->addedcategories[$category->parent]);
1800             } else {
1801                 // This category isn't in the navigation and niether is it's parent (yet).
1802                 // We need to go through the category path and add all of its components in order.
1803                 $path = explode('/', trim($category->path, '/'));
1804                 foreach ($path as $catid) {
1805                     if (!array_key_exists($catid, $this->addedcategories)) {
1806                         // This category isn't in the navigation yet so add it.
1807                         $subcategory = $categories[$catid];
1808                         if ($subcategory->parent == '0') {
1809                             // Yay we have a root category - this likely means we will now be able
1810                             // to add categories without problems.
1811                             $this->add_category($subcategory, $this->rootnodes['courses']);
1812                         } else if (array_key_exists($subcategory->parent, $this->addedcategories)) {
1813                             // The parent is in the category (as we'd expect) so add it now.
1814                             $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1815                             // Remove the category from the categories array.
1816                             unset($categories[$catid]);
1817                         } else {
1818                             // We should never ever arrive here - if we have then there is a bigger
1819                             // problem at hand.
1820                             throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1821                         }
1822                     }
1823                 }
1824             }
1825             // Remove the category from the categories array now that we know it has been added.
1826             unset($categories[$category->id]);
1827         }
1828         if ($categoryid === self::LOAD_ALL_CATEGORIES) {
1829             $this->allcategoriesloaded = true;
1830         }
1831         // Check if there are any categories to load.
1832         if (count($categoriestoload) > 0) {
1833             $readytoloadcourses = array();
1834             foreach ($categoriestoload as $category) {
1835                 if ($this->can_add_more_courses_to_category($category)) {
1836                     $readytoloadcourses[] = $category;
1837                 }
1838             }
1839             if (count($readytoloadcourses)) {
1840                 $this->load_all_courses($readytoloadcourses);
1841             }
1842         }
1844         // Look for all categories which have been loaded
1845         if (!empty($this->addedcategories)) {
1846             $categoryids = array();
1847             foreach ($this->addedcategories as $category) {
1848                 if ($this->can_add_more_courses_to_category($category)) {
1849                     $categoryids[] = $category->key;
1850                 }
1851             }
1852             if ($categoryids) {
1853                 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED);
1854                 $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20;
1855                 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1856                           FROM {course_categories} cc
1857                           JOIN {course} c ON c.category = cc.id
1858                          WHERE cc.id {$categoriessql}
1859                       GROUP BY cc.id
1860                         HAVING COUNT(c.id) > :limit";
1861                 $excessivecategories = $DB->get_records_sql($sql, $params);
1862                 foreach ($categories as &$category) {
1863                     if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1864                         $url = new moodle_url('/course/index.php', array('categoryid' => $category->key));
1865                         $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1866                     }
1867                 }
1868             }
1869         }
1870     }
1872     /**
1873      * Adds a structured category to the navigation in the correct order/place
1874      *
1875      * @param stdClass $category category to be added in navigation.
1876      * @param navigation_node $parent parent navigation node
1877      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1878      * @return void.
1879      */
1880     protected function add_category(stdClass $category, navigation_node $parent, $nodetype = self::TYPE_CATEGORY) {
1881         if (array_key_exists($category->id, $this->addedcategories)) {
1882             return;
1883         }
1884         $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
1885         $context = context_coursecat::instance($category->id);
1886         $categoryname = format_string($category->name, true, array('context' => $context));
1887         $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id);
1888         if (empty($category->visible)) {
1889             if (has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
1890                 $categorynode->hidden = true;
1891             } else {
1892                 $categorynode->display = false;
1893             }
1894         }
1895         $this->addedcategories[$category->id] = $categorynode;
1896     }
1898     /**
1899      * Loads the given course into the navigation
1900      *
1901      * @param stdClass $course
1902      * @return navigation_node
1903      */
1904     protected function load_course(stdClass $course) {
1905         global $SITE;
1906         if ($course->id == $SITE->id) {
1907             // This is always loaded during initialisation
1908             return $this->rootnodes['site'];
1909         } else if (array_key_exists($course->id, $this->addedcourses)) {
1910             // The course has already been loaded so return a reference
1911             return $this->addedcourses[$course->id];
1912         } else {
1913             // Add the course
1914             return $this->add_course($course);
1915         }
1916     }
1918     /**
1919      * Loads all of the courses section into the navigation.
1920      *
1921      * This function calls method from current course format, see
1922      * {@link format_base::extend_course_navigation()}
1923      * If course module ($cm) is specified but course format failed to create the node,
1924      * the activity node is created anyway.
1925      *
1926      * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
1927      *
1928      * @param stdClass $course Database record for the course
1929      * @param navigation_node $coursenode The course node within the navigation
1930      * @param null|int $sectionnum If specified load the contents of section with this relative number
1931      * @param null|cm_info $cm If specified make sure that activity node is created (either
1932      *    in containg section or by calling load_stealth_activity() )
1933      */
1934     protected function load_course_sections(stdClass $course, navigation_node $coursenode, $sectionnum = null, $cm = null) {
1935         global $CFG, $SITE;
1936         require_once($CFG->dirroot.'/course/lib.php');
1937         if (isset($cm->sectionnum)) {
1938             $sectionnum = $cm->sectionnum;
1939         }
1940         if ($sectionnum !== null) {
1941             $this->includesectionnum = $sectionnum;
1942         }
1943         course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
1944         if (isset($cm->id)) {
1945             $activity = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
1946             if (empty($activity)) {
1947                 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
1948             }
1949         }
1950    }
1952     /**
1953      * Generates an array of sections and an array of activities for the given course.
1954      *
1955      * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1956      *
1957      * @param stdClass $course
1958      * @return array Array($sections, $activities)
1959      */
1960     protected function generate_sections_and_activities(stdClass $course) {
1961         global $CFG;
1962         require_once($CFG->dirroot.'/course/lib.php');
1964         $modinfo = get_fast_modinfo($course);
1965         $sections = $modinfo->get_section_info_all();
1967         // For course formats using 'numsections' trim the sections list
1968         $courseformatoptions = course_get_format($course)->get_format_options();
1969         if (isset($courseformatoptions['numsections'])) {
1970             $sections = array_slice($sections, 0, $courseformatoptions['numsections']+1, true);
1971         }
1973         $activities = array();
1975         foreach ($sections as $key => $section) {
1976             // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1977             $sections[$key] = clone($section);
1978             unset($sections[$key]->summary);
1979             $sections[$key]->hasactivites = false;
1980             if (!array_key_exists($section->section, $modinfo->sections)) {
1981                 continue;
1982             }
1983             foreach ($modinfo->sections[$section->section] as $cmid) {
1984                 $cm = $modinfo->cms[$cmid];
1985                 $activity = new stdClass;
1986                 $activity->id = $cm->id;
1987                 $activity->course = $course->id;
1988                 $activity->section = $section->section;
1989                 $activity->name = $cm->name;
1990                 $activity->icon = $cm->icon;
1991                 $activity->iconcomponent = $cm->iconcomponent;
1992                 $activity->hidden = (!$cm->visible);
1993                 $activity->modname = $cm->modname;
1994                 $activity->nodetype = navigation_node::NODETYPE_LEAF;
1995                 $activity->onclick = $cm->onclick;
1996                 $url = $cm->url;
1997                 if (!$url) {
1998                     $activity->url = null;
1999                     $activity->display = false;
2000                 } else {
2001                     $activity->url = $url->out();
2002                     $activity->display = $cm->is_visible_on_course_page() ? true : false;
2003                     if (self::module_extends_navigation($cm->modname)) {
2004                         $activity->nodetype = navigation_node::NODETYPE_BRANCH;
2005                     }
2006                 }
2007                 $activities[$cmid] = $activity;
2008                 if ($activity->display) {
2009                     $sections[$key]->hasactivites = true;
2010                 }
2011             }
2012         }
2014         return array($sections, $activities);
2015     }
2017     /**
2018      * Generically loads the course sections into the course's navigation.
2019      *
2020      * @param stdClass $course
2021      * @param navigation_node $coursenode
2022      * @return array An array of course section nodes
2023      */
2024     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode) {
2025         global $CFG, $DB, $USER, $SITE;
2026         require_once($CFG->dirroot.'/course/lib.php');
2028         list($sections, $activities) = $this->generate_sections_and_activities($course);
2030         $navigationsections = array();
2031         foreach ($sections as $sectionid => $section) {
2032             $section = clone($section);
2033             if ($course->id == $SITE->id) {
2034                 $this->load_section_activities($coursenode, $section->section, $activities);
2035             } else {
2036                 if (!$section->uservisible || (!$this->showemptysections &&
2037                         !$section->hasactivites && $this->includesectionnum !== $section->section)) {
2038                     continue;
2039                 }
2041                 $sectionname = get_section_name($course, $section);
2042                 $url = course_get_url($course, $section->section, array('navigation' => true));
2044                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION,
2045                     null, $section->id, new pix_icon('i/section', ''));
2046                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
2047                 $sectionnode->hidden = (!$section->visible || !$section->available);
2048                 if ($this->includesectionnum !== false && $this->includesectionnum == $section->section) {
2049                     $this->load_section_activities($sectionnode, $section->section, $activities);
2050                 }
2051                 $section->sectionnode = $sectionnode;
2052                 $navigationsections[$sectionid] = $section;
2053             }
2054         }
2055         return $navigationsections;
2056     }
2058     /**
2059      * Loads all of the activities for a section into the navigation structure.
2060      *
2061      * @param navigation_node $sectionnode
2062      * @param int $sectionnumber
2063      * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
2064      * @param stdClass $course The course object the section and activities relate to.
2065      * @return array Array of activity nodes
2066      */
2067     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) {
2068         global $CFG, $SITE;
2069         // A static counter for JS function naming
2070         static $legacyonclickcounter = 0;
2072         $activitynodes = array();
2073         if (empty($activities)) {
2074             return $activitynodes;
2075         }
2077         if (!is_object($course)) {
2078             $activity = reset($activities);
2079             $courseid = $activity->course;
2080         } else {
2081             $courseid = $course->id;
2082         }
2083         $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods));
2085         foreach ($activities as $activity) {
2086             if ($activity->section != $sectionnumber) {
2087                 continue;
2088             }
2089             if ($activity->icon) {
2090                 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
2091             } else {
2092                 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
2093             }
2095             // Prepare the default name and url for the node
2096             $activityname = format_string($activity->name, true, array('context' => context_module::instance($activity->id)));
2097             $action = new moodle_url($activity->url);
2099             // Check if the onclick property is set (puke!)
2100             if (!empty($activity->onclick)) {
2101                 // Increment the counter so that we have a unique number.
2102                 $legacyonclickcounter++;
2103                 // Generate the function name we will use
2104                 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
2105                 $propogrationhandler = '';
2106                 // Check if we need to cancel propogation. Remember inline onclick
2107                 // events would return false if they wanted to prevent propogation and the
2108                 // default action.
2109                 if (strpos($activity->onclick, 'return false')) {
2110                     $propogrationhandler = 'e.halt();';
2111                 }
2112                 // Decode the onclick - it has already been encoded for display (puke)
2113                 $onclick = htmlspecialchars_decode($activity->onclick, ENT_QUOTES);
2114                 // Build the JS function the click event will call
2115                 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2116                 $this->page->requires->js_amd_inline($jscode);
2117                 // Override the default url with the new action link
2118                 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2119             }
2121             $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
2122             $activitynode->title(get_string('modulename', $activity->modname));
2123             $activitynode->hidden = $activity->hidden;
2124             $activitynode->display = $showactivities && $activity->display;
2125             $activitynode->nodetype = $activity->nodetype;
2126             $activitynodes[$activity->id] = $activitynode;
2127         }
2129         return $activitynodes;
2130     }
2131     /**
2132      * Loads a stealth module from unavailable section
2133      * @param navigation_node $coursenode
2134      * @param stdClass $modinfo
2135      * @return navigation_node or null if not accessible
2136      */
2137     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
2138         if (empty($modinfo->cms[$this->page->cm->id])) {
2139             return null;
2140         }
2141         $cm = $modinfo->cms[$this->page->cm->id];
2142         if ($cm->icon) {
2143             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
2144         } else {
2145             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
2146         }
2147         $url = $cm->url;
2148         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
2149         $activitynode->title(get_string('modulename', $cm->modname));
2150         $activitynode->hidden = (!$cm->visible);
2151         if (!$cm->is_visible_on_course_page()) {
2152             // Do not show any error here, let the page handle exception that activity is not visible for the current user.
2153             // Also there may be no exception at all in case when teacher is logged in as student.
2154             $activitynode->display = false;
2155         } else if (!$url) {
2156             // Don't show activities that don't have links!
2157             $activitynode->display = false;
2158         } else if (self::module_extends_navigation($cm->modname)) {
2159             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
2160         }
2161         return $activitynode;
2162     }
2163     /**
2164      * Loads the navigation structure for the given activity into the activities node.
2165      *
2166      * This method utilises a callback within the modules lib.php file to load the
2167      * content specific to activity given.
2168      *
2169      * The callback is a method: {modulename}_extend_navigation()
2170      * Examples:
2171      *  * {@link forum_extend_navigation()}
2172      *  * {@link workshop_extend_navigation()}
2173      *
2174      * @param cm_info|stdClass $cm
2175      * @param stdClass $course
2176      * @param navigation_node $activity
2177      * @return bool
2178      */
2179     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
2180         global $CFG, $DB;
2182         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2183         if (!($cm instanceof cm_info)) {
2184             $modinfo = get_fast_modinfo($course);
2185             $cm = $modinfo->get_cm($cm->id);
2186         }
2187         $activity->nodetype = navigation_node::NODETYPE_LEAF;
2188         $activity->make_active();
2189         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
2190         $function = $cm->modname.'_extend_navigation';
2192         if (file_exists($file)) {
2193             require_once($file);
2194             if (function_exists($function)) {
2195                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
2196                 $function($activity, $course, $activtyrecord, $cm);
2197             }
2198         }
2200         // Allow the active advanced grading method plugin to append module navigation
2201         $featuresfunc = $cm->modname.'_supports';
2202         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) {
2203             require_once($CFG->dirroot.'/grade/grading/lib.php');
2204             $gradingman = get_grading_manager($cm->context,  'mod_'.$cm->modname);
2205             $gradingman->extend_navigation($this, $activity);
2206         }
2208         return $activity->has_children();
2209     }
2210     /**
2211      * Loads user specific information into the navigation in the appropriate place.
2212      *
2213      * If no user is provided the current user is assumed.
2214      *
2215      * @param stdClass $user
2216      * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2217      * @return bool
2218      */
2219     protected function load_for_user($user=null, $forceforcontext=false) {
2220         global $DB, $CFG, $USER, $SITE;
2222         require_once($CFG->dirroot . '/course/lib.php');
2224         if ($user === null) {
2225             // We can't require login here but if the user isn't logged in we don't
2226             // want to show anything
2227             if (!isloggedin() || isguestuser()) {
2228                 return false;
2229             }
2230             $user = $USER;
2231         } else if (!is_object($user)) {
2232             // If the user is not an object then get them from the database
2233             $select = context_helper::get_preload_record_columns_sql('ctx');
2234             $sql = "SELECT u.*, $select
2235                       FROM {user} u
2236                       JOIN {context} ctx ON u.id = ctx.instanceid
2237                      WHERE u.id = :userid AND
2238                            ctx.contextlevel = :contextlevel";
2239             $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST);
2240             context_helper::preload_from_record($user);
2241         }
2243         $iscurrentuser = ($user->id == $USER->id);
2245         $usercontext = context_user::instance($user->id);
2247         // Get the course set against the page, by default this will be the site
2248         $course = $this->page->course;
2249         $baseargs = array('id'=>$user->id);
2250         if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) {
2251             $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
2252             $baseargs['course'] = $course->id;
2253             $coursecontext = context_course::instance($course->id);
2254             $issitecourse = false;
2255         } else {
2256             // Load all categories and get the context for the system
2257             $coursecontext = context_system::instance();
2258             $issitecourse = true;
2259         }
2261         // Create a node to add user information under.
2262         $usersnode = null;
2263         if (!$issitecourse) {
2264             // Not the current user so add it to the participants node for the current course.
2265             $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
2266             $userviewurl = new moodle_url('/user/view.php', $baseargs);
2267         } else if ($USER->id != $user->id) {
2268             // This is the site so add a users node to the root branch.
2269             $usersnode = $this->rootnodes['users'];
2270             if (course_can_view_participants($coursecontext)) {
2271                 $usersnode->action = new moodle_url('/user/index.php', array('id' => $course->id));
2272             }
2273             $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2274         }
2275         if (!$usersnode) {
2276             // We should NEVER get here, if the course hasn't been populated
2277             // with a participants node then the navigaiton either wasn't generated
2278             // for it (you are missing a require_login or set_context call) or
2279             // you don't have access.... in the interests of no leaking informatin
2280             // we simply quit...
2281             return false;
2282         }
2283         // Add a branch for the current user.
2284         // Only reveal user details if $user is the current user, or a user to which the current user has access.
2285         $viewprofile = true;
2286         if (!$iscurrentuser) {
2287             require_once($CFG->dirroot . '/user/lib.php');
2288             if ($this->page->context->contextlevel == CONTEXT_USER && !has_capability('moodle/user:viewdetails', $usercontext) ) {
2289                 $viewprofile = false;
2290             } else if ($this->page->context->contextlevel != CONTEXT_USER && !user_can_view_profile($user, $course, $usercontext)) {
2291                 $viewprofile = false;
2292             }
2293             if (!$viewprofile) {
2294                 $viewprofile = user_can_view_profile($user, null, $usercontext);
2295             }
2296         }
2298         // Now, conditionally add the user node.
2299         if ($viewprofile) {
2300             $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2301             $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, 'user' . $user->id);
2302         } else {
2303             $usernode = $usersnode->add(get_string('user'));
2304         }
2306         if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
2307             $usernode->make_active();
2308         }
2310         // Add user information to the participants or user node.
2311         if ($issitecourse) {
2313             // If the user is the current user or has permission to view the details of the requested
2314             // user than add a view profile link.
2315             if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) ||
2316                     has_capability('moodle/user:viewdetails', $usercontext)) {
2317                 if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
2318                     $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php', $baseargs));
2319                 } else {
2320                     $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php', $baseargs));
2321                 }
2322             }
2324             if (!empty($CFG->navadduserpostslinks)) {
2325                 // Add nodes for forum posts and discussions if the user can view either or both
2326                 // There are no capability checks here as the content of the page is based
2327                 // purely on the forums the current user has access too.
2328                 $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2329                 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2330                 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php',
2331                         array_merge($baseargs, array('mode' => 'discussions'))));
2332             }
2334             // Add blog nodes.
2335             if (!empty($CFG->enableblogs)) {
2336                 if (!$this->cache->cached('userblogoptions'.$user->id)) {
2337                     require_once($CFG->dirroot.'/blog/lib.php');
2338                     // Get all options for the user.
2339                     $options = blog_get_options_for_user($user);
2340                     $this->cache->set('userblogoptions'.$user->id, $options);
2341                 } else {
2342                     $options = $this->cache->{'userblogoptions'.$user->id};
2343                 }
2345                 if (count($options) > 0) {
2346                     $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
2347                     foreach ($options as $type => $option) {
2348                         if ($type == "rss") {
2349                             $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null,
2350                                     new pix_icon('i/rss', ''));
2351                         } else {
2352                             $blogs->add($option['string'], $option['link']);
2353                         }
2354                     }
2355                 }
2356             }
2358             // Add the messages link.
2359             // It is context based so can appear in the user's profile and in course participants information.
2360             if (!empty($CFG->messaging)) {
2361                 $messageargs = array('user1' => $USER->id);
2362                 if ($USER->id != $user->id) {
2363                     $messageargs['user2'] = $user->id;
2364                 }
2365                 $url = new moodle_url('/message/index.php', $messageargs);
2366                 $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
2367             }
2369             // Add the "My private files" link.
2370             // This link doesn't have a unique display for course context so only display it under the user's profile.
2371             if ($issitecourse && $iscurrentuser && has_capability('moodle/user:manageownfiles', $usercontext)) {
2372                 $url = new moodle_url('/user/files.php');
2373                 $usernode->add(get_string('privatefiles'), $url, self::TYPE_SETTING, null, 'privatefiles');
2374             }
2376             // Add a node to view the users notes if permitted.
2377             if (!empty($CFG->enablenotes) &&
2378                     has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2379                 $url = new moodle_url('/notes/index.php', array('user' => $user->id));
2380                 if ($coursecontext->instanceid != SITEID) {
2381                     $url->param('course', $coursecontext->instanceid);
2382                 }
2383                 $usernode->add(get_string('notes', 'notes'), $url);
2384             }
2386             // Show the grades node.
2387             if (($issitecourse && $iscurrentuser) || has_capability('moodle/user:viewdetails', $usercontext)) {
2388                 require_once($CFG->dirroot . '/user/lib.php');
2389                 // Set the grades node to link to the "Grades" page.
2390                 if ($course->id == SITEID) {
2391                     $url = user_mygrades_url($user->id, $course->id);
2392                 } else { // Otherwise we are in a course and should redirect to the user grade report (Activity report version).
2393                     $url = new moodle_url('/course/user.php', array('mode' => 'grade', 'id' => $course->id, 'user' => $user->id));
2394                 }
2395                 if ($USER->id != $user->id) {
2396                     $usernode->add(get_string('grades', 'grades'), $url, self::TYPE_SETTING, null, 'usergrades');
2397                 } else {
2398                     $usernode->add(get_string('grades', 'grades'), $url);
2399                 }
2400             }
2402             // If the user is the current user add the repositories for the current user.
2403             $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
2404             if (!$iscurrentuser &&
2405                     $course->id == $SITE->id &&
2406                     has_capability('moodle/user:viewdetails', $usercontext) &&
2407                     (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2409                 // Add view grade report is permitted.
2410                 $reports = core_component::get_plugin_list('gradereport');
2411                 arsort($reports); // User is last, we want to test it first.
2413                 $userscourses = enrol_get_users_courses($user->id, false, '*');
2414                 $userscoursesnode = $usernode->add(get_string('courses'));
2416                 $count = 0;
2417                 foreach ($userscourses as $usercourse) {
2418                     if ($count === (int)$CFG->navcourselimit) {
2419                         $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1));
2420                         $userscoursesnode->add(get_string('showallcourses'), $url);
2421                         break;
2422                     }
2423                     $count++;
2424                     $usercoursecontext = context_course::instance($usercourse->id);
2425                     $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext));
2426                     $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php',
2427                             array('id' => $user->id, 'course' => $usercourse->id)), self::TYPE_CONTAINER);
2429                     $gradeavailable = has_capability('moodle/grade:view', $usercoursecontext);
2430                     if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
2431                         foreach ($reports as $plugin => $plugindir) {
2432                             if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2433                                 // Stop when the first visible plugin is found.
2434                                 $gradeavailable = true;
2435                                 break;
2436                             }
2437                         }
2438                     }
2440                     if ($gradeavailable) {
2441                         $url = new moodle_url('/grade/report/index.php', array('id' => $usercourse->id));
2442                         $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null,
2443                                 new pix_icon('i/grades', ''));
2444                     }
2446                     // Add a node to view the users notes if permitted.
2447                     if (!empty($CFG->enablenotes) &&
2448                             has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2449                         $url = new moodle_url('/notes/index.php', array('user' => $user->id, 'course' => $usercourse->id));
2450                         $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2451                     }
2453                     if (can_access_course($usercourse, $user->id, '', true)) {
2454                         $usercoursenode->add(get_string('entercourse'), new moodle_url('/course/view.php',
2455                                 array('id' => $usercourse->id)), self::TYPE_SETTING, null, null, new pix_icon('i/course', ''));
2456                     }
2458                     $reporttab = $usercoursenode->add(get_string('activityreports'));
2460                     $reportfunctions = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2461                     foreach ($reportfunctions as $reportfunction) {
2462                         $reportfunction($reporttab, $user, $usercourse);
2463                     }
2465                     $reporttab->trim_if_empty();
2466                 }
2467             }
2469             // Let plugins hook into user navigation.
2470             $pluginsfunction = get_plugins_with_function('extend_navigation_user', 'lib.php');
2471             foreach ($pluginsfunction as $plugintype => $plugins) {
2472                 if ($plugintype != 'report') {
2473                     foreach ($plugins as $pluginfunction) {
2474                         $pluginfunction($usernode, $user, $usercontext, $course, $coursecontext);
2475                     }
2476                 }
2477             }
2478         }
2479         return true;
2480     }
2482     /**
2483      * This method simply checks to see if a given module can extend the navigation.
2484      *
2485      * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2486      *
2487      * @param string $modname
2488      * @return bool
2489      */
2490     public static function module_extends_navigation($modname) {
2491         global $CFG;
2492         static $extendingmodules = array();
2493         if (!array_key_exists($modname, $extendingmodules)) {
2494             $extendingmodules[$modname] = false;
2495             $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2496             if (file_exists($file)) {
2497                 $function = $modname.'_extend_navigation';
2498                 require_once($file);
2499                 $extendingmodules[$modname] = (function_exists($function));
2500             }
2501         }
2502         return $extendingmodules[$modname];
2503     }
2504     /**
2505      * Extends the navigation for the given user.
2506      *
2507      * @param stdClass $user A user from the database
2508      */
2509     public function extend_for_user($user) {
2510         $this->extendforuser[] = $user;
2511     }
2513     /**
2514      * Returns all of the users the navigation is being extended for
2515      *
2516      * @return array An array of extending users.
2517      */
2518     public function get_extending_users() {
2519         return $this->extendforuser;
2520     }
2521     /**
2522      * Adds the given course to the navigation structure.
2523      *
2524      * @param stdClass $course
2525      * @param bool $forcegeneric
2526      * @param bool $ismycourse
2527      * @return navigation_node
2528      */
2529     public function add_course(stdClass $course, $forcegeneric = false, $coursetype = self::COURSE_OTHER) {
2530         global $CFG, $SITE;
2532         // We found the course... we can return it now :)
2533         if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2534             return $this->addedcourses[$course->id];
2535         }
2537         $coursecontext = context_course::instance($course->id);
2539         if ($course->id != $SITE->id && !$course->visible) {
2540             if (is_role_switched($course->id)) {
2541                 // user has to be able to access course in order to switch, let's skip the visibility test here
2542             } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2543                 return false;
2544             }
2545         }
2547         $issite = ($course->id == $SITE->id);
2548         $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
2549         $fullname = format_string($course->fullname, true, array('context' => $coursecontext));
2550         // This is the name that will be shown for the course.
2551         $coursename = empty($CFG->navshowfullcoursenames) ? $shortname : $fullname;
2553         if ($coursetype == self::COURSE_CURRENT) {
2554             if ($coursenode = $this->rootnodes['mycourses']->find($course->id, self::TYPE_COURSE)) {
2555                 return $coursenode;
2556             } else {
2557                 $coursetype = self::COURSE_OTHER;
2558             }
2559         }
2561         // Can the user expand the course to see its content.
2562         $canexpandcourse = true;
2563         if ($issite) {
2564             $parent = $this;
2565             $url = null;
2566             if (empty($CFG->usesitenameforsitepages)) {
2567                 $coursename = get_string('sitepages');
2568             }
2569         } else if ($coursetype == self::COURSE_CURRENT) {
2570             $parent = $this->rootnodes['currentcourse'];
2571             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2572             $canexpandcourse = $this->can_expand_course($course);
2573         } else if ($coursetype == self::COURSE_MY && !$forcegeneric) {
2574             if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_MY_CATEGORY))) {
2575                 // Nothing to do here the above statement set $parent to the category within mycourses.
2576             } else {
2577                 $parent = $this->rootnodes['mycourses'];
2578             }
2579             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2580         } else {
2581             $parent = $this->rootnodes['courses'];
2582             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2583             // They can only expand the course if they can access it.
2584             $canexpandcourse = $this->can_expand_course($course);
2585             if (!empty($course->category) && $this->show_categories($coursetype == self::COURSE_MY)) {
2586                 if (!$this->is_category_fully_loaded($course->category)) {
2587                     // We need to load the category structure for this course
2588                     $this->load_all_categories($course->category, false);
2589                 }
2590                 if (array_key_exists($course->category, $this->addedcategories)) {
2591                     $parent = $this->addedcategories[$course->category];
2592                     // This could lead to the course being created so we should check whether it is the case again
2593                     if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2594                         return $this->addedcourses[$course->id];
2595                     }
2596                 }
2597             }
2598         }
2600         $coursenode = $parent->add($coursename, $url, self::TYPE_COURSE, $shortname, $course->id, new pix_icon('i/course', ''));
2601         $coursenode->showinflatnavigation = $coursetype == self::COURSE_MY;
2603         $coursenode->hidden = (!$course->visible);
2604         $coursenode->title(format_string($course->fullname, true, array('context' => $coursecontext, 'escape' => false)));
2605         if ($canexpandcourse) {
2606             // This course can be expanded by the user, make it a branch to make the system aware that its expandable by ajax.
2607             $coursenode->nodetype = self::NODETYPE_BRANCH;
2608             $coursenode->isexpandable = true;
2609         } else {
2610             $coursenode->nodetype = self::NODETYPE_LEAF;
2611             $coursenode->isexpandable = false;
2612         }
2613         if (!$forcegeneric) {
2614             $this->addedcourses[$course->id] = $coursenode;
2615         }
2617         return $coursenode;
2618     }
2620     /**
2621      * Returns a cache instance to use for the expand course cache.
2622      * @return cache_session
2623      */
2624     protected function get_expand_course_cache() {
2625         if ($this->cacheexpandcourse === null) {
2626             $this->cacheexpandcourse = cache::make('core', 'navigation_expandcourse');
2627         }
2628         return $this->cacheexpandcourse;
2629     }
2631     /**
2632      * Checks if a user can expand a course in the navigation.
2633      *
2634      * We use a cache here because in order to be accurate we need to call can_access_course which is a costly function.
2635      * Because this functionality is basic + non-essential and because we lack good event triggering this cache
2636      * permits stale data.
2637      * In the situation the user is granted access to a course after we've initialised this session cache the cache
2638      * will be stale.
2639      * It is brought up to date in only one of two ways.
2640      *   1. The user logs out and in again.
2641      *   2. The user browses to the course they've just being given access to.
2642      *
2643      * Really all this controls is whether the node is shown as expandable or not. It is uber un-important.
2644      *
2645      * @param stdClass $course
2646      * @return bool
2647      */
2648     protected function can_expand_course($course) {
2649         $cache = $this->get_expand_course_cache();
2650         $canexpand = $cache->get($course->id);
2651         if ($canexpand === false) {
2652             $canexpand = isloggedin() && can_access_course($course, null, '', true);
2653             $canexpand = (int)$canexpand;
2654             $cache->set($course->id, $canexpand);
2655         }
2656         return ($canexpand === 1);
2657     }
2659     /**
2660      * Returns true if the category has already been loaded as have any child categories
2661      *
2662      * @param int $categoryid
2663      * @return bool
2664      */
2665     protected function is_category_fully_loaded($categoryid) {
2666         return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0));
2667     }
2669     /**
2670      * Adds essential course nodes to the navigation for the given course.
2671      *
2672      * This method adds nodes such as reports, blogs and participants
2673      *
2674      * @param navigation_node $coursenode
2675      * @param stdClass $course
2676      * @return bool returns true on successful addition of a node.
2677      */
2678     public function add_course_essentials($coursenode, stdClass $course) {
2679         global $CFG, $SITE;
2680         require_once($CFG->dirroot . '/course/lib.php');
2682         if ($course->id == $SITE->id) {
2683             return $this->add_front_page_course_essentials($coursenode, $course);
2684         }
2686         if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2687             return true;
2688         }
2690         $navoptions = course_get_user_navigation_options($this->page->context, $course);
2692         //Participants
2693         if ($navoptions->participants) {
2694             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id),
2695                 self::TYPE_CONTAINER, get_string('participants'), 'participants', new pix_icon('i/users', ''));
2697             if ($navoptions->blogs) {
2698                 $blogsurls = new moodle_url('/blog/index.php');
2699                 if ($currentgroup = groups_get_course_group($course, true)) {
2700                     $blogsurls->param('groupid', $currentgroup);
2701                 } else {
2702                     $blogsurls->param('courseid', $course->id);
2703                 }
2704                 $participants->add(get_string('blogscourse', 'blog'), $blogsurls->out(), self::TYPE_SETTING, null, 'courseblogs');
2705             }
2707             if ($navoptions->notes) {
2708                 $participants->add(get_string('notes', 'notes'), new moodle_url('/notes/index.php', array('filtertype' => 'course', 'filterselect' => $course->id)), self::TYPE_SETTING, null, 'currentcoursenotes');
2709             }
2710         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2711             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2712         }
2714         // Badges.
2715         if ($navoptions->badges) {
2716             $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id));
2718             $coursenode->add(get_string('coursebadges', 'badges'), $url,
2719                     navigation_node::TYPE_SETTING, null, 'badgesview',
2720                     new pix_icon('i/badge', get_string('coursebadges', 'badges')));
2721         }
2723         // Check access to the course and competencies page.
2724         if ($navoptions->competencies) {
2725             // Just a link to course competency.
2726             $title = get_string('competencies', 'core_competency');
2727             $path = new moodle_url("/admin/tool/lp/coursecompetencies.php", array('courseid' => $course->id));
2728             $coursenode->add($title, $path, navigation_node::TYPE_SETTING, null, 'competencies',
2729                     new pix_icon('i/competencies', ''));
2730         }
2731         if ($navoptions->grades) {
2732             $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id));
2733             $gradenode = $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, 'grades', new pix_icon('i/grades', ''));
2734         }
2736         return true;
2737     }
2738     /**
2739      * This generates the structure of the course that won't be generated when
2740      * the modules and sections are added.
2741      *
2742      * Things such as the reports branch, the participants branch, blogs... get
2743      * added to the course node by this method.
2744      *
2745      * @param navigation_node $coursenode
2746      * @param stdClass $course
2747      * @return bool True for successfull generation
2748      */
2749     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2750         global $CFG, $USER, $COURSE, $SITE;
2751         require_once($CFG->dirroot . '/course/lib.php');
2753         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2754             return true;
2755         }
2757         $sitecontext = context_system::instance();
2758         $navoptions = course_get_user_navigation_options($sitecontext, $course);
2760         // Hidden node that we use to determine if the front page navigation is loaded.
2761         // This required as there are not other guaranteed nodes that may be loaded.
2762         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2764         // Participants.
2765         if ($navoptions->participants) {
2766             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2767         }
2769         // Blogs.
2770         if ($navoptions->blogs) {
2771             $blogsurls = new moodle_url('/blog/index.php');
2772             $coursenode->add(get_string('blogssite', 'blog'), $blogsurls->out(), self::TYPE_SYSTEM, null, 'siteblog');
2773         }
2775         $filterselect = 0;
2777         // Badges.
2778         if ($navoptions->badges) {
2779             $url = new moodle_url($CFG->wwwroot . '/badges/view.php', array('type' => 1));
2780             $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node::TYPE_CUSTOM);
2781         }
2783         // Notes.
2784         if ($navoptions->notes) {
2785             $coursenode->add(get_string('notes', 'notes'), new moodle_url('/notes/index.php',
2786                 array('filtertype' => 'course', 'filterselect' => $filterselect)), self::TYPE_SETTING, null, 'notes');
2787         }
2789         // Tags
2790         if ($navoptions->tags) {
2791             $node = $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'),
2792                     self::TYPE_SETTING, null, 'tags');
2793         }
2795         // Search.
2796         if ($navoptions->search) {
2797             $node = $coursenode->add(get_string('search', 'search'), new moodle_url('/search/index.php'),
2798                     self::TYPE_SETTING, null, 'search');
2799         }
2801         if ($navoptions->calendar) {
2802             $courseid = $COURSE->id;
2803             $params = array('view' => 'month');
2804             if ($courseid != $SITE->id) {
2805                 $params['course'] = $courseid;
2806             }
2808             // Calendar
2809             $calendarurl = new moodle_url('/calendar/view.php', $params);
2810             $node = $coursenode->add(get_string('calendar', 'calendar'), $calendarurl,
2811                 self::TYPE_CUSTOM, null, 'calendar', new pix_icon('i/calendar', ''));
2812             $node->showinflatnavigation = true;
2813         }
2815         if (isloggedin()) {
2816             $usercontext = context_user::instance($USER->id);
2817             if (has_capability('moodle/user:manageownfiles', $usercontext)) {
2818                 $url = new moodle_url('/user/files.php');
2819                 $node = $coursenode->add(get_string('privatefiles'), $url,
2820                     self::TYPE_SETTING, null, 'privatefiles', new pix_icon('i/privatefiles', ''));
2821                 $node->display = false;
2822                 $node->showinflatnavigation = true;
2823             }
2824         }
2826         return true;
2827     }
2829     /**
2830      * Clears the navigation cache
2831      */
2832     public function clear_cache() {
2833         $this->cache->clear();
2834     }
2836     /**
2837      * Sets an expansion limit for the navigation
2838      *
2839      * The expansion limit is used to prevent the display of content that has a type
2840      * greater than the provided $type.
2841      *
2842      * Can be used to ensure things such as activities or activity content don't get
2843      * shown on the navigation.
2844      * They are still generated in order to ensure the navbar still makes sense.
2845      *
2846      * @param int $type One of navigation_node::TYPE_*
2847      * @return bool true when complete.
2848      */
2849     public function set_expansion_limit($type) {
2850         global $SITE;
2851         $nodes = $this->find_all_of_type($type);
2853         // We only want to hide specific types of nodes.
2854         // Only nodes that represent "structure" in the navigation tree should be hidden.
2855         // If we hide all nodes then we risk hiding vital information.
2856         $typestohide = array(
2857             self::TYPE_CATEGORY,
2858             self::TYPE_COURSE,
2859             self::TYPE_SECTION,
2860             self::TYPE_ACTIVITY
2861         );
2863         foreach ($nodes as $node) {
2864             // We need to generate the full site node
2865             if ($type == self::TYPE_COURSE && $node->key == $SITE->id) {
2866                 continue;
2867             }
2868             foreach ($node->children as $child) {
2869                 $child->hide($typestohide);
2870             }
2871         }
2872         return true;
2873     }
2874     /**
2875      * Attempts to get the navigation with the given key from this nodes children.
2876      *
2877      * This function only looks at this nodes children, it does NOT look recursivily.
2878      * If the node can't be found then false is returned.
2879      *
2880      * If you need to search recursivily then use the {@link global_navigation::find()} method.
2881      *
2882      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2883      * may be of more use to you.
2884      *
2885      * @param string|int $key The key of the node you wish to receive.
2886      * @param int $type One of navigation_node::TYPE_*
2887      * @return navigation_node|false
2888      */
2889     public function get($key, $type = null) {
2890         if (!$this->initialised) {
2891             $this->initialise();
2892         }
2893         return parent::get($key, $type);
2894     }
2896     /**
2897      * Searches this nodes children and their children to find a navigation node
2898      * with the matching key and type.
2899      *
2900      * This method is recursive and searches children so until either a node is
2901      * found or there are no more nodes to search.
2902      *
2903      * If you know that the node being searched for is a child of this node
2904      * then use the {@link global_navigation::get()} method instead.
2905      *
2906      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2907      * may be of more use to you.
2908      *
2909      * @param string|int $key The key of the node you wish to receive.
2910      * @param int $type One of navigation_node::TYPE_*
2911      * @return navigation_node|false
2912      */
2913     public function find($key, $type) {
2914         if (!$this->initialised) {
2915             $this->initialise();
2916         }
2917         if ($type == self::TYPE_ROOTNODE && array_key_exists($key, $this->rootnodes)) {
2918             return $this->rootnodes[$key];
2919         }
2920         return parent::find($key, $type);
2921     }
2923     /**
2924      * They've expanded the 'my courses' branch.
2925      */
2926     protected function load_courses_enrolled() {
2927         global $CFG;
2929         $limit = (int) $CFG->navcourselimit;
2931         $courses = enrol_get_my_courses('*');
2932         $flatnavcourses = [];
2934         // Go through the courses and see which ones we want to display in the flatnav.
2935         foreach ($courses as $course) {
2936             $classify = course_classify_for_timeline($course);
2938             if ($classify == COURSE_TIMELINE_INPROGRESS) {
2939                 $flatnavcourses[$course->id] = $course;
2940             }
2941         }
2943         // Get the number of courses that can be displayed in the nav block and in the flatnav.
2944         $numtotalcourses = count($courses);
2945         $numtotalflatnavcourses = count($flatnavcourses);
2947         // Reduce the size of the arrays to abide by the 'navcourselimit' setting.
2948         $courses = array_slice($courses, 0, $limit, true);
2949         $flatnavcourses = array_slice($flatnavcourses, 0, $limit, true);
2951         // Get the number of courses we are going to show for each.
2952         $numshowncourses = count($courses);
2953         $numshownflatnavcourses = count($flatnavcourses);
2954         if ($numshowncourses && $this->show_my_categories()) {
2955             // Generate an array containing unique values of all the courses' categories.
2956             $categoryids = array();
2957             foreach ($courses as $course) {
2958                 if (in_array($course->category, $categoryids)) {
2959                     continue;
2960                 }
2961                 $categoryids[] = $course->category;
2962             }
2964             // Array of category IDs that include the categories of the user's courses and the related course categories.
2965             $fullpathcategoryids = [];
2966             // Get the course categories for the enrolled courses' category IDs.
2967             require_once('coursecatlib.php');
2968             $mycoursecategories = coursecat::get_many($categoryids);
2969             // Loop over each of these categories and build the category tree using each category's path.
2970             foreach ($mycoursecategories as $mycoursecat) {
2971                 $pathcategoryids = explode('/', $mycoursecat->path);
2972                 // First element of the exploded path is empty since paths begin with '/'.
2973                 array_shift($pathcategoryids);
2974                 // Merge the exploded category IDs into the full list of category IDs that we will fetch.
2975                 $fullpathcategoryids = array_merge($fullpathcategoryids, $pathcategoryids);
2976             }
2978             // Fetch all of the categories related to the user's courses.
2979             $pathcategories = coursecat::get_many($fullpathcategoryids);
2980             // Loop over each of these categories and build the category tree.
2981             foreach ($pathcategories as $coursecat) {
2982                 // No need to process categories that have already been added.
2983                 if (isset($this->addedcategories[$coursecat->id])) {
2984                     continue;
2985                 }
2987                 // Get this course category's parent node.
2988                 $parent = null;
2989                 if ($coursecat->parent && isset($this->addedcategories[$coursecat->parent])) {
2990                     $parent = $this->addedcategories[$coursecat->parent];
2991                 }
2992                 if (!$parent) {
2993                     // If it has no parent, then it should be right under the My courses node.
2994                     $parent = $this->rootnodes['mycourses'];
2995                 }
2997                 // Build the category object based from the coursecat object.
2998                 $mycategory = new stdClass();
2999                 $mycategory->id = $coursecat->id;
3000                 $mycategory->name = $coursecat->name;
3001                 $mycategory->visible = $coursecat->visible;
3003                 // Add this category to the nav tree.
3004                 $this->add_category($mycategory, $parent, self::TYPE_MY_CATEGORY);
3005             }
3006         }
3008         // Go through each course now and add it to the nav block, and the flatnav if applicable.
3009         foreach ($courses as $course) {
3010             $node = $this->add_course($course, false, self::COURSE_MY);
3011             if ($node) {
3012                 $node->showinflatnavigation = false;
3013                 // Check if we should also add this to the flat nav as well.
3014                 if (isset($flatnavcourses[$course->id])) {
3015                     $node->showinflatnavigation = true;
3016                 }
3017             }
3018         }
3020         // Go through each course in the flatnav now.
3021         foreach ($flatnavcourses as $course) {
3022             // Check if we haven't already added it.
3023             if (!isset($courses[$course->id])) {
3024                 // Ok, add it to the flatnav only.
3025                 $node = $this->add_course($course, false, self::COURSE_MY);
3026                 $node->display = false;
3027                 $node->showinflatnavigation = true;
3028             }
3029         }
3031         $showmorelinkinnav = $numtotalcourses > $numshowncourses;
3032         $showmorelinkinflatnav = $numtotalflatnavcourses > $numshownflatnavcourses;
3033         // Show a link to the course page if there are more courses the user is enrolled in.
3034         if ($showmorelinkinnav || $showmorelinkinflatnav) {
3035             // Adding hash to URL so the link is not highlighted in the navigation when clicked.
3036             $url = new moodle_url('/my/?myoverviewtab=courses');
3037             $parent = $this->rootnodes['mycourses'];
3038             $coursenode = $parent->add(get_string('morenavigationlinks'), $url, self::TYPE_CUSTOM, null, self::COURSE_INDEX_PAGE);
3040             if ($showmorelinkinnav) {
3041                 $coursenode->display = true;
3042             }
3044             if ($showmorelinkinflatnav) {
3045                 $coursenode->showinflatnavigation = true;
3046             }
3047         }
3048     }
3051 /**
3052  * The global navigation class used especially for AJAX requests.
3053  *
3054  * The primary methods that are used in the global navigation class have been overriden
3055  * to ensure that only the relevant branch is generated at the root of the tree.
3056  * This can be done because AJAX is only used when the backwards structure for the
3057  * requested branch exists.
3058  * This has been done only because it shortens the amounts of information that is generated
3059  * which of course will speed up the response time.. because no one likes laggy AJAX.
3060  *
3061  * @package   core
3062  * @category  navigation
3063  * @copyright 2009 Sam Hemelryk
3064  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3065  */
3066 class global_navigation_for_ajax extends global_navigation {
3068     /** @var int used for determining what type of navigation_node::TYPE_* is being used */
3069     protected $branchtype;
3071     /** @var int the instance id */
3072     protected $instanceid;
3074     /** @var array Holds an array of expandable nodes */
3075     protected $expandable = array();
3077     /**
3078      * Constructs the navigation for use in an AJAX request
3079      *
3080      * @param moodle_page $page moodle_page object
3081      * @param int $branchtype
3082      * @param int $id
3083      */
3084     public function __construct($page, $branchtype, $id) {
3085         $this->page = $page;
3086         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
3087         $this->children = new navigation_node_collection();
3088         $this->branchtype = $branchtype;
3089         $this->instanceid = $id;
3090         $this->initialise();
3091     }
3092     /**
3093      * Initialise the navigation given the type and id for the branch to expand.
3094      *
3095      * @return array An array of the expandable nodes
3096      */
3097     public function initialise() {
3098         global $DB, $SITE;
3100         if ($this->initialised || during_initial_install()) {
3101             return $this->expandable;
3102         }
3103         $this->initialised = true;
3105         $this->rootnodes = array();
3106         $this->rootnodes['site']    = $this->add_course($SITE);
3107         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self::TYPE_ROOTNODE, null, 'mycourses');
3108         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
3109         // The courses branch is always displayed, and is always expandable (although may be empty).
3110         // This mimicks what is done during {@link global_navigation::initialise()}.
3111         $this->rootnodes['courses']->isexpandable = true;
3113         // Branchtype will be one of navigation_node::TYPE_*
3114         switch ($this->branchtype) {
3115             case 0:
3116                 if ($this->instanceid === 'mycourses') {
3117                     $this->load_courses_enrolled();
3118                 } else if ($this->instanceid === 'courses') {
3119                     $this->load_courses_other();
3120                 }
3121                 break;
3122             case self::TYPE_CATEGORY :
3123                 $this->load_category($this->instanceid);
3124                 break;
3125             case self::TYPE_MY_CATEGORY :
3126                 $this->load_category($this->instanceid, self::TYPE_MY_CATEGORY);
3127                 break;
3128             case self::TYPE_COURSE :
3129                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
3130                 if (!can_access_course($course, null, '', true)) {
3131                     // Thats OK all courses are expandable by default. We don't need to actually expand it we can just
3132                     // add the course node and break. This leads to an empty node.
3133                     $this->add_course($course);
3134                     break;
3135                 }
3136                 require_course_login($course, true, null, false, true);
3137                 $this->page->set_context(context_course::instance($course->id));
3138                 $coursenode = $this->add_course($course);
3139                 $this->add_course_essentials($coursenode, $course);
3140                 $this->load_course_sections($course, $coursenode);
3141                 break;
3142             case self::TYPE_SECTION :
3143                 $sql = 'SELECT c.*, cs.section AS sectionnumber
3144                         FROM {course} c
3145                         LEFT JOIN {course_sections} cs ON cs.course = c.id
3146                         WHERE cs.id = ?';
3147                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
3148                 require_course_login($course, true, null, false, true);
3149                 $this->page->set_context(context_course::instance($course->id));
3150                 $coursenode = $this->add_course($course);
3151                 $this->add_course_essentials($coursenode, $course);
3152                 $this->load_course_sections($course, $coursenode, $course->sectionnumber);
3153                 break;
3154             case self::TYPE_ACTIVITY :
3155                 $sql = "SELECT c.*
3156                           FROM {course} c
3157                           JOIN {course_modules} cm ON cm.course = c.id
3158                          WHERE cm.id = :cmid";
3159                 $params = array('cmid' => $this->instanceid);
3160                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
3161                 $modinfo = get_fast_modinfo($course);
3162                 $cm = $modinfo->get_cm($this->instanceid);
3163                 require_course_login($course, true, $cm, false, true);
3164                 $this->page->set_context(context_module::instance($cm->id));
3165                 $coursenode = $this->load_course($course);
3166                 $this->load_course_sections($course, $coursenode, null, $cm);
3167                 $activitynode = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
3168                 if ($activitynode) {
3169                     $modulenode = $this->load_activity($cm, $course, $activitynode);
3170                 }
3171                 break;
3172             default:
3173                 throw new Exception('Unknown type');
3174                 return $this->expandable;
3175         }
3177         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) {
3178             $this->load_for_user(null, true);
3179         }
3181         $this->find_expandable($this->expandable);
3182         return $this->expandable;
3183     }
3185     /**
3186      * They've expanded the general 'courses' branch.
3187      */
3188     protected function load_courses_other() {
3189         $this->load_all_courses();
3190     }
3192     /**
3193      * Loads a single category into the AJAX navigation.
3194      *
3195      * This function is special in that it doesn't concern itself with the parent of
3196      * the requested category or its siblings.
3197      * This is because with the AJAX navigation we know exactly what is wanted and only need to
3198      * request that.
3199      *
3200      * @global moodle_database $DB
3201      * @param int $categoryid id of category to load in navigation.
3202      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
3203      * @return void.
3204      */
3205     protected function load_category($categoryid, $nodetype = self::TYPE_CATEGORY) {
3206         global $CFG, $DB;
3208         $limit = 20;
3209         if (!empty($CFG->navcourselimit)) {
3210             $limit = (int)$CFG->navcourselimit;
3211         }
3213         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
3214         $sql = "SELECT cc.*, $catcontextsql
3215                   FROM {course_categories} cc
3216                   JOIN {context} ctx ON cc.id = ctx.instanceid
3217                  WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND
3218                        (cc.id = :categoryid1 OR cc.parent = :categoryid2)
3219               ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
3220         $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
3221         $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
3222         $categorylist = array();
3223         $subcategories = array();
3224         $basecategory = null;
3225         foreach ($categories as $category) {
3226             $categorylist[] = $category->id;
3227             context_helper::preload_from_record($category);
3228             if ($category->id == $categoryid) {
3229                 $this->add_category($category, $this, $nodetype);
3230                 $basecategory = $this->addedcategories[$category->id];
3231             } else {
3232                 $subcategories[$category->id] = $category;
3233             }
3234         }
3235         $categories->close();
3238         // If category is shown in MyHome then only show enrolled courses and hide empty subcategories,
3239         // else show all courses.
3240         if ($nodetype === self::TYPE_MY_CATEGORY) {
3241             $courses = enrol_get_my_courses('*');
3242             $categoryids = array();
3244             // Only search for categories if basecategory was found.
3245             if (!is_null($basecategory)) {
3246                 // Get course parent category ids.
3247                 foreach ($courses as $course) {
3248                     $categoryids[] = $course->category;
3249                 }
3251                 // Get a unique list of category ids which a part of the path
3252                 // to user's courses.
3253                 $coursesubcategories = array();
3254                 $addedsubcategories = array();
3256                 list($sql, $params) = $DB->get_in_or_equal($categoryids);
3257                 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path');
3259                 foreach ($categories as $category){
3260                     $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path, "/")));
3261                 }
3262                 $categories->close();
3263                 $coursesubcategories = array_unique($coursesubcategories);
3265                 // Only add a subcategory if it is part of the path to user's course and
3266                 // wasn't already added.
3267                 foreach ($subcategories as $subid => $subcategory) {
3268                     if (in_array($subid, $coursesubcategories) &&
3269                             !in_array($subid, $addedsubcategories)) {
3270                             $this->add_category($subcategory, $basecategory, $nodetype);
3271                             $addedsubcategories[] = $subid;
3272                     }
3273                 }
3274             }
3276             foreach ($courses as $course) {
3277                 // Add course if it's in category.
3278                 if (in_array($course->category, $categorylist)) {
3279                     $this->add_course($course, true, self::COURSE_MY);
3280                 }
3281             }
3282         } else {
3283             if (!is_null($basecategory)) {
3284                 foreach ($subcategories as $key=>$category) {
3285                     $this->add_category($category, $basecategory, $nodetype);
3286                 }
3287             }
3288             $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
3289             foreach ($courses as $course) {
3290                 $this->add_course($course);
3291             }
3292             $courses->close();
3293         }
3294     }
3296     /**
3297      * Returns an array of expandable nodes
3298      * @return array
3299      */
3300     public function get_expandable() {
3301         return $this->expandable;
3302     }
3305 /**
3306  * Navbar class
3307  *
3308  * This class is used to manage the navbar, which is initialised from the navigation
3309  * object held by PAGE
3310  *
3311  * @package   core
3312  * @category  navigation
3313  * @copyright 2009 Sam Hemelryk
3314  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3315  */
3316 class navbar extends navigation_node {
3317     /** @var bool A switch for whether the navbar is initialised or not */
3318     protected $initialised = false;
3319     /** @var mixed keys used to reference the nodes on the navbar */
3320     protected $keys = array();
3321     /** @var null|string content of the navbar */
3322     protected $content = null;
3323     /** @var moodle_page object the moodle page that this navbar belongs to */
3324     protected $page;
3325     /** @var bool A switch for whether to ignore the active navigation information */
3326     protected $ignoreactive = false;
3327     /** @var bool A switch to let us know if we are in the middle of an install */
3328     protected $duringinstall = false;
3329     /** @var bool A switch for whether the navbar has items */
3330     protected $hasitems = false;
3331     /** @var array An array of navigation nodes for the navbar */
3332     protected $items;
3333     /** @var array An array of child node objects */
3334     public $children = array();
3335     /** @var bool A switch for whether we want to include the root node in the navbar */
3336     public $includesettingsbase = false;
3337     /** @var breadcrumb_navigation_node[] $prependchildren */
3338     protected $prependchildren = array();
3340     /**
3341      * The almighty constructor
3342      *
3343      * @param moodle_page $page
3344      */
3345     public function __construct(moodle_page $page) {
3346         global $CFG;
3347         if (during_initial_install()) {
3348             $this->duringinstall = true;
3349             return false;
3350         }
3351         $this->page = $page;
3352         $this->text = get_string('home');
3353         $this->shorttext = get_string('home');
3354         $this->action = new moodle_url($CFG->wwwroot);
3355         $this->nodetype = self::NODETYPE_BRANCH;
3356         $this->type = self::TYPE_SYSTEM;
3357     }
3359     /**
3360      * Quick check to see if the navbar will have items in.
3361      *
3362      * @return bool Returns true if the navbar will have items, false otherwise
3363      */
3364     public function has_items() {
3365         if ($this->duringinstall) {
3366             return false;
3367         } else if ($this->hasitems !== false) {
3368             return true;
3369         }
3370         if (count($this->children) > 0 || count($this->prependchildren) > 0) {
3371             // There have been manually added items - there are definitely items.
3372             $outcome = true;
3373         } else if (!$this->ignoreactive) {
3374             // We will need to initialise the navigation structure to check if there are active items.
3375             $this->page->navigation->initialise($this->page);
3376             $outcome = ($this->page->navigation->contains_active_node() || $this->page->settingsnav->contains_active_node());
3377         }
3378         $this->hasitems = $outcome;
3379         return $outcome;
3380     }
3382     /**
3383      * Turn on/off ignore active
3384      *
3385      * @param bool $setting
3386      */
3387     public function ignore_active($setting=true) {
3388         $this->ignoreactive = ($setting);
3389     }
3391     /**
3392      * Gets a navigation node
3393      *
3394      * @param string|int $key for referencing the navbar nodes
3395      * @param int $type breadcrumb_navigation_node::TYPE_*
3396      * @return breadcrumb_navigation_node|bool
3397      */
3398     public function get($key, $type = null) {
3399         foreach ($this->children as &$child) {
3400             if ($child->key === $key && ($type == null || $type == $child->type)) {
3401                 return $child;
3402             }
3403         }
3404         foreach ($this->prependchildren as &$child) {
3405             if ($child->key === $key && ($type == null || $type == $child->type)) {
3406                 return $child;
3407             }
3408         }
3409         return false;
3410     }
3411     /**
3412      * Returns an array of breadcrumb_navigation_nodes that make up the navbar.
3413      *
3414      * @return array
3415      */
3416     public function get_items() {
3417         global $CFG;
3418         $items = array();
3419         // Make sure that navigation is initialised
3420         if (!$this->has_items()) {
3421             return $items;
3422         }
3423         if ($this->items !== null) {
3424             return $this->items;
3425         }
3427         if (count($this->children) > 0) {
3428             // Add the custom children.
3429             $items = array_reverse($this->children);
3430         }
3432         // Check if navigation contains the active node
3433         if (!$this->ignoreactive) {
3434             // We will need to ensure the navigation has been initialised.
3435             $this->page->navigation->initialise($this->page);
3436             // Now find the active nodes on both the navigation and settings.
3437             $navigationactivenode = $this->page->navigation->find_active_node();
3438             $settingsactivenode = $this->page->settingsnav->find_active_node();
3440             if ($navigationactivenode && $settingsactivenode) {
3441                 // Parse a combined navigation tree
3442                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3443                     if (!$settingsactivenode->mainnavonly) {
3444                         $items[] = new breadcrumb_navigation_node($settingsactivenode);
3445                     }
3446                     $settingsactivenode = $settingsactivenode->parent;
3447                 }
3448                 if (!$this->includesettingsbase) {
3449                     // Removes the first node from the settings (root node) from the list
3450                     array_pop($items);
3451                 }
3452                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3453                     if (!$navigationactivenode->mainnavonly) {
3454                         $items[] = new breadcrumb_navigation_node($navigationactivenode);
3455                     }
3456                     if (!empty($CFG->navshowcategories) &&
3457                             $navigationactivenode->type === self::TYPE_COURSE &&
3458                             $navigationactivenode->parent->key === 'currentcourse') {
3459                         foreach ($this->get_course_categories() as $item) {
3460                             $items[] = new breadcrumb_navigation_node($item);
3461                         }
3462                     }
3463                     $navigationactivenode = $navigationactivenode->parent;
3464                 }
3465             } else if ($navigationactivenode) {
3466                 // Parse the navigation tree to get the active node
3467                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3468                     if (!$navigationactivenode->mainnavonly) {
3469                         $items[] = new breadcrumb_navigation_node($navigationactivenode);
3470                     }
3471                     if (!empty($CFG->navshowcategories) &&
3472                             $navigationactivenode->type === self::TYPE_COURSE &&
3473                             $navigationactivenode->parent->key === 'currentcourse') {
3474                         foreach ($this->get_course_categories() as $item) {
3475                             $items[] = new breadcrumb_navigation_node($item);
3476                         }
3477                     }
3478                     $navigationactivenode = $navigationactivenode->parent;
3479                 }
3480             } else if ($settingsactivenode) {
3481                 // Parse the settings navigation to get the active node
3482                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3483                     if (!$settingsactivenode->mainnavonly) {
3484                         $items[] = new breadcrumb_navigation_node($settingsactivenode);
3485                     }
3486                     $settingsactivenode = $settingsactivenode->parent;
3487                 }
3488             }
3489         }
3491         $items[] = new breadcrumb_navigation_node(array(
3492             'text' => $this->page->navigation->text,
3493             'shorttext' => $this->page->navigation->shorttext,
3494             'key' => $this->page->navigation->key,
3495             'action' => $this->page->navigation->action
3496         ));
3498         if (count($this->prependchildren) > 0) {
3499             // Add the custom children
3500             $items = array_merge($items, array_reverse($this->prependchildren));
3501         }
3503         $last = reset($items);
3504         if ($last) {
3505             $last->set_last(true);
3506         }
3507         $this->items = array_reverse($items);
3508         return $this->items;
3509     }
3511     /**
3512      * Get the list of categories leading to this course.
3513      *
3514      * This function is used by {@link navbar::get_items()} to add back the "courses"
3515      * node and category chain leading to the current course.  Note that this is only ever
3516      * called for the current course, so we don't need to bother taking in any parameters.
3517      *
3518      * @return array
3519      */
3520     private function get_course_categories() {
3521         global $CFG;
3522         require_once($CFG->dirroot.'/course/lib.php');
3523         require_once($CFG->libdir.'/coursecatlib.php');
3525         $categories = array();
3526         $cap = 'moodle/category:viewhiddencategories';
3527         $showcategories = coursecat::count_all() > 1;
3529         if ($showcategories) {
3530             foreach ($this->page->categories as $category) {
3531                 if (!$category->visible && !has_capability($cap, get_category_or_system_context($category->parent))) {
3532                     continue;
3533                 }
3534                 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
3535                 $name = format_string($category->name, true, array('context' => context_coursecat::instance($category->id)));
3536                 $categorynode = breadcrumb_navigation_node::create($name, $url, self::TYPE_CATEGORY, null, $category->id);
3537                 if (!$category->visible) {
3538                     $categorynode->hidden = true;
3539                 }
3540                 $categories[] = $categorynode;
3541             }
3542         }
3544         // Don't show the 'course' node if enrolled in this course.
3545         if (!is_enrolled(context_course::instance($this->page->course->id, null, '', true))) {
3546             $courses = $this->page->navigation->get('courses');
3547             if (!$courses) {
3548                 // Courses node may not be present.
3549                 $courses = breadcrumb_navigation_node::create(
3550                     get_string('courses'),
3551                     new moodle_url('/course/index.php'),
3552                     self::TYPE_CONTAINER
3553                 );
3554             }
3555             $categories[] = $courses;
3556         }
3558         return $categories;
3559     }
3561     /**
3562      * Add a new breadcrumb_navigation_node to the navbar, overrides parent::add
3563      *
3564      * This function overrides {@link breadcrumb_navigation_node::add()} so that we can change
3565      * the way nodes get added to allow us to simply call add and have the node added to the
3566      * end of the navbar
3567      *
3568      * @param string $text
3569      * @param string|moodle_url|action_link $action An action to associate with this node.
3570      * @param int $type One of navigation_node::TYPE_*
3571      * @param string $shorttext
3572      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3573      * @param pix_icon $icon An optional icon to use for this node.
3574      * @return navigation_node
3575      */
3576     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3577         if ($this->content !== null) {
3578             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3579         }
3581         // Properties array used when creating the new navigation node
3582         $itemarray = array(
3583             'text' => $text,
3584             'type' => $type
3585         );
3586         // Set the action if one was provided
3587         if ($action!==null) {
3588             $itemarray['action'] = $action;
3589         }
3590         // Set the shorttext if one was provided
3591         if ($shorttext!==null) {
3592             $itemarray['shorttext'] = $shorttext;
3593         }
3594         // Set the icon if one was provided
3595         if ($icon!==null) {
3596             $itemarray['icon'] = $icon;
3597         }
3598         // Default the key to the number of children if not provided
3599         if ($key === null) {
3600             $key = count($this->children);
3601         }
3602         // Set the key
3603         $itemarray['key'] = $key;
3604         // Set the parent to this node
3605         $itemarray['parent'] = $this;
3606         // Add the child using the navigation_node_collections add method
3607         $this->children[] = new breadcrumb_navigation_node($itemarray);
3608         return $this;
3609     }
3611     /**
3612      * Prepends a new navigation_node to the start of the navbar
3613      *
3614      * @param string $text
3615      * @param string|moodle_url|action_link $action An action to associate with this node.
3616      * @param int $type One of navigation_node::TYPE_*
3617      * @param string $shorttext
3618      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3619      * @param pix_icon $icon An optional icon to use for this node.
3620      * @return navigation_node
3621      */
3622     public function prepend($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3623         if ($this->content !== null) {
3624             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3625         }
3626         // Properties array used when creating the new navigation node.
3627         $itemarray = array(
3628             'text' => $text,
3629             'type' => $type
3630         );
3631         // Set the action if one was provided.
3632         if ($action!==null) {
3633             $itemarray['action'] = $action;
3634         }
3635         // Set the shorttext if one was provided.
3636         if ($shorttext!==null) {
3637             $itemarray['shorttext'] = $shorttext;
3638         }
3639         // Set the icon if one was provided.
3640         if ($icon!==null) {
3641             $itemarray['icon'] = $icon;
3642         }
3643         // Default the key to the number of children if not provided.
3644         if ($key === null) {
3645             $key = count($this->children);
3646         }
3647         // Set the key.
3648         $itemarray['key'] = $key;
3649         // Set the parent to this node.
3650         $itemarray['parent'] = $this;
3651         // Add the child node to the prepend list.
3652         $this->prependchildren[] = new breadcrumb_navigation_node($itemarray);
3653         return $this;
3654     }
3657 /**
3658  * Subclass of navigation_node allowing different rendering for the breadcrumbs
3659  * in particular adding extra metadata for search engine robots to leverage.
3660  *
3661  * @package   core
3662  * @category  navigation
3663  * @copyright 2015 Brendan Heywood
3664  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3665  */
3666 class breadcrumb_navigation_node extends navigation_node {
3668     /** @var $last boolean A flag indicating this is the last item in the list of breadcrumbs. */
3669     private $last = false;
3671     /**
3672      * A proxy constructor
3673      *
3674      * @param mixed $navnode A navigation_node or an array
3675      */
3676     public function __construct($navnode) {
3677         if (is_array($navnode)) {
3678             parent::__construct($navnode);
3679         } else if ($navnode instanceof navigation_node) {
3681             // Just clone everything.
3682             $objvalues = get_object_vars($navnode);
3683             foreach ($objvalues as $key => $value) {
3684                  $this->$key = $value;
3685             }
3686         } else {
3687             throw new coding_exception('Not a valid breadcrumb_navigation_node');
3688         }
3689     }
3691     /**
3692      * Getter for "last"
3693      * @return boolean
3694      */
3695     public function is_last() {
3696         return $this->last;
3697     }
3699     /**
3700      * Setter for "last"
3701      * @param $val boolean
3702      */
3703     public function set_last($val) {
3704         $this->last = $val;
3705     }
3708 /**
3709  * Subclass of navigation_node allowing different rendering for the flat navigation
3710  * in particular allowing dividers and indents.
3711  *
3712  * @package   core
3713  * @category  navigation
3714  * @copyright 2016 Damyon Wiese
3715  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3716  */
3717 class flat_navigation_node extends navigation_node {
3719     /** @var $indent integer The indent level */
3720     private $indent = 0;
3722     /** @var $showdivider bool Show a divider before this element */
3723     private $showdivider = false;
3725     /**
3726      * A proxy constructor
3727      *
3728      * @param mixed $navnode A navigation_node or an array
3729      */
3730     public function __construct($navnode, $indent) {
3731         if (is_array($navnode)) {
3732             parent::__construct($navnode);
3733         } else if ($navnode instanceof navigation_node) {
3735             // Just clone everything.
3736             $objvalues = get_object_vars($navnode);
3737             foreach ($objvalues as $key => $value) {
3738                  $this->$key = $value;
3739             }
3740         } else {
3741             throw new coding_exception('Not a valid flat_navigation_node');
3742         }
3743         $this->indent = $indent;
3744     }
3746     /**
3747      * Does this node represent a course section link.
3748      * @return boolean
3749      */
3750     public function is_section() {
3751         return $this->type == navigation_node::TYPE_SECTION;
3752     }
3754     /**
3755      * In flat navigation - sections are active if we are looking at activities in the section.
3756      * @return boolean
3757      */
3758     public function isactive() {
3759         global $PAGE;
3761         if ($this->is_section()) {
3762             $active = $PAGE->navigation->find_active_node();
3763             while ($active = $active->parent) {
3764                 if ($active->key == $this->key && $active->type == $this->type) {
3765                     return true;
3766                 }
3767             }
3768         }
3769         return $this->isactive;
3770     }
3772     /**
3773      * Getter for "showdivider"
3774      * @return boolean
3775      */
3776     public function showdivider() {
3777         return $this->showdivider;
3778     }
3780     /**
3781      * Setter for "showdivider"
3782      * @param $val boolean
3783      */
3784     public function set_showdivider($val) {
3785         $this->showdivider = $val;
3786     }
3788     /**
3789      * Getter for "indent"
3790      * @return boolean
3791      */
3792     public function get_indent() {
3793         return $this->indent;
3794     }
3796     /**
3797      * Setter for "indent"
3798      * @param $val boolean
3799      */
3800     public function set_indent($val) {
3801         $this->indent = $val;
3802     }
3806 /**
3807  * Class used to generate a collection of navigation nodes most closely related
3808  * to the current page.
3809  *
3810  * @package core
3811  * @copyright 2016 Damyon Wiese
3812  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3813  */
3814 class flat_navigation extends navigation_node_collection {
3815     /** @var moodle_page the moodle page that the navigation belongs to */
3816     protected $page;
3818     /**
3819      * Constructor.
3820      *
3821      * @param moodle_page $page
3822      */
3823     public function __construct(moodle_page &$page) {
3824         if (during_initial_install()) {
3825             return false;
3826         }
3827         $this->page = $page;
3828     }
3830     /**
3831      * Build the list of navigation nodes based on the current navigation and settings trees.
3832      *
3833      */
3834     public function initialise() {
3835         global $PAGE, $USER, $OUTPUT, $CFG;
3836         if (during_initial_install()) {
3837             return;
3838         }
3840         $current = false;
3842         $course = $PAGE->course;