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