b6ebf72769d1613aae48b3da94503d2c318eed2e
[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;
144     /** @var bool does the node need to be loaded via ajax */
145     public $requiresajaxloading = false;
147     /**
148      * Constructs a new navigation_node
149      *
150      * @param array|string $properties Either an array of properties or a string to use
151      *                     as the text for the node
152      */
153     public function __construct($properties) {
154         if (is_array($properties)) {
155             // Check the array for each property that we allow to set at construction.
156             // text         - The main content for the node
157             // shorttext    - A short text if required for the node
158             // icon         - The icon to display for the node
159             // type         - The type of the node
160             // key          - The key to use to identify the node
161             // parent       - A reference to the nodes parent
162             // action       - The action to attribute to this node, usually a URL to link to
163             if (array_key_exists('text', $properties)) {
164                 $this->text = $properties['text'];
165             }
166             if (array_key_exists('shorttext', $properties)) {
167                 $this->shorttext = $properties['shorttext'];
168             }
169             if (!array_key_exists('icon', $properties)) {
170                 $properties['icon'] = new pix_icon('i/navigationitem', '');
171             }
172             $this->icon = $properties['icon'];
173             if ($this->icon instanceof pix_icon) {
174                 if (empty($this->icon->attributes['class'])) {
175                     $this->icon->attributes['class'] = 'navicon';
176                 } else {
177                     $this->icon->attributes['class'] .= ' navicon';
178                 }
179             }
180             if (array_key_exists('type', $properties)) {
181                 $this->type = $properties['type'];
182             } else {
183                 $this->type = self::TYPE_CUSTOM;
184             }
185             if (array_key_exists('key', $properties)) {
186                 $this->key = $properties['key'];
187             }
188             // This needs to happen last because of the check_if_active call that occurs
189             if (array_key_exists('action', $properties)) {
190                 $this->action = $properties['action'];
191                 if (is_string($this->action)) {
192                     $this->action = new moodle_url($this->action);
193                 }
194                 if (self::$autofindactive) {
195                     $this->check_if_active();
196                 }
197             }
198             if (array_key_exists('parent', $properties)) {
199                 $this->set_parent($properties['parent']);
200             }
201         } else if (is_string($properties)) {
202             $this->text = $properties;
203         }
204         if ($this->text === null) {
205             throw new coding_exception('You must set the text for the node when you create it.');
206         }
207         // Instantiate a new navigation node collection for this nodes children
208         $this->children = new navigation_node_collection();
209     }
211     /**
212      * Checks if this node is the active node.
213      *
214      * This is determined by comparing the action for the node against the
215      * defined URL for the page. A match will see this node marked as active.
216      *
217      * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
218      * @return bool
219      */
220     public function check_if_active($strength=URL_MATCH_EXACT) {
221         global $FULLME, $PAGE;
222         // Set fullmeurl if it hasn't already been set
223         if (self::$fullmeurl == null) {
224             if ($PAGE->has_set_url()) {
225                 self::override_active_url(new moodle_url($PAGE->url));
226             } else {
227                 self::override_active_url(new moodle_url($FULLME));
228             }
229         }
231         // Compare the action of this node against the fullmeurl
232         if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
233             $this->make_active();
234             return true;
235         }
236         return false;
237     }
239     /**
240      * This sets the URL that the URL of new nodes get compared to when locating
241      * the active node.
242      *
243      * The active node is the node that matches the URL set here. By default this
244      * is either $PAGE->url or if that hasn't been set $FULLME.
245      *
246      * @param moodle_url $url The url to use for the fullmeurl.
247      * @param bool $loadadmintree use true if the URL point to administration tree
248      */
249     public static function override_active_url(moodle_url $url, $loadadmintree = false) {
250         // Clone the URL, in case the calling script changes their URL later.
251         self::$fullmeurl = new moodle_url($url);
252         // True means we do not want AJAX loaded admin tree, required for all admin pages.
253         if ($loadadmintree) {
254             // Do not change back to false if already set.
255             self::$loadadmintree = true;
256         }
257     }
259     /**
260      * Use when page is linked from the admin tree,
261      * if not used navigation could not find the page using current URL
262      * because the tree is not fully loaded.
263      */
264     public static function require_admin_tree() {
265         self::$loadadmintree = true;
266     }
268     /**
269      * Creates a navigation node, ready to add it as a child using add_node
270      * function. (The created node needs to be added before you can use it.)
271      * @param string $text
272      * @param moodle_url|action_link $action
273      * @param int $type
274      * @param string $shorttext
275      * @param string|int $key
276      * @param pix_icon $icon
277      * @return navigation_node
278      */
279     public static function create($text, $action=null, $type=self::TYPE_CUSTOM,
280             $shorttext=null, $key=null, pix_icon $icon=null) {
281         // Properties array used when creating the new navigation node
282         $itemarray = array(
283             'text' => $text,
284             'type' => $type
285         );
286         // Set the action if one was provided
287         if ($action!==null) {
288             $itemarray['action'] = $action;
289         }
290         // Set the shorttext if one was provided
291         if ($shorttext!==null) {
292             $itemarray['shorttext'] = $shorttext;
293         }
294         // Set the icon if one was provided
295         if ($icon!==null) {
296             $itemarray['icon'] = $icon;
297         }
298         // Set the key
299         $itemarray['key'] = $key;
300         // Construct and return
301         return new navigation_node($itemarray);
302     }
304     /**
305      * Adds a navigation node as a child of this node.
306      *
307      * @param string $text
308      * @param moodle_url|action_link $action
309      * @param int $type
310      * @param string $shorttext
311      * @param string|int $key
312      * @param pix_icon $icon
313      * @return navigation_node
314      */
315     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
316         // Create child node
317         $childnode = self::create($text, $action, $type, $shorttext, $key, $icon);
319         // Add the child to end and return
320         return $this->add_node($childnode);
321     }
323     /**
324      * Adds a navigation node as a child of this one, given a $node object
325      * created using the create function.
326      * @param navigation_node $childnode Node to add
327      * @param string $beforekey
328      * @return navigation_node The added node
329      */
330     public function add_node(navigation_node $childnode, $beforekey=null) {
331         // First convert the nodetype for this node to a branch as it will now have children
332         if ($this->nodetype !== self::NODETYPE_BRANCH) {
333             $this->nodetype = self::NODETYPE_BRANCH;
334         }
335         // Set the parent to this node
336         $childnode->set_parent($this);
338         // Default the key to the number of children if not provided
339         if ($childnode->key === null) {
340             $childnode->key = $this->children->count();
341         }
343         // Add the child using the navigation_node_collections add method
344         $node = $this->children->add($childnode, $beforekey);
346         // If added node is a category node or the user is logged in and it's a course
347         // then mark added node as a branch (makes it expandable by AJAX)
348         $type = $childnode->type;
349         if (($type == self::TYPE_CATEGORY) || (isloggedin() && ($type == self::TYPE_COURSE)) || ($type == self::TYPE_MY_CATEGORY) ||
350                 ($type === self::TYPE_SITE_ADMIN)) {
351             $node->nodetype = self::NODETYPE_BRANCH;
352         }
353         // If this node is hidden mark it's children as hidden also
354         if ($this->hidden) {
355             $node->hidden = true;
356         }
357         // Return added node (reference returned by $this->children->add()
358         return $node;
359     }
361     /**
362      * Return a list of all the keys of all the child nodes.
363      * @return array the keys.
364      */
365     public function get_children_key_list() {
366         return $this->children->get_key_list();
367     }
369     /**
370      * Searches for a node of the given type with the given key.
371      *
372      * This searches this node plus all of its children, and their children....
373      * If you know the node you are looking for is a child of this node then please
374      * use the get method instead.
375      *
376      * @param int|string $key The key of the node we are looking for
377      * @param int $type One of navigation_node::TYPE_*
378      * @return navigation_node|false
379      */
380     public function find($key, $type) {
381         return $this->children->find($key, $type);
382     }
384     /**
385      * Get the child of this node that has the given key + (optional) type.
386      *
387      * If you are looking for a node and want to search all children + their children
388      * then please use the find method instead.
389      *
390      * @param int|string $key The key of the node we are looking for
391      * @param int $type One of navigation_node::TYPE_*
392      * @return navigation_node|false
393      */
394     public function get($key, $type=null) {
395         return $this->children->get($key, $type);
396     }
398     /**
399      * Removes this node.
400      *
401      * @return bool
402      */
403     public function remove() {
404         return $this->parent->children->remove($this->key, $this->type);
405     }
407     /**
408      * Checks if this node has or could have any children
409      *
410      * @return bool Returns true if it has children or could have (by AJAX expansion)
411      */
412     public function has_children() {
413         return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0 || $this->isexpandable);
414     }
416     /**
417      * Marks this node as active and forces it open.
418      *
419      * Important: If you are here because you need to mark a node active to get
420      * the navigation to do what you want have you looked at {@link navigation_node::override_active_url()}?
421      * You can use it to specify a different URL to match the active navigation node on
422      * rather than having to locate and manually mark a node active.
423      */
424     public function make_active() {
425         $this->isactive = true;
426         $this->add_class('active_tree_node');
427         $this->force_open();
428         if ($this->parent !== null) {
429             $this->parent->make_inactive();
430         }
431     }
433     /**
434      * Marks a node as inactive and recusised back to the base of the tree
435      * doing the same to all parents.
436      */
437     public function make_inactive() {
438         $this->isactive = false;
439         $this->remove_class('active_tree_node');
440         if ($this->parent !== null) {
441             $this->parent->make_inactive();
442         }
443     }
445     /**
446      * Forces this node to be open and at the same time forces open all
447      * parents until the root node.
448      *
449      * Recursive.
450      */
451     public function force_open() {
452         $this->forceopen = true;
453         if ($this->parent !== null) {
454             $this->parent->force_open();
455         }
456     }
458     /**
459      * Adds a CSS class to this node.
460      *
461      * @param string $class
462      * @return bool
463      */
464     public function add_class($class) {
465         if (!in_array($class, $this->classes)) {
466             $this->classes[] = $class;
467         }
468         return true;
469     }
471     /**
472      * Removes a CSS class from this node.
473      *
474      * @param string $class
475      * @return bool True if the class was successfully removed.
476      */
477     public function remove_class($class) {
478         if (in_array($class, $this->classes)) {
479             $key = array_search($class,$this->classes);
480             if ($key!==false) {
481                 unset($this->classes[$key]);
482                 return true;
483             }
484         }
485         return false;
486     }
488     /**
489      * Sets the title for this node and forces Moodle to utilise it.
490      * @param string $title
491      */
492     public function title($title) {
493         $this->title = $title;
494         $this->forcetitle = true;
495     }
497     /**
498      * Resets the page specific information on this node if it is being unserialised.
499      */
500     public function __wakeup(){
501         $this->forceopen = false;
502         $this->isactive = false;
503         $this->remove_class('active_tree_node');
504     }
506     /**
507      * Checks if this node or any of its children contain the active node.
508      *
509      * Recursive.
510      *
511      * @return bool
512      */
513     public function contains_active_node() {
514         if ($this->isactive) {
515             return true;
516         } else {
517             foreach ($this->children as $child) {
518                 if ($child->isactive || $child->contains_active_node()) {
519                     return true;
520                 }
521             }
522         }
523         return false;
524     }
526     /**
527      * Finds the active node.
528      *
529      * Searches this nodes children plus all of the children for the active node
530      * and returns it if found.
531      *
532      * Recursive.
533      *
534      * @return navigation_node|false
535      */
536     public function find_active_node() {
537         if ($this->isactive) {
538             return $this;
539         } else {
540             foreach ($this->children as &$child) {
541                 $outcome = $child->find_active_node();
542                 if ($outcome !== false) {
543                     return $outcome;
544                 }
545             }
546         }
547         return false;
548     }
550     /**
551      * Searches all children for the best matching active node
552      * @return navigation_node|false
553      */
554     public function search_for_active_node() {
555         if ($this->check_if_active(URL_MATCH_BASE)) {
556             return $this;
557         } else {
558             foreach ($this->children as &$child) {
559                 $outcome = $child->search_for_active_node();
560                 if ($outcome !== false) {
561                     return $outcome;
562                 }
563             }
564         }
565         return false;
566     }
568     /**
569      * Gets the content for this node.
570      *
571      * @param bool $shorttext If true shorttext is used rather than the normal text
572      * @return string
573      */
574     public function get_content($shorttext=false) {
575         if ($shorttext && $this->shorttext!==null) {
576             return format_string($this->shorttext);
577         } else {
578             return format_string($this->text);
579         }
580     }
582     /**
583      * Gets the title to use for this node.
584      *
585      * @return string
586      */
587     public function get_title() {
588         if ($this->forcetitle || $this->action != null){
589             return $this->title;
590         } else {
591             return '';
592         }
593     }
595     /**
596      * Used to easily determine if this link in the breadcrumbs has a valid action/url.
597      *
598      * @return boolean
599      */
600     public function has_action() {
601         return !empty($this->action);
602     }
604     /**
605      * Gets the CSS class to add to this node to describe its type
606      *
607      * @return string
608      */
609     public function get_css_type() {
610         if (array_key_exists($this->type, $this->namedtypes)) {
611             return 'type_'.$this->namedtypes[$this->type];
612         }
613         return 'type_unknown';
614     }
616     /**
617      * Finds all nodes that are expandable by AJAX
618      *
619      * @param array $expandable An array by reference to populate with expandable nodes.
620      */
621     public function find_expandable(array &$expandable) {
622         foreach ($this->children as &$child) {
623             if ($child->display && $child->has_children() && $child->children->count() == 0) {
624                 $child->id = 'expandable_branch_'.$child->type.'_'.clean_param($child->key, PARAM_ALPHANUMEXT);
625                 $this->add_class('canexpand');
626                 $child->requiresajaxloading = true;
627                 $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type);
628             }
629             $child->find_expandable($expandable);
630         }
631     }
633     /**
634      * Finds all nodes of a given type (recursive)
635      *
636      * @param int $type One of navigation_node::TYPE_*
637      * @return array
638      */
639     public function find_all_of_type($type) {
640         $nodes = $this->children->type($type);
641         foreach ($this->children as &$node) {
642             $childnodes = $node->find_all_of_type($type);
643             $nodes = array_merge($nodes, $childnodes);
644         }
645         return $nodes;
646     }
648     /**
649      * Removes this node if it is empty
650      */
651     public function trim_if_empty() {
652         if ($this->children->count() == 0) {
653             $this->remove();
654         }
655     }
657     /**
658      * Creates a tab representation of this nodes children that can be used
659      * with print_tabs to produce the tabs on a page.
660      *
661      * call_user_func_array('print_tabs', $node->get_tabs_array());
662      *
663      * @param array $inactive
664      * @param bool $return
665      * @return array Array (tabs, selected, inactive, activated, return)
666      */
667     public function get_tabs_array(array $inactive=array(), $return=false) {
668         $tabs = array();
669         $rows = array();
670         $selected = null;
671         $activated = array();
672         foreach ($this->children as $node) {
673             $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title());
674             if ($node->contains_active_node()) {
675                 if ($node->children->count() > 0) {
676                     $activated[] = $node->key;
677                     foreach ($node->children as $child) {
678                         if ($child->contains_active_node()) {
679                             $selected = $child->key;
680                         }
681                         $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title());
682                     }
683                 } else {
684                     $selected = $node->key;
685                 }
686             }
687         }
688         return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
689     }
691     /**
692      * Sets the parent for this node and if this node is active ensures that the tree is properly
693      * adjusted as well.
694      *
695      * @param navigation_node $parent
696      */
697     public function set_parent(navigation_node $parent) {
698         // Set the parent (thats the easy part)
699         $this->parent = $parent;
700         // Check if this node is active (this is checked during construction)
701         if ($this->isactive) {
702             // Force all of the parent nodes open so you can see this node
703             $this->parent->force_open();
704             // Make all parents inactive so that its clear where we are.
705             $this->parent->make_inactive();
706         }
707     }
709     /**
710      * Hides the node and any children it has.
711      *
712      * @since Moodle 2.5
713      * @param array $typestohide Optional. An array of node types that should be hidden.
714      *      If null all nodes will be hidden.
715      *      If an array is given then nodes will only be hidden if their type mtatches an element in the array.
716      *          e.g. array(navigation_node::TYPE_COURSE) would hide only course nodes.
717      */
718     public function hide(array $typestohide = null) {
719         if ($typestohide === null || in_array($this->type, $typestohide)) {
720             $this->display = false;
721             if ($this->has_children()) {
722                 foreach ($this->children as $child) {
723                     $child->hide($typestohide);
724                 }
725             }
726         }
727     }
730 /**
731  * Navigation node collection
732  *
733  * This class is responsible for managing a collection of navigation nodes.
734  * It is required because a node's unique identifier is a combination of both its
735  * key and its type.
736  *
737  * Originally an array was used with a string key that was a combination of the two
738  * however it was decided that a better solution would be to use a class that
739  * implements the standard IteratorAggregate interface.
740  *
741  * @package   core
742  * @category  navigation
743  * @copyright 2010 Sam Hemelryk
744  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
745  */
746 class navigation_node_collection implements IteratorAggregate {
747     /**
748      * A multidimensional array to where the first key is the type and the second
749      * key is the nodes key.
750      * @var array
751      */
752     protected $collection = array();
753     /**
754      * An array that contains references to nodes in the same order they were added.
755      * This is maintained as a progressive array.
756      * @var array
757      */
758     protected $orderedcollection = array();
759     /**
760      * A reference to the last node that was added to the collection
761      * @var navigation_node
762      */
763     protected $last = null;
764     /**
765      * The total number of items added to this array.
766      * @var int
767      */
768     protected $count = 0;
770     /**
771      * Adds a navigation node to the collection
772      *
773      * @param navigation_node $node Node to add
774      * @param string $beforekey If specified, adds before a node with this key,
775      *   otherwise adds at end
776      * @return navigation_node Added node
777      */
778     public function add(navigation_node $node, $beforekey=null) {
779         global $CFG;
780         $key = $node->key;
781         $type = $node->type;
783         // First check we have a 2nd dimension for this type
784         if (!array_key_exists($type, $this->orderedcollection)) {
785             $this->orderedcollection[$type] = array();
786         }
787         // Check for a collision and report if debugging is turned on
788         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
789             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
790         }
792         // Find the key to add before
793         $newindex = $this->count;
794         $last = true;
795         if ($beforekey !== null) {
796             foreach ($this->collection as $index => $othernode) {
797                 if ($othernode->key === $beforekey) {
798                     $newindex = $index;
799                     $last = false;
800                     break;
801                 }
802             }
803             if ($newindex === $this->count) {
804                 debugging('Navigation node add_before: Reference node not found ' . $beforekey .
805                         ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER);
806             }
807         }
809         // Add the node to the appropriate place in the by-type structure (which
810         // is not ordered, despite the variable name)
811         $this->orderedcollection[$type][$key] = $node;
812         if (!$last) {
813             // Update existing references in the ordered collection (which is the
814             // one that isn't called 'ordered') to shuffle them along if required
815             for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) {
816                 $this->collection[$oldindex] = $this->collection[$oldindex - 1];
817             }
818         }
819         // Add a reference to the node to the progressive collection.
820         $this->collection[$newindex] = $this->orderedcollection[$type][$key];
821         // Update the last property to a reference to this new node.
822         $this->last = $this->orderedcollection[$type][$key];
824         // Reorder the array by index if needed
825         if (!$last) {
826             ksort($this->collection);
827         }
828         $this->count++;
829         // Return the reference to the now added node
830         return $node;
831     }
833     /**
834      * Return a list of all the keys of all the nodes.
835      * @return array the keys.
836      */
837     public function get_key_list() {
838         $keys = array();
839         foreach ($this->collection as $node) {
840             $keys[] = $node->key;
841         }
842         return $keys;
843     }
845     /**
846      * Fetches a node from this collection.
847      *
848      * @param string|int $key The key of the node we want to find.
849      * @param int $type One of navigation_node::TYPE_*.
850      * @return navigation_node|null
851      */
852     public function get($key, $type=null) {
853         if ($type !== null) {
854             // If the type is known then we can simply check and fetch
855             if (!empty($this->orderedcollection[$type][$key])) {
856                 return $this->orderedcollection[$type][$key];
857             }
858         } else {
859             // Because we don't know the type we look in the progressive array
860             foreach ($this->collection as $node) {
861                 if ($node->key === $key) {
862                     return $node;
863                 }
864             }
865         }
866         return false;
867     }
869     /**
870      * Searches for a node with matching key and type.
871      *
872      * This function searches both the nodes in this collection and all of
873      * the nodes in each collection belonging to the nodes in this collection.
874      *
875      * Recursive.
876      *
877      * @param string|int $key  The key of the node we want to find.
878      * @param int $type  One of navigation_node::TYPE_*.
879      * @return navigation_node|null
880      */
881     public function find($key, $type=null) {
882         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
883             return $this->orderedcollection[$type][$key];
884         } else {
885             $nodes = $this->getIterator();
886             // Search immediate children first
887             foreach ($nodes as &$node) {
888                 if ($node->key === $key && ($type === null || $type === $node->type)) {
889                     return $node;
890                 }
891             }
892             // Now search each childs children
893             foreach ($nodes as &$node) {
894                 $result = $node->children->find($key, $type);
895                 if ($result !== false) {
896                     return $result;
897                 }
898             }
899         }
900         return false;
901     }
903     /**
904      * Fetches the last node that was added to this collection
905      *
906      * @return navigation_node
907      */
908     public function last() {
909         return $this->last;
910     }
912     /**
913      * Fetches all nodes of a given type from this collection
914      *
915      * @param string|int $type  node type being searched for.
916      * @return array ordered collection
917      */
918     public function type($type) {
919         if (!array_key_exists($type, $this->orderedcollection)) {
920             $this->orderedcollection[$type] = array();
921         }
922         return $this->orderedcollection[$type];
923     }
924     /**
925      * Removes the node with the given key and type from the collection
926      *
927      * @param string|int $key The key of the node we want to find.
928      * @param int $type
929      * @return bool
930      */
931     public function remove($key, $type=null) {
932         $child = $this->get($key, $type);
933         if ($child !== false) {
934             foreach ($this->collection as $colkey => $node) {
935                 if ($node->key === $key && (is_null($type) || $node->type == $type)) {
936                     unset($this->collection[$colkey]);
937                     $this->collection = array_values($this->collection);
938                     break;
939                 }
940             }
941             unset($this->orderedcollection[$child->type][$child->key]);
942             $this->count--;
943             return true;
944         }
945         return false;
946     }
948     /**
949      * Gets the number of nodes in this collection
950      *
951      * This option uses an internal count rather than counting the actual options to avoid
952      * a performance hit through the count function.
953      *
954      * @return int
955      */
956     public function count() {
957         return $this->count;
958     }
959     /**
960      * Gets an array iterator for the collection.
961      *
962      * This is required by the IteratorAggregator interface and is used by routines
963      * such as the foreach loop.
964      *
965      * @return ArrayIterator
966      */
967     public function getIterator() {
968         return new ArrayIterator($this->collection);
969     }
972 /**
973  * The global navigation class used for... the global navigation
974  *
975  * This class is used by PAGE to store the global navigation for the site
976  * and is then used by the settings nav and navbar to save on processing and DB calls
977  *
978  * See
979  * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()}
980  * {@link lib/ajax/getnavbranch.php} Called by ajax
981  *
982  * @package   core
983  * @category  navigation
984  * @copyright 2009 Sam Hemelryk
985  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
986  */
987 class global_navigation extends navigation_node {
988     /** @var moodle_page The Moodle page this navigation object belongs to. */
989     protected $page;
990     /** @var bool switch to let us know if the navigation object is initialised*/
991     protected $initialised = false;
992     /** @var array An array of course information */
993     protected $mycourses = array();
994     /** @var navigation_node[] An array for containing  root navigation nodes */
995     protected $rootnodes = array();
996     /** @var bool A switch for whether to show empty sections in the navigation */
997     protected $showemptysections = true;
998     /** @var bool A switch for whether courses should be shown within categories on the navigation. */
999     protected $showcategories = null;
1000     /** @var null@var bool A switch for whether or not to show categories in the my courses branch. */
1001     protected $showmycategories = null;
1002     /** @var array An array of stdClasses for users that the navigation is extended for */
1003     protected $extendforuser = array();
1004     /** @var navigation_cache */
1005     protected $cache;
1006     /** @var array An array of course ids that are present in the navigation */
1007     protected $addedcourses = array();
1008     /** @var bool */
1009     protected $allcategoriesloaded = false;
1010     /** @var array An array of category ids that are included in the navigation */
1011     protected $addedcategories = array();
1012     /** @var int expansion limit */
1013     protected $expansionlimit = 0;
1014     /** @var int userid to allow parent to see child's profile page navigation */
1015     protected $useridtouseforparentchecks = 0;
1016     /** @var cache_session A cache that stores information on expanded courses */
1017     protected $cacheexpandcourse = null;
1019     /** Used when loading categories to load all top level categories [parent = 0] **/
1020     const LOAD_ROOT_CATEGORIES = 0;
1021     /** Used when loading categories to load all categories **/
1022     const LOAD_ALL_CATEGORIES = -1;
1024     /**
1025      * Constructs a new global navigation
1026      *
1027      * @param moodle_page $page The page this navigation object belongs to
1028      */
1029     public function __construct(moodle_page $page) {
1030         global $CFG, $SITE, $USER;
1032         if (during_initial_install()) {
1033             return;
1034         }
1036         if (get_home_page() == HOMEPAGE_SITE) {
1037             // We are using the site home for the root element
1038             $properties = array(
1039                 'key' => 'home',
1040                 'type' => navigation_node::TYPE_SYSTEM,
1041                 'text' => get_string('home'),
1042                 'action' => new moodle_url('/')
1043             );
1044         } else {
1045             // We are using the users my moodle for the root element
1046             $properties = array(
1047                 'key' => 'myhome',
1048                 'type' => navigation_node::TYPE_SYSTEM,
1049                 'text' => get_string('myhome'),
1050                 'action' => new moodle_url('/my/')
1051             );
1052         }
1054         // Use the parents constructor.... good good reuse
1055         parent::__construct($properties);
1057         // Initalise and set defaults
1058         $this->page = $page;
1059         $this->forceopen = true;
1060         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
1061     }
1063     /**
1064      * Mutator to set userid to allow parent to see child's profile
1065      * page navigation. See MDL-25805 for initial issue. Linked to it
1066      * is an issue explaining why this is a REALLY UGLY HACK thats not
1067      * for you to use!
1068      *
1069      * @param int $userid userid of profile page that parent wants to navigate around.
1070      */
1071     public function set_userid_for_parent_checks($userid) {
1072         $this->useridtouseforparentchecks = $userid;
1073     }
1076     /**
1077      * Initialises the navigation object.
1078      *
1079      * This causes the navigation object to look at the current state of the page
1080      * that it is associated with and then load the appropriate content.
1081      *
1082      * This should only occur the first time that the navigation structure is utilised
1083      * which will normally be either when the navbar is called to be displayed or
1084      * when a block makes use of it.
1085      *
1086      * @return bool
1087      */
1088     public function initialise() {
1089         global $CFG, $SITE, $USER;
1090         // Check if it has already been initialised
1091         if ($this->initialised || during_initial_install()) {
1092             return true;
1093         }
1094         $this->initialised = true;
1096         // Set up the five base root nodes. These are nodes where we will put our
1097         // content and are as follows:
1098         // site: Navigation for the front page.
1099         // myprofile: User profile information goes here.
1100         // currentcourse: The course being currently viewed.
1101         // mycourses: The users courses get added here.
1102         // courses: Additional courses are added here.
1103         // users: Other users information loaded here.
1104         $this->rootnodes = array();
1105         if (get_home_page() == HOMEPAGE_SITE) {
1106             // The home element should be my moodle because the root element is the site
1107             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
1108                 $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
1109             }
1110         } else {
1111             // The home element should be the site because the root node is my moodle
1112             $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
1113             if (!empty($CFG->defaulthomepage) && ($CFG->defaulthomepage == HOMEPAGE_MY)) {
1114                 // We need to stop automatic redirection
1115                 $this->rootnodes['home']->action->param('redirect', '0');
1116             }
1117         }
1118         $this->rootnodes['site'] = $this->add_course($SITE);
1119         $this->rootnodes['myprofile'] = $this->add(get_string('profile'), null, self::TYPE_USER, null, 'myprofile');
1120         $this->rootnodes['currentcourse'] = $this->add(get_string('currentcourse'), null, self::TYPE_ROOTNODE, null, 'currentcourse');
1121         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses');
1122         $this->rootnodes['courses'] = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self::TYPE_ROOTNODE, null, 'courses');
1123         $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
1125         // We always load the frontpage course to ensure it is available without
1126         // JavaScript enabled.
1127         $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE);
1128         $this->load_course_sections($SITE, $this->rootnodes['site']);
1130         $course = $this->page->course;
1132         // $issite gets set to true if the current pages course is the sites frontpage course
1133         $issite = ($this->page->course->id == $SITE->id);
1134         // Determine if the user is enrolled in any course.
1135         $enrolledinanycourse = enrol_user_sees_own_courses();
1137         $this->rootnodes['currentcourse']->mainnavonly = true;
1138         if ($enrolledinanycourse) {
1139             $this->rootnodes['mycourses']->isexpandable = true;
1140             if ($CFG->navshowallcourses) {
1141                 // When we show all courses we need to show both the my courses and the regular courses branch.
1142                 $this->rootnodes['courses']->isexpandable = true;
1143             }
1144         } else {
1145             $this->rootnodes['courses']->isexpandable = true;
1146         }
1148         // Load the users enrolled courses if they are viewing the My Moodle page AND the admin has not
1149         // set that they wish to keep the My Courses branch collapsed by default.
1150         if (!empty($CFG->navexpandmycourses) && $this->page->pagelayout === 'mydashboard'){
1151             $this->rootnodes['mycourses']->forceopen = true;
1152             $this->load_courses_enrolled();
1153         } else {
1154             $this->rootnodes['mycourses']->collapse = true;
1155             $this->rootnodes['mycourses']->make_inactive();
1156         }
1158         $canviewcourseprofile = true;
1160         // Next load context specific content into the navigation
1161         switch ($this->page->context->contextlevel) {
1162             case CONTEXT_SYSTEM :
1163                 // Nothing left to do here I feel.
1164                 break;
1165             case CONTEXT_COURSECAT :
1166                 // This is essential, we must load categories.
1167                 $this->load_all_categories($this->page->context->instanceid, true);
1168                 break;
1169             case CONTEXT_BLOCK :
1170             case CONTEXT_COURSE :
1171                 if ($issite) {
1172                     // Nothing left to do here.
1173                     break;
1174                 }
1176                 // Load the course associated with the current page into the navigation.
1177                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1178                 // If the course wasn't added then don't try going any further.
1179                 if (!$coursenode) {
1180                     $canviewcourseprofile = false;
1181                     break;
1182                 }
1184                 // If the user is not enrolled then we only want to show the
1185                 // course node and not populate it.
1187                 // Not enrolled, can't view, and hasn't switched roles
1188                 if (!can_access_course($course, null, '', true)) {
1189                     if ($coursenode->isexpandable === true) {
1190                         // Obviously the situation has changed, update the cache and adjust the node.
1191                         // This occurs if the user access to a course has been revoked (one way or another) after
1192                         // initially logging in for this session.
1193                         $this->get_expand_course_cache()->set($course->id, 1);
1194                         $coursenode->isexpandable = true;
1195                         $coursenode->nodetype = self::NODETYPE_BRANCH;
1196                     }
1197                     // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1198                     // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1199                     if (!$this->current_user_is_parent_role()) {
1200                         $coursenode->make_active();
1201                         $canviewcourseprofile = false;
1202                         break;
1203                     }
1204                 } else if ($coursenode->isexpandable === false) {
1205                     // Obviously the situation has changed, update the cache and adjust the node.
1206                     // This occurs if the user has been granted access to a course (one way or another) after initially
1207                     // logging in for this session.
1208                     $this->get_expand_course_cache()->set($course->id, 1);
1209                     $coursenode->isexpandable = true;
1210                     $coursenode->nodetype = self::NODETYPE_BRANCH;
1211                 }
1213                 // Add the essentials such as reports etc...
1214                 $this->add_course_essentials($coursenode, $course);
1215                 // Extend course navigation with it's sections/activities
1216                 $this->load_course_sections($course, $coursenode);
1217                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1218                     $coursenode->make_active();
1219                 }
1221                 break;
1222             case CONTEXT_MODULE :
1223                 if ($issite) {
1224                     // If this is the site course then most information will have
1225                     // already been loaded.
1226                     // However we need to check if there is more content that can
1227                     // yet be loaded for the specific module instance.
1228                     $activitynode = $this->rootnodes['site']->find($this->page->cm->id, navigation_node::TYPE_ACTIVITY);
1229                     if ($activitynode) {
1230                         $this->load_activity($this->page->cm, $this->page->course, $activitynode);
1231                     }
1232                     break;
1233                 }
1235                 $course = $this->page->course;
1236                 $cm = $this->page->cm;
1238                 // Load the course associated with the page into the navigation
1239                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1241                 // If the course wasn't added then don't try going any further.
1242                 if (!$coursenode) {
1243                     $canviewcourseprofile = false;
1244                     break;
1245                 }
1247                 // If the user is not enrolled then we only want to show the
1248                 // course node and not populate it.
1249                 if (!can_access_course($course, null, '', true)) {
1250                     $coursenode->make_active();
1251                     $canviewcourseprofile = false;
1252                     break;
1253                 }
1255                 $this->add_course_essentials($coursenode, $course);
1257                 // Load the course sections into the page
1258                 $this->load_course_sections($course, $coursenode, null, $cm);
1259                 $activity = $coursenode->find($cm->id, navigation_node::TYPE_ACTIVITY);
1260                 if (!empty($activity)) {
1261                     // Finally load the cm specific navigaton information
1262                     $this->load_activity($cm, $course, $activity);
1263                     // Check if we have an active ndoe
1264                     if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1265                         // And make the activity node active.
1266                         $activity->make_active();
1267                     }
1268                 }
1269                 break;
1270             case CONTEXT_USER :
1271                 if ($issite) {
1272                     // The users profile information etc is already loaded
1273                     // for the front page.
1274                     break;
1275                 }
1276                 $course = $this->page->course;
1277                 // Load the course associated with the user into the navigation
1278                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1280                 // If the course wasn't added then don't try going any further.
1281                 if (!$coursenode) {
1282                     $canviewcourseprofile = false;
1283                     break;
1284                 }
1286                 // If the user is not enrolled then we only want to show the
1287                 // course node and not populate it.
1288                 if (!can_access_course($course, null, '', true)) {
1289                     $coursenode->make_active();
1290                     $canviewcourseprofile = false;
1291                     break;
1292                 }
1293                 $this->add_course_essentials($coursenode, $course);
1294                 $this->load_course_sections($course, $coursenode);
1295                 break;
1296         }
1298         // Load for the current user
1299         $this->load_for_user();
1300         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) {
1301             $this->load_for_user(null, true);
1302         }
1303         // Load each extending user into the navigation.
1304         foreach ($this->extendforuser as $user) {
1305             if ($user->id != $USER->id) {
1306                 $this->load_for_user($user);
1307             }
1308         }
1310         // Give the local plugins a chance to include some navigation if they want.
1311         foreach (get_plugin_list_with_function('local', 'extend_navigation') as $function) {
1312             $function($this);
1313         }
1315         // Remove any empty root nodes
1316         foreach ($this->rootnodes as $node) {
1317             // Dont remove the home node
1318             /** @var navigation_node $node */
1319             if ($node->key !== 'home' && !$node->has_children() && !$node->isactive) {
1320                 $node->remove();
1321             }
1322         }
1324         if (!$this->contains_active_node()) {
1325             $this->search_for_active_node();
1326         }
1328         // If the user is not logged in modify the navigation structure as detailed
1329         // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1330         if (!isloggedin()) {
1331             $activities = clone($this->rootnodes['site']->children);
1332             $this->rootnodes['site']->remove();
1333             $children = clone($this->children);
1334             $this->children = new navigation_node_collection();
1335             foreach ($activities as $child) {
1336                 $this->children->add($child);
1337             }
1338             foreach ($children as $child) {
1339                 $this->children->add($child);
1340             }
1341         }
1342         return true;
1343     }
1345     /**
1346      * Returns true if the current user is a parent of the user being currently viewed.
1347      *
1348      * If the current user is not viewing another user, or if the current user does not hold any parent roles over the
1349      * other user being viewed this function returns false.
1350      * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()}
1351      *
1352      * @since Moodle 2.4
1353      * @return bool
1354      */
1355     protected function current_user_is_parent_role() {
1356         global $USER, $DB;
1357         if ($this->useridtouseforparentchecks && $this->useridtouseforparentchecks != $USER->id) {
1358             $usercontext = context_user::instance($this->useridtouseforparentchecks, MUST_EXIST);
1359             if (!has_capability('moodle/user:viewdetails', $usercontext)) {
1360                 return false;
1361             }
1362             if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))) {
1363                 return true;
1364             }
1365         }
1366         return false;
1367     }
1369     /**
1370      * Returns true if courses should be shown within categories on the navigation.
1371      *
1372      * @param bool $ismycourse Set to true if you are calculating this for a course.
1373      * @return bool
1374      */
1375     protected function show_categories($ismycourse = false) {
1376         global $CFG, $DB;
1377         if ($ismycourse) {
1378             return $this->show_my_categories();
1379         }
1380         if ($this->showcategories === null) {
1381             $show = false;
1382             if ($this->page->context->contextlevel == CONTEXT_COURSECAT) {
1383                 $show = true;
1384             } else if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1) {
1385                 $show = true;
1386             }
1387             $this->showcategories = $show;
1388         }
1389         return $this->showcategories;
1390     }
1392     /**
1393      * Returns true if we should show categories in the My Courses branch.
1394      * @return bool
1395      */
1396     protected function show_my_categories() {
1397         global $CFG, $DB;
1398         if ($this->showmycategories === null) {
1399             $this->showmycategories = !empty($CFG->navshowmycoursecategories) && $DB->count_records('course_categories') > 1;
1400         }
1401         return $this->showmycategories;
1402     }
1404     /**
1405      * Loads the courses in Moodle into the navigation.
1406      *
1407      * @global moodle_database $DB
1408      * @param string|array $categoryids An array containing categories to load courses
1409      *                     for, OR null to load courses for all categories.
1410      * @return array An array of navigation_nodes one for each course
1411      */
1412     protected function load_all_courses($categoryids = null) {
1413         global $CFG, $DB, $SITE;
1415         // Work out the limit of courses.
1416         $limit = 20;
1417         if (!empty($CFG->navcourselimit)) {
1418             $limit = $CFG->navcourselimit;
1419         }
1421         $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES;
1423         // If we are going to show all courses AND we are showing categories then
1424         // to save us repeated DB calls load all of the categories now
1425         if ($this->show_categories()) {
1426             $this->load_all_categories($toload);
1427         }
1429         // Will be the return of our efforts
1430         $coursenodes = array();
1432         // Check if we need to show categories.
1433         if ($this->show_categories()) {
1434             // Hmmm we need to show categories... this is going to be painful.
1435             // We now need to fetch up to $limit courses for each category to
1436             // be displayed.
1437             if ($categoryids !== null) {
1438                 if (!is_array($categoryids)) {
1439                     $categoryids = array($categoryids);
1440                 }
1441                 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc');
1442                 $categorywhere = 'WHERE cc.id '.$categorywhere;
1443             } else if ($toload == self::LOAD_ROOT_CATEGORIES) {
1444                 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1445                 $categoryparams = array();
1446             } else {
1447                 $categorywhere = '';
1448                 $categoryparams = array();
1449             }
1451             // First up we are going to get the categories that we are going to
1452             // need so that we can determine how best to load the courses from them.
1453             $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1454                         FROM {course_categories} cc
1455                     LEFT JOIN {course} c ON c.category = cc.id
1456                             {$categorywhere}
1457                     GROUP BY cc.id";
1458             $categories = $DB->get_recordset_sql($sql, $categoryparams);
1459             $fullfetch = array();
1460             $partfetch = array();
1461             foreach ($categories as $category) {
1462                 if (!$this->can_add_more_courses_to_category($category->id)) {
1463                     continue;
1464                 }
1465                 if ($category->coursecount > $limit * 5) {
1466                     $partfetch[] = $category->id;
1467                 } else if ($category->coursecount > 0) {
1468                     $fullfetch[] = $category->id;
1469                 }
1470             }
1471             $categories->close();
1473             if (count($fullfetch)) {
1474                 // First up fetch all of the courses in categories where we know that we are going to
1475                 // need the majority of courses.
1476                 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory');
1477                 $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1478                 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1479                 $categoryparams['contextlevel'] = CONTEXT_COURSE;
1480                 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1481                             FROM {course} c
1482                                 $ccjoin
1483                             WHERE c.category {$categoryids}
1484                         ORDER BY c.sortorder ASC";
1485                 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1486                 foreach ($coursesrs as $course) {
1487                     if ($course->id == $SITE->id) {
1488                         // This should not be necessary, frontpage is not in any category.
1489                         continue;
1490                     }
1491                     if (array_key_exists($course->id, $this->addedcourses)) {
1492                         // It is probably better to not include the already loaded courses
1493                         // directly in SQL because inequalities may confuse query optimisers
1494                         // and may interfere with query caching.
1495                         continue;
1496                     }
1497                     if (!$this->can_add_more_courses_to_category($course->category)) {
1498                         continue;
1499                     }
1500                     context_helper::preload_from_record($course);
1501                     if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1502                         continue;
1503                     }
1504                     $coursenodes[$course->id] = $this->add_course($course);
1505                 }
1506                 $coursesrs->close();
1507             }
1509             if (count($partfetch)) {
1510                 // Next we will work our way through the categories where we will likely only need a small
1511                 // proportion of the courses.
1512                 foreach ($partfetch as $categoryid) {
1513                     $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1514                     $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1515                     $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1516                                 FROM {course} c
1517                                     $ccjoin
1518                                 WHERE c.category = :categoryid
1519                             ORDER BY c.sortorder ASC";
1520                     $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE);
1521                     $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1522                     foreach ($coursesrs as $course) {
1523                         if ($course->id == $SITE->id) {
1524                             // This should not be necessary, frontpage is not in any category.
1525                             continue;
1526                         }
1527                         if (array_key_exists($course->id, $this->addedcourses)) {
1528                             // It is probably better to not include the already loaded courses
1529                             // directly in SQL because inequalities may confuse query optimisers
1530                             // and may interfere with query caching.
1531                             // This also helps to respect expected $limit on repeated executions.
1532                             continue;
1533                         }
1534                         if (!$this->can_add_more_courses_to_category($course->category)) {
1535                             break;
1536                         }
1537                         context_helper::preload_from_record($course);
1538                         if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1539                             continue;
1540                         }
1541                         $coursenodes[$course->id] = $this->add_course($course);
1542                     }
1543                     $coursesrs->close();
1544                 }
1545             }
1546         } else {
1547             // Prepare the SQL to load the courses and their contexts
1548             list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false);
1549             $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1550             $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1551             $courseparams['contextlevel'] = CONTEXT_COURSE;
1552             $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1553                         FROM {course} c
1554                             $ccjoin
1555                         WHERE c.id {$courseids}
1556                     ORDER BY c.sortorder ASC";
1557             $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1558             foreach ($coursesrs as $course) {
1559                 if ($course->id == $SITE->id) {
1560                     // frotpage is not wanted here
1561                     continue;
1562                 }
1563                 if ($this->page->course && ($this->page->course->id == $course->id)) {
1564                     // Don't include the currentcourse in this nodelist - it's displayed in the Current course node
1565                     continue;
1566                 }
1567                 context_helper::preload_from_record($course);
1568                 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1569                     continue;
1570                 }
1571                 $coursenodes[$course->id] = $this->add_course($course);
1572                 if (count($coursenodes) >= $limit) {
1573                     break;
1574                 }
1575             }
1576             $coursesrs->close();
1577         }
1579         return $coursenodes;
1580     }
1582     /**
1583      * Returns true if more courses can be added to the provided category.
1584      *
1585      * @param int|navigation_node|stdClass $category
1586      * @return bool
1587      */
1588     protected function can_add_more_courses_to_category($category) {
1589         global $CFG;
1590         $limit = 20;
1591         if (!empty($CFG->navcourselimit)) {
1592             $limit = (int)$CFG->navcourselimit;
1593         }
1594         if (is_numeric($category)) {
1595             if (!array_key_exists($category, $this->addedcategories)) {
1596                 return true;
1597             }
1598             $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE));
1599         } else if ($category instanceof navigation_node) {
1600             if (($category->type != self::TYPE_CATEGORY) || ($category->type != self::TYPE_MY_CATEGORY)) {
1601                 return false;
1602             }
1603             $coursecount = count($category->children->type(self::TYPE_COURSE));
1604         } else if (is_object($category) && property_exists($category,'id')) {
1605             $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE));
1606         }
1607         return ($coursecount <= $limit);
1608     }
1610     /**
1611      * Loads all categories (top level or if an id is specified for that category)
1612      *
1613      * @param int $categoryid The category id to load or null/0 to load all base level categories
1614      * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1615      *        as the requested category and any parent categories.
1616      * @return navigation_node|void returns a navigation node if a category has been loaded.
1617      */
1618     protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) {
1619         global $CFG, $DB;
1621         // Check if this category has already been loaded
1622         if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1623             return true;
1624         }
1626         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
1627         $sqlselect = "SELECT cc.*, $catcontextsql
1628                       FROM {course_categories} cc
1629                       JOIN {context} ctx ON cc.id = ctx.instanceid";
1630         $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT;
1631         $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1632         $params = array();
1634         $categoriestoload = array();
1635         if ($categoryid == self::LOAD_ALL_CATEGORIES) {
1636             // We are going to load all categories regardless... prepare to fire
1637             // on the database server!
1638         } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0
1639             // We are going to load all of the first level categories (categories without parents)
1640             $sqlwhere .= " AND cc.parent = 0";
1641         } else if (array_key_exists($categoryid, $this->addedcategories)) {
1642             // The category itself has been loaded already so we just need to ensure its subcategories
1643             // have been loaded
1644             $addedcategories = $this->addedcategories;
1645             unset($addedcategories[$categoryid]);
1646             if (count($addedcategories) > 0) {
1647                 list($sql, $params) = $DB->get_in_or_equal(array_keys($addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1648                 if ($showbasecategories) {
1649                     // We need to include categories with parent = 0 as well
1650                     $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1651                 } else {
1652                     // All we need is categories that match the parent
1653                     $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1654                 }
1655             }
1656             $params['categoryid'] = $categoryid;
1657         } else {
1658             // This category hasn't been loaded yet so we need to fetch it, work out its category path
1659             // and load this category plus all its parents and subcategories
1660             $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
1661             $categoriestoload = explode('/', trim($category->path, '/'));
1662             list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1663             // We are going to use select twice so double the params
1664             $params = array_merge($params, $params);
1665             $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':'';
1666             $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1667         }
1669         $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1670         $categories = array();
1671         foreach ($categoriesrs as $category) {
1672             // Preload the context.. we'll need it when adding the category in order
1673             // to format the category name.
1674             context_helper::preload_from_record($category);
1675             if (array_key_exists($category->id, $this->addedcategories)) {
1676                 // Do nothing, its already been added.
1677             } else if ($category->parent == '0') {
1678                 // This is a root category lets add it immediately
1679                 $this->add_category($category, $this->rootnodes['courses']);
1680             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1681                 // This categories parent has already been added we can add this immediately
1682                 $this->add_category($category, $this->addedcategories[$category->parent]);
1683             } else {
1684                 $categories[] = $category;
1685             }
1686         }
1687         $categoriesrs->close();
1689         // Now we have an array of categories we need to add them to the navigation.
1690         while (!empty($categories)) {
1691             $category = reset($categories);
1692             if (array_key_exists($category->id, $this->addedcategories)) {
1693                 // Do nothing
1694             } else if ($category->parent == '0') {
1695                 $this->add_category($category, $this->rootnodes['courses']);
1696             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1697                 $this->add_category($category, $this->addedcategories[$category->parent]);
1698             } else {
1699                 // This category isn't in the navigation and niether is it's parent (yet).
1700                 // We need to go through the category path and add all of its components in order.
1701                 $path = explode('/', trim($category->path, '/'));
1702                 foreach ($path as $catid) {
1703                     if (!array_key_exists($catid, $this->addedcategories)) {
1704                         // This category isn't in the navigation yet so add it.
1705                         $subcategory = $categories[$catid];
1706                         if ($subcategory->parent == '0') {
1707                             // Yay we have a root category - this likely means we will now be able
1708                             // to add categories without problems.
1709                             $this->add_category($subcategory, $this->rootnodes['courses']);
1710                         } else if (array_key_exists($subcategory->parent, $this->addedcategories)) {
1711                             // The parent is in the category (as we'd expect) so add it now.
1712                             $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1713                             // Remove the category from the categories array.
1714                             unset($categories[$catid]);
1715                         } else {
1716                             // We should never ever arrive here - if we have then there is a bigger
1717                             // problem at hand.
1718                             throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1719                         }
1720                     }
1721                 }
1722             }
1723             // Remove the category from the categories array now that we know it has been added.
1724             unset($categories[$category->id]);
1725         }
1726         if ($categoryid === self::LOAD_ALL_CATEGORIES) {
1727             $this->allcategoriesloaded = true;
1728         }
1729         // Check if there are any categories to load.
1730         if (count($categoriestoload) > 0) {
1731             $readytoloadcourses = array();
1732             foreach ($categoriestoload as $category) {
1733                 if ($this->can_add_more_courses_to_category($category)) {
1734                     $readytoloadcourses[] = $category;
1735                 }
1736             }
1737             if (count($readytoloadcourses)) {
1738                 $this->load_all_courses($readytoloadcourses);
1739             }
1740         }
1742         // Look for all categories which have been loaded
1743         if (!empty($this->addedcategories)) {
1744             $categoryids = array();
1745             foreach ($this->addedcategories as $category) {
1746                 if ($this->can_add_more_courses_to_category($category)) {
1747                     $categoryids[] = $category->key;
1748                 }
1749             }
1750             if ($categoryids) {
1751                 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED);
1752                 $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20;
1753                 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1754                           FROM {course_categories} cc
1755                           JOIN {course} c ON c.category = cc.id
1756                          WHERE cc.id {$categoriessql}
1757                       GROUP BY cc.id
1758                         HAVING COUNT(c.id) > :limit";
1759                 $excessivecategories = $DB->get_records_sql($sql, $params);
1760                 foreach ($categories as &$category) {
1761                     if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1762                         $url = new moodle_url('/course/index.php', array('categoryid' => $category->key));
1763                         $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1764                     }
1765                 }
1766             }
1767         }
1768     }
1770     /**
1771      * Adds a structured category to the navigation in the correct order/place
1772      *
1773      * @param stdClass $category category to be added in navigation.
1774      * @param navigation_node $parent parent navigation node
1775      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1776      * @return void.
1777      */
1778     protected function add_category(stdClass $category, navigation_node $parent, $nodetype = self::TYPE_CATEGORY) {
1779         if (array_key_exists($category->id, $this->addedcategories)) {
1780             return;
1781         }
1782         $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
1783         $context = context_coursecat::instance($category->id);
1784         $categoryname = format_string($category->name, true, array('context' => $context));
1785         $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id);
1786         if (empty($category->visible)) {
1787             if (has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
1788                 $categorynode->hidden = true;
1789             } else {
1790                 $categorynode->display = false;
1791             }
1792         }
1793         $this->addedcategories[$category->id] = $categorynode;
1794     }
1796     /**
1797      * Loads the given course into the navigation
1798      *
1799      * @param stdClass $course
1800      * @return navigation_node
1801      */
1802     protected function load_course(stdClass $course) {
1803         global $SITE;
1804         if ($course->id == $SITE->id) {
1805             // This is always loaded during initialisation
1806             return $this->rootnodes['site'];
1807         } else if (array_key_exists($course->id, $this->addedcourses)) {
1808             // The course has already been loaded so return a reference
1809             return $this->addedcourses[$course->id];
1810         } else {
1811             // Add the course
1812             return $this->add_course($course);
1813         }
1814     }
1816     /**
1817      * Loads all of the courses section into the navigation.
1818      *
1819      * This function calls method from current course format, see
1820      * {@link format_base::extend_course_navigation()}
1821      * If course module ($cm) is specified but course format failed to create the node,
1822      * the activity node is created anyway.
1823      *
1824      * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
1825      *
1826      * @param stdClass $course Database record for the course
1827      * @param navigation_node $coursenode The course node within the navigation
1828      * @param null|int $sectionnum If specified load the contents of section with this relative number
1829      * @param null|cm_info $cm If specified make sure that activity node is created (either
1830      *    in containg section or by calling load_stealth_activity() )
1831      */
1832     protected function load_course_sections(stdClass $course, navigation_node $coursenode, $sectionnum = null, $cm = null) {
1833         global $CFG, $SITE;
1834         require_once($CFG->dirroot.'/course/lib.php');
1835         if (isset($cm->sectionnum)) {
1836             $sectionnum = $cm->sectionnum;
1837         }
1838         if ($sectionnum !== null) {
1839             $this->includesectionnum = $sectionnum;
1840         }
1841         course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
1842         if (isset($cm->id)) {
1843             $activity = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
1844             if (empty($activity)) {
1845                 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
1846             }
1847         }
1848    }
1850     /**
1851      * Generates an array of sections and an array of activities for the given course.
1852      *
1853      * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1854      *
1855      * @param stdClass $course
1856      * @return array Array($sections, $activities)
1857      */
1858     protected function generate_sections_and_activities(stdClass $course) {
1859         global $CFG;
1860         require_once($CFG->dirroot.'/course/lib.php');
1862         $modinfo = get_fast_modinfo($course);
1863         $sections = $modinfo->get_section_info_all();
1865         // For course formats using 'numsections' trim the sections list
1866         $courseformatoptions = course_get_format($course)->get_format_options();
1867         if (isset($courseformatoptions['numsections'])) {
1868             $sections = array_slice($sections, 0, $courseformatoptions['numsections']+1, true);
1869         }
1871         $activities = array();
1873         foreach ($sections as $key => $section) {
1874             // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1875             $sections[$key] = clone($section);
1876             unset($sections[$key]->summary);
1877             $sections[$key]->hasactivites = false;
1878             if (!array_key_exists($section->section, $modinfo->sections)) {
1879                 continue;
1880             }
1881             foreach ($modinfo->sections[$section->section] as $cmid) {
1882                 $cm = $modinfo->cms[$cmid];
1883                 $activity = new stdClass;
1884                 $activity->id = $cm->id;
1885                 $activity->course = $course->id;
1886                 $activity->section = $section->section;
1887                 $activity->name = $cm->name;
1888                 $activity->icon = $cm->icon;
1889                 $activity->iconcomponent = $cm->iconcomponent;
1890                 $activity->hidden = (!$cm->visible);
1891                 $activity->modname = $cm->modname;
1892                 $activity->nodetype = navigation_node::NODETYPE_LEAF;
1893                 $activity->onclick = $cm->onclick;
1894                 $url = $cm->url;
1895                 if (!$url) {
1896                     $activity->url = null;
1897                     $activity->display = false;
1898                 } else {
1899                     $activity->url = $url->out();
1900                     $activity->display = $cm->uservisible ? true : false;
1901                     if (self::module_extends_navigation($cm->modname)) {
1902                         $activity->nodetype = navigation_node::NODETYPE_BRANCH;
1903                     }
1904                 }
1905                 $activities[$cmid] = $activity;
1906                 if ($activity->display) {
1907                     $sections[$key]->hasactivites = true;
1908                 }
1909             }
1910         }
1912         return array($sections, $activities);
1913     }
1915     /**
1916      * Generically loads the course sections into the course's navigation.
1917      *
1918      * @param stdClass $course
1919      * @param navigation_node $coursenode
1920      * @return array An array of course section nodes
1921      */
1922     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode) {
1923         global $CFG, $DB, $USER, $SITE;
1924         require_once($CFG->dirroot.'/course/lib.php');
1926         list($sections, $activities) = $this->generate_sections_and_activities($course);
1928         $navigationsections = array();
1929         foreach ($sections as $sectionid => $section) {
1930             $section = clone($section);
1931             if ($course->id == $SITE->id) {
1932                 $this->load_section_activities($coursenode, $section->section, $activities);
1933             } else {
1934                 if (!$section->uservisible || (!$this->showemptysections &&
1935                         !$section->hasactivites && $this->includesectionnum !== $section->section)) {
1936                     continue;
1937                 }
1939                 $sectionname = get_section_name($course, $section);
1940                 $url = course_get_url($course, $section->section, array('navigation' => true));
1942                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1943                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1944                 $sectionnode->hidden = (!$section->visible || !$section->available);
1945                 if ($this->includesectionnum !== false && $this->includesectionnum == $section->section) {
1946                     $this->load_section_activities($sectionnode, $section->section, $activities);
1947                 }
1948                 $section->sectionnode = $sectionnode;
1949                 $navigationsections[$sectionid] = $section;
1950             }
1951         }
1952         return $navigationsections;
1953     }
1955     /**
1956      * Loads all of the activities for a section into the navigation structure.
1957      *
1958      * @param navigation_node $sectionnode
1959      * @param int $sectionnumber
1960      * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
1961      * @param stdClass $course The course object the section and activities relate to.
1962      * @return array Array of activity nodes
1963      */
1964     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) {
1965         global $CFG, $SITE;
1966         // A static counter for JS function naming
1967         static $legacyonclickcounter = 0;
1969         $activitynodes = array();
1970         if (empty($activities)) {
1971             return $activitynodes;
1972         }
1974         if (!is_object($course)) {
1975             $activity = reset($activities);
1976             $courseid = $activity->course;
1977         } else {
1978             $courseid = $course->id;
1979         }
1980         $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods));
1982         foreach ($activities as $activity) {
1983             if ($activity->section != $sectionnumber) {
1984                 continue;
1985             }
1986             if ($activity->icon) {
1987                 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
1988             } else {
1989                 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
1990             }
1992             // Prepare the default name and url for the node
1993             $activityname = format_string($activity->name, true, array('context' => context_module::instance($activity->id)));
1994             $action = new moodle_url($activity->url);
1996             // Check if the onclick property is set (puke!)
1997             if (!empty($activity->onclick)) {
1998                 // Increment the counter so that we have a unique number.
1999                 $legacyonclickcounter++;
2000                 // Generate the function name we will use
2001                 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
2002                 $propogrationhandler = '';
2003                 // Check if we need to cancel propogation. Remember inline onclick
2004                 // events would return false if they wanted to prevent propogation and the
2005                 // default action.
2006                 if (strpos($activity->onclick, 'return false')) {
2007                     $propogrationhandler = 'e.halt();';
2008                 }
2009                 // Decode the onclick - it has already been encoded for display (puke)
2010                 $onclick = htmlspecialchars_decode($activity->onclick, ENT_QUOTES);
2011                 // Build the JS function the click event will call
2012                 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2013                 $this->page->requires->js_init_code($jscode);
2014                 // Override the default url with the new action link
2015                 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2016             }
2018             $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
2019             $activitynode->title(get_string('modulename', $activity->modname));
2020             $activitynode->hidden = $activity->hidden;
2021             $activitynode->display = $showactivities && $activity->display;
2022             $activitynode->nodetype = $activity->nodetype;
2023             $activitynodes[$activity->id] = $activitynode;
2024         }
2026         return $activitynodes;
2027     }
2028     /**
2029      * Loads a stealth module from unavailable section
2030      * @param navigation_node $coursenode
2031      * @param stdClass $modinfo
2032      * @return navigation_node or null if not accessible
2033      */
2034     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
2035         if (empty($modinfo->cms[$this->page->cm->id])) {
2036             return null;
2037         }
2038         $cm = $modinfo->cms[$this->page->cm->id];
2039         if ($cm->icon) {
2040             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
2041         } else {
2042             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
2043         }
2044         $url = $cm->url;
2045         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
2046         $activitynode->title(get_string('modulename', $cm->modname));
2047         $activitynode->hidden = (!$cm->visible);
2048         if (!$cm->uservisible) {
2049             // Do not show any error here, let the page handle exception that activity is not visible for the current user.
2050             // Also there may be no exception at all in case when teacher is logged in as student.
2051             $activitynode->display = false;
2052         } else if (!$url) {
2053             // Don't show activities that don't have links!
2054             $activitynode->display = false;
2055         } else if (self::module_extends_navigation($cm->modname)) {
2056             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
2057         }
2058         return $activitynode;
2059     }
2060     /**
2061      * Loads the navigation structure for the given activity into the activities node.
2062      *
2063      * This method utilises a callback within the modules lib.php file to load the
2064      * content specific to activity given.
2065      *
2066      * The callback is a method: {modulename}_extend_navigation()
2067      * Examples:
2068      *  * {@link forum_extend_navigation()}
2069      *  * {@link workshop_extend_navigation()}
2070      *
2071      * @param cm_info|stdClass $cm
2072      * @param stdClass $course
2073      * @param navigation_node $activity
2074      * @return bool
2075      */
2076     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
2077         global $CFG, $DB;
2079         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2080         if (!($cm instanceof cm_info)) {
2081             $modinfo = get_fast_modinfo($course);
2082             $cm = $modinfo->get_cm($cm->id);
2083         }
2084         $activity->nodetype = navigation_node::NODETYPE_LEAF;
2085         $activity->make_active();
2086         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
2087         $function = $cm->modname.'_extend_navigation';
2089         if (file_exists($file)) {
2090             require_once($file);
2091             if (function_exists($function)) {
2092                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
2093                 $function($activity, $course, $activtyrecord, $cm);
2094             }
2095         }
2097         // Allow the active advanced grading method plugin to append module navigation
2098         $featuresfunc = $cm->modname.'_supports';
2099         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) {
2100             require_once($CFG->dirroot.'/grade/grading/lib.php');
2101             $gradingman = get_grading_manager($cm->context,  'mod_'.$cm->modname);
2102             $gradingman->extend_navigation($this, $activity);
2103         }
2105         return $activity->has_children();
2106     }
2107     /**
2108      * Loads user specific information into the navigation in the appropriate place.
2109      *
2110      * If no user is provided the current user is assumed.
2111      *
2112      * @param stdClass $user
2113      * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2114      * @return bool
2115      */
2116     protected function load_for_user($user=null, $forceforcontext=false) {
2117         global $DB, $CFG, $USER, $SITE;
2119         if ($user === null) {
2120             // We can't require login here but if the user isn't logged in we don't
2121             // want to show anything
2122             if (!isloggedin() || isguestuser()) {
2123                 return false;
2124             }
2125             $user = $USER;
2126         } else if (!is_object($user)) {
2127             // If the user is not an object then get them from the database
2128             $select = context_helper::get_preload_record_columns_sql('ctx');
2129             $sql = "SELECT u.*, $select
2130                       FROM {user} u
2131                       JOIN {context} ctx ON u.id = ctx.instanceid
2132                      WHERE u.id = :userid AND
2133                            ctx.contextlevel = :contextlevel";
2134             $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST);
2135             context_helper::preload_from_record($user);
2136         }
2138         $iscurrentuser = ($user->id == $USER->id);
2140         $usercontext = context_user::instance($user->id);
2142         // Get the course set against the page, by default this will be the site
2143         $course = $this->page->course;
2144         $baseargs = array('id'=>$user->id);
2145         if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) {
2146             $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
2147             $baseargs['course'] = $course->id;
2148             $coursecontext = context_course::instance($course->id);
2149             $issitecourse = false;
2150         } else {
2151             // Load all categories and get the context for the system
2152             $coursecontext = context_system::instance();
2153             $issitecourse = true;
2154         }
2156         // Create a node to add user information under.
2157         $usersnode = null;
2158         if (!$issitecourse) {
2159             // Not the current user so add it to the participants node for the current course.
2160             $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
2161             $userviewurl = new moodle_url('/user/view.php', $baseargs);
2162         } else if ($USER->id != $user->id) {
2163             // This is the site so add a users node to the root branch.
2164             $usersnode = $this->rootnodes['users'];
2165             if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2166                 $usersnode->action = new moodle_url('/user/index.php', array('id' => $course->id));
2167             }
2168             $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2169         }
2170         if (!$usersnode) {
2171             // We should NEVER get here, if the course hasn't been populated
2172             // with a participants node then the navigaiton either wasn't generated
2173             // for it (you are missing a require_login or set_context call) or
2174             // you don't have access.... in the interests of no leaking informatin
2175             // we simply quit...
2176             return false;
2177         }
2178         // Add a branch for the current user.
2179         $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2180         $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, 'user' . $user->id);
2181         if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
2182             $usernode->make_active();
2183         }
2185         // Add user information to the participants or user node.
2186         if ($issitecourse) {
2188             // If the user is the current user or has permission to view the details of the requested
2189             // user than add a view profile link.
2190             if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) ||
2191                     has_capability('moodle/user:viewdetails', $usercontext)) {
2192                 if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
2193                     $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php', $baseargs));
2194                 } else {
2195                     $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php', $baseargs));
2196                 }
2197             }
2199             if (!empty($CFG->navadduserpostslinks)) {
2200                 // Add nodes for forum posts and discussions if the user can view either or both
2201                 // There are no capability checks here as the content of the page is based
2202                 // purely on the forums the current user has access too.
2203                 $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2204                 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2205                 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php',
2206                         array_merge($baseargs, array('mode' => 'discussions'))));
2207             }
2209             // Add blog nodes.
2210             if (!empty($CFG->enableblogs)) {
2211                 if (!$this->cache->cached('userblogoptions'.$user->id)) {
2212                     require_once($CFG->dirroot.'/blog/lib.php');
2213                     // Get all options for the user.
2214                     $options = blog_get_options_for_user($user);
2215                     $this->cache->set('userblogoptions'.$user->id, $options);
2216                 } else {
2217                     $options = $this->cache->{'userblogoptions'.$user->id};
2218                 }
2220                 if (count($options) > 0) {
2221                     $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
2222                     foreach ($options as $type => $option) {
2223                         if ($type == "rss") {
2224                             $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null,
2225                                     new pix_icon('i/rss', ''));
2226                         } else {
2227                             $blogs->add($option['string'], $option['link']);
2228                         }
2229                     }
2230                 }
2231             }
2233             // Add the messages link.
2234             // It is context based so can appear in the user's profile and in course participants information.
2235             if (!empty($CFG->messaging)) {
2236                 $messageargs = array('user1' => $USER->id);
2237                 if ($USER->id != $user->id) {
2238                     $messageargs['user2'] = $user->id;
2239                 }
2240                 if ($course->id != $SITE->id) {
2241                     $messageargs['viewing'] = MESSAGE_VIEW_COURSE. $course->id;
2242                 }
2243                 $url = new moodle_url('/message/index.php', $messageargs);
2244                 $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
2245             }
2247             // Add the "My private files" link.
2248             // This link doesn't have a unique display for course context so only display it under the user's profile.
2249             if ($issitecourse && $iscurrentuser && has_capability('moodle/user:manageownfiles', $usercontext)) {
2250                 $url = new moodle_url('/user/files.php');
2251                 $usernode->add(get_string('privatefiles'), $url, self::TYPE_SETTING);
2252             }
2254             // Add a node to view the users notes if permitted.
2255             if (!empty($CFG->enablenotes) &&
2256                     has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2257                 $url = new moodle_url('/notes/index.php', array('user' => $user->id));
2258                 if ($coursecontext->instanceid != SITEID) {
2259                     $url->param('course', $coursecontext->instanceid);
2260                 }
2261                 $usernode->add(get_string('notes', 'notes'), $url);
2262             }
2264             // Show the grades node.
2265             if (($issitecourse && $iscurrentuser) || has_capability('moodle/user:viewdetails', $usercontext)) {
2266                 require_once($CFG->dirroot . '/user/lib.php');
2267                 // Set the grades node to link to the "Grades" page.
2268                 if ($course->id == SITEID) {
2269                     $url = user_mygrades_url($user->id, $course->id);
2270                 } else { // Otherwise we are in a course and should redirect to the user grade report (Activity report version).
2271                     $url = new moodle_url('/course/user.php', array('mode' => 'grade', 'id' => $course->id, 'user' => $user->id));
2272                 }
2273                 if ($USER->id != $user->id) {
2274                     $usernode->add(get_string('grades', 'grades'), $url, self::TYPE_SETTING, null, 'usergrades');
2275                 } else {
2276                     $usernode->add(get_string('grades', 'grades'), $url);
2277                 }
2278             }
2280             // If the user is the current user add the repositories for the current user.
2281             $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
2282             if (!$iscurrentuser &&
2283                     $course->id == $SITE->id &&
2284                     has_capability('moodle/user:viewdetails', $usercontext) &&
2285                     (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2287                 // Add view grade report is permitted.
2288                 $reports = core_component::get_plugin_list('gradereport');
2289                 arsort($reports); // User is last, we want to test it first.
2291                 $userscourses = enrol_get_users_courses($user->id);
2292                 $userscoursesnode = $usernode->add(get_string('courses'));
2294                 $count = 0;
2295                 foreach ($userscourses as $usercourse) {
2296                     if ($count === (int)$CFG->navcourselimit) {
2297                         $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1));
2298                         $userscoursesnode->add(get_string('showallcourses'), $url);
2299                         break;
2300                     }
2301                     $count++;
2302                     $usercoursecontext = context_course::instance($usercourse->id);
2303                     $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext));
2304                     $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php',
2305                             array('id' => $user->id, 'course' => $usercourse->id)), self::TYPE_CONTAINER);
2307                     $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2308                     if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
2309                         foreach ($reports as $plugin => $plugindir) {
2310                             if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2311                                 // Stop when the first visible plugin is found.
2312                                 $gradeavailable = true;
2313                                 break;
2314                             }
2315                         }
2316                     }
2318                     if ($gradeavailable) {
2319                         $url = new moodle_url('/grade/report/index.php', array('id' => $usercourse->id));
2320                         $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null,
2321                                 new pix_icon('i/grades', ''));
2322                     }
2324                     // Add a node to view the users notes if permitted.
2325                     if (!empty($CFG->enablenotes) &&
2326                             has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2327                         $url = new moodle_url('/notes/index.php', array('user' => $user->id, 'course' => $usercourse->id));
2328                         $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2329                     }
2331                     if (can_access_course($usercourse, $user->id, '', true)) {
2332                         $usercoursenode->add(get_string('entercourse'), new moodle_url('/course/view.php',
2333                                 array('id' => $usercourse->id)), self::TYPE_SETTING, null, null, new pix_icon('i/course', ''));
2334                     }
2336                     $reporttab = $usercoursenode->add(get_string('activityreports'));
2338                     $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2339                     foreach ($reports as $reportfunction) {
2340                         $reportfunction($reporttab, $user, $usercourse);
2341                     }
2343                     $reporttab->trim_if_empty();
2344                 }
2345             }
2347             // Let plugins hook into user navigation.
2348             $pluginsfunction = get_plugins_with_function('extend_navigation_user', 'lib.php');
2349             foreach ($pluginsfunction as $plugintype => $plugins) {
2350                 if ($plugintype != 'report') {
2351                     foreach ($plugins as $pluginfunction) {
2352                         $pluginfunction($usernode, $user, $usercontext, $course, $coursecontext);
2353                     }
2354                 }
2355             }
2356         }
2357         return true;
2358     }
2360     /**
2361      * This method simply checks to see if a given module can extend the navigation.
2362      *
2363      * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2364      *
2365      * @param string $modname
2366      * @return bool
2367      */
2368     public static function module_extends_navigation($modname) {
2369         global $CFG;
2370         static $extendingmodules = array();
2371         if (!array_key_exists($modname, $extendingmodules)) {
2372             $extendingmodules[$modname] = false;
2373             $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2374             if (file_exists($file)) {
2375                 $function = $modname.'_extend_navigation';
2376                 require_once($file);
2377                 $extendingmodules[$modname] = (function_exists($function));
2378             }
2379         }
2380         return $extendingmodules[$modname];
2381     }
2382     /**
2383      * Extends the navigation for the given user.
2384      *
2385      * @param stdClass $user A user from the database
2386      */
2387     public function extend_for_user($user) {
2388         $this->extendforuser[] = $user;
2389     }
2391     /**
2392      * Returns all of the users the navigation is being extended for
2393      *
2394      * @return array An array of extending users.
2395      */
2396     public function get_extending_users() {
2397         return $this->extendforuser;
2398     }
2399     /**
2400      * Adds the given course to the navigation structure.
2401      *
2402      * @param stdClass $course
2403      * @param bool $forcegeneric
2404      * @param bool $ismycourse
2405      * @return navigation_node
2406      */
2407     public function add_course(stdClass $course, $forcegeneric = false, $coursetype = self::COURSE_OTHER) {
2408         global $CFG, $SITE;
2410         // We found the course... we can return it now :)
2411         if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2412             return $this->addedcourses[$course->id];
2413         }
2415         $coursecontext = context_course::instance($course->id);
2417         if ($course->id != $SITE->id && !$course->visible) {
2418             if (is_role_switched($course->id)) {
2419                 // user has to be able to access course in order to switch, let's skip the visibility test here
2420             } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2421                 return false;
2422             }
2423         }
2425         $issite = ($course->id == $SITE->id);
2426         $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
2427         $fullname = format_string($course->fullname, true, array('context' => $coursecontext));
2428         // This is the name that will be shown for the course.
2429         $coursename = empty($CFG->navshowfullcoursenames) ? $shortname : $fullname;
2431         // Can the user expand the course to see its content.
2432         $canexpandcourse = true;
2433         if ($issite) {
2434             $parent = $this;
2435             $url = null;
2436             if (empty($CFG->usesitenameforsitepages)) {
2437                 $coursename = get_string('sitepages');
2438             }
2439         } else if ($coursetype == self::COURSE_CURRENT) {
2440             $parent = $this->rootnodes['currentcourse'];
2441             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2442             $canexpandcourse = $this->can_expand_course($course);
2443         } else if ($coursetype == self::COURSE_MY && !$forcegeneric) {
2444             if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_MY_CATEGORY))) {
2445                 // Nothing to do here the above statement set $parent to the category within mycourses.
2446             } else {
2447                 $parent = $this->rootnodes['mycourses'];
2448             }
2449             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2450         } else {
2451             $parent = $this->rootnodes['courses'];
2452             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2453             // They can only expand the course if they can access it.
2454             $canexpandcourse = $this->can_expand_course($course);
2455             if (!empty($course->category) && $this->show_categories($coursetype == self::COURSE_MY)) {
2456                 if (!$this->is_category_fully_loaded($course->category)) {
2457                     // We need to load the category structure for this course
2458                     $this->load_all_categories($course->category, false);
2459                 }
2460                 if (array_key_exists($course->category, $this->addedcategories)) {
2461                     $parent = $this->addedcategories[$course->category];
2462                     // This could lead to the course being created so we should check whether it is the case again
2463                     if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2464                         return $this->addedcourses[$course->id];
2465                     }
2466                 }
2467             }
2468         }
2470         $coursenode = $parent->add($coursename, $url, self::TYPE_COURSE, $shortname, $course->id);
2471         $coursenode->hidden = (!$course->visible);
2472         $coursenode->title(format_string($course->fullname, true, array('context' => $coursecontext, 'escape' => false)));
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;
2548         require_once($CFG->dirroot . '/course/lib.php');
2550         if ($course->id == $SITE->id) {
2551             return $this->add_front_page_course_essentials($coursenode, $course);
2552         }
2554         if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2555             return true;
2556         }
2558         $navoptions = course_get_user_navigation_options($this->page->context);
2560         //Participants
2561         if ($navoptions->participants) {
2562             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
2564             if ($navoptions->blogs) {
2565                 $blogsurls = new moodle_url('/blog/index.php');
2566                 if ($currentgroup = groups_get_course_group($course, true)) {
2567                     $blogsurls->param('groupid', $currentgroup);
2568                 } else {
2569                     $blogsurls->param('courseid', $course->id);
2570                 }
2571                 $participants->add(get_string('blogscourse', 'blog'), $blogsurls->out(), self::TYPE_SETTING, null, 'courseblogs');
2572             }
2574             if ($navoptions->notes) {
2575                 $participants->add(get_string('notes', 'notes'), new moodle_url('/notes/index.php', array('filtertype' => 'course', 'filterselect' => $course->id)), self::TYPE_SETTING, null, 'currentcoursenotes');
2576             }
2577         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2578             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2579         }
2581         // Badges.
2582         if ($navoptions->badges) {
2583             $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id));
2585             $coursenode->add(get_string('coursebadges', 'badges'), null,
2586                     navigation_node::TYPE_CONTAINER, null, 'coursebadges');
2587             $coursenode->get('coursebadges')->add(get_string('badgesview', 'badges'), $url,
2588                     navigation_node::TYPE_SETTING, null, 'badgesview',
2589                     new pix_icon('i/badge', get_string('badgesview', 'badges')));
2590         }
2592         return true;
2593     }
2594     /**
2595      * This generates the structure of the course that won't be generated when
2596      * the modules and sections are added.
2597      *
2598      * Things such as the reports branch, the participants branch, blogs... get
2599      * added to the course node by this method.
2600      *
2601      * @param navigation_node $coursenode
2602      * @param stdClass $course
2603      * @return bool True for successfull generation
2604      */
2605     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2606         global $CFG;
2607         require_once($CFG->dirroot . '/course/lib.php');
2609         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2610             return true;
2611         }
2613         $sitecontext = context_system::instance();
2614         $navoptions = course_get_user_navigation_options($sitecontext, $course);
2616         // Hidden node that we use to determine if the front page navigation is loaded.
2617         // This required as there are not other guaranteed nodes that may be loaded.
2618         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2620         // Participants.
2621         if ($navoptions->participants) {
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 ($navoptions->blogs) {
2627             $blogsurls = new moodle_url('/blog/index.php');
2628             $coursenode->add(get_string('blogssite', 'blog'), $blogsurls->out(), self::TYPE_SYSTEM, null, 'siteblog');
2629         }
2631         $filterselect = 0;
2633         // Badges.
2634         if ($navoptions->badges) {
2635             $url = new moodle_url($CFG->wwwroot . '/badges/view.php', array('type' => 1));
2636             $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node::TYPE_CUSTOM);
2637         }
2639         // Notes.
2640         if ($navoptions->notes) {
2641             $coursenode->add(get_string('notes', 'notes'), new moodle_url('/notes/index.php',
2642                 array('filtertype' => 'course', 'filterselect' => $filterselect)), self::TYPE_SETTING, null, 'notes');
2643         }
2645         // Tags
2646         if ($navoptions->tags) {
2647             $node = $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'),
2648                     self::TYPE_SETTING, null, 'tags');
2649         }
2651         // Search.
2652         if ($navoptions->search) {
2653             $node = $coursenode->add(get_string('search', 'search'), new moodle_url('/search/index.php'),
2654                     self::TYPE_SETTING, null, 'search');
2655         }
2657         if ($navoptions->calendar) {
2658             // Calendar
2659             $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2660             $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self::TYPE_CUSTOM, null, 'calendar');
2661         }
2663         return true;
2664     }
2666     /**
2667      * Clears the navigation cache
2668      */
2669     public function clear_cache() {
2670         $this->cache->clear();
2671     }
2673     /**
2674      * Sets an expansion limit for the navigation
2675      *
2676      * The expansion limit is used to prevent the display of content that has a type
2677      * greater than the provided $type.
2678      *
2679      * Can be used to ensure things such as activities or activity content don't get
2680      * shown on the navigation.
2681      * They are still generated in order to ensure the navbar still makes sense.
2682      *
2683      * @param int $type One of navigation_node::TYPE_*
2684      * @return bool true when complete.
2685      */
2686     public function set_expansion_limit($type) {
2687         global $SITE;
2688         $nodes = $this->find_all_of_type($type);
2690         // We only want to hide specific types of nodes.
2691         // Only nodes that represent "structure" in the navigation tree should be hidden.
2692         // If we hide all nodes then we risk hiding vital information.
2693         $typestohide = array(
2694             self::TYPE_CATEGORY,
2695             self::TYPE_COURSE,
2696             self::TYPE_SECTION,
2697             self::TYPE_ACTIVITY
2698         );
2700         foreach ($nodes as $node) {
2701             // We need to generate the full site node
2702             if ($type == self::TYPE_COURSE && $node->key == $SITE->id) {
2703                 continue;
2704             }
2705             foreach ($node->children as $child) {
2706                 $child->hide($typestohide);
2707             }
2708         }
2709         return true;
2710     }
2711     /**
2712      * Attempts to get the navigation with the given key from this nodes children.
2713      *
2714      * This function only looks at this nodes children, it does NOT look recursivily.
2715      * If the node can't be found then false is returned.
2716      *
2717      * If you need to search recursivily then use the {@link global_navigation::find()} method.
2718      *
2719      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2720      * may be of more use to you.
2721      *
2722      * @param string|int $key The key of the node you wish to receive.
2723      * @param int $type One of navigation_node::TYPE_*
2724      * @return navigation_node|false
2725      */
2726     public function get($key, $type = null) {
2727         if (!$this->initialised) {
2728             $this->initialise();
2729         }
2730         return parent::get($key, $type);
2731     }
2733     /**
2734      * Searches this nodes children and their children to find a navigation node
2735      * with the matching key and type.
2736      *
2737      * This method is recursive and searches children so until either a node is
2738      * found or there are no more nodes to search.
2739      *
2740      * If you know that the node being searched for is a child of this node
2741      * then use the {@link global_navigation::get()} method instead.
2742      *
2743      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2744      * may be of more use to you.
2745      *
2746      * @param string|int $key The key of the node you wish to receive.
2747      * @param int $type One of navigation_node::TYPE_*
2748      * @return navigation_node|false
2749      */
2750     public function find($key, $type) {
2751         if (!$this->initialised) {
2752             $this->initialise();
2753         }
2754         if ($type == self::TYPE_ROOTNODE && array_key_exists($key, $this->rootnodes)) {
2755             return $this->rootnodes[$key];
2756         }
2757         return parent::find($key, $type);
2758     }
2760     /**
2761      * They've expanded the 'my courses' branch.
2762      */
2763     protected function load_courses_enrolled() {
2764         global $CFG, $DB;
2765         $sortorder = 'visible DESC';
2766         // Prevent undefined $CFG->navsortmycoursessort errors.
2767         if (empty($CFG->navsortmycoursessort)) {
2768             $CFG->navsortmycoursessort = 'sortorder';
2769         }
2770         // Append the chosen sortorder.
2771         $sortorder = $sortorder . ',' . $CFG->navsortmycoursessort . ' ASC';
2772         $courses = enrol_get_my_courses(null, $sortorder);
2773         if (count($courses) && $this->show_my_categories()) {
2774             // OK Actually we are loading categories. We only want to load categories that have a parent of 0.
2775             // In order to make sure we load everything required we must first find the categories that are not
2776             // base categories and work out the bottom category in thier path.
2777             $categoryids = array();
2778             foreach ($courses as $course) {
2779                 $categoryids[] = $course->category;
2780             }
2781             $categoryids = array_unique($categoryids);
2782             list($sql, $params) = $DB->get_in_or_equal($categoryids);
2783             $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent <> 0', $params, 'sortorder, id', 'id, path');
2784             foreach ($categories as $category) {
2785                 $bits = explode('/', trim($category->path,'/'));
2786                 $categoryids[] = array_shift($bits);
2787             }
2788             $categoryids = array_unique($categoryids);
2789             $categories->close();
2791             // Now we load the base categories.
2792             list($sql, $params) = $DB->get_in_or_equal($categoryids);
2793             $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent = 0', $params, 'sortorder, id');
2794             foreach ($categories as $category) {
2795                 $this->add_category($category, $this->rootnodes['mycourses'], self::TYPE_MY_CATEGORY);
2796             }
2797             $categories->close();
2798         } else {
2799             foreach ($courses as $course) {
2800                 $this->add_course($course, false, self::COURSE_MY);
2801             }
2802         }
2803     }
2806 /**
2807  * The global navigation class used especially for AJAX requests.
2808  *
2809  * The primary methods that are used in the global navigation class have been overriden
2810  * to ensure that only the relevant branch is generated at the root of the tree.
2811  * This can be done because AJAX is only used when the backwards structure for the
2812  * requested branch exists.
2813  * This has been done only because it shortens the amounts of information that is generated
2814  * which of course will speed up the response time.. because no one likes laggy AJAX.
2815  *
2816  * @package   core
2817  * @category  navigation
2818  * @copyright 2009 Sam Hemelryk
2819  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2820  */
2821 class global_navigation_for_ajax extends global_navigation {
2823     /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2824     protected $branchtype;
2826     /** @var int the instance id */
2827     protected $instanceid;
2829     /** @var array Holds an array of expandable nodes */
2830     protected $expandable = array();
2832     /**
2833      * Constructs the navigation for use in an AJAX request
2834      *
2835      * @param moodle_page $page moodle_page object
2836      * @param int $branchtype
2837      * @param int $id
2838      */
2839     public function __construct($page, $branchtype, $id) {
2840         $this->page = $page;
2841         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2842         $this->children = new navigation_node_collection();
2843         $this->branchtype = $branchtype;
2844         $this->instanceid = $id;
2845         $this->initialise();
2846     }
2847     /**
2848      * Initialise the navigation given the type and id for the branch to expand.
2849      *
2850      * @return array An array of the expandable nodes
2851      */
2852     public function initialise() {
2853         global $DB, $SITE;
2855         if ($this->initialised || during_initial_install()) {
2856             return $this->expandable;
2857         }
2858         $this->initialised = true;
2860         $this->rootnodes = array();
2861         $this->rootnodes['site']    = $this->add_course($SITE);
2862         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self::TYPE_ROOTNODE, null, 'mycourses');
2863         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2864         // The courses branch is always displayed, and is always expandable (although may be empty).
2865         // This mimicks what is done during {@link global_navigation::initialise()}.
2866         $this->rootnodes['courses']->isexpandable = true;
2868         // Branchtype will be one of navigation_node::TYPE_*
2869         switch ($this->branchtype) {
2870             case 0:
2871                 if ($this->instanceid === 'mycourses') {
2872                     $this->load_courses_enrolled();
2873                 } else if ($this->instanceid === 'courses') {
2874                     $this->load_courses_other();
2875                 }
2876                 break;
2877             case self::TYPE_CATEGORY :
2878                 $this->load_category($this->instanceid);
2879                 break;
2880             case self::TYPE_MY_CATEGORY :
2881                 $this->load_category($this->instanceid, self::TYPE_MY_CATEGORY);
2882                 break;
2883             case self::TYPE_COURSE :
2884                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
2885                 if (!can_access_course($course, null, '', true)) {
2886                     // Thats OK all courses are expandable by default. We don't need to actually expand it we can just
2887                     // add the course node and break. This leads to an empty node.
2888                     $this->add_course($course);
2889                     break;
2890                 }
2891                 require_course_login($course, true, null, false, true);
2892                 $this->page->set_context(context_course::instance($course->id));
2893                 $coursenode = $this->add_course($course);
2894                 $this->add_course_essentials($coursenode, $course);
2895                 $this->load_course_sections($course, $coursenode);
2896                 break;
2897             case self::TYPE_SECTION :
2898                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2899                         FROM {course} c
2900                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2901                         WHERE cs.id = ?';
2902                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
2903                 require_course_login($course, true, null, false, true);
2904                 $this->page->set_context(context_course::instance($course->id));
2905                 $coursenode = $this->add_course($course);
2906                 $this->add_course_essentials($coursenode, $course);
2907                 $this->load_course_sections($course, $coursenode, $course->sectionnumber);
2908                 break;
2909             case self::TYPE_ACTIVITY :
2910                 $sql = "SELECT c.*
2911                           FROM {course} c
2912                           JOIN {course_modules} cm ON cm.course = c.id
2913                          WHERE cm.id = :cmid";
2914                 $params = array('cmid' => $this->instanceid);
2915                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
2916                 $modinfo = get_fast_modinfo($course);
2917                 $cm = $modinfo->get_cm($this->instanceid);
2918                 require_course_login($course, true, $cm, false, true);
2919                 $this->page->set_context(context_module::instance($cm->id));
2920                 $coursenode = $this->load_course($course);
2921                 $this->load_course_sections($course, $coursenode, null, $cm);
2922                 $activitynode = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
2923                 if ($activitynode) {
2924                     $modulenode = $this->load_activity($cm, $course, $activitynode);
2925                 }
2926                 break;
2927             default:
2928                 throw new Exception('Unknown type');
2929                 return $this->expandable;
2930         }
2932         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) {
2933             $this->load_for_user(null, true);
2934         }
2936         $this->find_expandable($this->expandable);
2937         return $this->expandable;
2938     }
2940     /**
2941      * They've expanded the general 'courses' branch.
2942      */
2943     protected function load_courses_other() {
2944         $this->load_all_courses();
2945     }
2947     /**
2948      * Loads a single category into the AJAX navigation.
2949      *
2950      * This function is special in that it doesn't concern itself with the parent of
2951      * the requested category or its siblings.
2952      * This is because with the AJAX navigation we know exactly what is wanted and only need to
2953      * request that.
2954      *
2955      * @global moodle_database $DB
2956      * @param int $categoryid id of category to load in navigation.
2957      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
2958      * @return void.
2959      */
2960     protected function load_category($categoryid, $nodetype = self::TYPE_CATEGORY) {
2961         global $CFG, $DB;
2963         $limit = 20;
2964         if (!empty($CFG->navcourselimit)) {
2965             $limit = (int)$CFG->navcourselimit;
2966         }
2968         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
2969         $sql = "SELECT cc.*, $catcontextsql
2970                   FROM {course_categories} cc
2971                   JOIN {context} ctx ON cc.id = ctx.instanceid
2972                  WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND
2973                        (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2974               ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2975         $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2976         $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2977         $categorylist = array();
2978         $subcategories = array();
2979         $basecategory = null;
2980         foreach ($categories as $category) {
2981             $categorylist[] = $category->id;
2982             context_helper::preload_from_record($category);
2983             if ($category->id == $categoryid) {
2984                 $this->add_category($category, $this, $nodetype);
2985                 $basecategory = $this->addedcategories[$category->id];
2986             } else {
2987                 $subcategories[$category->id] = $category;
2988             }
2989         }
2990         $categories->close();
2993         // If category is shown in MyHome then only show enrolled courses and hide empty subcategories,
2994         // else show all courses.
2995         if ($nodetype === self::TYPE_MY_CATEGORY) {
2996             $courses = enrol_get_my_courses();
2997             $categoryids = array();
2999             // Only search for categories if basecategory was found.
3000             if (!is_null($basecategory)) {
3001                 // Get course parent category ids.
3002                 foreach ($courses as $course) {
3003                     $categoryids[] = $course->category;
3004                 }
3006                 // Get a unique list of category ids which a part of the path
3007                 // to user's courses.
3008                 $coursesubcategories = array();
3009                 $addedsubcategories = array();
3011                 list($sql, $params) = $DB->get_in_or_equal($categoryids);
3012                 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path');
3014                 foreach ($categories as $category){
3015                     $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path, "/")));
3016                 }
3017                 $coursesubcategories = array_unique($coursesubcategories);
3019                 // Only add a subcategory if it is part of the path to user's course and
3020                 // wasn't already added.
3021                 foreach ($subcategories as $subid => $subcategory) {
3022                     if (in_array($subid, $coursesubcategories) &&
3023                             !in_array($subid, $addedsubcategories)) {
3024                             $this->add_category($subcategory, $basecategory, $nodetype);
3025                             $addedsubcategories[] = $subid;
3026                     }
3027                 }
3028             }
3030             foreach ($courses as $course) {
3031                 // Add course if it's in category.
3032                 if (in_array($course->category, $categorylist)) {
3033                     $this->add_course($course, true, self::COURSE_MY);
3034                 }
3035             }
3036         } else {
3037             if (!is_null($basecategory)) {
3038                 foreach ($subcategories as $key=>$category) {
3039                     $this->add_category($category, $basecategory, $nodetype);
3040                 }
3041             }
3042             $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
3043             foreach ($courses as $course) {
3044                 $this->add_course($course);
3045             }
3046             $courses->close();
3047         }
3048     }
3050     /**
3051      * Returns an array of expandable nodes
3052      * @return array
3053      */
3054     public function get_expandable() {
3055         return $this->expandable;
3056     }
3059 /**
3060  * Navbar class
3061  *
3062  * This class is used to manage the navbar, which is initialised from the navigation
3063  * object held by PAGE
3064  *
3065  * @package   core
3066  * @category  navigation
3067  * @copyright 2009 Sam Hemelryk
3068  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3069  */
3070 class navbar extends navigation_node {
3071     /** @var bool A switch for whether the navbar is initialised or not */
3072     protected $initialised = false;
3073     /** @var mixed keys used to reference the nodes on the navbar */
3074     protected $keys = array();
3075     /** @var null|string content of the navbar */
3076     protected $content = null;
3077     /** @var moodle_page object the moodle page that this navbar belongs to */
3078     protected $page;
3079     /** @var bool A switch for whether to ignore the active navigation information */
3080     protected $ignoreactive = false;
3081     /** @var bool A switch to let us know if we are in the middle of an install */
3082     protected $duringinstall = false;
3083     /** @var bool A switch for whether the navbar has items */
3084     protected $hasitems = false;
3085     /** @var array An array of navigation nodes for the navbar */
3086     protected $items;
3087     /** @var array An array of child node objects */
3088     public $children = array();
3089     /** @var bool A switch for whether we want to include the root node in the navbar */
3090     public $includesettingsbase = false;
3091     /** @var breadcrumb_navigation_node[] $prependchildren */
3092     protected $prependchildren = array();
3093     /**
3094      * The almighty constructor
3095      *
3096      * @param moodle_page $page
3097      */
3100     public function __construct(moodle_page $page) {
3101         global $CFG;
3102         if (during_initial_install()) {
3103             $this->duringinstall = true;
3104             return false;
3105         }
3106         $this->page = $page;
3107         $this->text = get_string('home');
3108         $this->shorttext = get_string('home');
3109         $this->action = new moodle_url($CFG->wwwroot);
3110         $this->nodetype = self::NODETYPE_BRANCH;
3111         $this->type = self::TYPE_SYSTEM;
3112     }
3114     /**
3115      * Quick check to see if the navbar will have items in.
3116      *
3117      * @return bool Returns true if the navbar will have items, false otherwise
3118      */
3119     public function has_items() {
3120         if ($this->duringinstall) {
3121             return false;
3122         } else if ($this->hasitems !== false) {
3123             return true;
3124         }
3125         if (count($this->children) > 0 || count($this->prependchildren) > 0) {
3126             // There have been manually added items - there are definitely items.
3127             $outcome = true;
3128         } else if (!$this->ignoreactive) {
3129             // We will need to initialise the navigation structure to check if there are active items.
3130             $this->page->navigation->initialise($this->page);
3131             $outcome = ($this->page->navigation->contains_active_node() || $this->page->settingsnav->contains_active_node());
3132         }
3133         $this->hasitems = $outcome;
3134         return $outcome;
3135     }
3137     /**
3138      * Turn on/off ignore active
3139      *
3140      * @param bool $setting
3141      */
3142     public function ignore_active($setting=true) {
3143         $this->ignoreactive = ($setting);
3144     }
3146     /**
3147      * Gets a navigation node
3148      *
3149      * @param string|int $key for referencing the navbar nodes
3150      * @param int $type breadcrumb_navigation_node::TYPE_*
3151      * @return breadcrumb_navigation_node|bool
3152      */
3153     public function get($key, $type = null) {
3154         foreach ($this->children as &$child) {
3155             if ($child->key === $key && ($type == null || $type == $child->type)) {
3156                 return $child;
3157             }
3158         }
3159         foreach ($this->prependchildren as &$child) {
3160             if ($child->key === $key && ($type == null || $type == $child->type)) {
3161                 return $child;
3162             }
3163         }
3164         return false;
3165     }
3166     /**
3167      * Returns an array of breadcrumb_navigation_nodes that make up the navbar.
3168      *
3169      * @return array
3170      */
3171     public function get_items() {
3172         global $CFG;
3173         $items = array();
3174         // Make sure that navigation is initialised
3175         if (!$this->has_items()) {
3176             return $items;
3177         }
3178         if ($this->items !== null) {
3179             return $this->items;
3180         }
3182         if (count($this->children) > 0) {
3183             // Add the custom children.
3184             $items = array_reverse($this->children);
3185         }
3187         // Check if navigation contains the active node
3188         if (!$this->ignoreactive) {
3189             // We will need to ensure the navigation has been initialised.
3190             $this->page->navigation->initialise($this->page);
3191             // Now find the active nodes on both the navigation and settings.
3192             $navigationactivenode = $this->page->navigation->find_active_node();
3193             $settingsactivenode = $this->page->settingsnav->find_active_node();
3195             if ($navigationactivenode && $settingsactivenode) {
3196                 // Parse a combined navigation tree
3197                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3198                     if (!$settingsactivenode->mainnavonly) {
3199                         $items[] = new breadcrumb_navigation_node($settingsactivenode);
3200                     }
3201                     $settingsactivenode = $settingsactivenode->parent;
3202                 }
3203                 if (!$this->includesettingsbase) {
3204                     // Removes the first node from the settings (root node) from the list
3205                     array_pop($items);
3206                 }
3207                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3208                     if (!$navigationactivenode->mainnavonly) {
3209                         $items[] = new breadcrumb_navigation_node($navigationactivenode);
3210                     }
3211                     if (!empty($CFG->navshowcategories) &&
3212                             $navigationactivenode->type === self::TYPE_COURSE &&
3213                             $navigationactivenode->parent->key === 'currentcourse') {
3214                         foreach ($this->get_course_categories() as $item) {
3215                             $items[] = new breadcrumb_navigation_node($item);
3216                         }
3217                     }
3218                     $navigationactivenode = $navigationactivenode->parent;
3219                 }
3220             } else if ($navigationactivenode) {
3221                 // Parse the navigation tree to get the active node
3222                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3223                     if (!$navigationactivenode->mainnavonly) {
3224                         $items[] = new breadcrumb_navigation_node($navigationactivenode);
3225                     }
3226                     if (!empty($CFG->navshowcategories) &&
3227                             $navigationactivenode->type === self::TYPE_COURSE &&
3228                             $navigationactivenode->parent->key === 'currentcourse') {
3229                         foreach ($this->get_course_categories() as $item) {
3230                             $items[] = new breadcrumb_navigation_node($item);
3231                         }
3232                     }
3233                     $navigationactivenode = $navigationactivenode->parent;
3234                 }
3235             } else if ($settingsactivenode) {
3236                 // Parse the settings navigation to get the active node
3237                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3238                     if (!$settingsactivenode->mainnavonly) {
3239                         $items[] = new breadcrumb_navigation_node($settingsactivenode);
3240                     }
3241                     $settingsactivenode = $settingsactivenode->parent;
3242                 }
3243             }
3244         }
3246         $items[] = new breadcrumb_navigation_node(array(
3247             'text' => $this->page->navigation->text,
3248             'shorttext' => $this->page->navigation->shorttext,
3249             'key' => $this->page->navigation->key,
3250             'action' => $this->page->navigation->action
3251         ));
3253         if (count($this->prependchildren) > 0) {
3254             // Add the custom children
3255             $items = array_merge($items, array_reverse($this->prependchildren));
3256         }
3258         $this->items = array_reverse($items);
3259         return $this->items;
3260     }
3262     /**
3263      * Get the list of categories leading to this course.
3264      *
3265      * This function is used by {@link navbar::get_items()} to add back the "courses"
3266      * node and category chain leading to the current course.  Note that this is only ever
3267      * called for the current course, so we don't need to bother taking in any parameters.
3268      *
3269      * @return array
3270      */
3271     private function get_course_categories() {
3272         global $CFG;
3273         require_once($CFG->dirroot.'/course/lib.php');
3274         require_once($CFG->libdir.'/coursecatlib.php');
3276         $categories = array();
3277         $cap = 'moodle/category:viewhiddencategories';
3278         $showcategories = coursecat::count_all() > 1;
3280         if ($showcategories) {
3281             foreach ($this->page->categories as $category) {
3282                 if (!$category->visible && !has_capability($cap, get_category_or_system_context($category->parent))) {
3283                     continue;
3284                 }
3285                 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
3286                 $name = format_string($category->name, true, array('context' => context_coursecat::instance($category->id)));
3287                 $categorynode = breadcrumb_navigation_node::create($name, $url, self::TYPE_CATEGORY, null, $category->id);
3288                 if (!$category->visible) {
3289                     $categorynode->hidden = true;
3290                 }
3291                 $categories[] = $categorynode;
3292             }
3293         }
3295         // Don't show the 'course' node if enrolled in this course.
3296         if (!is_enrolled(context_course::instance($this->page->course->id, null, '', true))) {
3297             $courses = $this->page->navigation->get('courses');
3298             if (!$courses) {
3299                 // Courses node may not be present.
3300                 $courses = breadcrumb_navigation_node::create(
3301                     get_string('courses'),
3302                     new moodle_url('/course/index.php'),
3303                     self::TYPE_CONTAINER
3304                 );
3305             }
3306             $categories[] = $courses;
3307         }
3309         return $categories;
3310     }
3312     /**
3313      * Add a new breadcrumb_navigation_node to the navbar, overrides parent::add
3314      *
3315      * This function overrides {@link breadcrumb_navigation_node::add()} so that we can change
3316      * the way nodes get added to allow us to simply call add and have the node added to the
3317      * end of the navbar
3318      *
3319      * @param string $text
3320      * @param string|moodle_url|action_link $action An action to associate with this node.
3321      * @param int $type One of navigation_node::TYPE_*
3322      * @param string $shorttext
3323      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3324      * @param pix_icon $icon An optional icon to use for this node.
3325      * @return navigation_node
3326      */
3327     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3328         if ($this->content !== null) {
3329             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3330         }
3332         // Properties array used when creating the new navigation node
3333         $itemarray = array(
3334             'text' => $text,
3335             'type' => $type
3336         );
3337         // Set the action if one was provided
3338         if ($action!==null) {
3339             $itemarray['action'] = $action;
3340         }
3341         // Set the shorttext if one was provided
3342         if ($shorttext!==null) {
3343             $itemarray['shorttext'] = $shorttext;
3344         }
3345         // Set the icon if one was provided
3346         if ($icon!==null) {
3347             $itemarray['icon'] = $icon;
3348         }
3349         // Default the key to the number of children if not provided
3350         if ($key === null) {
3351             $key = count($this->children);
3352         }
3353         // Set the key
3354         $itemarray['key'] = $key;
3355         // Set the parent to this node
3356         $itemarray['parent'] = $this;
3357         // Add the child using the navigation_node_collections add method
3358         $this->children[] = new breadcrumb_navigation_node($itemarray);
3359         return $this;
3360     }
3362     /**
3363      * Prepends a new navigation_node to the start of the navbar
3364      *
3365      * @param string $text
3366      * @param string|moodle_url|action_link $action An action to associate with this node.
3367      * @param int $type One of navigation_node::TYPE_*
3368      * @param string $shorttext
3369      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3370      * @param pix_icon $icon An optional icon to use for this node.
3371      * @return navigation_node
3372      */
3373     public function prepend($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3374         if ($this->content !== null) {
3375             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3376         }
3377         // Properties array used when creating the new navigation node.
3378         $itemarray = array(
3379             'text' => $text,
3380             'type' => $type
3381         );
3382         // Set the action if one was provided.
3383         if ($action!==null) {
3384             $itemarray['action'] = $action;
3385         }
3386         // Set the shorttext if one was provided.
3387         if ($shorttext!==null) {
3388             $itemarray['shorttext'] = $shorttext;
3389         }
3390         // Set the icon if one was provided.
3391         if ($icon!==null) {
3392             $itemarray['icon'] = $icon;
3393         }
3394         // Default the key to the number of children if not provided.
3395         if ($key === null) {
3396             $key = count($this->children);
3397         }
3398         // Set the key.
3399         $itemarray['key'] = $key;
3400         // Set the parent to this node.
3401         $itemarray['parent'] = $this;
3402         // Add the child node to the prepend list.
3403         $this->prependchildren[] = new breadcrumb_navigation_node($itemarray);
3404         return $this;
3405     }
3408 /**
3409  * Subclass of navigation_node allowing different rendering for the breadcrumbs
3410  * in particular adding extra metadata for search engine robots to leverage.
3411  *
3412  * @package   core
3413  * @category  navigation
3414  * @copyright 2015 Brendan Heywood
3415  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3416  */
3417 class breadcrumb_navigation_node extends navigation_node {
3419     /**
3420      * A proxy constructor
3421      *
3422      * @param mixed $navnode A navigation_node or an array
3423      */
3424     public function __construct($navnode) {
3425         if (is_array($navnode)) {
3426             parent::__construct($navnode);
3427         } else if ($navnode instanceof navigation_node) {
3429             // Just clone everything.
3430             $objvalues = get_object_vars($navnode);
3431             foreach ($objvalues as $key => $value) {
3432                  $this->$key = $value;
3433             }
3434         } else {
3435             throw coding_exception('Not a valid breadcrumb_navigation_node');
3436         }
3437     }
3441 /**
3442  * Class used to manage the settings option for the current page
3443  *
3444  * This class is used to manage the settings options in a tree format (recursively)
3445  * and was created initially for use with the settings blocks.
3446  *
3447  * @package   core
3448  * @category  navigation
3449  * @copyright 2009 Sam Hemelryk
3450  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3451  */
3452 class settings_navigation extends navigation_node {
3453     /** @var stdClass the current context */
3454     protected $context;
3455     /** @var moodle_page the moodle page that the navigation belongs to */
3456     protected $page;
3457     /** @var string contains administration section navigation_nodes */
3458     protected $adminsection;
3459     /** @var bool A switch to see if the navigation node is initialised */
3460     protected $initialised = false;
3461     /** @var array An array of users that the nodes can extend for. */
3462     protected $userstoextendfor = array();
3463     /** @var navigation_cache **/
3464     protected $cache;
3466     /**
3467      * Sets up the object with basic settings and preparse it for use
3468      *
3469      * @param moodle_page $page
3470      */
3471     public function __construct(moodle_page &$page) {
3472         if (during_initial_install()) {
3473             return false;
3474         }
3475         $this->page = $page;
3476         // Initialise the main navigation. It is most important that this is done
3477         // before we try anything
3478         $this->page->navigation->initialise();
3479         // Initialise the navigation cache
3480         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
3481         $this->children = new navigation_node_collection();
3482     }
3483     /**
3484      * Initialise the settings navigation based on the current context
3485      *
3486      * This function initialises the settings navigation tree for a given context
3487      * by calling supporting functions to generate major parts of the tree.
3488      *
3489      */
3490     public function initialise() {
3491         global $DB, $SESSION, $SITE;
3493         if (during_initial_install()) {
3494             return false;
3495         } else if ($this->initialised) {
3496             return true;
3497         }
3498         $this->id = 'settingsnav';
3499         $this->context = $this->page->context;
3501         $context = $this->context;
3502         if ($context->contextlevel == CONTEXT_BLOCK) {
3503             $this->load_block_settings();
3504             $context = $context->get_parent_context();
3505         }
3506         switch ($context->contextlevel) {
3507             case CONTEXT_SYSTEM:
3508                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
3509                     $this->load_front_page_settings(($context->id == $this->context->id));
3510                 }
3511                 break;
3512             case CONTEXT_COURSECAT:
3513                 $this->load_category_settings();
3514                 break;
3515             case CONTEXT_COURSE:
3516                 if ($this->page->course->id != $SITE->id) {
3517                     $this->load_course_settings(($context->id == $this->context->id));
3518                 } else {
3519                     $this->load_front_page_settings(($context->id == $this->context->id));
3520                 }
3521                 break;
3522             case CONTEXT_MODULE:
3523                 $this->load_module_settings();
3524                 $this->load_course_settings();
3525                 break;
3526             case CONTEXT_USER:
3527                 if ($this->page->course->id != $SITE->id) {
3528                     $this->load_course_settings();
3529                 }
3530                 break;
3531         }
3533         $usersettings = $this->load_user_settings($this->page->course->id);
3535         $adminsettings = false;
3536         if (isloggedin() && !isguestuser() && (!isset($SESSION->load_navigation_admin) || $SESSION->load_navigation_admin)) {
3537             $isadminpage = $this->is_admin_tree_needed();
3539             if (has_capability('moodle/site:config', context_system::instance())) {
3540                 // Make sure this works even if config capability changes on the fly
3541                 // and also make it fast for admin right after login.
3542                 $SESSION->load_navigation_admin = 1;
3543                 if ($isadminpage) {
3544                     $adminsettings = $this->load_administration_settings();
3545                 }
3547             } else if (!isset($SESSION->load_navigation_admin)) {
3548                 $adminsettings = $this->load_administration_settings();
3549                 $SESSION->load_navigation_admin = (int)($adminsettings->children->count() > 0);
3551             } else if ($SESSION->load_navigation_admin) {
3552                 if ($isadminpage) {
3553                     $adminsettings = $this->load_administration_settings();
3554                 }
3555             }
3557             // Print empty navigation node, if needed.
3558             if ($SESSION->load_navigation_admin && !$isadminpage) {
3559                 if ($adminsettings) {
3560                     // Do not print settings tree on pages that do not need it, this helps with performance.
3561                     $adminsettings->remove();
3562                     $adminsettings = false;
3563                 }
3564                 $siteadminnode = $this->add(get_string('administrationsite'), new moodle_url('/admin'), self::TYPE_SITE_ADMIN, null, 'siteadministration');
3565                 $siteadminnode->id = 'expandable_branch_'.$siteadminnode->type.'_'.clean_param($siteadminnode->key, PARAM_ALPHANUMEXT);
3566                 $siteadminnode->requiresajaxloading = 'true';
3567             }
3568         }
3570         if ($context->contextlevel == CONTEXT_SYSTEM && $adminsettings) {
3571             $adminsettings->force_open();
3572         } else if ($context->contextlevel == CONTEXT_USER && $usersettings) {
3573             $usersettings->force_open();
3574         }
3576         // At this point we give any local plugins the ability to extend/tinker with the navigation settings.
3577         $this->load_local_plugin_settings();
3579         foreach ($this->children as $key=>$node) {
3580             if ($node->nodetype == self::NODETYPE_BRANCH && $node->children->count() == 0) {
3581                 // Site administration is shown as link.
3582                 if (!empty($SESSION->load_navigation_admin) && ($node->type === self::TYPE_SITE_ADMIN)) {
3583                     continue;
3584                 }
3585                 $node->remove();
3586             }
3587         }
3588         $this->initialised = true;
3589     }
3590     /**
3591      * Override the parent function so that we can add preceeding hr's and set a
3592      * root node class against all first level element
3593      *
3594      * It does this by first calling the parent's add method {@link navigation_node::add()}
3595      * and then proceeds to use the key to set class and hr
3596      *
3597      * @param string $text text to be used for the link.
3598      * @param string|moodle_url $url url for the new node
3599      * @param int $type the type of node navigation_node::TYPE_*
3600      * @param string $shorttext
3601      * @param string|int $key a key to access the node by.
3602      * @param pix_icon $icon An icon that appears next to the node.
3603      * @return navigation_node with the new node added to it.
3604      */
3605     public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
3606         $node = parent::add($text, $url, $type, $shorttext, $key, $icon);
3607         $node->add_class('root_node');
3608         return $node;
3609     }
3611     /**
3612      * This function allows the user to add something to the start of the settings
3613      * navigation, which means it will be at the top of the settings navigation block
3614      *
3615      * @param string $text text to be used for the link.
3616      * @param string|moodle_url $url url for the new node
3617      * @param int $type the type of node navigation_node::TYPE_*
3618      * @param string $shorttext
3619      * @param string|int $key a key to access the node by.
3620      * @param pix_icon $icon An icon that appears next to the node.
3621      * @return navigation_node $node with the new node added to it.
3622      */
3623     public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
3624         $children = $this->children;
3625         $childrenclass = get_class($children);
3626         $this->children = new $childrenclass;
3627         $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
3628         foreach ($children as $child) {
3629             $this->children->add($child);
3630         }
3631         return $node;
3632     }
3634     /**
3635      * Does this page require loading of full admin tree or is
3636      * it enough rely on AJAX?
3637      *
3638      * @return bool
3639      */
3640     protected function is_admin_tree_needed() {
3641         if (self::$loadadmintree) {
3642             // Usually external admin page or settings page.
3643             return true;
3644         }
3646         if ($this->page->pagelayout === 'admin' or strpos($this->page->pagetype, 'admin-') === 0) {
3647             // Admin settings tree is intended for system level settings and management only, use navigation for the rest!
3648             if ($this->page->context->contextlevel != CONTEXT_SYSTEM) {
3649                 return false;
3650             }
3651             return true;
3652         }
3654         return false;
3655     }
3657     /**
3658      * Load the site administration tree
3659      *
3660      * This function loads the site administration tree by using the lib/adminlib library functions
3661      *
3662      * @param navigation_node $referencebranch A reference to a branch in the settings
3663      *      navigation tree
3664      * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
3665      *      tree and start at the beginning
3666      * @return mixed A key to access the admin tree by
3667      */
3668     protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) {
3669         global $CFG;
3671         // Check if we are just starting to generate this navigation.
3672         if ($referencebranch === null) {
3674             // Require the admin lib then get an admin structure
3675             if (!function_exists('admin_get_root')) {
3676                 require_once($CFG->dirroot.'/lib/adminlib.php');
3677             }
3678             $adminroot = admin_get_root(false, false);
3679             // This is the active section identifier
3680             $this->adminsection = $this->page->url->param('section');
3682             // Disable the navigation from automatically finding the active node
3683             navigation_node::$autofindactive = false;
3684             $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SITE_ADMIN, null, 'root');
3685             foreach ($adminroot->children as $adminbranch) {
3686                 $this->load_administration_settings($referencebranch, $adminbranch);
3687             }
3688             navigation_node::$autofindactive = true;
3690             // Use the admin structure to locate the active page
3691             if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) {
3692                 $currentnode = $this;
3693                 while (($pathkey = array_pop($current->path))!==null && $currentnode) {
3694                     $currentnode = $currentnode->get($pathkey);
3695                 }
3696                 if ($currentnode) {
3697                     $currentnode->make_active();
3698                 }
3699             } else {
3700                 $this->scan_for_active_node($referencebranch);
3701             }
3702             return $referencebranch;
3703         } else if ($adminbranch->check_access()) {
3704             // We have a reference branch that we can access and is not hidden `hurrah`
3705             // Now we need to display it and any children it may have
3706             $url = null;
3707             $icon = null;
3708             if ($adminbranch instanceof admin_settingpage) {
3709                 $url = new moodle_url('/'.$CFG->admin.'/settings.php', array('section'=>$adminbranch->name));
3710             } else if ($adminbranch instanceof admin_externalpage) {
3711                 $url = $adminbranch->url;
3712             } else if (!empty($CFG->linkadmincategories) && $adminbranch instanceof admin_category) {
3713                 $url = new moodle_url('/'.$CFG->admin.'/category.php', array('category' => $adminbranch->name));
3714             }
3716             // Add the branch
3717             $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon);
3719             if ($adminbranch->is_hidden()) {
3720                 if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) {
3721                     $reference->add_class('hidden');
3722                 } else {
3723                     $reference->display = false;
3724                 }
3725             }
3727             // Check if we are generating the admin notifications and whether notificiations exist
3728             if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) {
3729                 $reference->add_class('criticalnotification');
3730             }
3731             // Check if this branch has children
3732             if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) {
3733                 foreach ($adminbranch->children as $branch) {
3734                     // Generate the child branches as well now using this branch as the reference
3735                     $this->load_administration_settings($reference, $branch);
3736                 }
3737             } else {
3738                 $reference->icon = new pix_icon('i/settings', '');
3739             }
3740         }
3741     }
3743     /**
3744      * This function recursivily scans nodes until it finds the active node or there
3745      * are no more nodes.
3746      * @param navigation_node $node
3747      */
3748     protected function scan_for_active_node(navigation_node $node) {
3749         if (!$node->check_if_active() && $node->children->count()>0) {
3750             foreach ($node->children as &$child) {
3751                 $this->scan_for_active_node($child);
3752             }
3753         }
3754     }
3756     /**
3757      * Gets a navigation node given an array of keys that represent the path to
3758      * the desired node.
3759      *
3760      * @param array $path
3761      * @return navigation_node|false
3762      */
3763     protected function get_by_path(array $path) {
3764         $node = $this->get(array_shift($path));
3765         foreach ($path as $key) {
3766             $node->get($key);
3767         }
3768         return $node;
3769     }
3771     /**
3772      * This function loads the course settings that are available for the user
3773      *
3774      * @param bool $forceopen If set to true the course node will be forced open
3775      * @return navigation_node|false
3776      */
3777     protected function load_course_settings($forceopen = false) {
3778         global $CFG;
3779         require_once($CFG->dirroot . '/course/lib.php');
3781         $course = $this->page->course;
3782         $coursecontext = context_course::instance($course->id);
3783         $adminoptions = course_get_user_administration_options($course, $coursecontext);
3785         // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
3787         $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin');
3788         if ($forceopen) {
3789             $coursenode->force_open();
3790         }
3792         if ($this->page->user_allowed_editing()) {
3793             // Add the turn on/off settings
3795             if ($this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
3796                 // We are on the course page, retain the current page params e.g. section.
3797                 $baseurl = clone($this->page->url);
3798                 $baseurl->param('sesskey', sesskey());
3799             } else {
3800                 // Edit on the main course page.
3801                 $baseurl = new moodle_url('/course/view.php', array('id'=>$course->id, 'return'=>$this->page->url->out_as_local_url(false), 'sesskey'=>sesskey()));
3802             }
3804             $editurl = clone($baseurl);
3805             if ($this->page->user_is_editing()) {
3806                 $editurl->param('edit', 'off');
3807                 $editstring = get_string('turneditingoff');
3808             } else {
3809                 $editurl->param('edit', 'on');
3810                 $editstring = get_string('turneditingon');
3811             }
3812             $coursenode->add($editstring, $editurl, self::TYPE_SETTING, null, 'turneditingonoff', new pix_icon('i/edit', ''));
3813         }
3815         if ($adminoptions->update) {
3816             // Add the course settings link