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