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