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