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