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