MDL-27855 navigation - only display participants link with permissions
[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 array */
941     protected $extendforuser = array();
942     /** @var navigation_cache */
943     protected $cache;
944     /** @var array */
945     protected $addedcourses = array();
946     /** @var array */
947     protected $addedcategories = array();
948     /** @var int */
949     protected $expansionlimit = 0;
950     /** @var int */
951     protected $useridtouseforparentchecks = 0;
953     /**
954      * Constructs a new global navigation
955      *
956      * @param moodle_page $page The page this navigation object belongs to
957      */
958     public function __construct(moodle_page $page) {
959         global $CFG, $SITE, $USER;
961         if (during_initial_install()) {
962             return;
963         }
965         if (get_home_page() == HOMEPAGE_SITE) {
966             // We are using the site home for the root element
967             $properties = array(
968                 'key' => 'home',
969                 'type' => navigation_node::TYPE_SYSTEM,
970                 'text' => get_string('home'),
971                 'action' => new moodle_url('/')
972             );
973         } else {
974             // We are using the users my moodle for the root element
975             $properties = array(
976                 'key' => 'myhome',
977                 'type' => navigation_node::TYPE_SYSTEM,
978                 'text' => get_string('myhome'),
979                 'action' => new moodle_url('/my/')
980             );
981         }
983         // Use the parents consturctor.... good good reuse
984         parent::__construct($properties);
986         // Initalise and set defaults
987         $this->page = $page;
988         $this->forceopen = true;
989         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
990     }
992     /**
993      * Mutator to set userid to allow parent to see child's profile
994      * page navigation. See MDL-25805 for initial issue. Linked to it
995      * is an issue explaining why this is a REALLY UGLY HACK thats not
996      * for you to use!
997      *
998      * @param int $userid userid of profile page that parent wants to navigate around. 
999      */
1000     public function set_userid_for_parent_checks($userid) {
1001         $this->useridtouseforparentchecks = $userid;
1002     }
1005     /**
1006      * Initialises the navigation object.
1007      *
1008      * This causes the navigation object to look at the current state of the page
1009      * that it is associated with and then load the appropriate content.
1010      *
1011      * This should only occur the first time that the navigation structure is utilised
1012      * which will normally be either when the navbar is called to be displayed or
1013      * when a block makes use of it.
1014      *
1015      * @return bool
1016      */
1017     public function initialise() {
1018         global $CFG, $SITE, $USER, $DB;
1019         // Check if it has alread been initialised
1020         if ($this->initialised || during_initial_install()) {
1021             return true;
1022         }
1023         $this->initialised = true;
1025         // Set up the five base root nodes. These are nodes where we will put our
1026         // content and are as follows:
1027         // site:        Navigation for the front page.
1028         // myprofile:     User profile information goes here.
1029         // mycourses:   The users courses get added here.
1030         // courses:     Additional courses are added here.
1031         // users:       Other users information loaded here.
1032         $this->rootnodes = array();
1033         if (get_home_page() == HOMEPAGE_SITE) {
1034             // The home element should be my moodle because the root element is the site
1035             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
1036                 $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
1037             }
1038         } else {
1039             // The home element should be the site because the root node is my moodle
1040             $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
1041             if ($CFG->defaulthomepage == HOMEPAGE_MY) {
1042                 // We need to stop automatic redirection
1043                 $this->rootnodes['home']->action->param('redirect', '0');
1044             }
1045         }
1046         $this->rootnodes['site']      = $this->add_course($SITE);
1047         $this->rootnodes['myprofile'] = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
1048         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses');
1049         $this->rootnodes['courses']   = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
1050         $this->rootnodes['users']     = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
1052         // Fetch all of the users courses.
1053         $limit = 20;
1054         if (!empty($CFG->navcourselimit)) {
1055             $limit = $CFG->navcourselimit;
1056         }
1058         if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') == 1) {
1059             // There is only one category so we don't want to show categories
1060             $CFG->navshowcategories = false;
1061         }
1063         $mycourses = enrol_get_my_courses(NULL, 'visible DESC,sortorder ASC', $limit);
1064         $showallcourses = (count($mycourses) == 0 || !empty($CFG->navshowallcourses));
1065         $showcategories = ($showallcourses && !empty($CFG->navshowcategories));
1066         $issite = ($this->page->course->id != SITEID);
1067         $ismycourse = (array_key_exists($this->page->course->id, $mycourses));
1069         // Check if any courses were returned.
1070         if (count($mycourses) > 0) {
1071             // Add all of the users courses to the navigation
1072             foreach ($mycourses as $course) {
1073                 $course->coursenode = $this->add_course($course, false, true);
1074             }
1075         }
1077         if ($showallcourses) {
1078             // Load all courses
1079             $this->load_all_courses();
1080         }
1082         // We always load the frontpage course to ensure it is available without
1083         // JavaScript enabled.
1084         $frontpagecourse = $this->load_course($SITE);
1085         $this->add_front_page_course_essentials($frontpagecourse, $SITE);
1087         $canviewcourseprofile = true;
1089         // Next load context specific content into the navigation
1090         switch ($this->page->context->contextlevel) {
1091             case CONTEXT_SYSTEM :
1092                 // This has already been loaded we just need to map the variable
1093                 $coursenode = $frontpagecourse;
1094                 $this->load_all_categories(null, $showcategories);
1095                 break;
1096             case CONTEXT_COURSECAT :
1097                 // This has already been loaded we just need to map the variable
1098                 $coursenode = $frontpagecourse;
1099                 $this->load_all_categories($this->page->context->instanceid, $showcategories);
1100                 break;
1101             case CONTEXT_BLOCK :
1102             case CONTEXT_COURSE :
1103                 // Load the course associated with the page into the navigation
1104                 $course = $this->page->course;
1105                 if ($showcategories && !$issite && !$ismycourse) {
1106                     $this->load_all_categories($course->category, $showcategories);
1107                 }
1108                 $coursenode = $this->load_course($course);
1110                 // If the course wasn't added then don't try going any further.
1111                 if (!$coursenode) {
1112                     $canviewcourseprofile = false;
1113                     break;
1114                 }
1116                 // If the user is not enrolled then we only want to show the
1117                 // course node and not populate it.
1118                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1120                 // Not enrolled, can't view, and hasn't switched roles
1121                 if (!can_access_course($coursecontext)) {
1122                     // TODO: very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1123                     // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1124                     $isparent = false;
1125                     if ($this->useridtouseforparentchecks) {
1126                         if ($this->useridtouseforparentchecks != $USER->id) {
1127                             $usercontext   = get_context_instance(CONTEXT_USER, $this->useridtouseforparentchecks, MUST_EXIST);
1128                             if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))
1129                                     and has_capability('moodle/user:viewdetails', $usercontext)) {
1130                                 $isparent = true;
1131                             }
1132                         }
1133                     }
1135                     if (!$isparent) {
1136                         $coursenode->make_active();
1137                         $canviewcourseprofile = false;
1138                         break;
1139                     }
1140                 }
1141                 // Add the essentials such as reports etc...
1142                 $this->add_course_essentials($coursenode, $course);
1143                 if ($this->format_display_course_content($course->format)) {
1144                     // Load the course sections
1145                     $sections = $this->load_course_sections($course, $coursenode);
1146                 }
1147                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1148                     $coursenode->make_active();
1149                 }
1150                 break;
1151             case CONTEXT_MODULE :
1152                 $course = $this->page->course;
1153                 $cm = $this->page->cm;
1155                 if ($showcategories && !$issite && !$ismycourse) {
1156                     $this->load_all_categories($course->category, $showcategories);
1157                 }
1159                 // Load the course associated with the page into the navigation
1160                 $coursenode = $this->load_course($course);
1162                 // If the user is not enrolled then we only want to show the
1163                 // course node and not populate it.
1164                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1165                 if (!can_access_course($coursecontext)) {
1166                     if ($coursenode) {
1167                         $coursenode->make_active();
1168                     }
1169                     $canviewcourseprofile = false;
1170                     break;
1171                 }
1173                 $this->add_course_essentials($coursenode, $course);
1174                 // Load the course sections into the page
1175                 $sections = $this->load_course_sections($course, $coursenode);
1176                 if ($course->id != SITEID) {
1177                     // Find the section for the $CM associated with the page and collect
1178                     // its section number.
1179                     if (isset($cm->sectionnum)) {
1180                         $cm->sectionnumber = $cm->sectionnum;
1181                     } else {
1182                         foreach ($sections as $section) {
1183                             if ($section->id == $cm->section) {
1184                                 $cm->sectionnumber = $section->section;
1185                                 break;
1186                             }
1187                         }
1188                     }
1190                     // Load all of the section activities for the section the cm belongs to.
1191                     if (isset($cm->sectionnumber) and !empty($sections[$cm->sectionnumber])) {
1192                         list($sectionarray, $activityarray) = $this->generate_sections_and_activities($course);
1193                         $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, $activityarray);
1194                     } else {
1195                         $activities = array();
1196                         if ($activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course))) {
1197                             // "stealth" activity from unavailable section
1198                             $activities[$cm->id] = $activity;
1199                         }
1200                     }
1201                 } else {
1202                     $activities = array();
1203                     $activities[$cm->id] = $coursenode->get($cm->id, navigation_node::TYPE_ACTIVITY);
1204                 }
1205                 if (!empty($activities[$cm->id])) {
1206                     // Finally load the cm specific navigaton information
1207                     $this->load_activity($cm, $course, $activities[$cm->id]);
1208                     // Check if we have an active ndoe
1209                     if (!$activities[$cm->id]->contains_active_node() && !$activities[$cm->id]->search_for_active_node()) {
1210                         // And make the activity node active.
1211                         $activities[$cm->id]->make_active();
1212                     }
1213                 } else {
1214                     //TODO: something is wrong, what to do? (Skodak)
1215                 }
1216                 break;
1217             case CONTEXT_USER :
1218                 $course = $this->page->course;
1219                 if ($course->id != SITEID) {
1220                     if ($showcategories && !$issite && !$ismycourse) {
1221                         $this->load_all_categories($course->category, $showcategories);
1222                     }
1223                     // Load the course associated with the user into the navigation
1224                     $coursenode = $this->load_course($course);
1225                     // If the user is not enrolled then we only want to show the
1226                     // course node and not populate it.
1227                     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1228                     if (!can_access_course($coursecontext)) {
1229                         $coursenode->make_active();
1230                         $canviewcourseprofile = false;
1231                         break;
1232                     }
1233                     $this->add_course_essentials($coursenode, $course);
1234                     $sections = $this->load_course_sections($course, $coursenode);
1235                 }
1236                 break;
1237         }
1239         $limit = 20;
1240         if (!empty($CFG->navcourselimit)) {
1241             $limit = $CFG->navcourselimit;
1242         }
1243         if ($showcategories) {
1244             $categories = $this->find_all_of_type(self::TYPE_CATEGORY);
1245             foreach ($categories as &$category) {
1246                 if ($category->children->count() >= $limit) {
1247                     $url = new moodle_url('/course/category.php', array('id'=>$category->key));
1248                     $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1249                 }
1250             }
1251         } else if ($this->rootnodes['courses']->children->count() >= $limit) {
1252             $this->rootnodes['courses']->add(get_string('viewallcoursescategories'), new moodle_url('/course/index.php'), self::TYPE_SETTING);
1253         }
1255         // Load for the current user
1256         $this->load_for_user();
1257         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != SITEID && $canviewcourseprofile) {
1258             $this->load_for_user(null, true);
1259         }
1260         // Load each extending user into the navigation.
1261         foreach ($this->extendforuser as $user) {
1262             if ($user->id != $USER->id) {
1263                 $this->load_for_user($user);
1264             }
1265         }
1267         // Give the local plugins a chance to include some navigation if they want.
1268         foreach (get_list_of_plugins('local') as $plugin) {
1269             if (!file_exists($CFG->dirroot.'/local/'.$plugin.'/lib.php')) {
1270                 continue;
1271             }
1272             require_once($CFG->dirroot.'/local/'.$plugin.'/lib.php');
1273             $function = $plugin.'_extends_navigation';
1274             if (function_exists($function)) {
1275                 $function($this);
1276             }
1277         }
1279         // Remove any empty root nodes
1280         foreach ($this->rootnodes as $node) {
1281             // Dont remove the home node
1282             if ($node->key !== 'home' && !$node->has_children()) {
1283                 $node->remove();
1284             }
1285         }
1287         if (!$this->contains_active_node()) {
1288             $this->search_for_active_node();
1289         }
1291         // If the user is not logged in modify the navigation structure as detailed
1292         // in {@link http://docs.moodle.org/en/Development:Navigation_2.0_structure}
1293         if (!isloggedin()) {
1294             $activities = clone($this->rootnodes['site']->children);
1295             $this->rootnodes['site']->remove();
1296             $children = clone($this->children);
1297             $this->children = new navigation_node_collection();
1298             foreach ($activities as $child) {
1299                 $this->children->add($child);
1300             }
1301             foreach ($children as $child) {
1302                 $this->children->add($child);
1303             }
1304         }
1305         return true;
1306     }
1307     /**
1308      * Checks the course format to see whether it wants the navigation to load
1309      * additional information for the course.
1310      *
1311      * This function utilises a callback that can exist within the course format lib.php file
1312      * The callback should be a function called:
1313      * callback_{formatname}_display_content()
1314      * It doesn't get any arguments and should return true if additional content is
1315      * desired. If the callback doesn't exist we assume additional content is wanted.
1316      *
1317      * @param string $format The course format
1318      * @return bool
1319      */
1320     protected function format_display_course_content($format) {
1321         global $CFG;
1322         $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
1323         if (file_exists($formatlib)) {
1324             require_once($formatlib);
1325             $displayfunc = 'callback_'.$format.'_display_content';
1326             if (function_exists($displayfunc) && !$displayfunc()) {
1327                 return $displayfunc();
1328             }
1329         }
1330         return true;
1331     }
1333     /**
1334      * Loads of the the courses in Moodle into the navigation.
1335      *
1336      * @global moodle_database $DB
1337      * @param string|array $categoryids Either a string or array of category ids to load courses for
1338      * @return array An array of navigation_node
1339      */
1340     protected function load_all_courses($categoryids=null) {
1341         global $CFG, $DB, $USER;
1343         if ($categoryids !== null) {
1344             if (is_array($categoryids)) {
1345                 list ($categoryselect, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'catid');
1346             } else {
1347                 $categoryselect = '= :categoryid';
1348                 $params = array('categoryid', $categoryids);
1349             }
1350             $params['siteid'] = SITEID;
1351             $categoryselect = ' AND c.category '.$categoryselect;
1352         } else {
1353             $params = array('siteid' => SITEID);
1354             $categoryselect = '';
1355         }
1357         list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1358         list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses) + array(SITEID), SQL_PARAMS_NAMED, 'lcourse', false);
1359         $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category, cat.path AS categorypath $ccselect
1360                   FROM {course} c
1361                        $ccjoin
1362              LEFT JOIN {course_categories} cat ON cat.id=c.category
1363                  WHERE c.id {$courseids} {$categoryselect}
1364               ORDER BY c.sortorder ASC";
1365         $limit = 20;
1366         if (!empty($CFG->navcourselimit)) {
1367             $limit = $CFG->navcourselimit;
1368         }
1369         $courses = $DB->get_records_sql($sql, $params + $courseparams, 0, $limit);
1371         $coursenodes = array();
1372         foreach ($courses as $course) {
1373             context_instance_preload($course);
1374             $coursenodes[$course->id] = $this->add_course($course);
1375         }
1376         return $coursenodes;
1377     }
1379     /**
1380      * Loads all categories (top level or if an id is specified for that category)
1381      *
1382      * @param int $categoryid The category id to load or null/0 to load all base level categories
1383      * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1384      *        as the requested category and any parent categories.
1385      * @return void
1386      */
1387     protected function load_all_categories($categoryid = null, $showbasecategories = false) {
1388         global $DB;
1390         // Check if this category has already been loaded
1391         if ($categoryid !== null && array_key_exists($categoryid, $this->addedcategories) && $this->addedcategories[$categoryid]->children->count() > 0) {
1392             return $this->addedcategories[$categoryid];
1393         }
1395         $coursestoload = array();
1396         if (empty($categoryid)) { // can be 0
1397             // We are going to load all of the first level categories (categories without parents)
1398             $categories = $DB->get_records('course_categories', array('parent'=>'0'), 'sortorder');
1399         } else if (array_key_exists($categoryid, $this->addedcategories)) {
1400             // The category itself has been loaded already so we just need to ensure its subcategories
1401             // have been loaded
1402             list($sql, $params) = $DB->get_in_or_equal(array_keys($this->addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1403             if ($showbasecategories) {
1404                 // We need to include categories with parent = 0 as well
1405                 $sql = "SELECT *
1406                           FROM {course_categories} cc
1407                          WHERE (parent = :categoryid OR parent = 0) AND
1408                                parent {$sql}
1409                       ORDER BY sortorder";
1410             } else {
1411                 $sql = "SELECT *
1412                           FROM {course_categories} cc
1413                          WHERE parent = :categoryid AND
1414                                parent {$sql}
1415                       ORDER BY sortorder";
1416             }
1417             $params['categoryid'] = $categoryid;
1418             $categories = $DB->get_records_sql($sql, $params);
1419             if (count($categories) == 0) {
1420                 // There are no further categories that require loading.
1421                 return;
1422             }
1423         } else {
1424             // This category hasn't been loaded yet so we need to fetch it, work out its category path
1425             // and load this category plus all its parents and subcategories
1426             $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
1427             $coursestoload = explode('/', trim($category->path, '/'));
1428             list($select, $params) = $DB->get_in_or_equal($coursestoload);
1429             $select = 'id '.$select.' OR parent '.$select;
1430             if ($showbasecategories) {
1431                 $select .= ' OR parent = 0';
1432             }
1433             $params = array_merge($params, $params);
1434             $categories = $DB->get_records_select('course_categories', $select, $params, 'sortorder');
1435         }
1437         // Now we have an array of categories we need to add them to the navigation.
1438         while (!empty($categories)) {
1439             $category = reset($categories);
1440             if (array_key_exists($category->id, $this->addedcategories)) {
1441                 // Do nothing
1442             } else if ($category->parent == '0') {
1443                 $this->add_category($category, $this->rootnodes['courses']);
1444             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1445                 $this->add_category($category, $this->addedcategories[$category->parent]);
1446             } else {
1447                 // This category isn't in the navigation and niether is it's parent (yet).
1448                 // We need to go through the category path and add all of its components in order.
1449                 $path = explode('/', trim($category->path, '/'));
1450                 foreach ($path as $catid) {
1451                     if (!array_key_exists($catid, $this->addedcategories)) {
1452                         // This category isn't in the navigation yet so add it.
1453                         $subcategory = $categories[$catid];
1454                         if (array_key_exists($subcategory->parent, $this->addedcategories)) {
1455                             // The parent is in the category (as we'd expect) so add it now.
1456                             $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1457                             // Remove the category from the categories array.
1458                             unset($categories[$catid]);
1459                         } else {
1460                             // We should never ever arrive here - if we have then there is a bigger
1461                             // problem at hand.
1462                             throw coding_exception('Category path order is incorrect and/or there are missing categories');
1463                         }
1464                     }
1465                 }
1466             }
1467             // Remove the category from the categories array now that we know it has been added.
1468             unset($categories[$category->id]);
1469         }
1470         // Check if there are any categories to load.
1471         if (count($coursestoload) > 0) {
1472             $this->load_all_courses($coursestoload);
1473         }
1474     }
1476     /**
1477      * Adds a structured category to the navigation in the correct order/place
1478      *
1479      * @param stdClass $category
1480      * @param navigation_node $parent
1481      */
1482     protected function add_category(stdClass $category, navigation_node $parent) {
1483         if (array_key_exists($category->id, $this->addedcategories)) {
1484             continue;
1485         }
1486         $url = new moodle_url('/course/category.php', array('id' => $category->id));
1487         $categorynode = $parent->add($category->name, $url, self::TYPE_CATEGORY, $category->name, $category->id);
1488         if (empty($category->visible)) {
1489             if (has_capability('moodle/category:viewhiddencategories', get_system_context())) {
1490                 $categorynode->hidden = true;
1491             } else {
1492                 $categorynode->display = false;
1493             }
1494         }
1495         $this->addedcategories[$category->id] = &$categorynode;
1496     }
1498     /**
1499      * Loads the given course into the navigation
1500      *
1501      * @param stdClass $course
1502      * @return navigation_node
1503      */
1504     protected function load_course(stdClass $course) {
1505         if ($course->id == SITEID) {
1506             return $this->rootnodes['site'];
1507         } else if (array_key_exists($course->id, $this->addedcourses)) {
1508             return $this->addedcourses[$course->id];
1509         } else {
1510             return $this->add_course($course);
1511         }
1512     }
1514     /**
1515      * Loads all of the courses section into the navigation.
1516      *
1517      * This function utilisies a callback that can be implemented within the course
1518      * formats lib.php file to customise the navigation that is generated at this
1519      * point for the course.
1520      *
1521      * By default (if not defined) the method {@see load_generic_course_sections} is
1522      * called instead.
1523      *
1524      * @param stdClass $course Database record for the course
1525      * @param navigation_node $coursenode The course node within the navigation
1526      * @return array Array of navigation nodes for the section with key = section id
1527      */
1528     protected function load_course_sections(stdClass $course, navigation_node $coursenode) {
1529         global $CFG;
1530         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
1531         $structurefunc = 'callback_'.$course->format.'_load_content';
1532         if (function_exists($structurefunc)) {
1533             return $structurefunc($this, $course, $coursenode);
1534         } else if (file_exists($structurefile)) {
1535             require_once $structurefile;
1536             if (function_exists($structurefunc)) {
1537                 return $structurefunc($this, $course, $coursenode);
1538             } else {
1539                 return $this->load_generic_course_sections($course, $coursenode);
1540             }
1541         } else {
1542             return $this->load_generic_course_sections($course, $coursenode);
1543         }
1544     }
1546     /**
1547      * Generates an array of sections and an array of activities for the given course.
1548      *
1549      * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1550      *
1551      * @param stdClass $course
1552      * @return array Array($sections, $activities)
1553      */
1554     protected function generate_sections_and_activities(stdClass $course) {
1555         global $CFG;
1556         require_once($CFG->dirroot.'/course/lib.php');
1558         if (!$this->cache->cached('course_sections_'.$course->id) || !$this->cache->cached('course_activites_'.$course->id)) {
1559             $modinfo = get_fast_modinfo($course);
1560             $sections = array_slice(get_all_sections($course->id), 0, $course->numsections+1, true);
1562             $activities = array();
1564             foreach ($sections as $key => $section) {
1565                 $sections[$key]->hasactivites = false;
1566                 if (!array_key_exists($section->section, $modinfo->sections)) {
1567                     continue;
1568                 }
1569                 foreach ($modinfo->sections[$section->section] as $cmid) {
1570                     $cm = $modinfo->cms[$cmid];
1571                     if (!$cm->uservisible) {
1572                         continue;
1573                     }
1574                     $activity = new stdClass;
1575                     $activity->section = $section->section;
1576                     $activity->name = $cm->name;
1577                     $activity->icon = $cm->icon;
1578                     $activity->iconcomponent = $cm->iconcomponent;
1579                     $activity->id = $cm->id;
1580                     $activity->hidden = (!$cm->visible);
1581                     $activity->modname = $cm->modname;
1582                     $activity->nodetype = navigation_node::NODETYPE_LEAF;
1583                     $url = $cm->get_url();
1584                     if (!$url) {
1585                         $activity->url = null;
1586                         $activity->display = false;
1587                     } else {
1588                         $activity->url = $cm->get_url()->out();
1589                         $activity->display = true;
1590                         if (self::module_extends_navigation($cm->modname)) {
1591                             $activity->nodetype = navigation_node::NODETYPE_BRANCH;
1592                         }
1593                     }
1594                     $activities[$cmid] = $activity;
1595                     $sections[$key]->hasactivites = true;
1596                 }
1597             }
1598             $this->cache->set('course_sections_'.$course->id, $sections);
1599             $this->cache->set('course_activites_'.$course->id, $activities);
1600         } else {
1601             $sections = $this->cache->{'course_sections_'.$course->id};
1602             $activities = $this->cache->{'course_activites_'.$course->id};
1603         }
1604         return array($sections, $activities);
1605     }
1607     /**
1608      * Generically loads the course sections into the course's navigation.
1609      *
1610      * @param stdClass $course
1611      * @param navigation_node $coursenode
1612      * @param string $courseformat The course format
1613      * @return array An array of course section nodes
1614      */
1615     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $courseformat='unknown') {
1616         global $CFG, $DB, $USER;
1617         require_once($CFG->dirroot.'/course/lib.php');
1619         list($sections, $activities) = $this->generate_sections_and_activities($course);
1621         $namingfunction = 'callback_'.$courseformat.'_get_section_name';
1622         $namingfunctionexists = (function_exists($namingfunction));
1623         $activesection = course_get_display($course->id);
1624         $viewhiddensections = has_capability('moodle/course:viewhiddensections', $this->page->context);
1626         $navigationsections = array();
1627         foreach ($sections as $sectionid => $section) {
1628             $section = clone($section);
1629             if ($course->id == SITEID) {
1630                 $this->load_section_activities($coursenode, $section->section, $activities);
1631             } else {
1632                 if ((!$viewhiddensections && !$section->visible) || (!$this->showemptysections && !$section->hasactivites)) {
1633                     continue;
1634                 }
1635                 if ($namingfunctionexists) {
1636                     $sectionname = $namingfunction($course, $section, $sections);
1637                 } else {
1638                     $sectionname = get_string('section').' '.$section->section;
1639                 }
1640                 //$url = new moodle_url('/course/view.php', array('id'=>$course->id));
1641                 $url = null;
1642                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1643                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1644                 $sectionnode->hidden = (!$section->visible);
1645                 if ($this->page->context->contextlevel != CONTEXT_MODULE && $section->hasactivites && ($sectionnode->isactive || ($activesection && $section->section == $activesection))) {
1646                     $sectionnode->force_open();
1647                     $this->load_section_activities($sectionnode, $section->section, $activities);
1648                 }
1649                 $section->sectionnode = $sectionnode;
1650                 $navigationsections[$sectionid] = $section;
1651             }
1652         }
1653         return $navigationsections;
1654     }
1655     /**
1656      * Loads all of the activities for a section into the navigation structure.
1657      *
1658      * @todo 2.2 - $activities should always be an array and we should no longer check for it being a
1659      *             course_modinfo object
1660      *
1661      * @param navigation_node $sectionnode
1662      * @param int $sectionnumber
1663      * @param course_modinfo $modinfo Object returned from {@see get_fast_modinfo()}
1664      * @return array Array of activity nodes
1665      */
1666     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, $activities) {
1668         if ($activities instanceof course_modinfo) {
1669             debugging('global_navigation::load_section_activities argument 3 should now recieve an array of activites. See that method for an example.', DEBUG_DEVELOPER);
1670             list($sections, $activities) = $this->generate_sections_and_activities($activities->course);
1671         }
1673         $activitynodes = array();
1674         foreach ($activities as $activity) {
1675             if ($activity->section != $sectionnumber) {
1676                 continue;
1677             }
1678             if ($activity->icon) {
1679                 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
1680             } else {
1681                 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
1682             }
1683             $activitynode = $sectionnode->add(format_string($activity->name), $activity->url, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
1684             $activitynode->title(get_string('modulename', $activity->modname));
1685             $activitynode->hidden = $activity->hidden;
1686             $activitynode->display = $activity->display;
1687             $activitynode->nodetype = $activity->nodetype;
1688             $activitynodes[$activity->id] = $activitynode;
1689         }
1691         return $activitynodes;
1692     }
1693     /**
1694      * Loads a stealth module from unavailable section
1695      * @param navigation_node $coursenode
1696      * @param stdClass $modinfo
1697      * @return navigation_node or null if not accessible
1698      */
1699     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
1700         if (empty($modinfo->cms[$this->page->cm->id])) {
1701             return null;
1702         }
1703         $cm = $modinfo->cms[$this->page->cm->id];
1704         if (!$cm->uservisible) {
1705             return null;
1706         }
1707         if ($cm->icon) {
1708             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
1709         } else {
1710             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
1711         }
1712         $url = $cm->get_url();
1713         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
1714         $activitynode->title(get_string('modulename', $cm->modname));
1715         $activitynode->hidden = (!$cm->visible);
1716         if (!$url) {
1717             // Don't show activities that don't have links!
1718             $activitynode->display = false;
1719         } else if (self::module_extends_navigation($cm->modname)) {
1720             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
1721         }
1722         return $activitynode;
1723     }
1724     /**
1725      * Loads the navigation structure for the given activity into the activities node.
1726      *
1727      * This method utilises a callback within the modules lib.php file to load the
1728      * content specific to activity given.
1729      *
1730      * The callback is a method: {modulename}_extend_navigation()
1731      * Examples:
1732      *  * {@see forum_extend_navigation()}
1733      *  * {@see workshop_extend_navigation()}
1734      *
1735      * @param cm_info|stdClass $cm
1736      * @param stdClass $course
1737      * @param navigation_node $activity
1738      * @return bool
1739      */
1740     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
1741         global $CFG, $DB;
1743         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
1744         if (!($cm instanceof cm_info)) {
1745             $modinfo = get_fast_modinfo($course);
1746             $cm = $modinfo->get_cm($cm->id);
1747         }
1749         $activity->make_active();
1750         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
1751         $function = $cm->modname.'_extend_navigation';
1753         if (file_exists($file)) {
1754             require_once($file);
1755             if (function_exists($function)) {
1756                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
1757                 $function($activity, $course, $activtyrecord, $cm);
1758                 return true;
1759             }
1760         }
1761         $activity->nodetype = navigation_node::NODETYPE_LEAF;
1762         return false;
1763     }
1764     /**
1765      * Loads user specific information into the navigation in the appopriate place.
1766      *
1767      * If no user is provided the current user is assumed.
1768      *
1769      * @param stdClass $user
1770      * @return bool
1771      */
1772     protected function load_for_user($user=null, $forceforcontext=false) {
1773         global $DB, $CFG, $USER;
1775         if ($user === null) {
1776             // We can't require login here but if the user isn't logged in we don't
1777             // want to show anything
1778             if (!isloggedin() || isguestuser()) {
1779                 return false;
1780             }
1781             $user = $USER;
1782         } else if (!is_object($user)) {
1783             // If the user is not an object then get them from the database
1784             list($select, $join) = context_instance_preload_sql('u.id', CONTEXT_USER, 'ctx');
1785             $sql = "SELECT u.* $select FROM {user} u $join WHERE u.id = :userid";
1786             $user = $DB->get_record_sql($sql, array('userid' => (int)$user), MUST_EXIST);
1787             context_instance_preload($user);
1788         }
1790         $iscurrentuser = ($user->id == $USER->id);
1792         $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1794         // Get the course set against the page, by default this will be the site
1795         $course = $this->page->course;
1796         $baseargs = array('id'=>$user->id);
1797         if ($course->id != SITEID && (!$iscurrentuser || $forceforcontext)) {
1798             $coursenode = $this->load_course($course);
1799             $baseargs['course'] = $course->id;
1800             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1801             $issitecourse = false;
1802         } else {
1803             // Load all categories and get the context for the system
1804             $coursecontext = get_context_instance(CONTEXT_SYSTEM);
1805             $issitecourse = true;
1806         }
1808         // Create a node to add user information under.
1809         if ($iscurrentuser && !$forceforcontext) {
1810             // If it's the current user the information will go under the profile root node
1811             $usernode = $this->rootnodes['myprofile'];
1812         } else {
1813             if (!$issitecourse) {
1814                 // Not the current user so add it to the participants node for the current course
1815                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
1816                 $userviewurl = new moodle_url('/user/view.php', $baseargs);
1817             } else {
1818                 // This is the site so add a users node to the root branch
1819                 $usersnode = $this->rootnodes['users'];
1820                 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
1821                     $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
1822                 }
1823                 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
1824             }
1825             if (!$usersnode) {
1826                 // We should NEVER get here, if the course hasn't been populated
1827                 // with a participants node then the navigaiton either wasn't generated
1828                 // for it (you are missing a require_login or set_context call) or
1829                 // you don't have access.... in the interests of no leaking informatin
1830                 // we simply quit...
1831                 return false;
1832             }
1833             // Add a branch for the current user
1834             $usernode = $usersnode->add(fullname($user, true), $userviewurl, self::TYPE_USER, null, $user->id);
1836             if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
1837                 $usernode->make_active();
1838             }
1839         }
1841         // If the user is the current user or has permission to view the details of the requested
1842         // user than add a view profile link.
1843         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
1844             if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
1845                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
1846             } else {
1847                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
1848             }
1849         }
1851         // Add nodes for forum posts and discussions if the user can view either or both
1852         // There are no capability checks here as the content of the page is based
1853         // purely on the forums the current user has access too.
1854         $forumtab = $usernode->add(get_string('forumposts', 'forum'));
1855         $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
1856         $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
1858         // Add blog nodes
1859         if (!empty($CFG->bloglevel)) {
1860             if (!$this->cache->cached('userblogoptions'.$user->id)) {
1861                 require_once($CFG->dirroot.'/blog/lib.php');
1862                 // Get all options for the user
1863                 $options = blog_get_options_for_user($user);
1864                 $this->cache->set('userblogoptions'.$user->id, $options);
1865             } else {
1866                 $options = $this->cache->{'userblogoptions'.$user->id};
1867             }
1869             if (count($options) > 0) {
1870                 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
1871                 foreach ($options as $option) {
1872                     $blogs->add($option['string'], $option['link']);
1873                 }
1874             }
1875         }
1877         if (!empty($CFG->messaging)) {
1878             $messageargs = null;
1879             if ($USER->id!=$user->id) {
1880                 $messageargs = array('id'=>$user->id);
1881             }
1882             $url = new moodle_url('/message/index.php',$messageargs);
1883             $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
1884         }
1886         $context = get_context_instance(CONTEXT_USER, $USER->id);
1887         if ($iscurrentuser && has_capability('moodle/user:manageownfiles', $context)) {
1888             $url = new moodle_url('/user/files.php');
1889             $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
1890         }
1892         // Add a node to view the users notes if permitted
1893         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
1894             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
1895             if ($coursecontext->instanceid) {
1896                 $url->param('course', $coursecontext->instanceid);
1897             }
1898             $usernode->add(get_string('notes', 'notes'), $url);
1899         }
1901         // Add a reports tab and then add reports the the user has permission to see.
1902         $anyreport      = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
1904         $outlinetreport = ($anyreport || has_capability('coursereport/outline:view', $coursecontext));
1905         $logtodayreport = ($anyreport || has_capability('coursereport/log:viewtoday', $coursecontext));
1906         $logreport      = ($anyreport || has_capability('coursereport/log:view', $coursecontext));
1907         $statsreport    = ($anyreport || has_capability('coursereport/stats:view', $coursecontext));
1909         $somereport     = $outlinetreport || $logtodayreport || $logreport || $statsreport;
1911         $viewreports = ($anyreport || $somereport || ($course->showreports && $iscurrentuser && $forceforcontext));
1912         if ($viewreports) {
1913             $reporttab = $usernode->add(get_string('activityreports'));
1914             $reportargs = array('user'=>$user->id);
1915             if (!empty($course->id)) {
1916                 $reportargs['id'] = $course->id;
1917             } else {
1918                 $reportargs['id'] = SITEID;
1919             }
1920             if ($viewreports || $outlinetreport) {
1921                 $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
1922                 $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
1923             }
1925             if ($viewreports || $logtodayreport) {
1926                 $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
1927             }
1929             if ($viewreports || $logreport ) {
1930                 $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
1931             }
1933             if (!empty($CFG->enablestats)) {
1934                 if ($viewreports || $statsreport) {
1935                     $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
1936                 }
1937             }
1939             $gradeaccess = false;
1940             if (has_capability('moodle/grade:viewall', $coursecontext)) {
1941                 //ok - can view all course grades
1942                 $gradeaccess = true;
1943             } else if ($course->showgrades) {
1944                 if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) {
1945                     //ok - can view own grades
1946                     $gradeaccess = true;
1947                 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
1948                     // ok - can view grades of this user - parent most probably
1949                     $gradeaccess = true;
1950                 } else if ($anyreport) {
1951                     // ok - can view grades of this user - parent most probably
1952                     $gradeaccess = true;
1953                 }
1954             }
1955             if ($gradeaccess) {
1956                 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'grade'))));
1957             }
1959             // Check the number of nodes in the report node... if there are none remove
1960             // the node
1961             $reporttab->trim_if_empty();
1962         }
1964         // If the user is the current user add the repositories for the current user
1965         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
1966         if ($iscurrentuser) {
1967             if (!$this->cache->cached('contexthasrepos'.$usercontext->id)) {
1968                 require_once($CFG->dirroot . '/repository/lib.php');
1969                 $editabletypes = repository::get_editable_types($usercontext);
1970                 $haseditabletypes = !empty($editabletypes);
1971                 unset($editabletypes);
1972                 $this->cache->set('contexthasrepos'.$usercontext->id, $haseditabletypes);
1973             } else {
1974                 $haseditabletypes = $this->cache->{'contexthasrepos'.$usercontext->id};
1975             }
1976             if ($haseditabletypes) {
1977                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
1978             }
1979         } else if ($course->id == SITEID && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
1981             // Add view grade report is permitted
1982             $reports = get_plugin_list('gradereport');
1983             arsort($reports); // user is last, we want to test it first
1985             $userscourses = enrol_get_users_courses($user->id);
1986             $userscoursesnode = $usernode->add(get_string('courses'));
1988             foreach ($userscourses as $usercourse) {
1989                 $usercoursecontext = get_context_instance(CONTEXT_COURSE, $usercourse->id);
1990                 $usercoursenode = $userscoursesnode->add($usercourse->shortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
1992                 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
1993                 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
1994                     foreach ($reports as $plugin => $plugindir) {
1995                         if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
1996                             //stop when the first visible plugin is found
1997                             $gradeavailable = true;
1998                             break;
1999                         }
2000                     }
2001                 }
2003                 if ($gradeavailable) {
2004                     $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
2005                     $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
2006                 }
2008                 // Add a node to view the users notes if permitted
2009                 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2010                     $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
2011                     $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2012                 }
2014                 if (can_access_course(get_context_instance(CONTEXT_COURSE, $usercourse->id), $user->id)) {
2015                     $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', ''));
2016                 }
2018                 $outlinetreport = ($anyreport || has_capability('coursereport/outline:view', $usercoursecontext));
2019                 $logtodayreport = ($anyreport || has_capability('coursereport/log:viewtoday', $usercoursecontext));
2020                 $logreport =      ($anyreport || has_capability('coursereport/log:view', $usercoursecontext));
2021                 $statsreport =    ($anyreport || has_capability('coursereport/stats:view', $usercoursecontext));
2022                 if ($outlinetreport || $logtodayreport || $logreport || $statsreport) {
2023                     $reporttab = $usercoursenode->add(get_string('activityreports'));
2024                     $reportargs = array('user'=>$user->id, 'id'=>$usercourse->id);
2025                     if ($outlinetreport) {
2026                         $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
2027                         $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
2028                     }
2030                     if ($logtodayreport) {
2031                         $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
2032                     }
2034                     if ($logreport) {
2035                         $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
2036                     }
2038                     if (!empty($CFG->enablestats) && $statsreport) {
2039                         $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
2040                     }
2041                 }
2042             }
2043         }
2044         return true;
2045     }
2047     /**
2048      * This method simply checks to see if a given module can extend the navigation.
2049      *
2050      * TODO: A shared caching solution should be used to save details on what extends navigation
2051      *
2052      * @param string $modname
2053      * @return bool
2054      */
2055     protected static function module_extends_navigation($modname) {
2056         global $CFG;
2057         static $extendingmodules = array();
2058         if (!array_key_exists($modname, $extendingmodules)) {
2059             $extendingmodules[$modname] = false;
2060             $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2061             if (file_exists($file)) {
2062                 $function = $modname.'_extend_navigation';
2063                 require_once($file);
2064                 $extendingmodules[$modname] = (function_exists($function));
2065             }
2066         }
2067         return $extendingmodules[$modname];
2068     }
2069     /**
2070      * Extends the navigation for the given user.
2071      *
2072      * @param stdClass $user A user from the database
2073      */
2074     public function extend_for_user($user) {
2075         $this->extendforuser[] = $user;
2076     }
2078     /**
2079      * Returns all of the users the navigation is being extended for
2080      *
2081      * @return array
2082      */
2083     public function get_extending_users() {
2084         return $this->extendforuser;
2085     }
2086     /**
2087      * Adds the given course to the navigation structure.
2088      *
2089      * @param stdClass $course
2090      * @return navigation_node
2091      */
2092     public function add_course(stdClass $course, $forcegeneric = false, $ismycourse = false) {
2093         global $CFG;
2095         // We found the course... we can return it now :)
2096         if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2097             return $this->addedcourses[$course->id];
2098         }
2100         if ($course->id != SITEID && !$course->visible) {
2101             if (is_role_switched($course->id)) {
2102                 // user has to be able to access course in order to switch, let's skip the visibility test here
2103             } else if (!has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
2104                 return false;
2105             }
2106         }
2108         $issite = ($course->id == SITEID);
2109         $ismycourse = ($ismycourse && !$forcegeneric);
2110         $shortname = $course->shortname;
2112         if ($issite) {
2113             $parent = $this;
2114             $url = null;
2115             $shortname = get_string('sitepages');
2116         } else if ($ismycourse) {
2117             $parent = $this->rootnodes['mycourses'];
2118             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2119         } else {
2120             $parent = $this->rootnodes['courses'];
2121             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2122         }
2124         if (!$ismycourse && !$issite && !empty($course->category)) {
2125             if (!empty($CFG->navshowcategories)) {
2126                 // We need to load the category structure for this course
2127                 $this->load_all_categories($course->category);
2128             }
2129             if (array_key_exists($course->category, $this->addedcategories)) {
2130                 $parent = $this->addedcategories[$course->category];
2131                 // This could lead to the course being created so we should check whether it is the case again
2132                 if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2133                     return $this->addedcourses[$course->id];
2134                 }
2135             }
2136         }
2138         $coursenode = $parent->add($shortname, $url, self::TYPE_COURSE, $shortname, $course->id);
2139         $coursenode->nodetype = self::NODETYPE_BRANCH;
2140         $coursenode->hidden = (!$course->visible);
2141         $coursenode->title($course->fullname);
2142         if (!$forcegeneric) {
2143             $this->addedcourses[$course->id] = &$coursenode;
2144         }
2145         if ($ismycourse && !empty($CFG->navshowallcourses)) {
2146             // We need to add this course to the general courses node as well as the
2147             // my courses node, rerun the function with the kill param
2148             $genericcourse = $this->add_course($course, true);
2149             if ($genericcourse->isactive) {
2150                 $genericcourse->make_inactive();
2151                 $genericcourse->collapse = true;
2152                 if ($genericcourse->parent && $genericcourse->parent->type == self::TYPE_CATEGORY) {
2153                     $parent = $genericcourse->parent;
2154                     while ($parent && $parent->type == self::TYPE_CATEGORY) {
2155                         $parent->collapse = true;
2156                         $parent = $parent->parent;
2157                     }
2158                 }
2159             }
2160         }
2162         return $coursenode;
2163     }
2164     /**
2165      * Adds essential course nodes to the navigation for the given course.
2166      *
2167      * This method adds nodes such as reports, blogs and participants
2168      *
2169      * @param navigation_node $coursenode
2170      * @param stdClass $course
2171      * @return bool
2172      */
2173     public function add_course_essentials(navigation_node $coursenode, stdClass $course) {
2174         global $CFG;
2176         if ($course->id == SITEID) {
2177             return $this->add_front_page_course_essentials($coursenode, $course);
2178         }
2180         if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2181             return true;
2182         }
2184         //Participants
2185         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
2186             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
2187             $currentgroup = groups_get_course_group($course, true);
2188             if ($course->id == SITEID) {
2189                 $filterselect = '';
2190             } else if ($course->id && !$currentgroup) {
2191                 $filterselect = $course->id;
2192             } else {
2193                 $filterselect = $currentgroup;
2194             }
2195             $filterselect = clean_param($filterselect, PARAM_INT);
2196             if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2197                and has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
2198                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2199                 $participants->add(get_string('blogs','blog'), $blogsurls->out());
2200             }
2201             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2202                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2203             }
2204         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2205             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2206         }
2208         // View course reports
2209         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
2210             $reportnav = $coursenode->add(get_string('reports'), new moodle_url('/course/report.php', array('id'=>$course->id)), self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2211             $coursereports = get_plugin_list('coursereport');
2212             foreach ($coursereports as $report=>$dir) {
2213                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2214                 if (file_exists($libfile)) {
2215                     require_once($libfile);
2216                     $reportfunction = $report.'_report_extend_navigation';
2217                     if (function_exists($report.'_report_extend_navigation')) {
2218                         $reportfunction($reportnav, $course, $this->page->context);
2219                     }
2220                 }
2221             }
2222         }
2223         return true;
2224     }
2225     /**
2226      * This generates the the structure of the course that won't be generated when
2227      * the modules and sections are added.
2228      *
2229      * Things such as the reports branch, the participants branch, blogs... get
2230      * added to the course node by this method.
2231      *
2232      * @param navigation_node $coursenode
2233      * @param stdClass $course
2234      * @return bool True for successfull generation
2235      */
2236     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2237         global $CFG;
2239         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2240             return true;
2241         }
2243         // Hidden node that we use to determine if the front page navigation is loaded.
2244         // This required as there are not other guaranteed nodes that may be loaded.
2245         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2247         //Participants
2248         if (has_capability('moodle/course:viewparticipants',  get_system_context())) {
2249             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2250         }
2252         $filterselect = 0;
2254         // Blogs
2255         if (!empty($CFG->bloglevel)
2256           and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2257           and has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
2258             $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2259             $coursenode->add(get_string('blogs','blog'), $blogsurls->out());
2260         }
2262         // Notes
2263         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2264             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2265         }
2267         // Tags
2268         if (!empty($CFG->usetags) && isloggedin()) {
2269             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2270         }
2272         // Calendar
2273         $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2274         $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self::TYPE_CUSTOM, null, 'calendar');
2276         // View course reports
2277         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
2278             $reportnav = $coursenode->add(get_string('reports'), new moodle_url('/course/report.php', array('id'=>$course->id)), self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2279             $coursereports = get_plugin_list('coursereport');
2280             foreach ($coursereports as $report=>$dir) {
2281                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2282                 if (file_exists($libfile)) {
2283                     require_once($libfile);
2284                     $reportfunction = $report.'_report_extend_navigation';
2285                     if (function_exists($report.'_report_extend_navigation')) {
2286                         $reportfunction($reportnav, $course, $this->page->context);
2287                     }
2288                 }
2289             }
2290         }
2291         return true;
2292     }
2294     /**
2295      * Clears the navigation cache
2296      */
2297     public function clear_cache() {
2298         $this->cache->clear();
2299     }
2301     /**
2302      * Sets an expansion limit for the navigation
2303      *
2304      * The expansion limit is used to prevent the display of content that has a type
2305      * greater than the provided $type.
2306      *
2307      * Can be used to ensure things such as activities or activity content don't get
2308      * shown on the navigation.
2309      * They are still generated in order to ensure the navbar still makes sense.
2310      *
2311      * @param int $type One of navigation_node::TYPE_*
2312      * @return <type>
2313      */
2314     public function set_expansion_limit($type) {
2315         $nodes = $this->find_all_of_type($type);
2316         foreach ($nodes as &$node) {
2317             // We need to generate the full site node
2318             if ($type == self::TYPE_COURSE && $node->key == SITEID) {
2319                 continue;
2320             }
2321             foreach ($node->children as &$child) {
2322                 // We still want to show course reports and participants containers
2323                 // or there will be navigation missing.
2324                 if ($type == self::TYPE_COURSE && $child->type === self::TYPE_CONTAINER) {
2325                     continue;
2326                 }
2327                 $child->display = false;
2328             }
2329         }
2330         return true;
2331     }
2332     /**
2333      * Attempts to get the navigation with the given key from this nodes children.
2334      *
2335      * This function only looks at this nodes children, it does NOT look recursivily.
2336      * If the node can't be found then false is returned.
2337      *
2338      * If you need to search recursivily then use the {@see find()} method.
2339      *
2340      * Note: If you are trying to set the active node {@see navigation_node::override_active_url()}
2341      * may be of more use to you.
2342      *
2343      * @param string|int $key The key of the node you wish to receive.
2344      * @param int $type One of navigation_node::TYPE_*
2345      * @return navigation_node|false
2346      */
2347     public function get($key, $type = null) {
2348         if (!$this->initialised) {
2349             $this->initialise();
2350         }
2351         return parent::get($key, $type);
2352     }
2354     /**
2355      * Searches this nodes children and thier children to find a navigation node
2356      * with the matching key and type.
2357      *
2358      * This method is recursive and searches children so until either a node is
2359      * found of there are no more nodes to search.
2360      *
2361      * If you know that the node being searched for is a child of this node
2362      * then use the {@see get()} method instead.
2363      *
2364      * Note: If you are trying to set the active node {@see navigation_node::override_active_url()}
2365      * may be of more use to you.
2366      *
2367      * @param string|int $key The key of the node you wish to receive.
2368      * @param int $type One of navigation_node::TYPE_*
2369      * @return navigation_node|false
2370      */
2371     public function find($key, $type) {
2372         if (!$this->initialised) {
2373             $this->initialise();
2374         }
2375         return parent::find($key, $type);
2376     }
2379 /**
2380  * The limited global navigation class used for the AJAX extension of the global
2381  * navigation class.
2382  *
2383  * The primary methods that are used in the global navigation class have been overriden
2384  * to ensure that only the relevant branch is generated at the root of the tree.
2385  * This can be done because AJAX is only used when the backwards structure for the
2386  * requested branch exists.
2387  * This has been done only because it shortens the amounts of information that is generated
2388  * which of course will speed up the response time.. because no one likes laggy AJAX.
2389  *
2390  * @package moodlecore
2391  * @subpackage navigation
2392  * @copyright 2009 Sam Hemelryk
2393  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2394  */
2395 class global_navigation_for_ajax extends global_navigation {
2397     protected $branchtype;
2398     protected $instanceid;
2400     /** @var array */
2401     protected $expandable = array();
2403     /**
2404      * Constructs the navigation for use in AJAX request
2405      */
2406     public function __construct($page, $branchtype, $id) {
2407         $this->page = $page;
2408         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2409         $this->children = new navigation_node_collection();
2410         $this->branchtype = $branchtype;
2411         $this->instanceid = $id;
2412         $this->initialise();
2413     }
2414     /**
2415      * Initialise the navigation given the type and id for the branch to expand.
2416      *
2417      * @return array The expandable nodes
2418      */
2419     public function initialise() {
2420         global $CFG, $DB, $SITE;
2422         if ($this->initialised || during_initial_install()) {
2423             return $this->expandable;
2424         }
2425         $this->initialised = true;
2427         $this->rootnodes = array();
2428         $this->rootnodes['site']    = $this->add_course($SITE);
2429         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2431         // Branchtype will be one of navigation_node::TYPE_*
2432         switch ($this->branchtype) {
2433             case self::TYPE_CATEGORY :
2434                 $this->load_all_categories($this->instanceid);
2435                 $limit = 20;
2436                 if (!empty($CFG->navcourselimit)) {
2437                     $limit = (int)$CFG->navcourselimit;
2438                 }
2439                 $courses = $DB->get_records('course', array('category' => $this->instanceid), 'sortorder','*', 0, $limit);
2440                 foreach ($courses as $course) {
2441                     $this->add_course($course);
2442                 }
2443                 break;
2444             case self::TYPE_COURSE :
2445                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
2446                 require_course_login($course);
2447                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2448                 $coursenode = $this->add_course($course);
2449                 $this->add_course_essentials($coursenode, $course);
2450                 if ($this->format_display_course_content($course->format)) {
2451                     $this->load_course_sections($course, $coursenode);
2452                 }
2453                 break;
2454             case self::TYPE_SECTION :
2455                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2456                         FROM {course} c
2457                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2458                         WHERE cs.id = ?';
2459                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
2460                 require_course_login($course);
2461                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2462                 $coursenode = $this->add_course($course);
2463                 $this->add_course_essentials($coursenode, $course);
2464                 $sections = $this->load_course_sections($course, $coursenode);
2465                 list($sectionarray, $activities) = $this->generate_sections_and_activities($course);
2466                 $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, $activities);
2467                 break;
2468             case self::TYPE_ACTIVITY :
2469                 $sql = "SELECT c.*
2470                           FROM {course} c
2471                           JOIN {course_modules} cm ON cm.course = c.id
2472                          WHERE cm.id = :cmid";
2473                 $params = array('cmid' => $this->instanceid);
2474                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
2475                 $modinfo = get_fast_modinfo($course);
2476                 $cm = $modinfo->get_cm($this->instanceid);
2477                 require_course_login($course, true, $cm);
2478                 $this->page->set_context(get_context_instance(CONTEXT_MODULE, $cm->id));
2479                 $coursenode = $this->load_course($course);
2480                 if ($course->id == SITEID) {
2481                     $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY));
2482                 } else {
2483                     $sections   = $this->load_course_sections($course, $coursenode);
2484                     list($sectionarray, $activities) = $this->generate_sections_and_activities($course);
2485                     $activities = $this->load_section_activities($sections[$cm->sectionnum]->sectionnode, $cm->sectionnum, $activities);
2486                     $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]);
2487                 }
2488                 break;
2489             default:
2490                 throw new Exception('Unknown type');
2491                 return $this->expandable;
2492         }
2494         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != SITEID) {
2495             $this->load_for_user(null, true);
2496         }
2498         $this->find_expandable($this->expandable);
2499         return $this->expandable;
2500     }
2502     /**
2503      * Returns an array of expandable nodes
2504      * @return array
2505      */
2506     public function get_expandable() {
2507         return $this->expandable;
2508     }
2511 /**
2512  * Navbar class
2513  *
2514  * This class is used to manage the navbar, which is initialised from the navigation
2515  * object held by PAGE
2516  *
2517  * @package moodlecore
2518  * @subpackage navigation
2519  * @copyright 2009 Sam Hemelryk
2520  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2521  */
2522 class navbar extends navigation_node {
2523     /** @var bool */
2524     protected $initialised = false;
2525     /** @var mixed */
2526     protected $keys = array();
2527     /** @var null|string */
2528     protected $content = null;
2529     /** @var moodle_page object */
2530     protected $page;
2531     /** @var bool */
2532     protected $ignoreactive = false;
2533     /** @var bool */
2534     protected $duringinstall = false;
2535     /** @var bool */
2536     protected $hasitems = false;
2537     /** @var array */
2538     protected $items;
2539     /** @var array */
2540     public $children = array();
2541     /** @var bool */
2542     public $includesettingsbase = false;
2543     /**
2544      * The almighty constructor
2545      *
2546      * @param moodle_page $page
2547      */
2548     public function __construct(moodle_page $page) {
2549         global $CFG;
2550         if (during_initial_install()) {
2551             $this->duringinstall = true;
2552             return false;
2553         }
2554         $this->page = $page;
2555         $this->text = get_string('home');
2556         $this->shorttext = get_string('home');
2557         $this->action = new moodle_url($CFG->wwwroot);
2558         $this->nodetype = self::NODETYPE_BRANCH;
2559         $this->type = self::TYPE_SYSTEM;
2560     }
2562     /**
2563      * Quick check to see if the navbar will have items in.
2564      *
2565      * @return bool Returns true if the navbar will have items, false otherwise
2566      */
2567     public function has_items() {
2568         if ($this->duringinstall) {
2569             return false;
2570         } else if ($this->hasitems !== false) {
2571             return true;
2572         }
2573         $this->page->navigation->initialise($this->page);
2575         $activenodefound = ($this->page->navigation->contains_active_node() ||
2576                             $this->page->settingsnav->contains_active_node());
2578         $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
2579         $this->hasitems = $outcome;
2580         return $outcome;
2581     }
2583     /**
2584      * Turn on/off ignore active
2585      *
2586      * @param bool $setting
2587      */
2588     public function ignore_active($setting=true) {
2589         $this->ignoreactive = ($setting);
2590     }
2591     public function get($key, $type = null) {
2592         foreach ($this->children as &$child) {
2593             if ($child->key === $key && ($type == null || $type == $child->type)) {
2594                 return $child;
2595             }
2596         }
2597         return false;
2598     }
2599     /**
2600      * Returns an array of navigation_node's that make up the navbar.
2601      *
2602      * @return array
2603      */
2604     public function get_items() {
2605         $items = array();
2606         // Make sure that navigation is initialised
2607         if (!$this->has_items()) {
2608             return $items;
2609         }
2610         if ($this->items !== null) {
2611             return $this->items;
2612         }
2614         if (count($this->children) > 0) {
2615             // Add the custom children
2616             $items = array_reverse($this->children);
2617         }
2619         $navigationactivenode = $this->page->navigation->find_active_node();
2620         $settingsactivenode = $this->page->settingsnav->find_active_node();
2622         // Check if navigation contains the active node
2623         if (!$this->ignoreactive) {
2625             if ($navigationactivenode && $settingsactivenode) {
2626                 // Parse a combined navigation tree
2627                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
2628                     if (!$settingsactivenode->mainnavonly) {
2629                         $items[] = $settingsactivenode;
2630                     }
2631                     $settingsactivenode = $settingsactivenode->parent;
2632                 }
2633                 if (!$this->includesettingsbase) {
2634                     // Removes the first node from the settings (root node) from the list
2635                     array_pop($items);
2636                 }
2637                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
2638                     if (!$navigationactivenode->mainnavonly) {
2639                         $items[] = $navigationactivenode;
2640                     }
2641                     $navigationactivenode = $navigationactivenode->parent;
2642                 }
2643             } else if ($navigationactivenode) {
2644                 // Parse the navigation tree to get the active node
2645                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
2646                     if (!$navigationactivenode->mainnavonly) {
2647                         $items[] = $navigationactivenode;
2648                     }
2649                     $navigationactivenode = $navigationactivenode->parent;
2650                 }
2651             } else if ($settingsactivenode) {
2652                 // Parse the settings navigation to get the active node
2653                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
2654                     if (!$settingsactivenode->mainnavonly) {
2655                         $items[] = $settingsactivenode;
2656                     }
2657                     $settingsactivenode = $settingsactivenode->parent;
2658                 }
2659             }
2660         }
2662         $items[] = new navigation_node(array(
2663             'text'=>$this->page->navigation->text,
2664             'shorttext'=>$this->page->navigation->shorttext,
2665             'key'=>$this->page->navigation->key,
2666             'action'=>$this->page->navigation->action
2667         ));
2669         $this->items = array_reverse($items);
2670         return $this->items;
2671     }
2673     /**
2674      * Add a new navigation_node to the navbar, overrides parent::add
2675      *
2676      * This function overrides {@link navigation_node::add()} so that we can change
2677      * the way nodes get added to allow us to simply call add and have the node added to the
2678      * end of the navbar
2679      *
2680      * @param string $text
2681      * @param string|moodle_url $action
2682      * @param int $type
2683      * @param string|int $key
2684      * @param string $shorttext
2685      * @param string $icon
2686      * @return navigation_node
2687      */
2688     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
2689         if ($this->content !== null) {
2690             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
2691         }
2693         // Properties array used when creating the new navigation node
2694         $itemarray = array(
2695             'text' => $text,
2696             'type' => $type
2697         );
2698         // Set the action if one was provided
2699         if ($action!==null) {
2700             $itemarray['action'] = $action;
2701         }
2702         // Set the shorttext if one was provided
2703         if ($shorttext!==null) {
2704             $itemarray['shorttext'] = $shorttext;
2705         }
2706         // Set the icon if one was provided
2707         if ($icon!==null) {
2708             $itemarray['icon'] = $icon;
2709         }
2710         // Default the key to the number of children if not provided
2711         if ($key === null) {
2712             $key = count($this->children);
2713         }
2714         // Set the key
2715         $itemarray['key'] = $key;
2716         // Set the parent to this node
2717         $itemarray['parent'] = $this;
2718         // Add the child using the navigation_node_collections add method
2719         $this->children[] = new navigation_node($itemarray);
2720         return $this;
2721     }
2724 /**
2725  * Class used to manage the settings option for the current page
2726  *
2727  * This class is used to manage the settings options in a tree format (recursively)
2728  * and was created initially for use with the settings blocks.
2729  *
2730  * @package moodlecore
2731  * @subpackage navigation
2732  * @copyright 2009 Sam Hemelryk
2733  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2734  */
2735 class settings_navigation extends navigation_node {
2736     /** @var stdClass */
2737     protected $context;
2738     /** @var moodle_page */
2739     protected $page;
2740     /** @var string */
2741     protected $adminsection;
2742     /** @var bool */
2743     protected $initialised = false;
2744     /** @var array */
2745     protected $userstoextendfor = array();
2746     /** @var navigation_cache **/
2747     protected $cache;
2749     /**
2750      * Sets up the object with basic settings and preparse it for use
2751      *
2752      * @param moodle_page $page
2753      */
2754     public function __construct(moodle_page &$page) {
2755         if (during_initial_install()) {
2756             return false;
2757         }
2758         $this->page = $page;
2759         // Initialise the main navigation. It is most important that this is done
2760         // before we try anything
2761         $this->page->navigation->initialise();
2762         // Initialise the navigation cache
2763         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2764         $this->children = new navigation_node_collection();
2765     }
2766     /**
2767      * Initialise the settings navigation based on the current context
2768      *
2769      * This function initialises the settings navigation tree for a given context
2770      * by calling supporting functions to generate major parts of the tree.
2771      *
2772      */
2773     public function initialise() {
2774         global $DB, $SESSION;
2776         if (during_initial_install()) {
2777             return false;
2778         } else if ($this->initialised) {
2779             return true;
2780         }
2781         $this->id = 'settingsnav';
2782         $this->context = $this->page->context;
2784         $context = $this->context;
2785         if ($context->contextlevel == CONTEXT_BLOCK) {
2786             $this->load_block_settings();
2787             $context = $DB->get_record_sql('SELECT ctx.* FROM {block_instances} bi LEFT JOIN {context} ctx ON ctx.id=bi.parentcontextid WHERE bi.id=?', array($context->instanceid));
2788         }
2790         switch ($context->contextlevel) {
2791             case CONTEXT_SYSTEM:
2792                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
2793                     $this->load_front_page_settings(($context->id == $this->context->id));
2794                 }
2795                 break;
2796             case CONTEXT_COURSECAT:
2797                 $this->load_category_settings();
2798                 break;
2799             case CONTEXT_COURSE:
2800                 if ($this->page->course->id != SITEID) {
2801                     $this->load_course_settings(($context->id == $this->context->id));
2802                 } else {
2803                     $this->load_front_page_settings(($context->id == $this->context->id));
2804                 }
2805                 break;
2806             case CONTEXT_MODULE:
2807                 $this->load_module_settings();
2808                 $this->load_course_settings();
2809                 break;
2810             case CONTEXT_USER:
2811                 if ($this->page->course->id != SITEID) {
2812                     $this->load_course_settings();
2813                 }
2814                 break;
2815         }
2817         $settings = $this->load_user_settings($this->page->course->id);
2819         if (isloggedin() && !isguestuser() && (!property_exists($SESSION, 'load_navigation_admin') || $SESSION->load_navigation_admin)) {
2820             $admin = $this->load_administration_settings();
2821             $SESSION->load_navigation_admin = ($admin->has_children());
2822         } else {
2823             $admin = false;
2824         }
2826         if ($context->contextlevel == CONTEXT_SYSTEM && $admin) {
2827             $admin->force_open();
2828         } else if ($context->contextlevel == CONTEXT_USER && $settings) {
2829             $settings->force_open();
2830         }
2832         // Check if the user is currently logged in as another user
2833         if (session_is_loggedinas()) {
2834             // Get the actual user, we need this so we can display an informative return link
2835             $realuser = session_get_realuser();
2836             // Add the informative return to original user link
2837             $url = new moodle_url('/course/loginas.php',array('id'=>$this->page->course->id, 'return'=>1,'sesskey'=>sesskey()));
2838             $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self::TYPE_SETTING, null, null, new pix_icon('t/left', ''));
2839         }
2841         foreach ($this->children as $key=>$node) {
2842             if ($node->nodetype != self::NODETYPE_BRANCH || $node->children->count()===0) {
2843                 $node->remove();
2844             }
2845         }
2846         $this->initialised = true;
2847     }
2848     /**
2849      * Override the parent function so that we can add preceeding hr's and set a
2850      * root node class against all first level element
2851      *
2852      * It does this by first calling the parent's add method {@link navigation_node::add()}
2853      * and then proceeds to use the key to set class and hr
2854      *
2855      * @param string $text
2856      * @param sting|moodle_url $url
2857      * @param string $shorttext
2858      * @param string|int $key
2859      * @param int $type
2860      * @param string $icon
2861      * @return navigation_node
2862      */
2863     public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
2864         $node = parent::add($text, $url, $type, $shorttext, $key, $icon);
2865         $node->add_class('root_node');
2866         return $node;
2867     }
2869     /**
2870      * This function allows the user to add something to the start of the settings
2871      * navigation, which means it will be at the top of the settings navigation block
2872      *
2873      * @param string $text
2874      * @param sting|moodle_url $url
2875      * @param string $shorttext
2876      * @param string|int $key
2877      * @param int $type
2878      * @param string $icon
2879      * @return navigation_node
2880      */
2881     public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
2882         $children = $this->children;
2883         $childrenclass = get_class($children);
2884         $this->children = new $childrenclass;
2885         $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
2886         foreach ($children as $child) {
2887             $this->children->add($child);
2888         }
2889         return $node;
2890     }
2891     /**
2892      * Load the site administration tree
2893      *
2894      * This function loads the site administration tree by using the lib/adminlib library functions
2895      *
2896      * @param navigation_node $referencebranch A reference to a branch in the settings
2897      *      navigation tree
2898      * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
2899      *      tree and start at the beginning
2900      * @return mixed A key to access the admin tree by
2901      */
2902     protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) {
2903         global $CFG;
2905         // Check if we are just starting to generate this navigation.
2906         if ($referencebranch === null) {
2908             // Require the admin lib then get an admin structure
2909             if (!function_exists('admin_get_root')) {
2910                 require_once($CFG->dirroot.'/lib/adminlib.php');
2911             }
2912             $adminroot = admin_get_root(false, false);
2913             // This is the active section identifier
2914             $this->adminsection = $this->page->url->param('section');
2916             // Disable the navigation from automatically finding the active node
2917             navigation_node::$autofindactive = false;
2918             $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SETTING, null, 'root');
2919             foreach ($adminroot->children as $adminbranch) {
2920                 $this->load_administration_settings($referencebranch, $adminbranch);
2921             }
2922             navigation_node::$autofindactive = true;
2924             // Use the admin structure to locate the active page
2925             if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) {
2926                 $currentnode = $this;
2927                 while (($pathkey = array_pop($current->path))!==null && $currentnode) {
2928                     $currentnode = $currentnode->get($pathkey);
2929                 }
2930                 if ($currentnode) {
2931                     $currentnode->make_active();
2932                 }
2933             } else {
2934                 $this->scan_for_active_node($referencebranch);
2935             }
2936             return $referencebranch;
2937         } else if ($adminbranch->check_access()) {
2938             // We have a reference branch that we can access and is not hidden `hurrah`
2939             // Now we need to display it and any children it may have
2940             $url = null;
2941             $icon = null;
2942             if ($adminbranch instanceof admin_settingpage) {
2943                 $url = new moodle_url('/admin/settings.php', array('section'=>$adminbranch->name));
2944             } else if ($adminbranch instanceof admin_externalpage) {
2945                 $url = $adminbranch->url;
2946             }
2948             // Add the branch
2949             $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon);
2951             if ($adminbranch->is_hidden()) {
2952                 if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) {
2953                     $reference->add_class('hidden');
2954                 } else {
2955                     $reference->display = false;
2956                 }
2957             }
2959             // Check if we are generating the admin notifications and whether notificiations exist
2960             if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) {
2961                 $reference->add_class('criticalnotification');
2962             }
2963             // Check if this branch has children
2964             if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) {
2965                 foreach ($adminbranch->children as $branch) {
2966                     // Generate the child branches as well now using this branch as the reference
2967                     $this->load_administration_settings($reference, $branch);
2968                 }
2969             } else {
2970                 $reference->icon = new pix_icon('i/settings', '');
2971             }
2972         }
2973     }
2975     /**
2976      * This function recursivily scans nodes until it finds the active node or there
2977      * are no more nodes.
2978      * @param navigation_node $node
2979      */
2980     protected function scan_for_active_node(navigation_node $node) {
2981         if (!$node->check_if_active() && $node->children->count()>0) {
2982             foreach ($node->children as &$child) {
2983                 $this->scan_for_active_node($child);
2984             }
2985         }
2986     }
2988     /**
2989      * Gets a navigation node given an array of keys that represent the path to
2990      * the desired node.
2991      *
2992      * @param array $path
2993      * @return navigation_node|false
2994      */
2995     protected function get_by_path(array $path) {
2996         $node = $this->get(array_shift($path));
2997         foreach ($path as $key) {
2998             $node->get($key);
2999         }
3000         return $node;
3001     }
3003     /**
3004      * Generate the list of modules for the given course.
3005      *
3006      * @param stdClass $course The course to get modules for
3007      */
3008     protected function get_course_modules($course) {
3009         global $CFG;
3010         $mods = $modnames = $modnamesplural = $modnamesused = array();
3011         // This function is included when we include course/lib.php at the top
3012         // of this file
3013         get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused);
3014         $resources = array();
3015         $activities = array();
3016         foreach($modnames as $modname=>$modnamestr) {
3017             if (!course_allowed_module($course, $modname)) {
3018                 continue;
3019             }
3021             $libfile = "$CFG->dirroot/mod/$modname/lib.php";
3022             if (!file_exists($libfile)) {
3023                 continue;
3024             }
3025             include_once($libfile);
3026             $gettypesfunc =  $modname.'_get_types';
3027             if (function_exists($gettypesfunc)) {
3028                 $types = $gettypesfunc();
3029                 foreach($types as $type) {
3030                     if (!isset($type->modclass) || !isset($type->typestr)) {
3031                         debugging('Incorrect activity type in '.$modname);
3032                         continue;
3033                     }
3034                     if ($type->modclass == MOD_CLASS_RESOURCE) {
3035                         $resources[html_entity_decode($type->type)] = $type->typestr;
3036                     } else {
3037                         $activities[html_entity_decode($type->type)] = $type->typestr;
3038                     }
3039                 }
3040             } else {
3041                 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
3042                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
3043                     $resources[$modname] = $modnamestr;
3044                 } else {
3045                     // all other archetypes are considered activity
3046                     $activities[$modname] = $modnamestr;
3047                 }
3048             }
3049         }
3050         return array($resources, $activities);
3051     }
3053     /**
3054      * This function loads the course settings that are available for the user
3055      *
3056      * @param bool $forceopen If set to true the course node will be forced open
3057      * @return navigation_node|false
3058      */
3059     protected function load_course_settings($forceopen = false) {
3060         global $CFG;
3062         $course = $this->page->course;
3063         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
3065         // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
3067         $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin');
3068         if ($forceopen) {
3069             $coursenode->force_open();
3070         }
3072         if (has_capability('moodle/course:update', $coursecontext)) {
3073             // Add the turn on/off settings
3074             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
3075             if ($this->page->user_is_editing()) {
3076                 $url->param('edit', 'off');
3077                 $editstring = get_string('turneditingoff');
3078             } else {
3079                 $url->param('edit', 'on');
3080                 $editstring = get_string('turneditingon');
3081             }
3082             $coursenode->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
3084             if ($this->page->user_is_editing()) {
3085                 // Removed as per MDL-22732
3086                 // $this->add_course_editing_links($course);
3087             }
3089             // Add the course settings link
3090             $url = new moodle_url('/course/edit.php', array('id'=>$course->id));
3091             $coursenode->add(get_string('editsettings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
3093             // Add the course completion settings link
3094             if ($CFG->enablecompletion && $course->enablecompletion) {
3095                 $url = new moodle_url('/course/completion.php', array('id'=>$course->id));
3096                 $coursenode->add(get_string('completion', 'completion'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
3097             }
3098         }
3100         // add enrol nodes
3101         enrol_add_course_navigation($coursenode, $course);
3103         // Manage filters
3104         if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
3105             $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
3106             $coursenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
3107         }
3109         // Add view grade report is permitted
3110         $reportavailable = false;
3111         if (has_capability('moodle/grade:viewall', $coursecontext)) {
3112             $reportavailable = true;
3113         } else if (!empty($course->showgrades)) {
3114             $reports = get_plugin_list('gradereport');
3115             if (is_array($reports) && count($reports)>0) {     // Get all installed reports
3116                 arsort($reports); // user is last, we want to test it first
3117                 foreach ($reports as $plugin => $plugindir) {
3118                     if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
3119                         //stop when the first visible plugin is found
3120                         $reportavailable = true;
3121                         break;
3122                     }
3123                 }
3124             }
3125         }
3126         if ($reportavailable) {
3127             $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id));
3128             $gradenode = $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, 'grades', new pix_icon('i/grades', ''));
3129         }
3131         //  Add outcome if permitted
3132         if (!empty($CFG->enableoutcomes) && has_capability('moodle/course:update', $coursecontext)) {
3133             $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id));
3134             $coursenode->add(get_string('outcomes', 'grades'), $url, self::TYPE_SETTING, null, 'outcomes', new pix_icon('i/outcomes', ''));
3135         }
3137         // Backup this course
3138         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
3139             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
3140             $coursenode->add(get_string('backup'), $url, self::TYPE_SETTING, null, 'backup', new pix_icon('i/backup', ''));
3141         }
3143         // Restore to this course
3144         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
3145             $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id));
3146             $coursenode->add(get_string('restore'), $url, self::TYPE_SETTING, null, 'restore', new pix_icon('i/restore', ''));
3147         }
3149         // Import data from other courses
3150         if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
3151             $url = new moodle_url('/backup/import.php', array('id'=>$course->id));
3152             $coursenode->add(get_string('import'), $url, self::TYPE_SETTING, null, 'import', new pix_icon('i/restore', ''));
3153         }
3155         // Publish course on a hub
3156         if (has_capability('moodle/course:publish', $coursecontext)) {
3157             $url = new moodle_url('/course/publish/index.php', array('id'=>$course->id));
3158             $coursenode->add(get_string('publish'), $url, self::TYPE_SETTING, null, 'publish', new pix_icon('i/publish', ''));
3159         }
3161         // Reset this course
3162         if (has_capability('moodle/course:reset', $coursecontext)) {
3163             $url = new moodle_url('/course/reset.php', array('id'=>$course->id));
3164             $coursenode->add(get_string('reset'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/return', ''));
3165         }
3167         // Questions
3168         require_once($CFG->dirroot.'/question/editlib.php');
3169         question_extend_settings_navigation($coursenode, $coursecontext)->trim_if_empty();
3171         if (has_capability('moodle/course:update', $coursecontext)) {
3172             // Repository Instances
3173             if (!$this->cache->cached('contexthasrepos'.$coursecontext->id)) {
3174                 require_once($CFG->dirroot . '/repository/lib.php');
3175                 $editabletypes = repository::get_editable_types($coursecontext);
3176                 $haseditabletypes = !empty($editabletypes);
3177                 unset($editabletypes);
3178                 $this->cache->set('contexthasrepos'.$coursecontext->id, $haseditabletypes);
3179             } else {
3180                 $haseditabletypes = $this->cache->{'contexthasrepos'.$coursecontext->id};
3181             }
3182             if ($haseditabletypes) {
3183                 $url = new moodle_url('/repository/manage_instances.php', array('contextid' => $coursecontext->id));
3184                 $coursenode->add(get_string('repositories'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/repository', ''));
3185             }
3186         }
3188         // Manage files
3189         if ($course->legacyfiles == 2 and has_capability('moodle/course:managefiles', $coursecontext)) {
3190             // hidden in new courses and courses where legacy files were turned off
3191             $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id));
3192             $coursenode->add(get_string('courselegacyfiles'), $url, self::TYPE_SETTING, null, 'coursefiles', new pix_icon('i/files', ''));
3193         }
3195         // Switch roles
3196         $roles = array();
3197         $assumedrole = $this->in_alternative_role();
3198         if ($assumedrole !== false) {
3199             $roles[0] = get_string('switchrolereturn');
3200         }
3201         if (has_capability('moodle/role:switchroles', $coursecontext)) {
3202             $availableroles = get_switchable_roles($coursecontext);
3203             if (is_array($availableroles)) {
3204                 foreach ($availableroles as $key=>$role) {
3205                     if ($assumedrole == (int)$key) {
3206                         continue;
3207                     }
3208                     $roles[$key] = $role;
3209                 }
3210             }
3211         }
3212         if (is_array($roles) && count($roles)>0) {
3213             $switchroles = $this->add(get_string('switchroleto'));
3214             if ((count($roles)==1 && array_key_exists(0, $roles))|| $assumedrole!==false) {
3215                 $switchroles->force_open();
3216             }
3217             $returnurl = $this->page->url;
3218             $returnurl->param('sesskey', sesskey());
3219             foreach ($roles as $key => $name) {
3220                 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>$returnurl->out(false)));
3221                 $switchroles->add($name, $url, self::TYPE_SETTING, null, $key, new pix_icon('i/roles', ''));
3222             }
3223         }
3224         // Return we are done
3225         return $coursenode;
3226     }
3228     /**
3229      * Adds branches and links to the settings navigation to add course activities
3230      * and resources.
3231      *
3232      * @param stdClass $course
3233      */
3234     protected function add_course_editing_links($course) {
3235         global $CFG;
3237         require_once($CFG->dirroot.'/course/lib.php');
3239         // Add `add` resources|activities branches
3240         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3241         if (file_exists($structurefile)) {
3242             require_once($structurefile);
3243             $requestkey = call_user_func('callback_'.$course->format.'_request_key');
3244             $formatidentifier = optional_param($requestkey, 0, PARAM_INT);
3245         } else {
3246             $requestkey = get_string('section');
3247             $formatidentifier = optional_param($requestkey, 0, PARAM_INT);
3248         }
3250         $sections = get_all_sections($course->id);
3252         $addresource = $this->add(get_string('addresource'));
3253         $addactivity = $this->add(get_string('addactivity'));
3254         if ($formatidentifier!==0) {
3255             $addresource->force_open();
3256             $addactivity->force_open();
3257         }
3259         $this->get_course_modules($course);
3261         $textlib = textlib_get_instance();
3263         foreach ($sections as $section) {
3264             if ($formatidentifier !== 0 && $section->section != $formatidentifier) {
3265                 continue;
3266             }
3267             $sectionurl = new moodle_url('/course/view.php', array('id'=>$course->id, $requestkey=>$section->section));
3268             if ($section->section == 0) {
3269                 $sectionresources = $addresource->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
3270                 $sectionactivities = $addactivity->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
3271             } else {
3272                 $sectionname = get_section_name($course, $section);
3273                 $sectionresources = $addresource->add($sectionname, $sectionurl, self::TYPE_SETTING);
3274                 $sectionactivities = $addactivity->add($sectionname, $sectionurl, self::TYPE_SETTING);
3275             }
3276             foreach ($resources as $value=>$resource) {
3277                 $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
3278                 $pos = strpos($value, '&type=');
3279                 if ($pos!==false) {
3280                     $url->param('add', $textlib->substr($value, 0,$pos));
3281                     $url->param('type', $textlib->substr($value, $pos+6));
3282                 } else {
3283                     $url->param('add', $value);
3284                 }
3285                 $sectionresources->add($resource, $url, self::TYPE_SETTING);
3286             }
3287             $subbranch = false;
3288             foreach ($activities as $activityname=>$activity) {
3289                 if ($activity==='--') {
3290                     $subbranch = false;
3291                     continue;
3292                 }
3293                 if (strpos($activity, '--')===0) {
3294                     $subbranch = $sectionactivities->add(trim($activity, '-'));
3295                     continue;
3296                 }
3297                 $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
3298                 $pos = strpos($activityname, '&type=');
3299                 if ($pos!==false) {
3300                     $url->param('add', $textlib->substr($activityname, 0,$pos));
3301                     $url->param('type', $textlib->substr($activityname, $pos+6));
3302                 } else {
3303                     $url->param('add', $activityname);
3304                 }
3305                 if ($subbranch !== false) {
3306                     $subbranch->add($activity, $url, self::TYPE_SETTING);
3307                 } else {
3308                     $sectionactivities->add($activity, $url, self::TYPE_SETTING);