Merge branch 'wip-MDL-38593-master' of git://github.com/marinaglancy/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     }
676     /**
677      * Hides the node and any children it has.
678      *
679      * @since 2.5
680      */
681     public function hide() {
682         $this->display = false;
683         if ($this->has_children()) {
684             foreach ($this->children as $child) {
685                 $child->hide();
686             }
687         }
688     }
691 /**
692  * Navigation node collection
693  *
694  * This class is responsible for managing a collection of navigation nodes.
695  * It is required because a node's unique identifier is a combination of both its
696  * key and its type.
697  *
698  * Originally an array was used with a string key that was a combination of the two
699  * however it was decided that a better solution would be to use a class that
700  * implements the standard IteratorAggregate interface.
701  *
702  * @package   core
703  * @category  navigation
704  * @copyright 2010 Sam Hemelryk
705  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
706  */
707 class navigation_node_collection implements IteratorAggregate {
708     /**
709      * A multidimensional array to where the first key is the type and the second
710      * key is the nodes key.
711      * @var array
712      */
713     protected $collection = array();
714     /**
715      * An array that contains references to nodes in the same order they were added.
716      * This is maintained as a progressive array.
717      * @var array
718      */
719     protected $orderedcollection = array();
720     /**
721      * A reference to the last node that was added to the collection
722      * @var navigation_node
723      */
724     protected $last = null;
725     /**
726      * The total number of items added to this array.
727      * @var int
728      */
729     protected $count = 0;
731     /**
732      * Adds a navigation node to the collection
733      *
734      * @param navigation_node $node Node to add
735      * @param string $beforekey If specified, adds before a node with this key,
736      *   otherwise adds at end
737      * @return navigation_node Added node
738      */
739     public function add(navigation_node $node, $beforekey=null) {
740         global $CFG;
741         $key = $node->key;
742         $type = $node->type;
744         // First check we have a 2nd dimension for this type
745         if (!array_key_exists($type, $this->orderedcollection)) {
746             $this->orderedcollection[$type] = array();
747         }
748         // Check for a collision and report if debugging is turned on
749         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
750             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
751         }
753         // Find the key to add before
754         $newindex = $this->count;
755         $last = true;
756         if ($beforekey !== null) {
757             foreach ($this->collection as $index => $othernode) {
758                 if ($othernode->key === $beforekey) {
759                     $newindex = $index;
760                     $last = false;
761                     break;
762                 }
763             }
764             if ($newindex === $this->count) {
765                 debugging('Navigation node add_before: Reference node not found ' . $beforekey .
766                         ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER);
767             }
768         }
770         // Add the node to the appropriate place in the by-type structure (which
771         // is not ordered, despite the variable name)
772         $this->orderedcollection[$type][$key] = $node;
773         if (!$last) {
774             // Update existing references in the ordered collection (which is the
775             // one that isn't called 'ordered') to shuffle them along if required
776             for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) {
777                 $this->collection[$oldindex] = $this->collection[$oldindex - 1];
778             }
779         }
780         // Add a reference to the node to the progressive collection.
781         $this->collection[$newindex] = $this->orderedcollection[$type][$key];
782         // Update the last property to a reference to this new node.
783         $this->last = $this->orderedcollection[$type][$key];
785         // Reorder the array by index if needed
786         if (!$last) {
787             ksort($this->collection);
788         }
789         $this->count++;
790         // Return the reference to the now added node
791         return $node;
792     }
794     /**
795      * Return a list of all the keys of all the nodes.
796      * @return array the keys.
797      */
798     public function get_key_list() {
799         $keys = array();
800         foreach ($this->collection as $node) {
801             $keys[] = $node->key;
802         }
803         return $keys;
804     }
806     /**
807      * Fetches a node from this collection.
808      *
809      * @param string|int $key The key of the node we want to find.
810      * @param int $type One of navigation_node::TYPE_*.
811      * @return navigation_node|null
812      */
813     public function get($key, $type=null) {
814         if ($type !== null) {
815             // If the type is known then we can simply check and fetch
816             if (!empty($this->orderedcollection[$type][$key])) {
817                 return $this->orderedcollection[$type][$key];
818             }
819         } else {
820             // Because we don't know the type we look in the progressive array
821             foreach ($this->collection as $node) {
822                 if ($node->key === $key) {
823                     return $node;
824                 }
825             }
826         }
827         return false;
828     }
830     /**
831      * Searches for a node with matching key and type.
832      *
833      * This function searches both the nodes in this collection and all of
834      * the nodes in each collection belonging to the nodes in this collection.
835      *
836      * Recursive.
837      *
838      * @param string|int $key  The key of the node we want to find.
839      * @param int $type  One of navigation_node::TYPE_*.
840      * @return navigation_node|null
841      */
842     public function find($key, $type=null) {
843         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
844             return $this->orderedcollection[$type][$key];
845         } else {
846             $nodes = $this->getIterator();
847             // Search immediate children first
848             foreach ($nodes as &$node) {
849                 if ($node->key === $key && ($type === null || $type === $node->type)) {
850                     return $node;
851                 }
852             }
853             // Now search each childs children
854             foreach ($nodes as &$node) {
855                 $result = $node->children->find($key, $type);
856                 if ($result !== false) {
857                     return $result;
858                 }
859             }
860         }
861         return false;
862     }
864     /**
865      * Fetches the last node that was added to this collection
866      *
867      * @return navigation_node
868      */
869     public function last() {
870         return $this->last;
871     }
873     /**
874      * Fetches all nodes of a given type from this collection
875      *
876      * @param string|int $type  node type being searched for.
877      * @return array ordered collection
878      */
879     public function type($type) {
880         if (!array_key_exists($type, $this->orderedcollection)) {
881             $this->orderedcollection[$type] = array();
882         }
883         return $this->orderedcollection[$type];
884     }
885     /**
886      * Removes the node with the given key and type from the collection
887      *
888      * @param string|int $key The key of the node we want to find.
889      * @param int $type
890      * @return bool
891      */
892     public function remove($key, $type=null) {
893         $child = $this->get($key, $type);
894         if ($child !== false) {
895             foreach ($this->collection as $colkey => $node) {
896                 if ($node->key == $key && $node->type == $type) {
897                     unset($this->collection[$colkey]);
898                     break;
899                 }
900             }
901             unset($this->orderedcollection[$child->type][$child->key]);
902             $this->count--;
903             return true;
904         }
905         return false;
906     }
908     /**
909      * Gets the number of nodes in this collection
910      *
911      * This option uses an internal count rather than counting the actual options to avoid
912      * a performance hit through the count function.
913      *
914      * @return int
915      */
916     public function count() {
917         return $this->count;
918     }
919     /**
920      * Gets an array iterator for the collection.
921      *
922      * This is required by the IteratorAggregator interface and is used by routines
923      * such as the foreach loop.
924      *
925      * @return ArrayIterator
926      */
927     public function getIterator() {
928         return new ArrayIterator($this->collection);
929     }
932 /**
933  * The global navigation class used for... the global navigation
934  *
935  * This class is used by PAGE to store the global navigation for the site
936  * and is then used by the settings nav and navbar to save on processing and DB calls
937  *
938  * See
939  * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()}
940  * {@link lib/ajax/getnavbranch.php} Called by ajax
941  *
942  * @package   core
943  * @category  navigation
944  * @copyright 2009 Sam Hemelryk
945  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
946  */
947 class global_navigation extends navigation_node {
948     /** @var moodle_page The Moodle page this navigation object belongs to. */
949     protected $page;
950     /** @var bool switch to let us know if the navigation object is initialised*/
951     protected $initialised = false;
952     /** @var array An array of course information */
953     protected $mycourses = array();
954     /** @var array An array for containing  root navigation nodes */
955     protected $rootnodes = array();
956     /** @var bool A switch for whether to show empty sections in the navigation */
957     protected $showemptysections = true;
958     /** @var bool A switch for whether courses should be shown within categories on the navigation. */
959     protected $showcategories = null;
960     /** @var null@var bool A switch for whether or not to show categories in the my courses branch. */
961     protected $showmycategories = null;
962     /** @var array An array of stdClasses for users that the navigation is extended for */
963     protected $extendforuser = array();
964     /** @var navigation_cache */
965     protected $cache;
966     /** @var array An array of course ids that are present in the navigation */
967     protected $addedcourses = array();
968     /** @var bool */
969     protected $allcategoriesloaded = false;
970     /** @var array An array of category ids that are included in the navigation */
971     protected $addedcategories = array();
972     /** @var int expansion limit */
973     protected $expansionlimit = 0;
974     /** @var int userid to allow parent to see child's profile page navigation */
975     protected $useridtouseforparentchecks = 0;
977     /** Used when loading categories to load all top level categories [parent = 0] **/
978     const LOAD_ROOT_CATEGORIES = 0;
979     /** Used when loading categories to load all categories **/
980     const LOAD_ALL_CATEGORIES = -1;
982     /**
983      * Constructs a new global navigation
984      *
985      * @param moodle_page $page The page this navigation object belongs to
986      */
987     public function __construct(moodle_page $page) {
988         global $CFG, $SITE, $USER;
990         if (during_initial_install()) {
991             return;
992         }
994         if (get_home_page() == HOMEPAGE_SITE) {
995             // We are using the site home for the root element
996             $properties = array(
997                 'key' => 'home',
998                 'type' => navigation_node::TYPE_SYSTEM,
999                 'text' => get_string('home'),
1000                 'action' => new moodle_url('/')
1001             );
1002         } else {
1003             // We are using the users my moodle for the root element
1004             $properties = array(
1005                 'key' => 'myhome',
1006                 'type' => navigation_node::TYPE_SYSTEM,
1007                 'text' => get_string('myhome'),
1008                 'action' => new moodle_url('/my/')
1009             );
1010         }
1012         // Use the parents constructor.... good good reuse
1013         parent::__construct($properties);
1015         // Initalise and set defaults
1016         $this->page = $page;
1017         $this->forceopen = true;
1018         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
1019     }
1021     /**
1022      * Mutator to set userid to allow parent to see child's profile
1023      * page navigation. See MDL-25805 for initial issue. Linked to it
1024      * is an issue explaining why this is a REALLY UGLY HACK thats not
1025      * for you to use!
1026      *
1027      * @param int $userid userid of profile page that parent wants to navigate around.
1028      */
1029     public function set_userid_for_parent_checks($userid) {
1030         $this->useridtouseforparentchecks = $userid;
1031     }
1034     /**
1035      * Initialises the navigation object.
1036      *
1037      * This causes the navigation object to look at the current state of the page
1038      * that it is associated with and then load the appropriate content.
1039      *
1040      * This should only occur the first time that the navigation structure is utilised
1041      * which will normally be either when the navbar is called to be displayed or
1042      * when a block makes use of it.
1043      *
1044      * @return bool
1045      */
1046     public function initialise() {
1047         global $CFG, $SITE, $USER;
1048         // Check if it has already been initialised
1049         if ($this->initialised || during_initial_install()) {
1050             return true;
1051         }
1052         $this->initialised = true;
1054         // Set up the five base root nodes. These are nodes where we will put our
1055         // content and are as follows:
1056         // site: Navigation for the front page.
1057         // myprofile: User profile information goes here.
1058         // currentcourse: The course being currently viewed.
1059         // mycourses: The users courses get added here.
1060         // courses: Additional courses are added here.
1061         // users: Other users information loaded here.
1062         $this->rootnodes = array();
1063         if (get_home_page() == HOMEPAGE_SITE) {
1064             // The home element should be my moodle because the root element is the site
1065             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
1066                 $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
1067             }
1068         } else {
1069             // The home element should be the site because the root node is my moodle
1070             $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
1071             if (!empty($CFG->defaulthomepage) && ($CFG->defaulthomepage == HOMEPAGE_MY)) {
1072                 // We need to stop automatic redirection
1073                 $this->rootnodes['home']->action->param('redirect', '0');
1074             }
1075         }
1076         $this->rootnodes['site'] = $this->add_course($SITE);
1077         $this->rootnodes['myprofile'] = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
1078         $this->rootnodes['currentcourse'] = $this->add(get_string('currentcourse'), null, self::TYPE_ROOTNODE, null, 'currentcourse');
1079         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my/'), self::TYPE_ROOTNODE, null, 'mycourses');
1080         $this->rootnodes['courses'] = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self::TYPE_ROOTNODE, null, 'courses');
1081         $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
1083         // We always load the frontpage course to ensure it is available without
1084         // JavaScript enabled.
1085         $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE);
1086         $this->load_course_sections($SITE, $this->rootnodes['site']);
1088         $course = $this->page->course;
1090         // $issite gets set to true if the current pages course is the sites frontpage course
1091         $issite = ($this->page->course->id == $SITE->id);
1092         // Determine if the user is enrolled in any course.
1093         $enrolledinanycourse = enrol_user_sees_own_courses();
1095         $this->rootnodes['currentcourse']->mainnavonly = true;
1096         if ($enrolledinanycourse) {
1097             $this->rootnodes['mycourses']->isexpandable = true;
1098             if ($CFG->navshowallcourses) {
1099                 // When we show all courses we need to show both the my courses and the regular courses branch.
1100                 $this->rootnodes['courses']->isexpandable = true;
1101             }
1102         } else {
1103             $this->rootnodes['courses']->isexpandable = true;
1104         }
1106         if ($this->rootnodes['mycourses']->isactive) {
1107             $this->load_courses_enrolled();
1108         }
1110         $canviewcourseprofile = true;
1112         // Next load context specific content into the navigation
1113         switch ($this->page->context->contextlevel) {
1114             case CONTEXT_SYSTEM :
1115                 // Nothing left to do here I feel.
1116                 break;
1117             case CONTEXT_COURSECAT :
1118                 // This is essential, we must load categories.
1119                 $this->load_all_categories($this->page->context->instanceid, true);
1120                 break;
1121             case CONTEXT_BLOCK :
1122             case CONTEXT_COURSE :
1123                 if ($issite) {
1124                     // Nothing left to do here.
1125                     break;
1126                 }
1128                 // Load the course associated with the current page into the navigation.
1129                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1130                 // If the course wasn't added then don't try going any further.
1131                 if (!$coursenode) {
1132                     $canviewcourseprofile = false;
1133                     break;
1134                 }
1136                 // If the user is not enrolled then we only want to show the
1137                 // course node and not populate it.
1139                 // Not enrolled, can't view, and hasn't switched roles
1140                 if (!can_access_course($course)) {
1141                     // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1142                     // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1143                     if (!$this->current_user_is_parent_role()) {
1144                         $coursenode->make_active();
1145                         $canviewcourseprofile = false;
1146                         break;
1147                     }
1148                 }
1150                 // Add the essentials such as reports etc...
1151                 $this->add_course_essentials($coursenode, $course);
1152                 // Extend course navigation with it's sections/activities
1153                 $this->load_course_sections($course, $coursenode);
1154                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1155                     $coursenode->make_active();
1156                 }
1158                 break;
1159             case CONTEXT_MODULE :
1160                 if ($issite) {
1161                     // If this is the site course then most information will have
1162                     // already been loaded.
1163                     // However we need to check if there is more content that can
1164                     // yet be loaded for the specific module instance.
1165                     $activitynode = $this->rootnodes['site']->find($this->page->cm->id, navigation_node::TYPE_ACTIVITY);
1166                     if ($activitynode) {
1167                         $this->load_activity($this->page->cm, $this->page->course, $activitynode);
1168                     }
1169                     break;
1170                 }
1172                 $course = $this->page->course;
1173                 $cm = $this->page->cm;
1175                 // Load the course associated with the page into the navigation
1176                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1178                 // If the course wasn't added then don't try going any further.
1179                 if (!$coursenode) {
1180                     $canviewcourseprofile = false;
1181                     break;
1182                 }
1184                 // If the user is not enrolled then we only want to show the
1185                 // course node and not populate it.
1186                 if (!can_access_course($course)) {
1187                     $coursenode->make_active();
1188                     $canviewcourseprofile = false;
1189                     break;
1190                 }
1192                 $this->add_course_essentials($coursenode, $course);
1194                 // Load the course sections into the page
1195                 $this->load_course_sections($course, $coursenode, null, $cm);
1196                 $activity = $coursenode->find($cm->id, navigation_node::TYPE_ACTIVITY);
1197                 // Finally load the cm specific navigaton information
1198                 $this->load_activity($cm, $course, $activity);
1199                 // Check if we have an active ndoe
1200                 if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1201                     // And make the activity node active.
1202                     $activity->make_active();
1203                 }
1204                 break;
1205             case CONTEXT_USER :
1206                 if ($issite) {
1207                     // The users profile information etc is already loaded
1208                     // for the front page.
1209                     break;
1210                 }
1211                 $course = $this->page->course;
1212                 // Load the course associated with the user into the navigation
1213                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1215                 // If the course wasn't added then don't try going any further.
1216                 if (!$coursenode) {
1217                     $canviewcourseprofile = false;
1218                     break;
1219                 }
1221                 // If the user is not enrolled then we only want to show the
1222                 // course node and not populate it.
1223                 if (!can_access_course($course)) {
1224                     $coursenode->make_active();
1225                     $canviewcourseprofile = false;
1226                     break;
1227                 }
1228                 $this->add_course_essentials($coursenode, $course);
1229                 $this->load_course_sections($course, $coursenode);
1230                 break;
1231         }
1233         // Load for the current user
1234         $this->load_for_user();
1235         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) {
1236             $this->load_for_user(null, true);
1237         }
1238         // Load each extending user into the navigation.
1239         foreach ($this->extendforuser as $user) {
1240             if ($user->id != $USER->id) {
1241                 $this->load_for_user($user);
1242             }
1243         }
1245         // Give the local plugins a chance to include some navigation if they want.
1246         foreach (get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $file) {
1247             $function = "local_{$plugin}_extends_navigation";
1248             $oldfunction = "{$plugin}_extends_navigation";
1249             if (function_exists($function)) {
1250                 // This is the preferred function name as there is less chance of conflicts
1251                 $function($this);
1252             } else if (function_exists($oldfunction)) {
1253                 // We continue to support the old function name to ensure backwards compatibility
1254                 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);
1255                 $oldfunction($this);
1256             }
1257         }
1259         // Remove any empty root nodes
1260         foreach ($this->rootnodes as $node) {
1261             // Dont remove the home node
1262             if ($node->key !== 'home' && !$node->has_children()) {
1263                 $node->remove();
1264             }
1265         }
1267         if (!$this->contains_active_node()) {
1268             $this->search_for_active_node();
1269         }
1271         // If the user is not logged in modify the navigation structure as detailed
1272         // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1273         if (!isloggedin()) {
1274             $activities = clone($this->rootnodes['site']->children);
1275             $this->rootnodes['site']->remove();
1276             $children = clone($this->children);
1277             $this->children = new navigation_node_collection();
1278             foreach ($activities as $child) {
1279                 $this->children->add($child);
1280             }
1281             foreach ($children as $child) {
1282                 $this->children->add($child);
1283             }
1284         }
1285         return true;
1286     }
1288     /**
1289      * Returns true if the current user is a parent of the user being currently viewed.
1290      *
1291      * If the current user is not viewing another user, or if the current user does not hold any parent roles over the
1292      * other user being viewed this function returns false.
1293      * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()}
1294      *
1295      * @since 2.4
1296      * @return bool
1297      */
1298     protected function current_user_is_parent_role() {
1299         global $USER, $DB;
1300         if ($this->useridtouseforparentchecks && $this->useridtouseforparentchecks != $USER->id) {
1301             $usercontext = context_user::instance($this->useridtouseforparentchecks, MUST_EXIST);
1302             if (!has_capability('moodle/user:viewdetails', $usercontext)) {
1303                 return false;
1304             }
1305             if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))) {
1306                 return true;
1307             }
1308         }
1309         return false;
1310     }
1312     /**
1313      * Returns true if courses should be shown within categories on the navigation.
1314      *
1315      * @param bool $ismycourse Set to true if you are calculating this for a course.
1316      * @return bool
1317      */
1318     protected function show_categories($ismycourse = false) {
1319         global $CFG, $DB;
1320         if ($ismycourse) {
1321             return $this->show_my_categories();
1322         }
1323         if ($this->showcategories === null) {
1324             $show = false;
1325             if ($this->page->context->contextlevel == CONTEXT_COURSECAT) {
1326                 $show = true;
1327             } else if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1) {
1328                 $show = true;
1329             }
1330             $this->showcategories = $show;
1331         }
1332         return $this->showcategories;
1333     }
1335     /**
1336      * Returns true if we should show categories in the My Courses branch.
1337      * @return bool
1338      */
1339     protected function show_my_categories() {
1340         global $CFG, $DB;
1341         if ($this->showmycategories === null) {
1342             $this->showmycategories = !empty($CFG->navshowmycoursecategories) && $DB->count_records('course_categories') > 1;
1343         }
1344         return $this->showmycategories;
1345     }
1347     /**
1348      * Loads the courses in Moodle into the navigation.
1349      *
1350      * @global moodle_database $DB
1351      * @param string|array $categoryids An array containing categories to load courses
1352      *                     for, OR null to load courses for all categories.
1353      * @return array An array of navigation_nodes one for each course
1354      */
1355     protected function load_all_courses($categoryids = null) {
1356         global $CFG, $DB, $SITE;
1358         // Work out the limit of courses.
1359         $limit = 20;
1360         if (!empty($CFG->navcourselimit)) {
1361             $limit = $CFG->navcourselimit;
1362         }
1364         $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES;
1366         // If we are going to show all courses AND we are showing categories then
1367         // to save us repeated DB calls load all of the categories now
1368         if ($this->show_categories()) {
1369             $this->load_all_categories($toload);
1370         }
1372         // Will be the return of our efforts
1373         $coursenodes = array();
1375         // Check if we need to show categories.
1376         if ($this->show_categories()) {
1377             // Hmmm we need to show categories... this is going to be painful.
1378             // We now need to fetch up to $limit courses for each category to
1379             // be displayed.
1380             if ($categoryids !== null) {
1381                 if (!is_array($categoryids)) {
1382                     $categoryids = array($categoryids);
1383                 }
1384                 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc');
1385                 $categorywhere = 'WHERE cc.id '.$categorywhere;
1386             } else if ($toload == self::LOAD_ROOT_CATEGORIES) {
1387                 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1388                 $categoryparams = array();
1389             } else {
1390                 $categorywhere = '';
1391                 $categoryparams = array();
1392             }
1394             // First up we are going to get the categories that we are going to
1395             // need so that we can determine how best to load the courses from them.
1396             $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1397                         FROM {course_categories} cc
1398                     LEFT JOIN {course} c ON c.category = cc.id
1399                             {$categorywhere}
1400                     GROUP BY cc.id";
1401             $categories = $DB->get_recordset_sql($sql, $categoryparams);
1402             $fullfetch = array();
1403             $partfetch = array();
1404             foreach ($categories as $category) {
1405                 if (!$this->can_add_more_courses_to_category($category->id)) {
1406                     continue;
1407                 }
1408                 if ($category->coursecount > $limit * 5) {
1409                     $partfetch[] = $category->id;
1410                 } else if ($category->coursecount > 0) {
1411                     $fullfetch[] = $category->id;
1412                 }
1413             }
1414             $categories->close();
1416             if (count($fullfetch)) {
1417                 // First up fetch all of the courses in categories where we know that we are going to
1418                 // need the majority of courses.
1419                 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1420                 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory');
1421                 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1422                             FROM {course} c
1423                                 $ccjoin
1424                             WHERE c.category {$categoryids}
1425                         ORDER BY c.sortorder ASC";
1426                 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1427                 foreach ($coursesrs as $course) {
1428                     if ($course->id == $SITE->id) {
1429                         // This should not be necessary, frontpage is not in any category.
1430                         continue;
1431                     }
1432                     if (array_key_exists($course->id, $this->addedcourses)) {
1433                         // It is probably better to not include the already loaded courses
1434                         // directly in SQL because inequalities may confuse query optimisers
1435                         // and may interfere with query caching.
1436                         continue;
1437                     }
1438                     if (!$this->can_add_more_courses_to_category($course->category)) {
1439                         continue;
1440                     }
1441                     context_instance_preload($course);
1442                     if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1443                         continue;
1444                     }
1445                     $coursenodes[$course->id] = $this->add_course($course);
1446                 }
1447                 $coursesrs->close();
1448             }
1450             if (count($partfetch)) {
1451                 // Next we will work our way through the categories where we will likely only need a small
1452                 // proportion of the courses.
1453                 foreach ($partfetch as $categoryid) {
1454                     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1455                     $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1456                                 FROM {course} c
1457                                     $ccjoin
1458                                 WHERE c.category = :categoryid
1459                             ORDER BY c.sortorder ASC";
1460                     $courseparams = array('categoryid' => $categoryid);
1461                     $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1462                     foreach ($coursesrs as $course) {
1463                         if ($course->id == $SITE->id) {
1464                             // This should not be necessary, frontpage is not in any category.
1465                             continue;
1466                         }
1467                         if (array_key_exists($course->id, $this->addedcourses)) {
1468                             // It is probably better to not include the already loaded courses
1469                             // directly in SQL because inequalities may confuse query optimisers
1470                             // and may interfere with query caching.
1471                             // This also helps to respect expected $limit on repeated executions.
1472                             continue;
1473                         }
1474                         if (!$this->can_add_more_courses_to_category($course->category)) {
1475                             break;
1476                         }
1477                         context_instance_preload($course);
1478                         if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1479                             continue;
1480                         }
1481                         $coursenodes[$course->id] = $this->add_course($course);
1482                     }
1483                     $coursesrs->close();
1484                 }
1485             }
1486         } else {
1487             // Prepare the SQL to load the courses and their contexts
1488             list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1489             list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false);
1490             $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1491                         FROM {course} c
1492                             $ccjoin
1493                         WHERE c.id {$courseids}
1494                     ORDER BY c.sortorder ASC";
1495             $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1496             foreach ($coursesrs as $course) {
1497                 if ($course->id == $SITE->id) {
1498                     // frotpage is not wanted here
1499                     continue;
1500                 }
1501                 if ($this->page->course && ($this->page->course->id == $course->id)) {
1502                     // Don't include the currentcourse in this nodelist - it's displayed in the Current course node
1503                     continue;
1504                 }
1505                 context_instance_preload($course);
1506                 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1507                     continue;
1508                 }
1509                 $coursenodes[$course->id] = $this->add_course($course);
1510                 if (count($coursenodes) >= $limit) {
1511                     break;
1512                 }
1513             }
1514             $coursesrs->close();
1515         }
1517         return $coursenodes;
1518     }
1520     /**
1521      * Returns true if more courses can be added to the provided category.
1522      *
1523      * @param int|navigation_node|stdClass $category
1524      * @return bool
1525      */
1526     protected function can_add_more_courses_to_category($category) {
1527         global $CFG;
1528         $limit = 20;
1529         if (!empty($CFG->navcourselimit)) {
1530             $limit = (int)$CFG->navcourselimit;
1531         }
1532         if (is_numeric($category)) {
1533             if (!array_key_exists($category, $this->addedcategories)) {
1534                 return true;
1535             }
1536             $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE));
1537         } else if ($category instanceof navigation_node) {
1538             if (($category->type != self::TYPE_CATEGORY) || ($category->type != self::TYPE_MY_CATEGORY)) {
1539                 return false;
1540             }
1541             $coursecount = count($category->children->type(self::TYPE_COURSE));
1542         } else if (is_object($category) && property_exists($category,'id')) {
1543             $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE));
1544         }
1545         return ($coursecount <= $limit);
1546     }
1548     /**
1549      * Loads all categories (top level or if an id is specified for that category)
1550      *
1551      * @param int $categoryid The category id to load or null/0 to load all base level categories
1552      * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1553      *        as the requested category and any parent categories.
1554      * @return navigation_node|void returns a navigation node if a category has been loaded.
1555      */
1556     protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) {
1557         global $CFG, $DB;
1559         // Check if this category has already been loaded
1560         if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1561             return true;
1562         }
1564         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
1565         $sqlselect = "SELECT cc.*, $catcontextsql
1566                       FROM {course_categories} cc
1567                       JOIN {context} ctx ON cc.id = ctx.instanceid";
1568         $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT;
1569         $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1570         $params = array();
1572         $categoriestoload = array();
1573         if ($categoryid == self::LOAD_ALL_CATEGORIES) {
1574             // We are going to load all categories regardless... prepare to fire
1575             // on the database server!
1576         } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0
1577             // We are going to load all of the first level categories (categories without parents)
1578             $sqlwhere .= " AND cc.parent = 0";
1579         } else if (array_key_exists($categoryid, $this->addedcategories)) {
1580             // The category itself has been loaded already so we just need to ensure its subcategories
1581             // have been loaded
1582             list($sql, $params) = $DB->get_in_or_equal(array_keys($this->addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1583             if ($showbasecategories) {
1584                 // We need to include categories with parent = 0 as well
1585                 $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1586             } else {
1587                 // All we need is categories that match the parent
1588                 $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1589             }
1590             $params['categoryid'] = $categoryid;
1591         } else {
1592             // This category hasn't been loaded yet so we need to fetch it, work out its category path
1593             // and load this category plus all its parents and subcategories
1594             $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
1595             $categoriestoload = explode('/', trim($category->path, '/'));
1596             list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1597             // We are going to use select twice so double the params
1598             $params = array_merge($params, $params);
1599             $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':'';
1600             $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1601         }
1603         $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1604         $categories = array();
1605         foreach ($categoriesrs as $category) {
1606             // Preload the context.. we'll need it when adding the category in order
1607             // to format the category name.
1608             context_helper::preload_from_record($category);
1609             if (array_key_exists($category->id, $this->addedcategories)) {
1610                 // Do nothing, its already been added.
1611             } else if ($category->parent == '0') {
1612                 // This is a root category lets add it immediately
1613                 $this->add_category($category, $this->rootnodes['courses']);
1614             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1615                 // This categories parent has already been added we can add this immediately
1616                 $this->add_category($category, $this->addedcategories[$category->parent]);
1617             } else {
1618                 $categories[] = $category;
1619             }
1620         }
1621         $categoriesrs->close();
1623         // Now we have an array of categories we need to add them to the navigation.
1624         while (!empty($categories)) {
1625             $category = reset($categories);
1626             if (array_key_exists($category->id, $this->addedcategories)) {
1627                 // Do nothing
1628             } else if ($category->parent == '0') {
1629                 $this->add_category($category, $this->rootnodes['courses']);
1630             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1631                 $this->add_category($category, $this->addedcategories[$category->parent]);
1632             } else {
1633                 // This category isn't in the navigation and niether is it's parent (yet).
1634                 // We need to go through the category path and add all of its components in order.
1635                 $path = explode('/', trim($category->path, '/'));
1636                 foreach ($path as $catid) {
1637                     if (!array_key_exists($catid, $this->addedcategories)) {
1638                         // This category isn't in the navigation yet so add it.
1639                         $subcategory = $categories[$catid];
1640                         if ($subcategory->parent == '0') {
1641                             // Yay we have a root category - this likely means we will now be able
1642                             // to add categories without problems.
1643                             $this->add_category($subcategory, $this->rootnodes['courses']);
1644                         } else if (array_key_exists($subcategory->parent, $this->addedcategories)) {
1645                             // The parent is in the category (as we'd expect) so add it now.
1646                             $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1647                             // Remove the category from the categories array.
1648                             unset($categories[$catid]);
1649                         } else {
1650                             // We should never ever arrive here - if we have then there is a bigger
1651                             // problem at hand.
1652                             throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1653                         }
1654                     }
1655                 }
1656             }
1657             // Remove the category from the categories array now that we know it has been added.
1658             unset($categories[$category->id]);
1659         }
1660         if ($categoryid === self::LOAD_ALL_CATEGORIES) {
1661             $this->allcategoriesloaded = true;
1662         }
1663         // Check if there are any categories to load.
1664         if (count($categoriestoload) > 0) {
1665             $readytoloadcourses = array();
1666             foreach ($categoriestoload as $category) {
1667                 if ($this->can_add_more_courses_to_category($category)) {
1668                     $readytoloadcourses[] = $category;
1669                 }
1670             }
1671             if (count($readytoloadcourses)) {
1672                 $this->load_all_courses($readytoloadcourses);
1673             }
1674         }
1676         // Look for all categories which have been loaded
1677         if (!empty($this->addedcategories)) {
1678             $categoryids = array();
1679             foreach ($this->addedcategories as $category) {
1680                 if ($this->can_add_more_courses_to_category($category)) {
1681                     $categoryids[] = $category->key;
1682                 }
1683             }
1684             if ($categoryids) {
1685                 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED);
1686                 $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20;
1687                 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1688                           FROM {course_categories} cc
1689                           JOIN {course} c ON c.category = cc.id
1690                          WHERE cc.id {$categoriessql}
1691                       GROUP BY cc.id
1692                         HAVING COUNT(c.id) > :limit";
1693                 $excessivecategories = $DB->get_records_sql($sql, $params);
1694                 foreach ($categories as &$category) {
1695                     if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1696                         $url = new moodle_url('/course/index.php', array('categoryid' => $category->key));
1697                         $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1698                     }
1699                 }
1700             }
1701         }
1702     }
1704     /**
1705      * Adds a structured category to the navigation in the correct order/place
1706      *
1707      * @param stdClass $category category to be added in navigation.
1708      * @param navigation_node $parent parent navigation node
1709      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1710      * @return void.
1711      */
1712     protected function add_category(stdClass $category, navigation_node $parent, $nodetype = self::TYPE_CATEGORY) {
1713         if (array_key_exists($category->id, $this->addedcategories)) {
1714             return;
1715         }
1716         $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
1717         $context = context_coursecat::instance($category->id);
1718         $categoryname = format_string($category->name, true, array('context' => $context));
1719         $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id);
1720         if (empty($category->visible)) {
1721             if (has_capability('moodle/category:viewhiddencategories', get_system_context())) {
1722                 $categorynode->hidden = true;
1723             } else {
1724                 $categorynode->display = false;
1725             }
1726         }
1727         $this->addedcategories[$category->id] = $categorynode;
1728     }
1730     /**
1731      * Loads the given course into the navigation
1732      *
1733      * @param stdClass $course
1734      * @return navigation_node
1735      */
1736     protected function load_course(stdClass $course) {
1737         global $SITE;
1738         if ($course->id == $SITE->id) {
1739             // This is always loaded during initialisation
1740             return $this->rootnodes['site'];
1741         } else if (array_key_exists($course->id, $this->addedcourses)) {
1742             // The course has already been loaded so return a reference
1743             return $this->addedcourses[$course->id];
1744         } else {
1745             // Add the course
1746             return $this->add_course($course);
1747         }
1748     }
1750     /**
1751      * Loads all of the courses section into the navigation.
1752      *
1753      * This function calls method from current course format, see
1754      * {@link format_base::extend_course_navigation()}
1755      * If course module ($cm) is specified but course format failed to create the node,
1756      * the activity node is created anyway.
1757      *
1758      * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
1759      *
1760      * @param stdClass $course Database record for the course
1761      * @param navigation_node $coursenode The course node within the navigation
1762      * @param null|int $sectionnum If specified load the contents of section with this relative number
1763      * @param null|cm_info $cm If specified make sure that activity node is created (either
1764      *    in containg section or by calling load_stealth_activity() )
1765      */
1766     protected function load_course_sections(stdClass $course, navigation_node $coursenode, $sectionnum = null, $cm = null) {
1767         global $CFG, $SITE;
1768         require_once($CFG->dirroot.'/course/lib.php');
1769         if (isset($cm->sectionnum)) {
1770             $sectionnum = $cm->sectionnum;
1771         }
1772         if ($sectionnum !== null) {
1773             $this->includesectionnum = $sectionnum;
1774         }
1775         course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
1776         if (isset($cm->id)) {
1777             $activity = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
1778             if (empty($activity)) {
1779                 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
1780             }
1781         }
1782    }
1784     /**
1785      * Generates an array of sections and an array of activities for the given course.
1786      *
1787      * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1788      *
1789      * @param stdClass $course
1790      * @return array Array($sections, $activities)
1791      */
1792     protected function generate_sections_and_activities(stdClass $course) {
1793         global $CFG;
1794         require_once($CFG->dirroot.'/course/lib.php');
1796         $modinfo = get_fast_modinfo($course);
1797         $sections = $modinfo->get_section_info_all();
1799         // For course formats using 'numsections' trim the sections list
1800         $courseformatoptions = course_get_format($course)->get_format_options();
1801         if (isset($courseformatoptions['numsections'])) {
1802             $sections = array_slice($sections, 0, $courseformatoptions['numsections']+1, true);
1803         }
1805         $activities = array();
1807         foreach ($sections as $key => $section) {
1808             // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1809             $sections[$key] = clone($section);
1810             unset($sections[$key]->summary);
1811             $sections[$key]->hasactivites = false;
1812             if (!array_key_exists($section->section, $modinfo->sections)) {
1813                 continue;
1814             }
1815             foreach ($modinfo->sections[$section->section] as $cmid) {
1816                 $cm = $modinfo->cms[$cmid];
1817                 if (!$cm->uservisible) {
1818                     continue;
1819                 }
1820                 $activity = new stdClass;
1821                 $activity->id = $cm->id;
1822                 $activity->course = $course->id;
1823                 $activity->section = $section->section;
1824                 $activity->name = $cm->name;
1825                 $activity->icon = $cm->icon;
1826                 $activity->iconcomponent = $cm->iconcomponent;
1827                 $activity->hidden = (!$cm->visible);
1828                 $activity->modname = $cm->modname;
1829                 $activity->nodetype = navigation_node::NODETYPE_LEAF;
1830                 $activity->onclick = $cm->get_on_click();
1831                 $url = $cm->get_url();
1832                 if (!$url) {
1833                     $activity->url = null;
1834                     $activity->display = false;
1835                 } else {
1836                     $activity->url = $cm->get_url()->out();
1837                     $activity->display = true;
1838                     if (self::module_extends_navigation($cm->modname)) {
1839                         $activity->nodetype = navigation_node::NODETYPE_BRANCH;
1840                     }
1841                 }
1842                 $activities[$cmid] = $activity;
1843                 if ($activity->display) {
1844                     $sections[$key]->hasactivites = true;
1845                 }
1846             }
1847         }
1849         return array($sections, $activities);
1850     }
1852     /**
1853      * Generically loads the course sections into the course's navigation.
1854      *
1855      * @param stdClass $course
1856      * @param navigation_node $coursenode
1857      * @return array An array of course section nodes
1858      */
1859     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode) {
1860         global $CFG, $DB, $USER, $SITE;
1861         require_once($CFG->dirroot.'/course/lib.php');
1863         list($sections, $activities) = $this->generate_sections_and_activities($course);
1865         $navigationsections = array();
1866         foreach ($sections as $sectionid => $section) {
1867             $section = clone($section);
1868             if ($course->id == $SITE->id) {
1869                 $this->load_section_activities($coursenode, $section->section, $activities);
1870             } else {
1871                 if (!$section->uservisible || (!$this->showemptysections &&
1872                         !$section->hasactivites && $this->includesectionnum !== $section->section)) {
1873                     continue;
1874                 }
1876                 $sectionname = get_section_name($course, $section);
1877                 $url = course_get_url($course, $section->section, array('navigation' => true));
1879                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1880                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1881                 $sectionnode->hidden = (!$section->visible || !$section->available);
1882                 if ($this->includesectionnum !== false && $this->includesectionnum == $section->section) {
1883                     $this->load_section_activities($sectionnode, $section->section, $activities);
1884                 }
1885                 $section->sectionnode = $sectionnode;
1886                 $navigationsections[$sectionid] = $section;
1887             }
1888         }
1889         return $navigationsections;
1890     }
1892     /**
1893      * Loads all of the activities for a section into the navigation structure.
1894      *
1895      * @param navigation_node $sectionnode
1896      * @param int $sectionnumber
1897      * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
1898      * @param stdClass $course The course object the section and activities relate to.
1899      * @return array Array of activity nodes
1900      */
1901     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) {
1902         global $CFG, $SITE;
1903         // A static counter for JS function naming
1904         static $legacyonclickcounter = 0;
1906         $activitynodes = array();
1907         if (empty($activities)) {
1908             return $activitynodes;
1909         }
1911         if (!is_object($course)) {
1912             $activity = reset($activities);
1913             $courseid = $activity->course;
1914         } else {
1915             $courseid = $course->id;
1916         }
1917         $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods));
1919         foreach ($activities as $activity) {
1920             if ($activity->section != $sectionnumber) {
1921                 continue;
1922             }
1923             if ($activity->icon) {
1924                 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
1925             } else {
1926                 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
1927             }
1929             // Prepare the default name and url for the node
1930             $activityname = format_string($activity->name, true, array('context' => context_module::instance($activity->id)));
1931             $action = new moodle_url($activity->url);
1933             // Check if the onclick property is set (puke!)
1934             if (!empty($activity->onclick)) {
1935                 // Increment the counter so that we have a unique number.
1936                 $legacyonclickcounter++;
1937                 // Generate the function name we will use
1938                 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
1939                 $propogrationhandler = '';
1940                 // Check if we need to cancel propogation. Remember inline onclick
1941                 // events would return false if they wanted to prevent propogation and the
1942                 // default action.
1943                 if (strpos($activity->onclick, 'return false')) {
1944                     $propogrationhandler = 'e.halt();';
1945                 }
1946                 // Decode the onclick - it has already been encoded for display (puke)
1947                 $onclick = htmlspecialchars_decode($activity->onclick, ENT_QUOTES);
1948                 // Build the JS function the click event will call
1949                 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
1950                 $this->page->requires->js_init_code($jscode);
1951                 // Override the default url with the new action link
1952                 $action = new action_link($action, $activityname, new component_action('click', $functionname));
1953             }
1955             $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
1956             $activitynode->title(get_string('modulename', $activity->modname));
1957             $activitynode->hidden = $activity->hidden;
1958             $activitynode->display = $showactivities && $activity->display;
1959             $activitynode->nodetype = $activity->nodetype;
1960             $activitynodes[$activity->id] = $activitynode;
1961         }
1963         return $activitynodes;
1964     }
1965     /**
1966      * Loads a stealth module from unavailable section
1967      * @param navigation_node $coursenode
1968      * @param stdClass $modinfo
1969      * @return navigation_node or null if not accessible
1970      */
1971     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
1972         if (empty($modinfo->cms[$this->page->cm->id])) {
1973             return null;
1974         }
1975         $cm = $modinfo->cms[$this->page->cm->id];
1976         if (!$cm->uservisible) {
1977             return null;
1978         }
1979         if ($cm->icon) {
1980             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
1981         } else {
1982             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
1983         }
1984         $url = $cm->get_url();
1985         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
1986         $activitynode->title(get_string('modulename', $cm->modname));
1987         $activitynode->hidden = (!$cm->visible);
1988         if (!$url) {
1989             // Don't show activities that don't have links!
1990             $activitynode->display = false;
1991         } else if (self::module_extends_navigation($cm->modname)) {
1992             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
1993         }
1994         return $activitynode;
1995     }
1996     /**
1997      * Loads the navigation structure for the given activity into the activities node.
1998      *
1999      * This method utilises a callback within the modules lib.php file to load the
2000      * content specific to activity given.
2001      *
2002      * The callback is a method: {modulename}_extend_navigation()
2003      * Examples:
2004      *  * {@link forum_extend_navigation()}
2005      *  * {@link workshop_extend_navigation()}
2006      *
2007      * @param cm_info|stdClass $cm
2008      * @param stdClass $course
2009      * @param navigation_node $activity
2010      * @return bool
2011      */
2012     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
2013         global $CFG, $DB;
2015         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2016         if (!($cm instanceof cm_info)) {
2017             $modinfo = get_fast_modinfo($course);
2018             $cm = $modinfo->get_cm($cm->id);
2019         }
2020         $activity->nodetype = navigation_node::NODETYPE_LEAF;
2021         $activity->make_active();
2022         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
2023         $function = $cm->modname.'_extend_navigation';
2025         if (file_exists($file)) {
2026             require_once($file);
2027             if (function_exists($function)) {
2028                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
2029                 $function($activity, $course, $activtyrecord, $cm);
2030             }
2031         }
2033         // Allow the active advanced grading method plugin to append module navigation
2034         $featuresfunc = $cm->modname.'_supports';
2035         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) {
2036             require_once($CFG->dirroot.'/grade/grading/lib.php');
2037             $gradingman = get_grading_manager($cm->context, $cm->modname);
2038             $gradingman->extend_navigation($this, $activity);
2039         }
2041         return $activity->has_children();
2042     }
2043     /**
2044      * Loads user specific information into the navigation in the appropriate place.
2045      *
2046      * If no user is provided the current user is assumed.
2047      *
2048      * @param stdClass $user
2049      * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2050      * @return bool
2051      */
2052     protected function load_for_user($user=null, $forceforcontext=false) {
2053         global $DB, $CFG, $USER, $SITE;
2055         if ($user === null) {
2056             // We can't require login here but if the user isn't logged in we don't
2057             // want to show anything
2058             if (!isloggedin() || isguestuser()) {
2059                 return false;
2060             }
2061             $user = $USER;
2062         } else if (!is_object($user)) {
2063             // If the user is not an object then get them from the database
2064             $select = context_helper::get_preload_record_columns_sql('ctx');
2065             $sql = "SELECT u.*, $select
2066                       FROM {user} u
2067                       JOIN {context} ctx ON u.id = ctx.instanceid
2068                      WHERE u.id = :userid AND
2069                            ctx.contextlevel = :contextlevel";
2070             $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST);
2071             context_helper::preload_from_record($user);
2072         }
2074         $iscurrentuser = ($user->id == $USER->id);
2076         $usercontext = context_user::instance($user->id);
2078         // Get the course set against the page, by default this will be the site
2079         $course = $this->page->course;
2080         $baseargs = array('id'=>$user->id);
2081         if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) {
2082             $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
2083             $baseargs['course'] = $course->id;
2084             $coursecontext = context_course::instance($course->id);
2085             $issitecourse = false;
2086         } else {
2087             // Load all categories and get the context for the system
2088             $coursecontext = context_system::instance();
2089             $issitecourse = true;
2090         }
2092         // Create a node to add user information under.
2093         if ($iscurrentuser && !$forceforcontext) {
2094             // If it's the current user the information will go under the profile root node
2095             $usernode = $this->rootnodes['myprofile'];
2096             $course = get_site();
2097             $coursecontext = context_course::instance($course->id);
2098             $issitecourse = true;
2099         } else {
2100             if (!$issitecourse) {
2101                 // Not the current user so add it to the participants node for the current course
2102                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
2103                 $userviewurl = new moodle_url('/user/view.php', $baseargs);
2104             } else {
2105                 // This is the site so add a users node to the root branch
2106                 $usersnode = $this->rootnodes['users'];
2107                 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2108                     $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
2109                 }
2110                 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2111             }
2112             if (!$usersnode) {
2113                 // We should NEVER get here, if the course hasn't been populated
2114                 // with a participants node then the navigaiton either wasn't generated
2115                 // for it (you are missing a require_login or set_context call) or
2116                 // you don't have access.... in the interests of no leaking informatin
2117                 // we simply quit...
2118                 return false;
2119             }
2120             // Add a branch for the current user
2121             $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2122             $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, $user->id);
2124             if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
2125                 $usernode->make_active();
2126             }
2127         }
2129         // If the user is the current user or has permission to view the details of the requested
2130         // user than add a view profile link.
2131         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
2132             if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
2133                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
2134             } else {
2135                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
2136             }
2137         }
2139         if (!empty($CFG->navadduserpostslinks)) {
2140             // Add nodes for forum posts and discussions if the user can view either or both
2141             // There are no capability checks here as the content of the page is based
2142             // purely on the forums the current user has access too.
2143             $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2144             $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2145             $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
2146         }
2148         // Add blog nodes
2149         if (!empty($CFG->enableblogs)) {
2150             if (!$this->cache->cached('userblogoptions'.$user->id)) {
2151                 require_once($CFG->dirroot.'/blog/lib.php');
2152                 // Get all options for the user
2153                 $options = blog_get_options_for_user($user);
2154                 $this->cache->set('userblogoptions'.$user->id, $options);
2155             } else {
2156                 $options = $this->cache->{'userblogoptions'.$user->id};
2157             }
2159             if (count($options) > 0) {
2160                 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
2161                 foreach ($options as $type => $option) {
2162                     if ($type == "rss") {
2163                         $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2164                     } else {
2165                         $blogs->add($option['string'], $option['link']);
2166                     }
2167                 }
2168             }
2169         }
2171         if (!empty($CFG->messaging)) {
2172             $messageargs = null;
2173             if ($USER->id != $user->id) {
2174                 $messageargs = array('user1' => $user->id);
2175             }
2176             $url = new moodle_url('/message/index.php',$messageargs);
2177             $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
2178         }
2180         if ($iscurrentuser && has_capability('moodle/user:manageownfiles', context_user::instance($USER->id))) {
2181             $url = new moodle_url('/user/files.php');
2182             $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
2183         }
2185         if (!empty($CFG->enablebadges) && $iscurrentuser &&
2186                 has_capability('moodle/badges:manageownbadges', context_user::instance($USER->id))) {
2187             $url = new moodle_url('/badges/mybadges.php');
2188             $usernode->add(get_string('mybadges', 'badges'), $url, self::TYPE_SETTING);
2189         }
2191         // Add a node to view the users notes if permitted
2192         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2193             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
2194             if ($coursecontext->instanceid) {
2195                 $url->param('course', $coursecontext->instanceid);
2196             }
2197             $usernode->add(get_string('notes', 'notes'), $url);
2198         }
2200         // If the user is the current user add the repositories for the current user
2201         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
2202         if ($iscurrentuser) {
2203             if (!$this->cache->cached('contexthasrepos'.$usercontext->id)) {
2204                 require_once($CFG->dirroot . '/repository/lib.php');
2205                 $editabletypes = repository::get_editable_types($usercontext);
2206                 $haseditabletypes = !empty($editabletypes);
2207                 unset($editabletypes);
2208                 $this->cache->set('contexthasrepos'.$usercontext->id, $haseditabletypes);
2209             } else {
2210                 $haseditabletypes = $this->cache->{'contexthasrepos'.$usercontext->id};
2211             }
2212             if ($haseditabletypes) {
2213                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
2214             }
2215         } else if ($course->id == $SITE->id && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2217             // Add view grade report is permitted
2218             $reports = get_plugin_list('gradereport');
2219             arsort($reports); // user is last, we want to test it first
2221             $userscourses = enrol_get_users_courses($user->id);
2222             $userscoursesnode = $usernode->add(get_string('courses'));
2224             foreach ($userscourses as $usercourse) {
2225                 $usercoursecontext = context_course::instance($usercourse->id);
2226                 $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext));
2227                 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
2229                 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2230                 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
2231                     foreach ($reports as $plugin => $plugindir) {
2232                         if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2233                             //stop when the first visible plugin is found
2234                             $gradeavailable = true;
2235                             break;
2236                         }
2237                     }
2238                 }
2240                 if ($gradeavailable) {
2241                     $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
2242                     $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
2243                 }
2245                 // Add a node to view the users notes if permitted
2246                 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2247                     $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
2248                     $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2249                 }
2251                 if (can_access_course($usercourse, $user->id)) {
2252                     $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', ''));
2253                 }
2255                 $reporttab = $usercoursenode->add(get_string('activityreports'));
2257                 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2258                 foreach ($reports as $reportfunction) {
2259                     $reportfunction($reporttab, $user, $usercourse);
2260                 }
2262                 $reporttab->trim_if_empty();
2263             }
2264         }
2265         return true;
2266     }
2268     /**
2269      * This method simply checks to see if a given module can extend the navigation.
2270      *
2271      * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2272      *
2273      * @param string $modname
2274      * @return bool
2275      */
2276     public static function module_extends_navigation($modname) {
2277         global $CFG;
2278         static $extendingmodules = array();
2279         if (!array_key_exists($modname, $extendingmodules)) {
2280             $extendingmodules[$modname] = false;
2281             $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2282             if (file_exists($file)) {
2283                 $function = $modname.'_extend_navigation';
2284                 require_once($file);
2285                 $extendingmodules[$modname] = (function_exists($function));
2286             }
2287         }
2288         return $extendingmodules[$modname];
2289     }
2290     /**
2291      * Extends the navigation for the given user.
2292      *
2293      * @param stdClass $user A user from the database
2294      */
2295     public function extend_for_user($user) {
2296         $this->extendforuser[] = $user;
2297     }
2299     /**
2300      * Returns all of the users the navigation is being extended for
2301      *
2302      * @return array An array of extending users.
2303      */
2304     public function get_extending_users() {
2305         return $this->extendforuser;
2306     }
2307     /**
2308      * Adds the given course to the navigation structure.
2309      *
2310      * @param stdClass $course
2311      * @param bool $forcegeneric
2312      * @param bool $ismycourse
2313      * @return navigation_node
2314      */
2315     public function add_course(stdClass $course, $forcegeneric = false, $coursetype = self::COURSE_OTHER) {
2316         global $CFG, $SITE;
2318         // We found the course... we can return it now :)
2319         if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2320             return $this->addedcourses[$course->id];
2321         }
2323         $coursecontext = context_course::instance($course->id);
2325         if ($course->id != $SITE->id && !$course->visible) {
2326             if (is_role_switched($course->id)) {
2327                 // user has to be able to access course in order to switch, let's skip the visibility test here
2328             } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2329                 return false;
2330             }
2331         }
2333         $issite = ($course->id == $SITE->id);
2334         $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
2335         $fullname = format_string($course->fullname, true, array('context' => $coursecontext));
2336         // This is the name that will be shown for the course.
2337         $coursename = empty($CFG->navshowfullcoursenames) ? $shortname : $fullname;
2339         if ($issite) {
2340             $parent = $this;
2341             $url = null;
2342             if (empty($CFG->usesitenameforsitepages)) {
2343                 $coursename = get_string('sitepages');
2344             }
2345         } else if ($coursetype == self::COURSE_CURRENT) {
2346             $parent = $this->rootnodes['currentcourse'];
2347             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2348         } else if ($coursetype == self::COURSE_MY && !$forcegeneric) {
2349             if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_MY_CATEGORY))) {
2350                 // Nothing to do here the above statement set $parent to the category within mycourses.
2351             } else {
2352                 $parent = $this->rootnodes['mycourses'];
2353             }
2354             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2355         } else {
2356             $parent = $this->rootnodes['courses'];
2357             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2358             if (!empty($course->category) && $this->show_categories($coursetype == self::COURSE_MY)) {
2359                 if (!$this->is_category_fully_loaded($course->category)) {
2360                     // We need to load the category structure for this course
2361                     $this->load_all_categories($course->category, false);
2362                 }
2363                 if (array_key_exists($course->category, $this->addedcategories)) {
2364                     $parent = $this->addedcategories[$course->category];
2365                     // This could lead to the course being created so we should check whether it is the case again
2366                     if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2367                         return $this->addedcourses[$course->id];
2368                     }
2369                 }
2370             }
2371         }
2373         $coursenode = $parent->add($coursename, $url, self::TYPE_COURSE, $shortname, $course->id);
2374         $coursenode->nodetype = self::NODETYPE_BRANCH;
2375         $coursenode->hidden = (!$course->visible);
2376         $coursenode->title($fullname);
2377         if (!$forcegeneric) {
2378             $this->addedcourses[$course->id] = $coursenode;
2379         }
2381         return $coursenode;
2382     }
2384     /**
2385      * Returns true if the category has already been loaded as have any child categories
2386      *
2387      * @param int $categoryid
2388      * @return bool
2389      */
2390     protected function is_category_fully_loaded($categoryid) {
2391         return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0));
2392     }
2394     /**
2395      * Adds essential course nodes to the navigation for the given course.
2396      *
2397      * This method adds nodes such as reports, blogs and participants
2398      *
2399      * @param navigation_node $coursenode
2400      * @param stdClass $course
2401      * @return bool returns true on successful addition of a node.
2402      */
2403     public function add_course_essentials($coursenode, stdClass $course) {
2404         global $CFG, $SITE;
2406         if ($course->id == $SITE->id) {
2407             return $this->add_front_page_course_essentials($coursenode, $course);
2408         }
2410         if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2411             return true;
2412         }
2414         //Participants
2415         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
2416             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
2417             $currentgroup = groups_get_course_group($course, true);
2418             if ($course->id == $SITE->id) {
2419                 $filtervar = 'courseid';
2420                 $filterselect = '';
2421             } else if ($course->id && !$currentgroup) {
2422                 $filtervar = 'courseid';
2423                 $filterselect = $course->id;
2424             } else {
2425                 $filtervar = 'groupid';
2426                 $filterselect = $currentgroup;
2427             }
2428             $filterselect = clean_param($filterselect, PARAM_INT);
2429             if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2430                and has_capability('moodle/blog:view', context_system::instance())) {
2431                 $blogsurls = new moodle_url('/blog/index.php', array($filtervar => $filterselect));
2432                 $participants->add(get_string('blogscourse','blog'), $blogsurls->out());
2433             }
2434             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2435                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id)));
2436             }
2437         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2438             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2439         }
2441         // Badges.
2442         if ($CFG->enablebadges && has_capability('moodle/badges:viewbadges', $this->page->context)) {
2443             $url = new moodle_url($CFG->wwwroot . '/badges/view.php',
2444                     array('type' => 2, 'id' => $course->id));
2446             $coursenode->add(get_string('coursebadges', 'badges'), null,
2447                     navigation_node::TYPE_CONTAINER, null, 'coursebadges');
2448             $coursenode->get('coursebadges')->add(get_string('badgesview', 'badges'), $url,
2449                     navigation_node::TYPE_SETTING, null, 'badgesview',
2450                     new pix_icon('i/badge', get_string('badgesview', 'badges')));
2451         }
2453         return true;
2454     }
2455     /**
2456      * This generates the structure of the course that won't be generated when
2457      * the modules and sections are added.
2458      *
2459      * Things such as the reports branch, the participants branch, blogs... get
2460      * added to the course node by this method.
2461      *
2462      * @param navigation_node $coursenode
2463      * @param stdClass $course
2464      * @return bool True for successfull generation
2465      */
2466     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2467         global $CFG;
2469         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2470             return true;
2471         }
2473         // Hidden node that we use to determine if the front page navigation is loaded.
2474         // This required as there are not other guaranteed nodes that may be loaded.
2475         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2477         //Participants
2478         if (has_capability('moodle/course:viewparticipants',  get_system_context())) {
2479             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2480         }
2482         $filterselect = 0;
2484         // Blogs
2485         if (!empty($CFG->enableblogs)
2486           and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2487           and has_capability('moodle/blog:view', context_system::instance())) {
2488             $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2489             $coursenode->add(get_string('blogssite','blog'), $blogsurls->out());
2490         }
2492         //Badges
2493         if (!empty($CFG->enablebadges) && has_capability('moodle/badges:viewbadges', $this->page->context)) {
2494             $url = new moodle_url($CFG->wwwroot . '/badges/view.php', array('type' => 1));
2495             $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node::TYPE_CUSTOM);
2496         }
2498         // Notes
2499         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2500             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2501         }
2503         // Tags
2504         if (!empty($CFG->usetags) && isloggedin()) {
2505             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2506         }
2508         if (isloggedin()) {
2509             // Calendar
2510             $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2511             $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self::TYPE_CUSTOM, null, 'calendar');
2512         }
2514         return true;
2515     }
2517     /**
2518      * Clears the navigation cache
2519      */
2520     public function clear_cache() {
2521         $this->cache->clear();
2522     }
2524     /**
2525      * Sets an expansion limit for the navigation
2526      *
2527      * The expansion limit is used to prevent the display of content that has a type
2528      * greater than the provided $type.
2529      *
2530      * Can be used to ensure things such as activities or activity content don't get
2531      * shown on the navigation.
2532      * They are still generated in order to ensure the navbar still makes sense.
2533      *
2534      * @param int $type One of navigation_node::TYPE_*
2535      * @return bool true when complete.
2536      */
2537     public function set_expansion_limit($type) {
2538         global $SITE;
2539         $nodes = $this->find_all_of_type($type);
2540         foreach ($nodes as $node) {
2541             // We need to generate the full site node
2542             if ($type == self::TYPE_COURSE && $node->key == $SITE->id) {
2543                 continue;
2544             }
2545             foreach ($node->children as $child) {
2546                 // We still want to show course reports and participants containers
2547                 // or there will be navigation missing.
2548                 if ($type == self::TYPE_COURSE && $child->type === self::TYPE_CONTAINER) {
2549                     continue;
2550                 }
2551                 $child->hide();
2552             }
2553         }
2554         return true;
2555     }
2556     /**
2557      * Attempts to get the navigation with the given key from this nodes children.
2558      *
2559      * This function only looks at this nodes children, it does NOT look recursivily.
2560      * If the node can't be found then false is returned.
2561      *
2562      * If you need to search recursivily then use the {@link global_navigation::find()} method.
2563      *
2564      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2565      * may be of more use to you.
2566      *
2567      * @param string|int $key The key of the node you wish to receive.
2568      * @param int $type One of navigation_node::TYPE_*
2569      * @return navigation_node|false
2570      */
2571     public function get($key, $type = null) {
2572         if (!$this->initialised) {
2573             $this->initialise();
2574         }
2575         return parent::get($key, $type);
2576     }
2578     /**
2579      * Searches this nodes children and their children to find a navigation node
2580      * with the matching key and type.
2581      *
2582      * This method is recursive and searches children so until either a node is
2583      * found or there are no more nodes to search.
2584      *
2585      * If you know that the node being searched for is a child of this node
2586      * then use the {@link global_navigation::get()} method instead.
2587      *
2588      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2589      * may be of more use to you.
2590      *
2591      * @param string|int $key The key of the node you wish to receive.
2592      * @param int $type One of navigation_node::TYPE_*
2593      * @return navigation_node|false
2594      */
2595     public function find($key, $type) {
2596         if (!$this->initialised) {
2597             $this->initialise();
2598         }
2599         if ($type == self::TYPE_ROOTNODE && array_key_exists($key, $this->rootnodes)) {
2600             return $this->rootnodes[$key];
2601         }
2602         return parent::find($key, $type);
2603     }
2605     /**
2606      * They've expanded the 'my courses' branch.
2607      */
2608     protected function load_courses_enrolled() {
2609         global $CFG, $DB;
2610         $sortorder = 'visible DESC';
2611         // Prevent undefined $CFG->navsortmycoursessort errors.
2612         if (empty($CFG->navsortmycoursessort)) {
2613             $CFG->navsortmycoursessort = 'sortorder';
2614         }
2615         // Append the chosen sortorder.
2616         $sortorder = $sortorder . ',' . $CFG->navsortmycoursessort . ' ASC';
2617         $courses = enrol_get_my_courses(null, $sortorder);
2618         if (count($courses) && $this->show_my_categories()) {
2619             // OK Actually we are loading categories. We only want to load categories that have a parent of 0.
2620             // In order to make sure we load everything required we must first find the categories that are not
2621             // base categories and work out the bottom category in thier path.
2622             $categoryids = array();
2623             foreach ($courses as $course) {
2624                 $categoryids[] = $course->category;
2625             }
2626             $categoryids = array_unique($categoryids);
2627             list($sql, $params) = $DB->get_in_or_equal($categoryids);
2628             $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent <> 0', $params, 'sortorder, id', 'id, path');
2629             foreach ($categories as $category) {
2630                 $bits = explode('/', trim($category->path,'/'));
2631                 $categoryids[] = array_shift($bits);
2632             }
2633             $categoryids = array_unique($categoryids);
2634             $categories->close();
2636             // Now we load the base categories.
2637             list($sql, $params) = $DB->get_in_or_equal($categoryids);
2638             $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent = 0', $params, 'sortorder, id');
2639             foreach ($categories as $category) {
2640                 $this->add_category($category, $this->rootnodes['mycourses']);
2641             }
2642             $categories->close();
2643         } else {
2644             foreach ($courses as $course) {
2645                 $this->add_course($course, false, self::COURSE_MY);
2646             }
2647         }
2648     }
2651 /**
2652  * The global navigation class used especially for AJAX requests.
2653  *
2654  * The primary methods that are used in the global navigation class have been overriden
2655  * to ensure that only the relevant branch is generated at the root of the tree.
2656  * This can be done because AJAX is only used when the backwards structure for the
2657  * requested branch exists.
2658  * This has been done only because it shortens the amounts of information that is generated
2659  * which of course will speed up the response time.. because no one likes laggy AJAX.
2660  *
2661  * @package   core
2662  * @category  navigation
2663  * @copyright 2009 Sam Hemelryk
2664  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2665  */
2666 class global_navigation_for_ajax extends global_navigation {
2668     /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2669     protected $branchtype;
2671     /** @var int the instance id */
2672     protected $instanceid;
2674     /** @var array Holds an array of expandable nodes */
2675     protected $expandable = array();
2677     /**
2678      * Constructs the navigation for use in an AJAX request
2679      *
2680      * @param moodle_page $page moodle_page object
2681      * @param int $branchtype
2682      * @param int $id
2683      */
2684     public function __construct($page, $branchtype, $id) {
2685         $this->page = $page;
2686         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2687         $this->children = new navigation_node_collection();
2688         $this->branchtype = $branchtype;
2689         $this->instanceid = $id;
2690         $this->initialise();
2691     }
2692     /**
2693      * Initialise the navigation given the type and id for the branch to expand.
2694      *
2695      * @return array An array of the expandable nodes
2696      */
2697     public function initialise() {
2698         global $DB, $SITE;
2700         if ($this->initialised || during_initial_install()) {
2701             return $this->expandable;
2702         }
2703         $this->initialised = true;
2705         $this->rootnodes = array();
2706         $this->rootnodes['site']    = $this->add_course($SITE);
2707         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self::TYPE_ROOTNODE, null, 'mycourses');
2708         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2710         // Branchtype will be one of navigation_node::TYPE_*
2711         switch ($this->branchtype) {
2712             case 0:
2713                 if ($this->instanceid === 'mycourses') {
2714                     $this->load_courses_enrolled();
2715                 } else if ($this->instanceid === 'courses') {
2716                     $this->load_courses_other();
2717                 }
2718                 break;
2719             case self::TYPE_CATEGORY :
2720                 $this->load_category($this->instanceid);
2721                 break;
2722             case self::TYPE_MY_CATEGORY :
2723                 $this->load_category($this->instanceid, self::TYPE_MY_CATEGORY);
2724                 break;
2725             case self::TYPE_COURSE :
2726                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
2727                 require_course_login($course, true, null, false, true);
2728                 $this->page->set_context(context_course::instance($course->id));
2729                 $coursenode = $this->add_course($course);
2730                 $this->add_course_essentials($coursenode, $course);
2731                 $this->load_course_sections($course, $coursenode);
2732                 break;
2733             case self::TYPE_SECTION :
2734                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2735                         FROM {course} c
2736                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2737                         WHERE cs.id = ?';
2738                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
2739                 require_course_login($course, true, null, false, true);
2740                 $this->page->set_context(context_course::instance($course->id));
2741                 $coursenode = $this->add_course($course);
2742                 $this->add_course_essentials($coursenode, $course);
2743                 $this->load_course_sections($course, $coursenode, $course->sectionnumber);
2744                 break;
2745             case self::TYPE_ACTIVITY :
2746                 $sql = "SELECT c.*
2747                           FROM {course} c
2748                           JOIN {course_modules} cm ON cm.course = c.id
2749                          WHERE cm.id = :cmid";
2750                 $params = array('cmid' => $this->instanceid);
2751                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
2752                 $modinfo = get_fast_modinfo($course);
2753                 $cm = $modinfo->get_cm($this->instanceid);
2754                 require_course_login($course, true, $cm, false, true);
2755                 $this->page->set_context(context_module::instance($cm->id));
2756                 $coursenode = $this->load_course($course);
2757                 if ($course->id != $SITE->id) {
2758                     $this->load_course_sections($course, $coursenode, null, $cm);
2759                 }
2760                 $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY));
2761                 break;
2762             default:
2763                 throw new Exception('Unknown type');
2764                 return $this->expandable;
2765         }
2767         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) {
2768             $this->load_for_user(null, true);
2769         }
2771         $this->find_expandable($this->expandable);
2772         return $this->expandable;
2773     }
2775     /**
2776      * They've expanded the general 'courses' branch.
2777      */
2778     protected function load_courses_other() {
2779         $this->load_all_courses();
2780     }
2782     /**
2783      * Loads a single category into the AJAX navigation.
2784      *
2785      * This function is special in that it doesn't concern itself with the parent of
2786      * the requested category or its siblings.
2787      * This is because with the AJAX navigation we know exactly what is wanted and only need to
2788      * request that.
2789      *
2790      * @global moodle_database $DB
2791      * @param int $categoryid id of category to load in navigation.
2792      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
2793      * @return void.
2794      */
2795     protected function load_category($categoryid, $nodetype = self::TYPE_CATEGORY) {
2796         global $CFG, $DB;
2798         $limit = 20;
2799         if (!empty($CFG->navcourselimit)) {
2800             $limit = (int)$CFG->navcourselimit;
2801         }
2803         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
2804         $sql = "SELECT cc.*, $catcontextsql
2805                   FROM {course_categories} cc
2806                   JOIN {context} ctx ON cc.id = ctx.instanceid
2807                  WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND
2808                        (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2809               ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2810         $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2811         $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2812         $categorylist = array();
2813         $subcategories = array();
2814         $basecategory = null;
2815         foreach ($categories as $category) {
2816             $categorylist[] = $category->id;
2817             context_helper::preload_from_record($category);
2818             if ($category->id == $categoryid) {
2819                 $this->add_category($category, $this, $nodetype);
2820                 $basecategory = $this->addedcategories[$category->id];
2821             } else {
2822                 $subcategories[] = $category;
2823             }
2824         }
2825         $categories->close();
2827         if (!is_null($basecategory)) {
2828             foreach ($subcategories as $category) {
2829                 $this->add_category($category, $basecategory, $nodetype);
2830             }
2831         }
2833         // If category is shown in MyHome then only show enrolled courses, else show all courses.
2834         if ($nodetype === self::TYPE_MY_CATEGORY) {
2835             $courses = enrol_get_my_courses();
2836             foreach ($courses as $course) {
2837                 // Add course if it's in category.
2838                 if (in_array($course->category, $categorylist)) {
2839                     $this->add_course($course, true, self::COURSE_MY);
2840                 }
2841             }
2842         } else {
2843             $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
2844             foreach ($courses as $course) {
2845                 $this->add_course($course);
2846             }
2847             $courses->close();
2848         }
2849     }
2851     /**
2852      * Returns an array of expandable nodes
2853      * @return array
2854      */
2855     public function get_expandable() {
2856         return $this->expandable;
2857     }
2860 /**
2861  * Navbar class
2862  *
2863  * This class is used to manage the navbar, which is initialised from the navigation
2864  * object held by PAGE
2865  *
2866  * @package   core
2867  * @category  navigation
2868  * @copyright 2009 Sam Hemelryk
2869  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2870  */
2871 class navbar extends navigation_node {
2872     /** @var bool A switch for whether the navbar is initialised or not */
2873     protected $initialised = false;
2874     /** @var mixed keys used to reference the nodes on the navbar */
2875     protected $keys = array();
2876     /** @var null|string content of the navbar */
2877     protected $content = null;
2878     /** @var moodle_page object the moodle page that this navbar belongs to */
2879     protected $page;
2880     /** @var bool A switch for whether to ignore the active navigation information */
2881     protected $ignoreactive = false;
2882     /** @var bool A switch to let us know if we are in the middle of an install */
2883     protected $duringinstall = false;
2884     /** @var bool A switch for whether the navbar has items */
2885     protected $hasitems = false;
2886     /** @var array An array of navigation nodes for the navbar */
2887     protected $items;
2888     /** @var array An array of child node objects */
2889     public $children = array();
2890     /** @var bool A switch for whether we want to include the root node in the navbar */
2891     public $includesettingsbase = false;
2892     /**
2893      * The almighty constructor
2894      *
2895      * @param moodle_page $page
2896      */
2897     public function __construct(moodle_page $page) {
2898         global $CFG;
2899         if (during_initial_install()) {
2900             $this->duringinstall = true;
2901             return false;
2902         }
2903         $this->page = $page;
2904         $this->text = get_string('home');
2905         $this->shorttext = get_string('home');
2906         $this->action = new moodle_url($CFG->wwwroot);
2907         $this->nodetype = self::NODETYPE_BRANCH;
2908         $this->type = self::TYPE_SYSTEM;
2909     }
2911     /**
2912      * Quick check to see if the navbar will have items in.
2913      *
2914      * @return bool Returns true if the navbar will have items, false otherwise
2915      */
2916     public function has_items() {
2917         if ($this->duringinstall) {
2918             return false;
2919         } else if ($this->hasitems !== false) {
2920             return true;
2921         }
2922         $this->page->navigation->initialise($this->page);
2924         $activenodefound = ($this->page->navigation->contains_active_node() ||
2925                             $this->page->settingsnav->contains_active_node());
2927         $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
2928         $this->hasitems = $outcome;
2929         return $outcome;
2930     }
2932     /**
2933      * Turn on/off ignore active
2934      *
2935      * @param bool $setting
2936      */
2937     public function ignore_active($setting=true) {
2938         $this->ignoreactive = ($setting);
2939     }
2941     /**
2942      * Gets a navigation node
2943      *
2944      * @param string|int $key for referencing the navbar nodes
2945      * @param int $type navigation_node::TYPE_*
2946      * @return navigation_node|bool
2947      */
2948     public function get($key, $type = null) {
2949         foreach ($this->children as &$child) {
2950             if ($child->key === $key && ($type == null || $type == $child->type)) {
2951                 return $child;
2952             }
2953         }
2954         return false;
2955     }
2956     /**
2957      * Returns an array of navigation_node's that make up the navbar.
2958      *
2959      * @return array
2960      */
2961     public function get_items() {
2962         $items = array();
2963         // Make sure that navigation is initialised
2964         if (!$this->has_items()) {
2965             return $items;
2966         }
2967         if ($this->items !== null) {
2968             return $this->items;
2969         }
2971         if (count($this->children) > 0) {
2972             // Add the custom children
2973             $items = array_reverse($this->children);
2974         }
2976         $navigationactivenode = $this->page->navigation->find_active_node();
2977         $settingsactivenode = $this->page->settingsnav->find_active_node();
2979         // Check if navigation contains the active node
2980         if (!$this->ignoreactive) {
2982             if ($navigationactivenode && $settingsactivenode) {
2983                 // Parse a combined navigation tree
2984                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
2985                     if (!$settingsactivenode->mainnavonly) {
2986                         $items[] = $settingsactivenode;
2987                     }
2988                     $settingsactivenode = $settingsactivenode->parent;
2989                 }
2990                 if (!$this->includesettingsbase) {
2991                     // Removes the first node from the settings (root node) from the list
2992                     array_pop($items);
2993                 }
2994                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
2995                     if (!$navigationactivenode->mainnavonly) {
2996                         $items[] = $navigationactivenode;
2997                     }
2998                     $navigationactivenode = $navigationactivenode->parent;
2999                 }
3000             } else if ($navigationactivenode) {
3001                 // Parse the navigation tree to get the active node
3002                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3003                     if (!$navigationactivenode->mainnavonly) {
3004                         $items[] = $navigationactivenode;
3005                     }
3006                     $navigationactivenode = $navigationactivenode->parent;
3007                 }
3008             } else if ($settingsactivenode) {
3009                 // Parse the settings navigation to get the active node
3010                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3011                     if (!$settingsactivenode->mainnavonly) {
3012                         $items[] = $settingsactivenode;
3013                     }
3014                     $settingsactivenode = $settingsactivenode->parent;
3015                 }
3016             }
3017         }
3019         $items[] = new navigation_node(array(
3020             'text'=>$this->page->navigation->text,
3021             'shorttext'=>$this->page->navigation->shorttext,
3022             'key'=>$this->page->navigation->key,
3023             'action'=>$this->page->navigation->action
3024         ));
3026         $this->items = array_reverse($items);
3027         return $this->items;
3028     }
3030     /**
3031      * Add a new navigation_node to the navbar, overrides parent::add
3032      *
3033      * This function overrides {@link navigation_node::add()} so that we can change
3034      * the way nodes get added to allow us to simply call add and have the node added to the
3035      * end of the navbar
3036      *
3037      * @param string $text
3038      * @param string|moodle_url|action_link $action An action to associate with this node.
3039      * @param int $type One of navigation_node::TYPE_*
3040      * @param string $shorttext
3041      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3042      * @param pix_icon $icon An optional icon to use for this node.
3043      * @return navigation_node
3044      */
3045     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3046         if ($this->content !== null) {
3047             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3048         }
3050         // Properties array used when creating the new navigation node
3051         $itemarray = array(
3052             'text' => $text,
3053             'type' => $type
3054         );
3055         // Set the action if one was provided
3056         if ($action!==null) {
3057             $itemarray['action'] = $action;
3058         }
3059         // Set the shorttext if one was provided
3060         if ($shorttext!==null) {
3061             $itemarray['shorttext'] = $shorttext;
3062         }
3063         // Set the icon if one was provided
3064         if ($icon!==null) {
3065             $itemarray['icon'] = $icon;
3066         }
3067         // Default the key to the number of children if not provided
3068         if ($key === null) {
3069             $key = count($this->children);
3070         }
3071         // Set the key
3072         $itemarray['key'] = $key;
3073         // Set the parent to this node
3074         $itemarray['parent'] = $this;
3075         // Add the child using the navigation_node_collections add method
3076         $this->children[] = new navigation_node($itemarray);
3077         return $this;
3078     }
3081 /**
3082  * Class used to manage the settings option for the current page
3083  *
3084  * This class is used to manage the settings options in a tree format (recursively)
3085  * and was created initially for use with the settings blocks.
3086  *
3087  * @package   core
3088  * @category  navigation
3089  * @copyright 2009 Sam Hemelryk
3090  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3091  */
3092 class settings_navigation extends navigation_node {
3093     /** @var stdClass the current context */
3094     protected $context;
3095     /** @var moodle_page the moodle page that the navigation belongs to */
3096     protected $page;
3097     /** @var string contains administration section navigation_nodes */
3098     protected $adminsection;
3099     /** @var bool A switch to see if the navigation node is initialised */
3100     protected $initialised = false;
3101     /** @var array An array of users that the nodes can extend for. */
3102     protected $userstoextendfor = array();
3103     /** @var navigation_cache **/
3104     protected $cache;
3106     /**
3107      * Sets up the object with basic settings and preparse it for use
3108      *
3109      * @param moodle_page $page
3110      */
3111     public function __construct(moodle_page &$page) {
3112         if (during_initial_install()) {
3113             return false;
3114         }
3115         $this->page = $page;
3116         // Initialise the main navigation. It is most important that this is done
3117         // before we try anything
3118         $this->page->navigation->initialise();
3119         // Initialise the navigation cache
3120         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
3121         $this->children = new navigation_node_collection();
3122     }
3123     /**
3124      * Initialise the settings navigation based on the current context
3125      *
3126      * This function initialises the settings navigation tree for a given context
3127      * by calling supporting functions to generate major parts of the tree.
3128      *
3129      */
3130     public function initialise() {
3131         global $DB, $SESSION, $SITE;
3133         if (during_initial_install()) {
3134             return false;
3135         } else if ($this->initialised) {
3136             return true;
3137         }
3138         $this->id = 'settingsnav';
3139         $this->context = $this->page->context;
3141         $context = $this->context;
3142         if ($context->contextlevel == CONTEXT_BLOCK) {
3143             $this->load_block_settings();
3144             $context = $context->get_parent_context();
3145         }
3147         switch ($context->contextlevel) {
3148             case CONTEXT_SYSTEM:
3149                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
3150                     $this->load_front_page_settings(($context->id == $this->context->id));
3151                 }
3152                 break;
3153             case CONTEXT_COURSECAT:
3154                 $this->load_category_settings();
3155                 break;
3156             case CONTEXT_COURSE:
3157                 if ($this->page->course->id != $SITE->id) {
3158                     $this->load_course_settings(($context->id == $this->context->id));
3159                 } else {
3160                     $this->load_front_page_settings(($context->id == $this->context->id));
3161                 }
3162                 break;
3163             case CONTEXT_MODULE:
3164                 $this->load_module_settings();
3165                 $this->load_course_settings();
3166                 break;
3167             case CONTEXT_USER:
3168                 if ($this->page->course->id != $SITE->id) {
3169                     $this->load_course_settings();
3170                 }
3171                 break;
3172         }
3174         $settings = $this->load_user_settings($this->page->course->id);
3176         if (isloggedin() && !isguestuser() && (!property_exists($SESSION, 'load_navigation_admin') || $SESSION->load_navigation_admin)) {
3177             $admin = $this->load_administration_settings();
3178             $SESSION->load_navigation_admin = ($admin->has_children());
3179         } else {
3180             $admin = false;
3181         }
3183         if ($context->contextlevel == CONTEXT_SYSTEM && $admin) {
3184             $admin->force_open();
3185         } else if ($context->contextlevel == CONTEXT_USER && $settings) {
3186             $settings->force_open();
3187         }
3189         // Check if the user is currently logged in as another user
3190         if (session_is_loggedinas()) {
3191             // Get the actual user, we need this so we can display an informative return link
3192             $realuser = session_get_realuser();
3193             // Add the informative return to original user link
3194             $url = new moodle_url('/course/loginas.php',array('id'=>$this->page->course->id, 'return'=>1,'sesskey'=>sesskey()));
3195             $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self::TYPE_SETTING, null, null, new pix_icon('t/left', ''));
3196         }
3198         // At this point we give any local plugins the ability to extend/tinker with the navigation settings.
3199         $this->load_local_plugin_settings();
3201         foreach ($this->children as $key=>$node) {
3202             if ($node->nodetype != self::NODETYPE_BRANCH || $node->children->count()===0) {
3203                 $node->remove();
3204             }
3205         }
3206         $this->initialised = true;
3207     }
3208     /**
3209      * Override the parent function so that we can add preceeding hr's and set a
3210      * root node class against all first level element
3211      *
3212      * It does this by first calling the parent's add method {@link navigation_node::add()}
3213      * and then proceeds to use the key to set class and hr
3214      *
3215      * @param string $text text to be used for the link.
3216      * @param string|moodle_url $url url for the new node
3217      * @param int $type the type of node navigation_node::TYPE_*
3218      * @param string $shorttext
3219      * @param string|int $key a key to access the node by.
3220      * @param pix_icon $icon An icon that appears next to the node.
3221      * @return navigation_node with the new node added to it.
3222      */
3223     public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
3224         $node = parent::add($text, $url, $type, $shorttext, $key, $icon);
3225         $node->add_class('root_node');
3226         return $node;
3227     }
3229     /**
3230      * This function allows the user to add something to the start of the settings
3231      * navigation, which means it will be at the top of the settings navigation block
3232      *
3233      * @param string $text text to be used for the link.
3234      * @param string|moodle_url $url url for the new node
3235      * @param int $type the type of node navigation_node::TYPE_*
3236      * @param string $shorttext
3237      * @param string|int $key a key to access the node by.
3238      * @param pix_icon $icon An icon that appears next to the node.
3239      * @return navigation_node $node with the new node added to it.
3240      */
3241     public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
3242         $children = $this->children;
3243         $childrenclass = get_class($children);
3244         $this->children = new $childrenclass;
3245         $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
3246         foreach ($children as $child) {
3247             $this->children->add($child);
3248         }
3249         return $node;
3250     }
3251     /**
3252      * Load the site administration tree
3253      *
3254      * This function loads the site administration tree by using the lib/adminlib library functions
3255      *
3256      * @param navigation_node $referencebranch A reference to a branch in the settings
3257      *      navigation tree
3258      * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
3259      *      tree and start at the beginning
3260      * @return mixed A key to access the admin tree by
3261      */
3262     protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) {
3263         global $CFG;
3265         // Check if we are just starting to generate this navigation.
3266         if ($referencebranch === null) {
3268             // Require the admin lib then get an admin structure
3269             if (!function_exists('admin_get_root')) {
3270                 require_once($CFG->dirroot.'/lib/adminlib.php');
3271             }
3272             $adminroot = admin_get_root(false, false);
3273             // This is the active section identifier
3274             $this->adminsection = $this->page->url->param('section');
3276             // Disable the navigation from automatically finding the active node
3277             navigation_node::$autofindactive = false;
3278             $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SETTING, null, 'root');
3279             foreach ($adminroot->children as $adminbranch) {
3280                 $this->load_administration_settings($referencebranch, $adminbranch);
3281             }
3282             navigation_node::$autofindactive = true;
3284             // Use the admin structure to locate the active page
3285             if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) {
3286                 $currentnode = $this;
3287                 while (($pathkey = array_pop($current->path))!==null && $currentnode) {
3288                     $currentnode = $currentnode->get($pathkey);
3289                 }
3290                 if ($currentnode) {
3291                     $currentnode->make_active();
3292                 }
3293             } else {
3294                 $this->scan_for_active_node($referencebranch);
3295             }
3296             return $referencebranch;
3297         } else if ($adminbranch->check_access()) {
3298             // We have a reference branch that we can access and is not hidden `hurrah`
3299             // Now we need to display it and any children it may have
3300             $url = null;
3301             $icon = null;
3302             if ($adminbranch instanceof admin_settingpage) {
3303                 $url = new moodle_url('/'.$CFG->admin.'/settings.php', array('section'=>$adminbranch->name));
3304             } else if ($adminbranch instanceof admin_externalpage) {
3305                 $url = $adminbranch->url;