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