297fb8244f4f414d81448d86f0f6aaf81bf02c61
[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 */
121     public $parent = null;
122     /** @var bool Override to not display the icon even if one is provided **/
123     public $hideicon = false;
124     /** @var array */
125     protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting', 80=>'user');
126     /** @var moodle_url */
127     protected static $fullmeurl = null;
128     /** @var bool toogles auto matching of active node */
129     public static $autofindactive = true;
131     /**
132      * Constructs a new navigation_node
133      *
134      * @param array|string $properties Either an array of properties or a string to use
135      *                     as the text for the node
136      */
137     public function __construct($properties) {
138         if (is_array($properties)) {
139             // Check the array for each property that we allow to set at construction.
140             // text         - The main content for the node
141             // shorttext    - A short text if required for the node
142             // icon         - The icon to display for the node
143             // type         - The type of the node
144             // key          - The key to use to identify the node
145             // parent       - A reference to the nodes parent
146             // action       - The action to attribute to this node, usually a URL to link to
147             if (array_key_exists('text', $properties)) {
148                 $this->text = $properties['text'];
149             }
150             if (array_key_exists('shorttext', $properties)) {
151                 $this->shorttext = $properties['shorttext'];
152             }
153             if (!array_key_exists('icon', $properties)) {
154                 $properties['icon'] = new pix_icon('i/navigationitem', 'moodle');
155             }
156             $this->icon = $properties['icon'];
157             if ($this->icon instanceof pix_icon) {
158                 if (empty($this->icon->attributes['class'])) {
159                     $this->icon->attributes['class'] = 'navicon';
160                 } else {
161                     $this->icon->attributes['class'] .= ' navicon';
162                 }
163             }
164             if (array_key_exists('type', $properties)) {
165                 $this->type = $properties['type'];
166             } else {
167                 $this->type = self::TYPE_CUSTOM;
168             }
169             if (array_key_exists('key', $properties)) {
170                 $this->key = $properties['key'];
171             }
172             if (array_key_exists('parent', $properties)) {
173                 $this->parent = $properties['parent'];
174             }
175             // This needs to happen last because of the check_if_active call that occurs
176             if (array_key_exists('action', $properties)) {
177                 $this->action = $properties['action'];
178                 if (is_string($this->action)) {
179                     $this->action = new moodle_url($this->action);
180                 }
181                 if (self::$autofindactive) {
182                     $this->check_if_active();
183                 }
184             }
185         } else if (is_string($properties)) {
186             $this->text = $properties;
187         }
188         if ($this->text === null) {
189             throw new coding_exception('You must set the text for the node when you create it.');
190         }
191         // Default the title to the text
192         $this->title = $this->text;
193         // Instantiate a new navigation node collection for this nodes children
194         $this->children = new navigation_node_collection();
195     }
197     /**
198      * Checks if this node is the active node.
199      *
200      * This is determined by comparing the action for the node against the
201      * defined URL for the page. A match will see this node marked as active.
202      *
203      * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
204      * @return bool
205      */
206     public function check_if_active($strength=URL_MATCH_EXACT) {
207         global $FULLME, $PAGE;
208         // Set fullmeurl if it hasn't already been set
209         if (self::$fullmeurl == null) {
210             if ($PAGE->has_set_url()) {
211                 self::override_active_url(new moodle_url($PAGE->url));
212             } else {
213                 self::override_active_url(new moodle_url($FULLME));
214             }
215         }
217         // Compare the action of this node against the fullmeurl
218         if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
219             $this->make_active();
220             return true;
221         }
222         return false;
223     }
225     /**
226      * This sets the URL that the URL of new nodes get compared to when locating
227      * the active node.
228      *
229      * The active node is the node that matches the URL set here. By default this
230      * is either $PAGE->url or if that hasn't been set $FULLME.
231      *
232      * @param moodle_url $url The url to use for the fullmeurl.
233      */
234     public static function override_active_url(moodle_url $url) {
235         // Clone the URL, in case the calling script changes their URL later.
236         self::$fullmeurl = new moodle_url($url);
237     }
239     /**
240      * Creates a navigation node, ready to add it as a child using add_node
241      * function. (The created node needs to be added before you can use it.)
242      * @param string $text
243      * @param moodle_url|action_link $action
244      * @param int $type
245      * @param string $shorttext
246      * @param string|int $key
247      * @param pix_icon $icon
248      * @return navigation_node
249      */
250     public static function create($text, $action=null, $type=self::TYPE_CUSTOM,
251             $shorttext=null, $key=null, pix_icon $icon=null) {
252         // Properties array used when creating the new navigation node
253         $itemarray = array(
254             'text' => $text,
255             'type' => $type
256         );
257         // Set the action if one was provided
258         if ($action!==null) {
259             $itemarray['action'] = $action;
260         }
261         // Set the shorttext if one was provided
262         if ($shorttext!==null) {
263             $itemarray['shorttext'] = $shorttext;
264         }
265         // Set the icon if one was provided
266         if ($icon!==null) {
267             $itemarray['icon'] = $icon;
268         }
269         // Set the key
270         $itemarray['key'] = $key;
271         // Construct and return
272         return new navigation_node($itemarray);
273     }
275     /**
276      * Adds a navigation node as a child of this node.
277      *
278      * @param string $text
279      * @param moodle_url|action_link $action
280      * @param int $type
281      * @param string $shorttext
282      * @param string|int $key
283      * @param pix_icon $icon
284      * @return navigation_node
285      */
286     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
287         // Create child node
288         $childnode = self::create($text, $action, $type, $shorttext, $key, $icon);
290         // Add the child to end and return
291         return $this->add_node($childnode);
292     }
294     /**
295      * Adds a navigation node as a child of this one, given a $node object
296      * created using the create function.
297      * @param navigation_node $childnode Node to add
298      * @param int|string $key The key of a node to add this before. If not
299      *   specified, adds at end of list
300      * @return navigation_node The added node
301      */
302     public function add_node(navigation_node $childnode, $beforekey=null) {
303         // First convert the nodetype for this node to a branch as it will now have children
304         if ($this->nodetype !== self::NODETYPE_BRANCH) {
305             $this->nodetype = self::NODETYPE_BRANCH;
306         }
307         // Set the parent to this node
308         $childnode->parent = $this;
310         // Default the key to the number of children if not provided
311         if ($childnode->key === null) {
312             $childnode->key = $this->children->count();
313         }
315         // Add the child using the navigation_node_collections add method
316         $node = $this->children->add($childnode, $beforekey);
318         // If added node is a category node or the user is logged in and it's a course
319         // then mark added node as a branch (makes it expandable by AJAX)
320         $type = $childnode->type;
321         if (($type==self::TYPE_CATEGORY) || (isloggedin() && $type==self::TYPE_COURSE)) {
322             $node->nodetype = self::NODETYPE_BRANCH;
323         }
324         // If this node is hidden mark it's children as hidden also
325         if ($this->hidden) {
326             $node->hidden = true;
327         }
328         // Return added node (reference returned by $this->children->add()
329         return $node;
330     }
332     /**
333      * Return a list of all the keys of all the child nodes.
334      * @return array the keys.
335      */
336     public function get_children_key_list() {
337         return $this->children->get_key_list();
338     }
340     /**
341      * Searches for a node of the given type with the given key.
342      *
343      * This searches this node plus all of its children, and their children....
344      * If you know the node you are looking for is a child of this node then please
345      * use the get method instead.
346      *
347      * @param int|string $key The key of the node we are looking for
348      * @param int $type One of navigation_node::TYPE_*
349      * @return navigation_node|false
350      */
351     public function find($key, $type) {
352         return $this->children->find($key, $type);
353     }
355     /**
356      * Get ths child of this node that has the given key + (optional) type.
357      *
358      * If you are looking for a node and want to search all children + thier children
359      * then please use the find method instead.
360      *
361      * @param int|string $key The key of the node we are looking for
362      * @param int $type One of navigation_node::TYPE_*
363      * @return navigation_node|false
364      */
365     public function get($key, $type=null) {
366         return $this->children->get($key, $type);
367     }
369     /**
370      * Removes this node.
371      *
372      * @return bool
373      */
374     public function remove() {
375         return $this->parent->children->remove($this->key, $this->type);
376     }
378     /**
379      * Checks if this node has or could have any children
380      *
381      * @return bool Returns true if it has children or could have (by AJAX expansion)
382      */
383     public function has_children() {
384         return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0);
385     }
387     /**
388      * Marks this node as active and forces it open.
389      *
390      * Important: If you are here because you need to mark a node active to get
391      * the navigation to do what you want have you looked at {@see navigation_node::override_active_url()}?
392      * You can use it to specify a different URL to match the active navigation node on
393      * rather than having to locate and manually mark a node active.
394      */
395     public function make_active() {
396         $this->isactive = true;
397         $this->add_class('active_tree_node');
398         $this->force_open();
399         if ($this->parent !== null) {
400             $this->parent->make_inactive();
401         }
402     }
404     /**
405      * Marks a node as inactive and recusised back to the base of the tree
406      * doing the same to all parents.
407      */
408     public function make_inactive() {
409         $this->isactive = false;
410         $this->remove_class('active_tree_node');
411         if ($this->parent !== null) {
412             $this->parent->make_inactive();
413         }
414     }
416     /**
417      * Forces this node to be open and at the same time forces open all
418      * parents until the root node.
419      *
420      * Recursive.
421      */
422     public function force_open() {
423         $this->forceopen = true;
424         if ($this->parent !== null) {
425             $this->parent->force_open();
426         }
427     }
429     /**
430      * Adds a CSS class to this node.
431      *
432      * @param string $class
433      * @return bool
434      */
435     public function add_class($class) {
436         if (!in_array($class, $this->classes)) {
437             $this->classes[] = $class;
438         }
439         return true;
440     }
442     /**
443      * Removes a CSS class from this node.
444      *
445      * @param string $class
446      * @return bool True if the class was successfully removed.
447      */
448     public function remove_class($class) {
449         if (in_array($class, $this->classes)) {
450             $key = array_search($class,$this->classes);
451             if ($key!==false) {
452                 unset($this->classes[$key]);
453                 return true;
454             }
455         }
456         return false;
457     }
459     /**
460      * Sets the title for this node and forces Moodle to utilise it.
461      * @param string $title
462      */
463     public function title($title) {
464         $this->title = $title;
465         $this->forcetitle = true;
466     }
468     /**
469      * Resets the page specific information on this node if it is being unserialised.
470      */
471     public function __wakeup(){
472         $this->forceopen = false;
473         $this->isactive = false;
474         $this->remove_class('active_tree_node');
475     }
477     /**
478      * Checks if this node or any of its children contain the active node.
479      *
480      * Recursive.
481      *
482      * @return bool
483      */
484     public function contains_active_node() {
485         if ($this->isactive) {
486             return true;
487         } else {
488             foreach ($this->children as $child) {
489                 if ($child->isactive || $child->contains_active_node()) {
490                     return true;
491                 }
492             }
493         }
494         return false;
495     }
497     /**
498      * Finds the active node.
499      *
500      * Searches this nodes children plus all of the children for the active node
501      * and returns it if found.
502      *
503      * Recursive.
504      *
505      * @return navigation_node|false
506      */
507     public function find_active_node() {
508         if ($this->isactive) {
509             return $this;
510         } else {
511             foreach ($this->children as &$child) {
512                 $outcome = $child->find_active_node();
513                 if ($outcome !== false) {
514                     return $outcome;
515                 }
516             }
517         }
518         return false;
519     }
521     /**
522      * Searches all children for the best matching active node
523      * @return navigation_node|false
524      */
525     public function search_for_active_node() {
526         if ($this->check_if_active(URL_MATCH_BASE)) {
527             return $this;
528         } else {
529             foreach ($this->children as &$child) {
530                 $outcome = $child->search_for_active_node();
531                 if ($outcome !== false) {
532                     return $outcome;
533                 }
534             }
535         }
536         return false;
537     }
539     /**
540      * Gets the content for this node.
541      *
542      * @param bool $shorttext If true shorttext is used rather than the normal text
543      * @return string
544      */
545     public function get_content($shorttext=false) {
546         if ($shorttext && $this->shorttext!==null) {
547             return format_string($this->shorttext);
548         } else {
549             return format_string($this->text);
550         }
551     }
553     /**
554      * Gets the title to use for this node.
555      *
556      * @return string
557      */
558     public function get_title() {
559         if ($this->forcetitle || $this->action != null){
560             return $this->title;
561         } else {
562             return '';
563         }
564     }
566     /**
567      * Gets the CSS class to add to this node to describe its type
568      *
569      * @return string
570      */
571     public function get_css_type() {
572         if (array_key_exists($this->type, $this->namedtypes)) {
573             return 'type_'.$this->namedtypes[$this->type];
574         }
575         return 'type_unknown';
576     }
578     /**
579      * Finds all nodes that are expandable by AJAX
580      *
581      * @param array $expandable An array by reference to populate with expandable nodes.
582      */
583     public function find_expandable(array &$expandable) {
584         foreach ($this->children as &$child) {
585             if ($child->nodetype == self::NODETYPE_BRANCH && $child->children->count() == 0 && $child->display) {
586                 $child->id = 'expandable_branch_'.(count($expandable)+1);
587                 $this->add_class('canexpand');
588                 $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type);
589             }
590             $child->find_expandable($expandable);
591         }
592     }
594     /**
595      * Finds all nodes of a given type (recursive)
596      *
597      * @param int $type On of navigation_node::TYPE_*
598      * @return array
599      */
600     public function find_all_of_type($type) {
601         $nodes = $this->children->type($type);
602         foreach ($this->children as &$node) {
603             $childnodes = $node->find_all_of_type($type);
604             $nodes = array_merge($nodes, $childnodes);
605         }
606         return $nodes;
607     }
609     /**
610      * Removes this node if it is empty
611      */
612     public function trim_if_empty() {
613         if ($this->children->count() == 0) {
614             $this->remove();
615         }
616     }
618     /**
619      * Creates a tab representation of this nodes children that can be used
620      * with print_tabs to produce the tabs on a page.
621      *
622      * call_user_func_array('print_tabs', $node->get_tabs_array());
623      *
624      * @param array $inactive
625      * @param bool $return
626      * @return array Array (tabs, selected, inactive, activated, return)
627      */
628     public function get_tabs_array(array $inactive=array(), $return=false) {
629         $tabs = array();
630         $rows = array();
631         $selected = null;
632         $activated = array();
633         foreach ($this->children as $node) {
634             $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title());
635             if ($node->contains_active_node()) {
636                 if ($node->children->count() > 0) {
637                     $activated[] = $node->key;
638                     foreach ($node->children as $child) {
639                         if ($child->contains_active_node()) {
640                             $selected = $child->key;
641                         }
642                         $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title());
643                     }
644                 } else {
645                     $selected = $node->key;
646                 }
647             }
648         }
649         return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
650     }
653 /**
654  * Navigation node collection
655  *
656  * This class is responsible for managing a collection of navigation nodes.
657  * It is required because a node's unique identifier is a combination of both its
658  * key and its type.
659  *
660  * Originally an array was used with a string key that was a combination of the two
661  * however it was decided that a better solution would be to use a class that
662  * implements the standard IteratorAggregate interface.
663  *
664  * @package moodlecore
665  * @subpackage navigation
666  * @copyright 2010 Sam Hemelryk
667  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
668  */
669 class navigation_node_collection implements IteratorAggregate {
670     /**
671      * A multidimensional array to where the first key is the type and the second
672      * key is the nodes key.
673      * @var array
674      */
675     protected $collection = array();
676     /**
677      * An array that contains references to nodes in the same order they were added.
678      * This is maintained as a progressive array.
679      * @var array
680      */
681     protected $orderedcollection = array();
682     /**
683      * A reference to the last node that was added to the collection
684      * @var navigation_node
685      */
686     protected $last = null;
687     /**
688      * The total number of items added to this array.
689      * @var int
690      */
691     protected $count = 0;
693     /**
694      * Adds a navigation node to the collection
695      *
696      * @param navigation_node $node Node to add
697      * @param string $beforekey If specified, adds before a node with this key,
698      *   otherwise adds at end
699      * @return navigation_node Added node
700      */
701     public function add(navigation_node $node, $beforekey=null) {
702         global $CFG;
703         $key = $node->key;
704         $type = $node->type;
706         // First check we have a 2nd dimension for this type
707         if (!array_key_exists($type, $this->orderedcollection)) {
708             $this->orderedcollection[$type] = array();
709         }
710         // Check for a collision and report if debugging is turned on
711         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
712             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
713         }
715         // Find the key to add before
716         $newindex = $this->count;
717         $last = true;
718         if ($beforekey !== null) {
719             foreach ($this->collection as $index => $othernode) {
720                 if ($othernode->key === $beforekey) {
721                     $newindex = $index;
722                     $last = false;
723                     break;
724                 }
725             }
726             if ($newindex === $this->count) {
727                 debugging('Navigation node add_before: Reference node not found ' . $beforekey .
728                         ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER);
729             }
730         }
732         // Add the node to the appropriate place in the by-type structure (which
733         // is not ordered, despite the variable name)
734         $this->orderedcollection[$type][$key] = $node;
735         if (!$last) {
736             // Update existing references in the ordered collection (which is the
737             // one that isn't called 'ordered') to shuffle them along if required
738             for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) {
739                 $this->collection[$oldindex] = $this->collection[$oldindex - 1];
740             }
741         }
742         // Add a reference to the node to the progressive collection.
743         $this->collection[$newindex] = &$this->orderedcollection[$type][$key];
744         // Update the last property to a reference to this new node.
745         $this->last = &$this->orderedcollection[$type][$key];
747         // Reorder the array by index if needed
748         if (!$last) {
749             ksort($this->collection);
750         }
751         $this->count++;
752         // Return the reference to the now added node
753         return $node;
754     }
756     /**
757      * Return a list of all the keys of all the nodes.
758      * @return array the keys.
759      */
760     public function get_key_list() {
761         $keys = array();
762         foreach ($this->collection as $node) {
763             $keys[] = $node->key;
764         }
765         return $keys;
766     }
768     /**
769      * Fetches a node from this collection.
770      *
771      * @param string|int $key The key of the node we want to find.
772      * @param int $type One of navigation_node::TYPE_*.
773      * @return navigation_node|null
774      */
775     public function get($key, $type=null) {
776         if ($type !== null) {
777             // If the type is known then we can simply check and fetch
778             if (!empty($this->orderedcollection[$type][$key])) {
779                 return $this->orderedcollection[$type][$key];
780             }
781         } else {
782             // Because we don't know the type we look in the progressive array
783             foreach ($this->collection as $node) {
784                 if ($node->key === $key) {
785                     return $node;
786                 }
787             }
788         }
789         return false;
790     }
792     /**
793      * Searches for a node with matching key and type.
794      *
795      * This function searches both the nodes in this collection and all of
796      * the nodes in each collection belonging to the nodes in this collection.
797      *
798      * Recursive.
799      *
800      * @param string|int $key  The key of the node we want to find.
801      * @param int $type  One of navigation_node::TYPE_*.
802      * @return navigation_node|null
803      */
804     public function find($key, $type=null) {
805         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
806             return $this->orderedcollection[$type][$key];
807         } else {
808             $nodes = $this->getIterator();
809             // Search immediate children first
810             foreach ($nodes as &$node) {
811                 if ($node->key === $key && ($type === null || $type === $node->type)) {
812                     return $node;
813                 }
814             }
815             // Now search each childs children
816             foreach ($nodes as &$node) {
817                 $result = $node->children->find($key, $type);
818                 if ($result !== false) {
819                     return $result;
820                 }
821             }
822         }
823         return false;
824     }
826     /**
827      * Fetches the last node that was added to this collection
828      *
829      * @return navigation_node
830      */
831     public function last() {
832         return $this->last;
833     }
835     /**
836      * Fetches all nodes of a given type from this collection
837      */
838     public function type($type) {
839         if (!array_key_exists($type, $this->orderedcollection)) {
840             $this->orderedcollection[$type] = array();
841         }
842         return $this->orderedcollection[$type];
843     }
844     /**
845      * Removes the node with the given key and type from the collection
846      *
847      * @param string|int $key
848      * @param int $type
849      * @return bool
850      */
851     public function remove($key, $type=null) {
852         $child = $this->get($key, $type);
853         if ($child !== false) {
854             foreach ($this->collection as $colkey => $node) {
855                 if ($node->key == $key && $node->type == $type) {
856                     unset($this->collection[$colkey]);
857                     break;
858                 }
859             }
860             unset($this->orderedcollection[$child->type][$child->key]);
861             $this->count--;
862             return true;
863         }
864         return false;
865     }
867     /**
868      * Gets the number of nodes in this collection
869      * @return int
870      */
871     public function count() {
872         return count($this->collection);
873     }
874     /**
875      * Gets an array iterator for the collection.
876      *
877      * This is required by the IteratorAggregator interface and is used by routines
878      * such as the foreach loop.
879      *
880      * @return ArrayIterator
881      */
882     public function getIterator() {
883         return new ArrayIterator($this->collection);
884     }
887 /**
888  * The global navigation class used for... the global navigation
889  *
890  * This class is used by PAGE to store the global navigation for the site
891  * and is then used by the settings nav and navbar to save on processing and DB calls
892  *
893  * See
894  * <ul>
895  * <li><b>{@link lib/pagelib.php}</b> {@link moodle_page::initialise_theme_and_output()}<li>
896  * <li><b>{@link lib/ajax/getnavbranch.php}</b> Called by ajax<li>
897  * </ul>
898  *
899  * @package moodlecore
900  * @subpackage navigation
901  * @copyright 2009 Sam Hemelryk
902  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
903  */
904 class global_navigation extends navigation_node {
905     /**
906      * The Moodle page this navigation object belongs to.
907      * @var moodle_page
908      */
909     protected $page;
910     /** @var bool */
911     protected $initialised = false;
912     /** @var array */
913     protected $mycourses = array();
914     /** @var array */
915     protected $rootnodes = array();
916     /** @var bool */
917     protected $showemptysections = false;
918     /** @var array */
919     protected $extendforuser = array();
920     /** @var navigation_cache */
921     protected $cache;
922     /** @var array */
923     protected $addedcourses = array();
924     /** @var int */
925     protected $expansionlimit = 0;
926     /** @var int */
927     protected $useridtouseforparentchecks = 0;
929     /**
930      * Constructs a new global navigation
931      *
932      * @param moodle_page $page The page this navigation object belongs to
933      */
934     public function __construct(moodle_page $page) {
935         global $CFG, $SITE, $USER;
937         if (during_initial_install()) {
938             return;
939         }
941         if (get_home_page() == HOMEPAGE_SITE) {
942             // We are using the site home for the root element
943             $properties = array(
944                 'key' => 'home',
945                 'type' => navigation_node::TYPE_SYSTEM,
946                 'text' => get_string('home'),
947                 'action' => new moodle_url('/')
948             );
949         } else {
950             // We are using the users my moodle for the root element
951             $properties = array(
952                 'key' => 'myhome',
953                 'type' => navigation_node::TYPE_SYSTEM,
954                 'text' => get_string('myhome'),
955                 'action' => new moodle_url('/my/')
956             );
957         }
959         // Use the parents consturctor.... good good reuse
960         parent::__construct($properties);
962         // Initalise and set defaults
963         $this->page = $page;
964         $this->forceopen = true;
965         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
967         // Check if we need to clear the cache
968         $regenerate = optional_param('regenerate', null, PARAM_TEXT);
969         if ($regenerate === 'navigation') {
970             $this->cache->clear();
971         }
972     }
974     /**
975      * Mutator to set userid to allow parent to see child's profile
976      * page navigation. See MDL-25805 for initial issue. Linked to it
977      * is an issue explaining why this is a REALLY UGLY HACK thats not
978      * for you to use!
979      *
980      * @param int $userid userid of profile page that parent wants to navigate around. 
981      */
982     public function set_userid_for_parent_checks($userid) {
983         $this->useridtouseforparentchecks = $userid;
984     }
987     /**
988      * Initialises the navigation object.
989      *
990      * This causes the navigation object to look at the current state of the page
991      * that it is associated with and then load the appropriate content.
992      *
993      * This should only occur the first time that the navigation structure is utilised
994      * which will normally be either when the navbar is called to be displayed or
995      * when a block makes use of it.
996      *
997      * @return bool
998      */
999     public function initialise() {
1000         global $CFG, $SITE, $USER, $DB;
1001         // Check if it has alread been initialised
1002         if ($this->initialised || during_initial_install()) {
1003             return true;
1004         }
1005         $this->initialised = true;
1007         // Set up the five base root nodes. These are nodes where we will put our
1008         // content and are as follows:
1009         // site:        Navigation for the front page.
1010         // myprofile:     User profile information goes here.
1011         // mycourses:   The users courses get added here.
1012         // courses:     Additional courses are added here.
1013         // users:       Other users information loaded here.
1014         $this->rootnodes = array();
1015         if (get_home_page() == HOMEPAGE_SITE) {
1016             // The home element should be my moodle because the root element is the site
1017             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
1018                 $this->rootnodes['home']      = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
1019             }
1020         } else {
1021             // The home element should be the site because the root node is my moodle
1022             $this->rootnodes['home']      = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
1023             if ($CFG->defaulthomepage == HOMEPAGE_MY) {
1024                 // We need to stop automatic redirection
1025                 $this->rootnodes['home']->action->param('redirect', '0');
1026             }
1027         }
1028         $this->rootnodes['site']      = $this->add_course($SITE);
1029         $this->rootnodes['myprofile']   = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
1030         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses');
1031         $this->rootnodes['courses']   = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
1032         $this->rootnodes['users']     = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
1034         // Fetch all of the users courses.
1035         $limit = 20;
1036         if (!empty($CFG->navcourselimit)) {
1037             $limit = $CFG->navcourselimit;
1038         }
1040         if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') == 1) {
1041             // There is only one category so we don't want to show categories
1042             $CFG->navshowcategories = false;
1043         }
1045         $this->mycourses = enrol_get_my_courses(NULL, 'visible DESC,sortorder ASC', $limit);
1046         $showallcourses = (count($this->mycourses) == 0 || !empty($CFG->navshowallcourses));
1047         $showcategories = ($showallcourses && !empty($CFG->navshowcategories));
1049         // Check if any courses were returned.
1050         if (count($this->mycourses) > 0) {
1051             // Add all of the users courses to the navigation
1052             foreach ($this->mycourses as &$course) {
1053                 $course->coursenode = $this->add_course($course);
1054             }
1055         }
1057         if ($showcategories) {
1058             // Load all categories (ensures we get the base categories)
1059             $this->load_all_categories();
1060         } else if ($showallcourses) {
1061             // Load all courses
1062             $this->load_all_courses();
1063         }
1065         // We always load the frontpage course to ensure it is available without
1066         // JavaScript enabled.
1067         $frontpagecourse = $this->load_course($SITE);
1068         $this->add_front_page_course_essentials($frontpagecourse, $SITE);
1070         $canviewcourseprofile = true;
1072         // Next load context specific content into the navigation
1073         switch ($this->page->context->contextlevel) {
1074             case CONTEXT_SYSTEM :
1075                 // This has already been loaded we just need to map the variable
1076                 $coursenode = $frontpagecourse;
1077                 break;
1078             case CONTEXT_COURSECAT :
1079                 // This has already been loaded we just need to map the variable
1080                 $coursenode = $frontpagecourse;
1081                 $this->load_all_categories($this->page->context->instanceid);
1082                 break;
1083             case CONTEXT_BLOCK :
1084             case CONTEXT_COURSE :
1085                 // Load the course associated with the page into the navigation
1086                 $course = $this->page->course;
1087                 $coursenode = $this->load_course($course);
1089                 // If the course wasn't added then don't try going any further.
1090                 if (!$coursenode) {
1091                     $canviewcourseprofile = false;
1092                     break;
1093                 }
1095                 // If the user is not enrolled then we only want to show the
1096                 // course node and not populate it.
1097                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1099                 // Not enrolled, can't view, and hasn't switched roles
1100                 if (!can_access_course($coursecontext)) {
1101                     // TODO: very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1102                     // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1103                     $isparent = false;
1104                     if ($this->useridtouseforparentchecks) {
1105                         $currentuser = ($this->useridtouseforparentchecks == $USER->id);
1106                         if (!$currentuser) {
1107                             $usercontext   = get_context_instance(CONTEXT_USER, $this->useridtouseforparentchecks, MUST_EXIST);
1108                             if ($DB->record_exists('role_assignments', array('userid'=>$USER->id, 'contextid'=>$usercontext->id))
1109                                     and has_capability('moodle/user:viewdetails', $usercontext)) {
1110                                 $isparent = true;
1111                             }
1112                         }
1113                     }
1115                     if (!$isparent) {
1116                         $coursenode->make_active();
1117                         $canviewcourseprofile = false;
1118                         break;
1119                     }
1120                 }
1121                 // Add the essentials such as reports etc...
1122                 $this->add_course_essentials($coursenode, $course);
1123                 if ($this->format_display_course_content($course->format)) {
1124                     // Load the course sections
1125                     $sections = $this->load_course_sections($course, $coursenode);
1126                 }
1127                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1128                     $coursenode->make_active();
1129                 }
1130                 break;
1131             case CONTEXT_MODULE :
1132                 $course = $this->page->course;
1133                 $cm = $this->page->cm;
1134                 // Load the course associated with the page into the navigation
1135                 $coursenode = $this->load_course($course);
1137                 // If the user is not enrolled then we only want to show the
1138                 // course node and not populate it.
1139                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1140                 if (!can_access_course($coursecontext)) {
1141                     if ($coursenode) {
1142                         $coursenode->make_active();
1143                     }
1144                     $canviewcourseprofile = false;
1145                     break;
1146                 }
1148                 $this->add_course_essentials($coursenode, $course);
1149                 // Load the course sections into the page
1150                 $sections = $this->load_course_sections($course, $coursenode);
1151                 if ($course->id != SITEID) {
1152                     // Find the section for the $CM associated with the page and collect
1153                     // its section number.
1154                     if (isset($cm->sectionnum)) {
1155                         $cm->sectionnumber = $cm->sectionnum;
1156                     } else {
1157                         foreach ($sections as $section) {
1158                             if ($section->id == $cm->section) {
1159                                 $cm->sectionnumber = $section->section;
1160                                 break;
1161                             }
1162                         }
1163                     }
1165                     // Load all of the section activities for the section the cm belongs to.
1166                     if (isset($cm->sectionnumber) and !empty($sections[$cm->sectionnumber])) {
1167                         $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course));
1168                     } else {
1169                         $activities = array();
1170                         if ($activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course))) {
1171                             // "stealth" activity from unavailable section
1172                             $activities[$cm->id] = $activity;
1173                         }
1174                     }
1175                 } else {
1176                     $activities = array();
1177                     $activities[$cm->id] = $coursenode->get($cm->id, navigation_node::TYPE_ACTIVITY);
1178                 }
1179                 if (!empty($activities[$cm->id])) {
1180                     // Finally load the cm specific navigaton information
1181                     $this->load_activity($cm, $course, $activities[$cm->id]);
1182                     // Check if we have an active ndoe
1183                     if (!$activities[$cm->id]->contains_active_node() && !$activities[$cm->id]->search_for_active_node()) {
1184                         // And make the activity node active.
1185                         $activities[$cm->id]->make_active();
1186                     }
1187                 } else {
1188                     //TODO: something is wrong, what to do? (Skodak)
1189                 }
1190                 break;
1191             case CONTEXT_USER :
1192                 $course = $this->page->course;
1193                 if ($course->id != SITEID) {
1194                     // Load the course associated with the user into the navigation
1195                     $coursenode = $this->load_course($course);
1196                     // If the user is not enrolled then we only want to show the
1197                     // course node and not populate it.
1198                     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1199                     if (!can_access_course($coursecontext)) {
1200                         $coursenode->make_active();
1201                         $canviewcourseprofile = false;
1202                         break;
1203                     }
1204                     $this->add_course_essentials($coursenode, $course);
1205                     $sections = $this->load_course_sections($course, $coursenode);
1206                 }
1207                 break;
1208         }
1210         $limit = 20;
1211         if (!empty($CFG->navcourselimit)) {
1212             $limit = $CFG->navcourselimit;
1213         }
1214         if ($showcategories) {
1215             $categories = $this->find_all_of_type(self::TYPE_CATEGORY);
1216             foreach ($categories as &$category) {
1217                 if ($category->children->count() >= $limit) {
1218                     $url = new moodle_url('/course/category.php', array('id'=>$category->key));
1219                     $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1220                 }
1221             }
1222         } else if ($this->rootnodes['courses']->children->count() >= $limit) {
1223             $this->rootnodes['courses']->add(get_string('viewallcoursescategories'), new moodle_url('/course/index.php'), self::TYPE_SETTING);
1224         }
1226         // Load for the current user
1227         $this->load_for_user();
1228         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != SITEID && $canviewcourseprofile) {
1229             $this->load_for_user(null, true);
1230         }
1231         // Load each extending user into the navigation.
1232         foreach ($this->extendforuser as $user) {
1233             if ($user->id != $USER->id) {
1234                 $this->load_for_user($user);
1235             }
1236         }
1238         // Give the local plugins a chance to include some navigation if they want.
1239         foreach (get_list_of_plugins('local') as $plugin) {
1240             if (!file_exists($CFG->dirroot.'/local/'.$plugin.'/lib.php')) {
1241                 continue;
1242             }
1243             require_once($CFG->dirroot.'/local/'.$plugin.'/lib.php');
1244             $function = $plugin.'_extends_navigation';
1245             if (function_exists($function)) {
1246                 $function($this);
1247             }
1248         }
1250         // Remove any empty root nodes
1251         foreach ($this->rootnodes as $node) {
1252             // Dont remove the home node
1253             if ($node->key !== 'home' && !$node->has_children()) {
1254                 $node->remove();
1255             }
1256         }
1258         if (!$this->contains_active_node()) {
1259             $this->search_for_active_node();
1260         }
1262         // If the user is not logged in modify the navigation structure as detailed
1263         // in {@link http://docs.moodle.org/en/Development:Navigation_2.0_structure}
1264         if (!isloggedin()) {
1265             $activities = clone($this->rootnodes['site']->children);
1266             $this->rootnodes['site']->remove();
1267             $children = clone($this->children);
1268             $this->children = new navigation_node_collection();
1269             foreach ($activities as $child) {
1270                 $this->children->add($child);
1271             }
1272             foreach ($children as $child) {
1273                 $this->children->add($child);
1274             }
1275         }
1276         return true;
1277     }
1278     /**
1279      * Checks the course format to see whether it wants the navigation to load
1280      * additional information for the course.
1281      *
1282      * This function utilises a callback that can exist within the course format lib.php file
1283      * The callback should be a function called:
1284      * callback_{formatname}_display_content()
1285      * It doesn't get any arguments and should return true if additional content is
1286      * desired. If the callback doesn't exist we assume additional content is wanted.
1287      *
1288      * @param string $format The course format
1289      * @return bool
1290      */
1291     protected function format_display_course_content($format) {
1292         global $CFG;
1293         $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
1294         if (file_exists($formatlib)) {
1295             require_once($formatlib);
1296             $displayfunc = 'callback_'.$format.'_display_content';
1297             if (function_exists($displayfunc) && !$displayfunc()) {
1298                 return $displayfunc();
1299             }
1300         }
1301         return true;
1302     }
1304     /**
1305      * Loads of the the courses in Moodle into the navigation.
1306      *
1307      * @param string|array $categoryids Either a string or array of category ids to load courses for
1308      * @return array An array of navigation_node
1309      */
1310     protected function load_all_courses($categoryids=null) {
1311         global $CFG, $DB, $USER;
1313         if ($categoryids !== null) {
1314             if (is_array($categoryids)) {
1315                 list ($select, $params) = $DB->get_in_or_equal($categoryids);
1316             } else {
1317                 $select = '= ?';
1318                 $params = array($categoryids);
1319             }
1320             array_unshift($params, SITEID);
1321             $select = ' AND c.category '.$select;
1322         } else {
1323             $params = array(SITEID);
1324             $select = '';
1325         }
1327         list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1328         $sql = "SELECT c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.category,cat.path AS categorypath $ccselect
1329                 FROM {course} c
1330                 $ccjoin
1331                 LEFT JOIN {course_categories} cat ON cat.id=c.category
1332                 WHERE c.id <> ?$select
1333                 ORDER BY c.sortorder ASC";
1334         $limit = 20;
1335         if (!empty($CFG->navcourselimit)) {
1336             $limit = $CFG->navcourselimit;
1337         }
1338         $courses = $DB->get_records_sql($sql, $params, 0, $limit);
1340         $coursenodes = array();
1341         foreach ($courses as $course) {
1342             context_instance_preload($course);
1343             $coursenodes[$course->id] = $this->add_course($course);
1344         }
1345         return $coursenodes;
1346     }
1348     /**
1349      * Loads all categories (top level or if an id is specified for that category)
1350      *
1351      * @param int $categoryid
1352      * @return void
1353      */
1354     protected function load_all_categories($categoryid=null) {
1355         global $DB;
1356         if ($categoryid == null)  {
1357             $categories = $DB->get_records('course_categories', array('parent'=>'0'), 'sortorder');
1358         } else {
1359             $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST);
1360             $wantedids = explode('/', trim($category->path, '/'));
1361             list($select, $params) = $DB->get_in_or_equal($wantedids);
1362             $select = 'id '.$select.' OR parent '.$select;
1363             $params = array_merge($params, $params);
1364             $categories = $DB->get_records_select('course_categories', $select, $params, 'sortorder');
1365         }
1366         $structured = array();
1367         $categoriestoload = array();
1368         foreach ($categories as $category) {
1369             if ($category->parent == '0') {
1370                 $structured[$category->id] = array('category'=>$category, 'children'=>array());
1371             } else {
1372                 if ($category->parent == $categoryid) {
1373                     $categoriestoload[] = $category->id;
1374                 }
1375                 $parents = array();
1376                 $id = $category->parent;
1377                 while ($id != '0') {
1378                     $parents[] = $id;
1379                     if (!array_key_exists($id, $categories)) {
1380                         $categories[$id] = $DB->get_record('course_categories', array('id'=>$id), '*', MUST_EXIST);
1381                     }
1382                     $id = $categories[$id]->parent;
1383                 }
1384                 $parents = array_reverse($parents);
1385                 $parentref = &$structured[array_shift($parents)];
1386                 foreach ($parents as $parent) {
1387                     if (!array_key_exists($parent, $parentref['children'])) {
1388                         $parentref['children'][$parent] = array('category'=>$categories[$parent], 'children'=>array());
1389                     }
1390                     $parentref = &$parentref['children'][$parent];
1391                 }
1392                 if (!array_key_exists($category->id, $parentref['children'])) {
1393                     $parentref['children'][$category->id] = array('category'=>$category, 'children'=>array());
1394                 }
1395             }
1396         }
1398         foreach ($structured as $category) {
1399             $this->add_category($category, $this->rootnodes['courses']);
1400         }
1402         if ($categoryid !== null && count($wantedids)) {
1403             foreach ($wantedids as $catid) {
1404                 $this->load_all_courses($catid);
1405             }
1406         }
1407     }
1409     /**
1410      * Adds a structured category to the navigation in the correct order/place
1411      *
1412      * @param object $cat
1413      * @param navigation_node $parent
1414      */
1415     protected function add_category($cat, navigation_node $parent) {
1416         $categorynode = $parent->get($cat['category']->id, navigation_node::TYPE_CATEGORY);
1417         if (!$categorynode) {
1418             $category = $cat['category'];
1419             $url = new moodle_url('/course/category.php', array('id'=>$category->id));
1420             $categorynode = $parent->add($category->name, $url, self::TYPE_CATEGORY, $category->name, $category->id);
1421             if (empty($category->visible)) {
1422                 if (has_capability('moodle/category:viewhiddencategories', get_system_context())) {
1423                     $categorynode->hidden = true;
1424                 } else {
1425                     $categorynode->display = false;
1426                 }
1427             }
1428         }
1429         foreach ($cat['children'] as $child) {
1430             $this->add_category($child, $categorynode);
1431         }
1432     }
1434     /**
1435      * Loads the given course into the navigation
1436      *
1437      * @param stdClass $course
1438      * @return navigation_node
1439      */
1440     protected function load_course(stdClass $course) {
1441         if ($course->id == SITEID) {
1442             $coursenode = $this->rootnodes['site'];
1443         } else if (array_key_exists($course->id, $this->mycourses)) {
1444             if (!isset($this->mycourses[$course->id]->coursenode)) {
1445                 $this->mycourses[$course->id]->coursenode = $this->add_course($course);
1446             }
1447             $coursenode = $this->mycourses[$course->id]->coursenode;
1448         } else {
1449             $coursenode = $this->add_course($course);
1450         }
1451         return $coursenode;
1452     }
1454     /**
1455      * Loads all of the courses section into the navigation.
1456      *
1457      * This function utilisies a callback that can be implemented within the course
1458      * formats lib.php file to customise the navigation that is generated at this
1459      * point for the course.
1460      *
1461      * By default (if not defined) the method {@see load_generic_course_sections} is
1462      * called instead.
1463      *
1464      * @param stdClass $course Database record for the course
1465      * @param navigation_node $coursenode The course node within the navigation
1466      * @return array Array of navigation nodes for the section with key = section id
1467      */
1468     protected function load_course_sections(stdClass $course, navigation_node $coursenode) {
1469         global $CFG;
1470         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
1471         $structurefunc = 'callback_'.$course->format.'_load_content';
1472         if (function_exists($structurefunc)) {
1473             return $structurefunc($this, $course, $coursenode);
1474         } else if (file_exists($structurefile)) {
1475             require_once $structurefile;
1476             if (function_exists($structurefunc)) {
1477                 return $structurefunc($this, $course, $coursenode);
1478             } else {
1479                 return $this->load_generic_course_sections($course, $coursenode);
1480             }
1481         } else {
1482             return $this->load_generic_course_sections($course, $coursenode);
1483         }
1484     }
1486     /**
1487      * Generically loads the course sections into the course's navigation.
1488      *
1489      * @param stdClass $course
1490      * @param navigation_node $coursenode
1491      * @param string $name The string that identifies each section. e.g Topic, or Week
1492      * @param string $activeparam The url used to identify the active section
1493      * @return array An array of course section nodes
1494      */
1495     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $courseformat='unknown') {
1496         global $CFG, $DB, $USER;
1498         require_once($CFG->dirroot.'/course/lib.php');
1500         if (!$this->cache->cached('modinfo'.$course->id)) {
1501             $this->cache->set('modinfo'.$course->id, get_fast_modinfo($course));
1502         }
1503         $modinfo = $this->cache->{'modinfo'.$course->id};
1505         if (!$this->cache->cached('coursesections'.$course->id)) {
1506             $this->cache->set('coursesections'.$course->id, array_slice(get_all_sections($course->id), 0, $course->numsections+1, true));
1507         }
1508         $sections = $this->cache->{'coursesections'.$course->id};
1510         $viewhiddensections = has_capability('moodle/course:viewhiddensections', $this->page->context);
1512         $activesection = course_get_display($course->id);
1514         $namingfunction = 'callback_'.$courseformat.'_get_section_name';
1515         $namingfunctionexists = (function_exists($namingfunction));
1517         $activeparamfunction = 'callback_'.$courseformat.'_request_key';
1518         if (function_exists($activeparamfunction)) {
1519             $activeparam = $activeparamfunction();
1520         } else {
1521             $activeparam = 'section';
1522         }
1523         $navigationsections = array();
1524         foreach ($sections as $sectionid=>$section) {
1525             $section = clone($section);
1526             if ($course->id == SITEID) {
1527                 $this->load_section_activities($coursenode, $section->section, $modinfo);
1528             } else {
1529                 if ((!$viewhiddensections && !$section->visible) || (!$this->showemptysections && !array_key_exists($section->section, $modinfo->sections))) {
1530                     continue;
1531                 }
1532                 if ($namingfunctionexists) {
1533                     $sectionname = $namingfunction($course, $section, $sections);
1534                 } else {
1535                     $sectionname = get_string('section').' '.$section->section;
1536                 }
1537                 //$url = new moodle_url('/course/view.php', array('id'=>$course->id));
1538                 $url = null;
1539                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1540                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1541                 $sectionnode->hidden = (!$section->visible);
1542                 if ($this->page->context->contextlevel != CONTEXT_MODULE && ($sectionnode->isactive || ($activesection && $section->section == $activesection))) {
1543                     $sectionnode->force_open();
1544                     $this->load_section_activities($sectionnode, $section->section, $modinfo);
1545                 }
1546                 $section->sectionnode = $sectionnode;
1547                 $navigationsections[$sectionid] = $section;
1548             }
1549         }
1550         return $navigationsections;
1551     }
1552     /**
1553      * Loads all of the activities for a section into the navigation structure.
1554      *
1555      * @param navigation_node $sectionnode
1556      * @param int $sectionnumber
1557      * @param course_modinfo $modinfo Object returned from {@see get_fast_modinfo()}
1558      * @return array Array of activity nodes
1559      */
1560     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, course_modinfo $modinfo) {
1561         if (!array_key_exists($sectionnumber, $modinfo->sections)) {
1562             return true;
1563         }
1565         $activities = array();
1567         foreach ($modinfo->sections[$sectionnumber] as $cmid) {
1568             $cm = $modinfo->cms[$cmid];
1569             if (!$cm->uservisible) {
1570                 continue;
1571             }
1572             if ($cm->icon) {
1573                 $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
1574             } else {
1575                 $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
1576             }
1577             $url = $cm->get_url();
1578             $activitynode = $sectionnode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
1579             $activitynode->title(get_string('modulename', $cm->modname));
1580             $activitynode->hidden = (!$cm->visible);
1581             if (!$url) {
1582                 // Do not show activities that don't have links!
1583                 $activitynode->display = false;
1584             } else if ($this->module_extends_navigation($cm->modname)) {
1585                 $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
1586             }
1587             $activities[$cmid] = $activitynode;
1588         }
1590         return $activities;
1591     }
1592     /**
1593      * Loads a stealth module from unavailable section
1594      * @param navigation_node $coursenode
1595      * @param stdClass $modinfo
1596      * @return navigation_node or null if not accessible
1597      */
1598     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
1599         if (empty($modinfo->cms[$this->page->cm->id])) {
1600             return null;
1601         }
1602         $cm = $modinfo->cms[$this->page->cm->id];
1603         if (!$cm->uservisible) {
1604             return null;
1605         }
1606         if ($cm->icon) {
1607             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
1608         } else {
1609             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
1610         }
1611         $url = $cm->get_url();
1612         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
1613         $activitynode->title(get_string('modulename', $cm->modname));
1614         $activitynode->hidden = (!$cm->visible);
1615         if (!$url) {
1616             // Don't show activities that don't have links!
1617             $activitynode->display = false;
1618         } else if ($this->module_extends_navigation($cm->modname)) {
1619             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
1620         }
1621         return $activitynode;
1622     }
1623     /**
1624      * Loads the navigation structure for the given activity into the activities node.
1625      *
1626      * This method utilises a callback within the modules lib.php file to load the
1627      * content specific to activity given.
1628      *
1629      * The callback is a method: {modulename}_extend_navigation()
1630      * Examples:
1631      *  * {@see forum_extend_navigation()}
1632      *  * {@see workshop_extend_navigation()}
1633      *
1634      * @param cm_info|stdClass $cm
1635      * @param stdClass $course
1636      * @param navigation_node $activity
1637      * @return bool
1638      */
1639     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
1640         global $CFG, $DB;
1642         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
1643         if (!($cm instanceof cm_info)) {
1644             $modinfo = get_fast_modinfo($course);
1645             $cm = $modinfo->get_cm($cm->id);
1646         }
1648         $activity->make_active();
1649         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
1650         $function = $cm->modname.'_extend_navigation';
1652         if (file_exists($file)) {
1653             require_once($file);
1654             if (function_exists($function)) {
1655                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
1656                 $function($activity, $course, $activtyrecord, $cm);
1657                 return true;
1658             }
1659         }
1660         $activity->nodetype = navigation_node::NODETYPE_LEAF;
1661         return false;
1662     }
1663     /**
1664      * Loads user specific information into the navigation in the appopriate place.
1665      *
1666      * If no user is provided the current user is assumed.
1667      *
1668      * @param stdClass $user
1669      * @return bool
1670      */
1671     protected function load_for_user($user=null, $forceforcontext=false) {
1672         global $DB, $CFG, $USER;
1674         if ($user === null) {
1675             // We can't require login here but if the user isn't logged in we don't
1676             // want to show anything
1677             if (!isloggedin() || isguestuser()) {
1678                 return false;
1679             }
1680             $user = $USER;
1681         } else if (!is_object($user)) {
1682             // If the user is not an object then get them from the database
1683             $user = $DB->get_record('user', array('id'=>(int)$user), '*', MUST_EXIST);
1684         }
1686         $iscurrentuser = ($user->id == $USER->id);
1688         $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1690         // Get the course set against the page, by default this will be the site
1691         $course = $this->page->course;
1692         $baseargs = array('id'=>$user->id);
1693         if ($course->id != SITEID && (!$iscurrentuser || $forceforcontext)) {
1694             if (array_key_exists($course->id, $this->mycourses)) {
1695                 $coursenode = $this->mycourses[$course->id]->coursenode;
1696             } else {
1697                 $coursenode = $this->rootnodes['courses']->find($course->id, navigation_node::TYPE_COURSE);
1698                 if (!$coursenode) {
1699                     $coursenode = $this->load_course($course);
1700                 }
1701             }
1702             $baseargs['course'] = $course->id;
1703             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1704             $issitecourse = false;
1705         } else {
1706             // Load all categories and get the context for the system
1707             $coursecontext = get_context_instance(CONTEXT_SYSTEM);
1708             $issitecourse = true;
1709         }
1711         // Create a node to add user information under.
1712         if ($iscurrentuser && !$forceforcontext) {
1713             // If it's the current user the information will go under the profile root node
1714             $usernode = $this->rootnodes['myprofile'];
1715         } else {
1716             if (!$issitecourse) {
1717                 // Not the current user so add it to the participants node for the current course
1718                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
1719                 $userviewurl = new moodle_url('/user/view.php', $baseargs);
1720             } else {
1721                 // This is the site so add a users node to the root branch
1722                 $usersnode = $this->rootnodes['users'];
1723                 $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
1724                 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
1725             }
1726             if (!$usersnode) {
1727                 // We should NEVER get here, if the course hasn't been populated
1728                 // with a participants node then the navigaiton either wasn't generated
1729                 // for it (you are missing a require_login or set_context call) or
1730                 // you don't have access.... in the interests of no leaking informatin
1731                 // we simply quit...
1732                 return false;
1733             }
1734             // Add a branch for the current user
1735             $usernode = $usersnode->add(fullname($user, true), $userviewurl, self::TYPE_USER, null, $user->id);
1737             if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
1738                 $usernode->make_active();
1739             }
1740         }
1742         // If the user is the current user or has permission to view the details of the requested
1743         // user than add a view profile link.
1744         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
1745             if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
1746                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
1747             } else {
1748                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
1749             }
1750         }
1752         // Add nodes for forum posts and discussions if the user can view either or both
1753         // There are no capability checks here as the content of the page is based
1754         // purely on the forums the current user has access too.
1755         $forumtab = $usernode->add(get_string('forumposts', 'forum'));
1756         $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
1757         $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
1759         // Add blog nodes
1760         if (!empty($CFG->bloglevel)) {
1761             require_once($CFG->dirroot.'/blog/lib.php');
1762             // Get all options for the user
1763             $options = blog_get_options_for_user($user);
1764             if (count($options) > 0) {
1765                 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
1766                 foreach ($options as $option) {
1767                     $blogs->add($option['string'], $option['link']);
1768                 }
1769             }
1770         }
1772         if (!empty($CFG->messaging)) {
1773             $messageargs = null;
1774             if ($USER->id!=$user->id) {
1775                 $messageargs = array('id'=>$user->id);
1776             }
1777             $url = new moodle_url('/message/index.php',$messageargs);
1778             $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
1779         }
1781         $context = get_context_instance(CONTEXT_USER, $USER->id);
1782         if ($iscurrentuser && has_capability('moodle/user:manageownfiles', $context)) {
1783             $url = new moodle_url('/user/files.php');
1784             $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
1785         }
1787         // Add a node to view the users notes if permitted
1788         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
1789             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
1790             if ($coursecontext->instanceid) {
1791                 $url->param('course', $coursecontext->instanceid);
1792             }
1793             $usernode->add(get_string('notes', 'notes'), $url);
1794         }
1796         // Add a reports tab and then add reports the the user has permission to see.
1797         $anyreport      = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
1799         $outlinetreport = ($anyreport || has_capability('coursereport/outline:view', $coursecontext));
1800         $logtodayreport = ($anyreport || has_capability('coursereport/log:viewtoday', $coursecontext));
1801         $logreport      = ($anyreport || has_capability('coursereport/log:view', $coursecontext));
1802         $statsreport    = ($anyreport || has_capability('coursereport/stats:view', $coursecontext));
1804         $somereport     = $outlinetreport || $logtodayreport || $logreport || $statsreport;
1806         $viewreports = ($anyreport || $somereport || ($course->showreports && $iscurrentuser && $forceforcontext));
1807         if ($viewreports) {
1808             $reporttab = $usernode->add(get_string('activityreports'));
1809             $reportargs = array('user'=>$user->id);
1810             if (!empty($course->id)) {
1811                 $reportargs['id'] = $course->id;
1812             } else {
1813                 $reportargs['id'] = SITEID;
1814             }
1815             if ($viewreports || $outlinetreport) {
1816                 $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
1817                 $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
1818             }
1820             if ($viewreports || $logtodayreport) {
1821                 $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
1822             }
1824             if ($viewreports || $logreport ) {
1825                 $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
1826             }
1828             if (!empty($CFG->enablestats)) {
1829                 if ($viewreports || $statsreport) {
1830                     $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
1831                 }
1832             }
1834             $gradeaccess = false;
1835             if (has_capability('moodle/grade:viewall', $coursecontext)) {
1836                 //ok - can view all course grades
1837                 $gradeaccess = true;
1838             } else if ($course->showgrades) {
1839                 if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) {
1840                     //ok - can view own grades
1841                     $gradeaccess = true;
1842                 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
1843                     // ok - can view grades of this user - parent most probably
1844                     $gradeaccess = true;
1845                 } else if ($anyreport) {
1846                     // ok - can view grades of this user - parent most probably
1847                     $gradeaccess = true;
1848                 }
1849             }
1850             if ($gradeaccess) {
1851                 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'grade'))));
1852             }
1854             // Check the number of nodes in the report node... if there are none remove
1855             // the node
1856             if (count($reporttab->children)===0) {
1857                 $usernode->remove_child($reporttab);
1858             }
1859         }
1861         // If the user is the current user add the repositories for the current user
1862         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
1863         if ($iscurrentuser) {
1864             require_once($CFG->dirroot . '/repository/lib.php');
1865             $editabletypes = repository::get_editable_types($usercontext);
1866             if (!empty($editabletypes)) {
1867                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
1868             }
1869         } else if ($course->id == SITEID && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
1871             // Add view grade report is permitted
1872             $reports = get_plugin_list('gradereport');
1873             arsort($reports); // user is last, we want to test it first
1875             $userscourses = enrol_get_users_courses($user->id);
1876             $userscoursesnode = $usernode->add(get_string('courses'));
1878             foreach ($userscourses as $usercourse) {
1879                 $usercoursecontext = get_context_instance(CONTEXT_COURSE, $usercourse->id);
1880                 $usercoursenode = $userscoursesnode->add($usercourse->shortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
1882                 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
1883                 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
1884                     foreach ($reports as $plugin => $plugindir) {
1885                         if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
1886                             //stop when the first visible plugin is found
1887                             $gradeavailable = true;
1888                             break;
1889                         }
1890                     }
1891                 }
1893                 if ($gradeavailable) {
1894                     $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
1895                     $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
1896                 }
1898                 // Add a node to view the users notes if permitted
1899                 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
1900                     $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
1901                     $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
1902                 }
1904                 if (can_access_course(get_context_instance(CONTEXT_COURSE, $usercourse->id), $user->id)) {
1905                     $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', ''));
1906                 }
1908                 $outlinetreport = ($anyreport || has_capability('coursereport/outline:view', $usercoursecontext));
1909                 $logtodayreport = ($anyreport || has_capability('coursereport/log:viewtoday', $usercoursecontext));
1910                 $logreport =      ($anyreport || has_capability('coursereport/log:view', $usercoursecontext));
1911                 $statsreport =    ($anyreport || has_capability('coursereport/stats:view', $usercoursecontext));
1912                 if ($outlinetreport || $logtodayreport || $logreport || $statsreport) {
1913                     $reporttab = $usercoursenode->add(get_string('activityreports'));
1914                     $reportargs = array('user'=>$user->id, 'id'=>$usercourse->id);
1915                     if ($outlinetreport) {
1916                         $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
1917                         $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
1918                     }
1920                     if ($logtodayreport) {
1921                         $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
1922                     }
1924                     if ($logreport) {
1925                         $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
1926                     }
1928                     if (!empty($CFG->enablestats) && $statsreport) {
1929                         $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
1930                     }
1931                 }
1932             }
1933         }
1934         return true;
1935     }
1937     /**
1938      * This method simply checks to see if a given module can extend the navigation.
1939      *
1940      * @param string $modname
1941      * @return bool
1942      */
1943     protected function module_extends_navigation($modname) {
1944         global $CFG;
1945         if ($this->cache->cached($modname.'_extends_navigation')) {
1946             return $this->cache->{$modname.'_extends_navigation'};
1947         }
1948         $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
1949         $function = $modname.'_extend_navigation';
1950         if (function_exists($function)) {
1951             $this->cache->{$modname.'_extends_navigation'} = true;
1952             return true;
1953         } else if (file_exists($file)) {
1954             require_once($file);
1955             if (function_exists($function)) {
1956                 $this->cache->{$modname.'_extends_navigation'} = true;
1957                 return true;
1958             }
1959         }
1960         $this->cache->{$modname.'_extends_navigation'} = false;
1961         return false;
1962     }
1963     /**
1964      * Extends the navigation for the given user.
1965      *
1966      * @param stdClass $user A user from the database
1967      */
1968     public function extend_for_user($user) {
1969         $this->extendforuser[] = $user;
1970     }
1972     /**
1973      * Returns all of the users the navigation is being extended for
1974      *
1975      * @return array
1976      */
1977     public function get_extending_users() {
1978         return $this->extendforuser;
1979     }
1980     /**
1981      * Adds the given course to the navigation structure.
1982      *
1983      * @param stdClass $course
1984      * @return navigation_node
1985      */
1986     public function add_course(stdClass $course, $forcegeneric = false) {
1987         global $CFG;
1989         if ($course->id != SITEID) {
1990             if (!$course->visible) {
1991                 if (is_role_switched($course->id)) {
1992                     // user has to be able to access course in order to switch, let's skip the visibility test here
1993                 } else if (!has_capability('moodle/course:viewhiddencourses', get_context_instance(CONTEXT_COURSE, $course->id))) {
1994                     return false;
1995                 }
1996             }
1997         }
1999         $issite = ($course->id == SITEID);
2000         $ismycourse = (array_key_exists($course->id, $this->mycourses) && !$forcegeneric);
2001         $displaycategories = (!$ismycourse && !$issite && !empty($CFG->navshowcategories));
2002         $shortname = $course->shortname;
2004         if ($issite) {
2005             $parent = $this;
2006             $url = null;
2007             $shortname = get_string('sitepages');
2008         } else if ($ismycourse) {
2009             $parent = $this->rootnodes['mycourses'];
2010             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2011         } else {
2012             $parent = $this->rootnodes['courses'];
2013             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2014         }
2016         if ($displaycategories) {
2017             // We need to load the category structure for this course
2018             $categoryfound = false;
2019             if (!empty($course->categorypath)) {
2020                 $categories = explode('/', trim($course->categorypath, '/'));
2021                 $category = $parent;
2022                 while ($category && $categoryid = array_shift($categories)) {
2023                     $category = $category->get($categoryid, self::TYPE_CATEGORY);
2024                 }
2025                 if ($category instanceof navigation_node) {
2026                     $parent = $category;
2027                     $categoryfound = true;
2028                 }
2029                 if (!$categoryfound && $forcegeneric) {
2030                     $this->load_all_categories($course->category);
2031                     if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) {
2032                         $parent = $category;
2033                         $categoryfound = true;
2034                     }
2035                 }
2036             } else if (!empty($course->category)) {
2037                 $this->load_all_categories($course->category);
2038                 if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) {
2039                     $parent = $category;
2040                     $categoryfound = true;
2041                 }
2042                 if (!$categoryfound && !$forcegeneric) {
2043                     $this->load_all_categories($course->category);
2044                     if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) {
2045                         $parent = $category;
2046                         $categoryfound = true;
2047                     }
2048                 }
2049             }
2050         }
2052         // We found the course... we can return it now :)
2053         if ($coursenode = $parent->get($course->id, self::TYPE_COURSE)) {
2054             return $coursenode;
2055         }
2057         $coursenode = $parent->add($shortname, $url, self::TYPE_COURSE, $shortname, $course->id);
2058         $coursenode->nodetype = self::NODETYPE_BRANCH;
2059         $coursenode->hidden = (!$course->visible);
2060         $coursenode->title($course->fullname);
2061         $this->addedcourses[$course->id] = &$coursenode;
2062         if ($ismycourse && !empty($CFG->navshowallcourses)) {
2063             // We need to add this course to the general courses node as well as the
2064             // my courses node, rerun the function with the kill param
2065             $genericcourse = $this->add_course($course, true);
2066             if ($genericcourse->isactive) {
2067                 $genericcourse->make_inactive();
2068                 $genericcourse->collapse = true;
2069                 if ($genericcourse->parent && $genericcourse->parent->type == self::TYPE_CATEGORY) {
2070                     $parent = $genericcourse->parent;
2071                     while ($parent && $parent->type == self::TYPE_CATEGORY) {
2072                         $parent->collapse = true;
2073                         $parent = $parent->parent;
2074                     }
2075                 }
2076             }
2077         }
2078         return $coursenode;
2079     }
2080     /**
2081      * Adds essential course nodes to the navigation for the given course.
2082      *
2083      * This method adds nodes such as reports, blogs and participants
2084      *
2085      * @param navigation_node $coursenode
2086      * @param stdClass $course
2087      * @return bool
2088      */
2089     public function add_course_essentials(navigation_node $coursenode, stdClass $course) {
2090         global $CFG;
2092         if ($course->id == SITEID) {
2093             return $this->add_front_page_course_essentials($coursenode, $course);
2094         }
2096         if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2097             return true;
2098         }
2100         //Participants
2101         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
2102             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
2103             $currentgroup = groups_get_course_group($course, true);
2104             if ($course->id == SITEID) {
2105                 $filterselect = '';
2106             } else if ($course->id && !$currentgroup) {
2107                 $filterselect = $course->id;
2108             } else {
2109                 $filterselect = $currentgroup;
2110             }
2111             $filterselect = clean_param($filterselect, PARAM_INT);
2112             if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2113                and has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
2114                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2115                 $participants->add(get_string('blogs','blog'), $blogsurls->out());
2116             }
2117             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2118                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2119             }
2120         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2121             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2122         }
2124         // View course reports
2125         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
2126             $reportnav = $coursenode->add(get_string('reports'), new moodle_url('/course/report.php', array('id'=>$course->id)), self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2127             $coursereports = get_plugin_list('coursereport');
2128             foreach ($coursereports as $report=>$dir) {
2129                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2130                 if (file_exists($libfile)) {
2131                     require_once($libfile);
2132                     $reportfunction = $report.'_report_extend_navigation';
2133                     if (function_exists($report.'_report_extend_navigation')) {
2134                         $reportfunction($reportnav, $course, $this->page->context);
2135                     }
2136                 }
2137             }
2138         }
2139         return true;
2140     }
2141     /**
2142      * This generates the the structure of the course that won't be generated when
2143      * the modules and sections are added.
2144      *
2145      * Things such as the reports branch, the participants branch, blogs... get
2146      * added to the course node by this method.
2147      *
2148      * @param navigation_node $coursenode
2149      * @param stdClass $course
2150      * @return bool True for successfull generation
2151      */
2152     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2153         global $CFG;
2155         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2156             return true;
2157         }
2159         // Hidden node that we use to determine if the front page navigation is loaded.
2160         // This required as there are not other guaranteed nodes that may be loaded.
2161         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2163         //Participants
2164         if (has_capability('moodle/course:viewparticipants',  get_system_context())) {
2165             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2166         }
2168         $filterselect = 0;
2170         // Blogs
2171         if (!empty($CFG->bloglevel)
2172           and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2173           and has_capability('moodle/blog:view', get_context_instance(CONTEXT_SYSTEM))) {
2174             $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2175             $coursenode->add(get_string('blogs','blog'), $blogsurls->out());
2176         }
2178         // Notes
2179         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2180             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2181         }
2183         // Tags
2184         if (!empty($CFG->usetags) && isloggedin()) {
2185             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2186         }
2189         // View course reports
2190         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
2191             $reportnav = $coursenode->add(get_string('reports'), new moodle_url('/course/report.php', array('id'=>$course->id)), self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2192             $coursereports = get_plugin_list('coursereport');
2193             foreach ($coursereports as $report=>$dir) {
2194                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2195                 if (file_exists($libfile)) {
2196                     require_once($libfile);
2197                     $reportfunction = $report.'_report_extend_navigation';
2198                     if (function_exists($report.'_report_extend_navigation')) {
2199                         $reportfunction($reportnav, $course, $this->page->context);
2200                     }
2201                 }
2202             }
2203         }
2204         return true;
2205     }
2207     /**
2208      * Clears the navigation cache
2209      */
2210     public function clear_cache() {
2211         $this->cache->clear();
2212     }
2214     /**
2215      * Sets an expansion limit for the navigation
2216      *
2217      * The expansion limit is used to prevent the display of content that has a type
2218      * greater than the provided $type.
2219      *
2220      * Can be used to ensure things such as activities or activity content don't get
2221      * shown on the navigation.
2222      * They are still generated in order to ensure the navbar still makes sense.
2223      *
2224      * @param int $type One of navigation_node::TYPE_*
2225      * @return <type>
2226      */
2227     public function set_expansion_limit($type) {
2228         $nodes = $this->find_all_of_type($type);
2229         foreach ($nodes as &$node) {
2230             // We need to generate the full site node
2231             if ($type == self::TYPE_COURSE && $node->key == SITEID) {
2232                 continue;
2233             }
2234             foreach ($node->children as &$child) {
2235                 // We still want to show course reports and participants containers
2236                 // or there will be navigation missing.
2237                 if ($type == self::TYPE_COURSE && $child->type === self::TYPE_CONTAINER) {
2238                     continue;
2239                 }
2240                 $child->display = false;
2241             }
2242         }
2243         return true;
2244     }
2245     /**
2246      * Attempts to get the navigation with the given key from this nodes children.
2247      *
2248      * This function only looks at this nodes children, it does NOT look recursivily.
2249      * If the node can't be found then false is returned.
2250      *
2251      * If you need to search recursivily then use the {@see find()} method.
2252      *
2253      * Note: If you are trying to set the active node {@see navigation_node::override_active_url()}
2254      * may be of more use to you.
2255      *
2256      * @param string|int $key The key of the node you wish to receive.
2257      * @param int $type One of navigation_node::TYPE_*
2258      * @return navigation_node|false
2259      */
2260     public function get($key, $type = null) {
2261         if (!$this->initialised) {
2262             $this->initialise();
2263         }
2264         return parent::get($key, $type);
2265     }
2267     /**
2268      * Searches this nodes children and thier children to find a navigation node
2269      * with the matching key and type.
2270      *
2271      * This method is recursive and searches children so until either a node is
2272      * found of there are no more nodes to search.
2273      *
2274      * If you know that the node being searched for is a child of this node
2275      * then use the {@see get()} method instead.
2276      *
2277      * Note: If you are trying to set the active node {@see navigation_node::override_active_url()}
2278      * may be of more use to you.
2279      *
2280      * @param string|int $key The key of the node you wish to receive.
2281      * @param int $type One of navigation_node::TYPE_*
2282      * @return navigation_node|false
2283      */
2284     public function find($key, $type) {
2285         if (!$this->initialised) {
2286             $this->initialise();
2287         }
2288         return parent::find($key, $type);
2289     }
2292 /**
2293  * The limited global navigation class used for the AJAX extension of the global
2294  * navigation class.
2295  *
2296  * The primary methods that are used in the global navigation class have been overriden
2297  * to ensure that only the relevant branch is generated at the root of the tree.
2298  * This can be done because AJAX is only used when the backwards structure for the
2299  * requested branch exists.
2300  * This has been done only because it shortens the amounts of information that is generated
2301  * which of course will speed up the response time.. because no one likes laggy AJAX.
2302  *
2303  * @package moodlecore
2304  * @subpackage navigation
2305  * @copyright 2009 Sam Hemelryk
2306  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2307  */
2308 class global_navigation_for_ajax extends global_navigation {
2310     protected $branchtype;
2311     protected $instanceid;
2313     /** @var array */
2314     protected $expandable = array();
2316     /**
2317      * Constructs the navigation for use in AJAX request
2318      */
2319     public function __construct($page, $branchtype, $id) {
2320         $this->page = $page;
2321         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2322         $this->children = new navigation_node_collection();
2323         $this->branchtype = $branchtype;
2324         $this->instanceid = $id;
2325         $this->initialise();
2326     }
2327     /**
2328      * Initialise the navigation given the type and id for the branch to expand.
2329      *
2330      * @return array The expandable nodes
2331      */
2332     public function initialise() {
2333         global $CFG, $DB, $SITE;
2335         if ($this->initialised || during_initial_install()) {
2336             return $this->expandable;
2337         }
2338         $this->initialised = true;
2340         $this->rootnodes = array();
2341         $this->rootnodes['site']      = $this->add_course($SITE);
2342         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2344         // Branchtype will be one of navigation_node::TYPE_*
2345         switch ($this->branchtype) {
2346             case self::TYPE_CATEGORY :
2347                 $this->load_all_categories($this->instanceid);
2348                 $limit = 20;
2349                 if (!empty($CFG->navcourselimit)) {
2350                     $limit = (int)$CFG->navcourselimit;
2351                 }
2352                 $courses = $DB->get_records('course', array('category' => $this->instanceid), 'sortorder','*', 0, $limit);
2353                 foreach ($courses as $course) {
2354                     $this->add_course($course);
2355                 }
2356                 break;
2357             case self::TYPE_COURSE :
2358                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
2359                 require_course_login($course);
2360                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2361                 $coursenode = $this->add_course($course);
2362                 $this->add_course_essentials($coursenode, $course);
2363                 if ($this->format_display_course_content($course->format)) {
2364                     $this->load_course_sections($course, $coursenode);
2365                 }
2366                 break;
2367             case self::TYPE_SECTION :
2368                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2369                         FROM {course} c
2370                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2371                         WHERE cs.id = ?';
2372                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
2373                 require_course_login($course);
2374                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2375                 $coursenode = $this->add_course($course);
2376                 $this->add_course_essentials($coursenode, $course);
2377                 $sections = $this->load_course_sections($course, $coursenode);
2378                 $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, get_fast_modinfo($course));
2379                 break;
2380             case self::TYPE_ACTIVITY :
2381                 $sql = "SELECT c.*
2382                           FROM {course} c
2383                           JOIN {course_modules} cm ON cm.course = c.id
2384                          WHERE cm.id = :cmid";
2385                 $params = array('cmid' => $this->instanceid);
2386                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
2387                 $modinfo = get_fast_modinfo($course);
2388                 $cm = $modinfo->get_cm($this->instanceid);
2389                 require_course_login($course, true, $cm);
2390                 $this->page->set_context(get_context_instance(CONTEXT_MODULE, $cm->id));
2391                 $coursenode = $this->load_course($course);
2392                 if ($course->id == SITEID) {
2393                     $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY));
2394                 } else {
2395                     $sections   = $this->load_course_sections($course, $coursenode);
2396                     $activities = $this->load_section_activities($sections[$cm->sectionnum]->sectionnode, $cm->sectionnum, get_fast_modinfo($course));
2397                     $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]);
2398                 }
2399                 break;
2400             default:
2401                 throw new Exception('Unknown type');
2402                 return $this->expandable;
2403         }
2405         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != SITEID) {
2406             $this->load_for_user(null, true);
2407         }
2409         $this->find_expandable($this->expandable);
2410         return $this->expandable;
2411     }
2413     /**
2414      * Returns an array of expandable nodes
2415      * @return array
2416      */
2417     public function get_expandable() {
2418         return $this->expandable;
2419     }
2422 /**
2423  * Navbar class
2424  *
2425  * This class is used to manage the navbar, which is initialised from the navigation
2426  * object held by PAGE
2427  *
2428  * @package moodlecore
2429  * @subpackage navigation
2430  * @copyright 2009 Sam Hemelryk
2431  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2432  */
2433 class navbar extends navigation_node {
2434     /** @var bool */
2435     protected $initialised = false;
2436     /** @var mixed */
2437     protected $keys = array();
2438     /** @var null|string */
2439     protected $content = null;
2440     /** @var moodle_page object */
2441     protected $page;
2442     /** @var bool */
2443     protected $ignoreactive = false;
2444     /** @var bool */
2445     protected $duringinstall = false;
2446     /** @var bool */
2447     protected $hasitems = false;
2448     /** @var array */
2449     protected $items;
2450     /** @var array */
2451     public $children = array();
2452     /** @var bool */
2453     public $includesettingsbase = false;
2454     /**
2455      * The almighty constructor
2456      *
2457      * @param moodle_page $page
2458      */
2459     public function __construct(moodle_page $page) {
2460         global $CFG;
2461         if (during_initial_install()) {
2462             $this->duringinstall = true;
2463             return false;
2464         }
2465         $this->page = $page;
2466         $this->text = get_string('home');
2467         $this->shorttext = get_string('home');
2468         $this->action = new moodle_url($CFG->wwwroot);
2469         $this->nodetype = self::NODETYPE_BRANCH;
2470         $this->type = self::TYPE_SYSTEM;
2471     }
2473     /**
2474      * Quick check to see if the navbar will have items in.
2475      *
2476      * @return bool Returns true if the navbar will have items, false otherwise
2477      */
2478     public function has_items() {
2479         if ($this->duringinstall) {
2480             return false;
2481         } else if ($this->hasitems !== false) {
2482             return true;
2483         }
2484         $this->page->navigation->initialise($this->page);
2486         $activenodefound = ($this->page->navigation->contains_active_node() ||
2487                             $this->page->settingsnav->contains_active_node());
2489         $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
2490         $this->hasitems = $outcome;
2491         return $outcome;
2492     }
2494     /**
2495      * Turn on/off ignore active
2496      *
2497      * @param bool $setting
2498      */
2499     public function ignore_active($setting=true) {
2500         $this->ignoreactive = ($setting);
2501     }
2502     public function get($key, $type = null) {
2503         foreach ($this->children as &$child) {
2504             if ($child->key === $key && ($type == null || $type == $child->type)) {
2505                 return $child;
2506             }
2507         }
2508         return false;
2509     }
2510     /**
2511      * Returns an array of navigation_node's that make up the navbar.
2512      *
2513      * @return array
2514      */
2515     public function get_items() {
2516         $items = array();
2517         // Make sure that navigation is initialised
2518         if (!$this->has_items()) {
2519             return $items;
2520         }
2521         if ($this->items !== null) {
2522             return $this->items;
2523         }
2525         if (count($this->children) > 0) {
2526             // Add the custom children
2527             $items = array_reverse($this->children);
2528         }
2530         $navigationactivenode = $this->page->navigation->find_active_node();
2531         $settingsactivenode = $this->page->settingsnav->find_active_node();
2533         // Check if navigation contains the active node
2534         if (!$this->ignoreactive) {
2536             if ($navigationactivenode && $settingsactivenode) {
2537                 // Parse a combined navigation tree
2538                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
2539                     if (!$settingsactivenode->mainnavonly) {
2540                         $items[] = $settingsactivenode;
2541                     }
2542                     $settingsactivenode = $settingsactivenode->parent;
2543                 }
2544                 if (!$this->includesettingsbase) {
2545                     // Removes the first node from the settings (root node) from the list
2546                     array_pop($items);
2547                 }
2548                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
2549                     if (!$navigationactivenode->mainnavonly) {
2550                         $items[] = $navigationactivenode;
2551                     }
2552                     $navigationactivenode = $navigationactivenode->parent;
2553                 }
2554             } else if ($navigationactivenode) {
2555                 // Parse the navigation tree to get the active node
2556                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
2557                     if (!$navigationactivenode->mainnavonly) {
2558                         $items[] = $navigationactivenode;
2559                     }
2560                     $navigationactivenode = $navigationactivenode->parent;
2561                 }
2562             } else if ($settingsactivenode) {
2563                 // Parse the settings navigation to get the active node
2564                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
2565                     if (!$settingsactivenode->mainnavonly) {
2566                         $items[] = $settingsactivenode;
2567                     }
2568                     $settingsactivenode = $settingsactivenode->parent;
2569                 }
2570             }
2571         }
2573         $items[] = new navigation_node(array(
2574             'text'=>$this->page->navigation->text,
2575             'shorttext'=>$this->page->navigation->shorttext,
2576             'key'=>$this->page->navigation->key,
2577             'action'=>$this->page->navigation->action
2578         ));
2580         $this->items = array_reverse($items);
2581         return $this->items;
2582     }
2584     /**
2585      * Add a new navigation_node to the navbar, overrides parent::add
2586      *
2587      * This function overrides {@link navigation_node::add()} so that we can change
2588      * the way nodes get added to allow us to simply call add and have the node added to the
2589      * end of the navbar
2590      *
2591      * @param string $text
2592      * @param string|moodle_url $action
2593      * @param int $type
2594      * @param string|int $key
2595      * @param string $shorttext
2596      * @param string $icon
2597      * @return navigation_node
2598      */
2599     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
2600         if ($this->content !== null) {
2601             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
2602         }
2604         // Properties array used when creating the new navigation node
2605         $itemarray = array(
2606             'text' => $text,
2607             'type' => $type
2608         );
2609         // Set the action if one was provided
2610         if ($action!==null) {
2611             $itemarray['action'] = $action;
2612         }
2613         // Set the shorttext if one was provided
2614         if ($shorttext!==null) {
2615             $itemarray['shorttext'] = $shorttext;
2616         }
2617         // Set the icon if one was provided
2618         if ($icon!==null) {
2619             $itemarray['icon'] = $icon;
2620         }
2621         // Default the key to the number of children if not provided
2622         if ($key === null) {
2623             $key = count($this->children);
2624         }
2625         // Set the key
2626         $itemarray['key'] = $key;
2627         // Set the parent to this node
2628         $itemarray['parent'] = $this;
2629         // Add the child using the navigation_node_collections add method
2630         $this->children[] = new navigation_node($itemarray);
2631         return $this;
2632     }
2635 /**
2636  * Class used to manage the settings option for the current page
2637  *
2638  * This class is used to manage the settings options in a tree format (recursively)
2639  * and was created initially for use with the settings blocks.
2640  *
2641  * @package moodlecore
2642  * @subpackage navigation
2643  * @copyright 2009 Sam Hemelryk
2644  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2645  */
2646 class settings_navigation extends navigation_node {
2647     /** @var stdClass */
2648     protected $context;
2649     /** @var navigation_cache */
2650     protected $cache;
2651     /** @var moodle_page */
2652     protected $page;
2653     /** @var string */
2654     protected $adminsection;
2655     /** @var bool */
2656     protected $initialised = false;
2657     /** @var array */
2658     protected $userstoextendfor = array();
2660     /**
2661      * Sets up the object with basic settings and preparse it for use
2662      *
2663      * @param moodle_page $page
2664      */
2665     public function __construct(moodle_page &$page) {
2666         if (during_initial_install()) {
2667             return false;
2668         }
2669         $this->page = $page;
2670         // Initialise the main navigation. It is most important that this is done
2671         // before we try anything
2672         $this->page->navigation->initialise();
2673         // Initialise the navigation cache
2674         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2675         $this->children = new navigation_node_collection();
2676     }
2677     /**
2678      * Initialise the settings navigation based on the current context
2679      *
2680      * This function initialises the settings navigation tree for a given context
2681      * by calling supporting functions to generate major parts of the tree.
2682      *
2683      */
2684     public function initialise() {
2685         global $DB, $SESSION;
2687         if (during_initial_install()) {
2688             return false;
2689         } else if ($this->initialised) {
2690             return true;
2691         }
2692         $this->id = 'settingsnav';
2693         $this->context = $this->page->context;
2695         $context = $this->context;
2696         if ($context->contextlevel == CONTEXT_BLOCK) {
2697             $this->load_block_settings();
2698             $context = $DB->get_record_sql('SELECT ctx.* FROM {block_instances} bi LEFT JOIN {context} ctx ON ctx.id=bi.parentcontextid WHERE bi.id=?', array($context->instanceid));
2699         }
2701         switch ($context->contextlevel) {
2702             case CONTEXT_SYSTEM:
2703                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
2704                     $this->load_front_page_settings(($context->id == $this->context->id));
2705                 }
2706                 break;
2707             case CONTEXT_COURSECAT:
2708                 $this->load_category_settings();
2709                 break;
2710             case CONTEXT_COURSE:
2711                 if ($this->page->course->id != SITEID) {
2712                     $this->load_course_settings(($context->id == $this->context->id));
2713                 } else {
2714                     $this->load_front_page_settings(($context->id == $this->context->id));
2715                 }
2716                 break;
2717             case CONTEXT_MODULE:
2718                 $this->load_module_settings();
2719                 $this->load_course_settings();
2720                 break;
2721             case CONTEXT_USER:
2722                 if ($this->page->course->id != SITEID) {
2723                     $this->load_course_settings();
2724                 }
2725                 break;
2726         }
2728         $settings = $this->load_user_settings($this->page->course->id);
2730         if (isloggedin() && !isguestuser() && (!property_exists($SESSION, 'load_navigation_admin') || $SESSION->load_navigation_admin)) {
2731             $admin = $this->load_administration_settings();
2732             $SESSION->load_navigation_admin = ($admin->has_children());
2733         } else {
2734             $admin = false;
2735         }
2737         if ($context->contextlevel == CONTEXT_SYSTEM && $admin) {
2738             $admin->force_open();
2739         } else if ($context->contextlevel == CONTEXT_USER && $settings) {
2740             $settings->force_open();
2741         }
2743         // Check if the user is currently logged in as another user
2744         if (session_is_loggedinas()) {
2745             // Get the actual user, we need this so we can display an informative return link
2746             $realuser = session_get_realuser();
2747             // Add the informative return to original user link
2748             $url = new moodle_url('/course/loginas.php',array('id'=>$this->page->course->id, 'return'=>1,'sesskey'=>sesskey()));
2749             $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self::TYPE_SETTING, null, null, new pix_icon('t/left', ''));
2750         }
2752         foreach ($this->children as $key=>$node) {
2753             if ($node->nodetype != self::NODETYPE_BRANCH || $node->children->count()===0) {
2754                 $node->remove();
2755             }
2756         }
2757         $this->initialised = true;
2758     }
2759     /**
2760      * Override the parent function so that we can add preceeding hr's and set a
2761      * root node class against all first level element
2762      *
2763      * It does this by first calling the parent's add method {@link navigation_node::add()}
2764      * and then proceeds to use the key to set class and hr
2765      *
2766      * @param string $text
2767      * @param sting|moodle_url $url
2768      * @param string $shorttext
2769      * @param string|int $key
2770      * @param int $type
2771      * @param string $icon
2772      * @return navigation_node
2773      */
2774     public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
2775         $node = parent::add($text, $url, $type, $shorttext, $key, $icon);
2776         $node->add_class('root_node');
2777         return $node;
2778     }
2780     /**
2781      * This function allows the user to add something to the start of the settings
2782      * navigation, which means it will be at the top of the settings navigation block
2783      *
2784      * @param string $text
2785      * @param sting|moodle_url $url
2786      * @param string $shorttext
2787      * @param string|int $key
2788      * @param int $type
2789      * @param string $icon
2790      * @return navigation_node
2791      */
2792     public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
2793         $children = $this->children;
2794         $childrenclass = get_class($children);
2795         $this->children = new $childrenclass;
2796         $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
2797         foreach ($children as $child) {
2798             $this->children->add($child);
2799         }
2800         return $node;
2801     }
2802     /**
2803      * Load the site administration tree
2804      *
2805      * This function loads the site administration tree by using the lib/adminlib library functions
2806      *
2807      * @param navigation_node $referencebranch A reference to a branch in the settings
2808      *      navigation tree
2809      * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
2810      *      tree and start at the beginning
2811      * @return mixed A key to access the admin tree by
2812      */
2813     protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) {
2814         global $CFG;
2816         // Check if we are just starting to generate this navigation.
2817         if ($referencebranch === null) {
2819             // Require the admin lib then get an admin structure
2820             if (!function_exists('admin_get_root')) {
2821                 require_once($CFG->dirroot.'/lib/adminlib.php');
2822             }
2823             $adminroot = admin_get_root(false, false);
2824             // This is the active section identifier
2825             $this->adminsection = $this->page->url->param('section');
2827             // Disable the navigation from automatically finding the active node
2828             navigation_node::$autofindactive = false;
2829             $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SETTING, null, 'root');
2830             foreach ($adminroot->children as $adminbranch) {
2831                 $this->load_administration_settings($referencebranch, $adminbranch);
2832             }
2833             navigation_node::$autofindactive = true;
2835             // Use the admin structure to locate the active page
2836             if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) {
2837                 $currentnode = $this;
2838                 while (($pathkey = array_pop($current->path))!==null && $currentnode) {
2839                     $currentnode = $currentnode->get($pathkey);
2840                 }
2841                 if ($currentnode) {
2842                     $currentnode->make_active();
2843                 }
2844             } else {
2845                 $this->scan_for_active_node($referencebranch);
2846             }
2847             return $referencebranch;
2848         } else if ($adminbranch->check_access()) {
2849             // We have a reference branch that we can access and is not hidden `hurrah`
2850             // Now we need to display it and any children it may have
2851             $url = null;
2852             $icon = null;
2853             if ($adminbranch instanceof admin_settingpage) {
2854                 $url = new moodle_url('/admin/settings.php', array('section'=>$adminbranch->name));
2855             } else if ($adminbranch instanceof admin_externalpage) {
2856                 $url = $adminbranch->url;
2857             }
2859             // Add the branch
2860             $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon);
2862             if ($adminbranch->is_hidden()) {
2863                 if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) {
2864                     $reference->add_class('hidden');
2865                 } else {
2866                     $reference->display = false;
2867                 }
2868             }
2870             // Check if we are generating the admin notifications and whether notificiations exist
2871             if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) {
2872                 $reference->add_class('criticalnotification');
2873             }
2874             // Check if this branch has children
2875             if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) {
2876                 foreach ($adminbranch->children as $branch) {
2877                     // Generate the child branches as well now using this branch as the reference
2878                     $this->load_administration_settings($reference, $branch);
2879                 }
2880             } else {
2881                 $reference->icon = new pix_icon('i/settings', '');
2882             }
2883         }
2884     }
2886     /**
2887      * This function recursivily scans nodes until it finds the active node or there
2888      * are no more nodes.
2889      * @param navigation_node $node
2890      */
2891     protected function scan_for_active_node(navigation_node $node) {
2892         if (!$node->check_if_active() && $node->children->count()>0) {
2893             foreach ($node->children as &$child) {
2894                 $this->scan_for_active_node($child);
2895             }
2896         }
2897     }
2899     /**
2900      * Gets a navigation node given an array of keys that represent the path to
2901      * the desired node.
2902      *
2903      * @param array $path
2904      * @return navigation_node|false
2905      */
2906     protected function get_by_path(array $path) {
2907         $node = $this->get(array_shift($path));
2908         foreach ($path as $key) {
2909             $node->get($key);
2910         }
2911         return $node;
2912     }
2914     /**
2915      * Generate the list of modules for the given course.
2916      *
2917      * The array of resources and activities that can be added to a course is then
2918      * stored in the cache so that we can access it for anywhere.
2919      * It saves us generating it all the time
2920      *
2921      * <code php>
2922      * // To get resources:
2923      * $this->cache->{'course'.$courseid.'resources'}
2924      * // To get activities:
2925      * $this->cache->{'course'.$courseid.'activities'}
2926      * </code>
2927      *
2928      * @param stdClass $course The course to get modules for
2929      */
2930     protected function get_course_modules($course) {
2931         global $CFG;
2932         $mods = $modnames = $modnamesplural = $modnamesused = array();
2933         // This function is included when we include course/lib.php at the top
2934         // of this file
2935         get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused);
2936         $resources = array();
2937         $activities = array();
2938         foreach($modnames as $modname=>$modnamestr) {
2939             if (!course_allowed_module($course, $modname)) {
2940                 continue;
2941             }
2943             $libfile = "$CFG->dirroot/mod/$modname/lib.php";
2944             if (!file_exists($libfile)) {
2945                 continue;
2946             }
2947             include_once($libfile);
2948             $gettypesfunc =  $modname.'_get_types';
2949             if (function_exists($gettypesfunc)) {
2950                 $types = $gettypesfunc();
2951                 foreach($types as $type) {
2952                     if (!isset($type->modclass) || !isset($type->typestr)) {
2953                         debugging('Incorrect activity type in '.$modname);
2954                         continue;
2955                     }
2956                     if ($type->modclass == MOD_CLASS_RESOURCE) {
2957                         $resources[html_entity_decode($type->type)] = $type->typestr;
2958                     } else {
2959                         $activities[html_entity_decode($type->type)] = $type->typestr;
2960                     }
2961                 }
2962             } else {
2963                 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2964                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
2965                     $resources[$modname] = $modnamestr;
2966                 } else {
2967                     // all other archetypes are considered activity
2968                     $activities[$modname] = $modnamestr;
2969                 }
2970             }
2971         }
2972         $this->cache->{'course'.$course->id.'resources'} = $resources;
2973         $this->cache->{'course'.$course->id.'activities'} = $activities;
2974     }
2976     /**
2977      * This function loads the course settings that are available for the user
2978      *
2979      * @param bool $forceopen If set to true the course node will be forced open
2980      * @return navigation_node|false
2981      */
2982     protected function load_course_settings($forceopen = false) {
2983         global $CFG, $USER, $SESSION, $OUTPUT;
2985         $course = $this->page->course;
2986         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2988         // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
2990         $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin');
2991         if ($forceopen) {
2992             $coursenode->force_open();
2993         }
2995         if (has_capability('moodle/course:update', $coursecontext)) {
2996             // Add the turn on/off settings
2997             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
2998             if ($this->page->user_is_editing()) {
2999                 $url->param('edit', 'off');
3000                 $editstring = get_string('turneditingoff');
3001             } else {
3002                 $url->param('edit', 'on');
3003                 $editstring = get_string('turneditingon');
3004             }
3005             $coursenode->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
3007             if ($this->page->user_is_editing()) {
3008                 // Removed as per MDL-22732
3009                 // $this->add_course_editing_links($course);
3010             }
3012             // Add the course settings link
3013             $url = new moodle_url('/course/edit.php', array('id'=>$course->id));
3014             $coursenode->add(get_string('editsettings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
3016             // Add the course completion settings link
3017             if ($CFG->enablecompletion && $course->enablecompletion) {
3018                 $url = new moodle_url('/course/completion.php', array('id'=>$course->id));
3019                 $coursenode->add(get_string('completion', 'completion'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
3020             }
3021         }
3023         // add enrol nodes
3024         enrol_add_course_navigation($coursenode, $course);
3026         // Manage filters
3027         if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
3028             $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
3029             $coursenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
3030         }
3032         // Add view grade report is permitted
3033         $reportavailable = false;
3034         if (has_capability('moodle/grade:viewall', $coursecontext)) {
3035             $reportavailable = true;
3036         } else if (!empty($course->showgrades)) {
3037             $reports = get_plugin_list('gradereport');
3038             if (is_array($reports) && count($reports)>0) {     // Get all installed reports
3039                 arsort($reports); // user is last, we want to test it first
3040                 foreach ($reports as $plugin => $plugindir) {
3041                     if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
3042                         //stop when the first visible plugin is found
3043                         $reportavailable = true;
3044                         break;
3045                     }
3046                 }
3047             }
3048         }
3049         if ($reportavailable) {
3050             $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id));
3051             $gradenode = $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, 'grades', new pix_icon('i/grades', ''));
3052         }
3054         //  Add outcome if permitted
3055         if (!empty($CFG->enableoutcomes) && has_capability('moodle/course:update', $coursecontext)) {
3056             $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id));
3057             $coursenode->add(get_string('outcomes', 'grades'), $url, self::TYPE_SETTING, null, 'outcomes', new pix_icon('i/outcomes', ''));
3058         }
3060         // Backup this course
3061         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
3062             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
3063             $coursenode->add(get_string('backup'), $url, self::TYPE_SETTING, null, 'backup', new pix_icon('i/backup', ''));
3064         }
3066         // Restore to this course
3067         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
3068             $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id));
3069             $coursenode->add(get_string('restore'), $url, self::TYPE_SETTING, null, 'restore', new pix_icon('i/restore', ''));
3070         }
3072         // Import data from other courses
3073         if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
3074             $url = new moodle_url('/backup/import.php', array('id'=>$course->id));
3075             $coursenode->add(get_string('import'), $url, self::TYPE_SETTING, null, 'import', new pix_icon('i/restore', ''));
3076         }
3078         // Publish course on a hub
3079         if (has_capability('moodle/course:publish', $coursecontext)) {
3080             $url = new moodle_url('/course/publish/index.php', array('id'=>$course->id));
3081             $coursenode->add(get_string('publish'), $url, self::TYPE_SETTING, null, 'publish', new pix_icon('i/publish', ''));
3082         }
3084         // Reset this course
3085         if (has_capability('moodle/course:reset', $coursecontext)) {
3086             $url = new moodle_url('/course/reset.php', array('id'=>$course->id));
3087             $coursenode->add(get_string('reset'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/return', ''));
3088         }
3090         // Questions
3091         require_once($CFG->dirroot.'/question/editlib.php');
3092         question_extend_settings_navigation($coursenode, $coursecontext)->trim_if_empty();
3094         // Repository Instances
3095         require_once($CFG->dirroot.'/repository/lib.php');
3096         $editabletypes = repository::get_editable_types($coursecontext);
3097         if (has_capability('moodle/course:update', $coursecontext) && !empty($editabletypes)) {
3098             $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$coursecontext->id));
3099             $coursenode->add(get_string('repositories'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/repository', ''));
3100         }
3102         // Manage files
3103         if ($course->legacyfiles == 2 and has_capability('moodle/course:managefiles', $coursecontext)) {
3104             // hidden in new courses and courses where legacy files were turned off
3105             $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id));
3106             $coursenode->add(get_string('courselegacyfiles'), $url, self::TYPE_SETTING, null, 'coursefiles', new pix_icon('i/files', ''));
3107         }
3109         // Switch roles
3110         $roles = array();
3111         $assumedrole = $this->in_alternative_role();
3112         if ($assumedrole!==false) {
3113             $roles[0] = get_string('switchrolereturn');
3114         }
3115         if (has_capability('moodle/role:switchroles', $coursecontext)) {
3116             $availableroles = get_switchable_roles($coursecontext);
3117             if (is_array($availableroles)) {
3118                 foreach ($availableroles as $key=>$role) {
3119                     if ($assumedrole == (int)$key) {
3120                         continue;
3121                     }
3122                     $roles[$key] = $role;
3123                 }
3124             }
3125         }
3126         if (is_array($roles) && count($roles)>0) {
3127             $switchroles = $this->add(get_string('switchroleto'));
3128             if ((count($roles)==1 && array_key_exists(0, $roles))|| $assumedrole!==false) {
3129                 $switchroles->force_open();
3130             }
3131             $returnurl = $this->page->url;
3132             $returnurl->param('sesskey', sesskey());
3133             $SESSION->returnurl = serialize($returnurl);
3134             foreach ($roles as $key=>$name) {
3135                 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>'1'));
3136                 $switchroles->add($name, $url, self::TYPE_SETTING, null, $key, new pix_icon('i/roles', ''));
3137             }
3138         }
3139         // Return we are done
3140         return $coursenode;
3141     }
3143     /**
3144      * Adds branches and links to the settings navigation to add course activities
3145      * and resources.
3146      *
3147      * @param stdClass $course
3148      */
3149     protected function add_course_editing_links($course) {
3150         global $CFG;
3152         require_once($CFG->dirroot.'/course/lib.php');
3154         // Add `add` resources|activities branches
3155         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3156         if (file_exists($structurefile)) {
3157             require_once($structurefile);
3158             $requestkey = call_user_func('callback_'.$course->format.'_request_key');
3159             $formatidentifier = optional_param($requestkey, 0, PARAM_INT);
3160         } else {
3161             $requestkey = get_string('section');
3162             $formatidentifier = optional_param($requestkey, 0, PARAM_INT);
3163         }
3165         $sections = get_all_sections($course->id);
3167         $addresource = $this->add(get_string('addresource'));
3168         $addactivity = $this->add(get_string('addactivity'));
3169         if ($formatidentifier!==0) {
3170             $addresource->force_open();
3171             $addactivity->force_open();
3172         }
3174         if (!$this->cache->cached('course'.$course->id.'resources')) {
3175             $this->get_course_modules($course);
3176         }
3177         $resources = $this->cache->{'course'.$course->id.'resources'};
3178         $activities = $this->cache->{'course'.$course->id.'activities'};
3180         $textlib = textlib_get_instance();
3182         foreach ($sections as $section) {
3183             if ($formatidentifier !== 0 && $section->section != $formatidentifier) {
3184                 continue;
3185             }
3186             $sectionurl = new moodle_url('/course/view.php', array('id'=>$course->id, $requestkey=>$section->section));
3187             if ($section->section == 0) {
3188                 $sectionresources = $addresource->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
3189                 $sectionactivities = $addactivity->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
3190             } else {
3191                 $sectionname = get_section_name($course, $section);
3192                 $sectionresources = $addresource->add($sectionname, $sectionurl, self::TYPE_SETTING);
3193                 $sectionactivities = $addactivity->add($sectionname, $sectionurl, self::TYPE_SETTING);
3194             }
3195             foreach ($resources as $value=>$resource) {
3196                 $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
3197                 $pos = strpos($value, '&type=');
3198                 if ($pos!==false) {
3199                     $url->param('add', $textlib->substr($value, 0,$pos));
3200                     $url->param('type', $textlib->substr($value, $pos+6));
3201                 } else {
3202                     $url->param('add', $value);
3203                 }
3204                 $sectionresources->add($resource, $url, self::TYPE_SETTING);
3205             }
3206             $subbranch = false;
3207             foreach ($activities as $activityname=>$activity) {
3208                 if ($activity==='--') {
3209                     $subbranch = false;
3210                     continue;
3211                 }
3212                 if (strpos($activity, '--')===0) {
3213                     $subbranch = $sectionactivities->add(trim($activity, '-'));
3214                     continue;
3215                 }
3216                 $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
3217                 $pos = strpos($activityname, '&type=');
3218                 if ($pos!==false) {
3219                     $url->param('add', $textlib->substr($activityname, 0,$pos));
3220                     $url->param('type', $textlib->substr($activityname, $pos+6));
3221                 } else {
3222                     $url->param('add', $activityname);
3223                 }
3224                 if ($subbranch !== false) {
3225                     $subbranch->add($activity, $url, self::TYPE_SETTING);
3226                 } else {
3227                     $sectionactivities->add($activity, $url, self::TYPE_SETTING);
3228                 }
3229             }
3230         }
3231     }
3233     /**
3234      * This function calls the module function to inject module settings into the
3235      * settings navigation tree.
3236      *
3237      * This only gets called if there is a corrosponding function in the modules
3238      * lib file.
3239      *
3240      * For examples mod/forum/lib.php ::: forum_extend_settings_navigation()
3241      *
3242      * @return navigation_node|false
3243      */
3244     protected function load_module_settings() {
3245         global $CFG;
3247         if (!$this->page->cm && $this->context->contextlevel == CONTEXT_MODULE && $this->context->instanceid) {
3248             $cm = get_coursemodule_from_id(false, $this->context->instanceid, 0, false, MUST_EXIST);
3249             $this->page->set_cm($cm, $this->page->course);
3250         }
3252         $file = $CFG->dirroot.'/mod/'.$this->page->activityname.'/lib.php';
3253         if (file_exists($file)) {
3254             require_once($file);
3255         }
3257         $modulenode = $this->add(get_string('pluginadministration', $this->page->activityname));
3258         $modulenode->force_open();
3260         // Settings for the module
3261         if (has_capability('moodle/course:manageactivities', $this->page->cm->context)) {
3262             $url = new moodle_url('/course/modedit.php', array('update' => $this->page->cm->id, 'return' => true, 'sesskey' => sesskey()));
3263             $modulenode->add(get_string('editsettings'), $url, navigation_node::TYPE_SETTING, null, 'modedit');
3264         }
3265         // Assign local roles
3266         if (count(get_assignable_roles($this->page->cm->context))>0) {
3267             $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->page->cm->context->id));
3268             $modulenode->add(get_string('localroles', 'role'), $url, self::TYPE_SETTING, null, 'roleassign');
3269         }
3270         // Override roles
3271         if (has_capability('moodle/role:review', $this->page->cm->context) or count(get_overridable_roles($this->page->cm->context))>0) {
3272             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->page->cm->context->id));
3273             $modulenode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING, null, 'roleoverride');
3274         }
3275         // Check role permissions
3276         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page->cm->context)) {
3277             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->page->cm->context->id));
3278             $modulenode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING, null, 'rolecheck');
3279         }
3280         // Manage filters
3281         if (has_capability('moodle/filter:manage', $this->page->cm->context) && count(filter_get_available_in_context($this->page->cm->context))>0) {
3282             $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page->cm->context->id));
3283             $modulenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, 'filtermanage');
3284         }
3286         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $this->page->cm->course))) {
3287             $url = new moodle_url('/course/report/log/index.php', array('chooselog'=>'1','id'=>$this->page->cm->course,'modid'=>$this->page->cm->id));
3288             $modulenode->add(get_string('logs'), $url, self::TYPE_SETTING, null, 'logreport');
3289         }
3291         // Add a backup link
3292         $featuresfunc = $this->page->activityname.'_supports';
3293         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2) && has_capability('moodle/backup:backupactivity', $this->page->cm->context)) {
3294             $url = new moodle_url('/backup/backup.php', array('id'=>$this->page->cm->course, 'cm'=>$this->page->cm->id));
3295             $modulenode->add(get_string('backup'), $url, self::TYPE_SETTING, null, 'backup');
3296         }
3298         // Restore this activity
3299         $featuresfunc = $this->page->activityname.'_supports';
3300         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2) && has_capability('moodle/restore:restoreactivity', $this->page->cm->context)) {
3301             $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$this->page->cm->context->id));
3302             $modulenode->add(get_string('restore'), $url, self::TYPE_SETTING, null, 'restore');
3303         }
3305         $function = $this->page->activityname.'_extend_settings_navigation';
3306         if (!function_exists($function)) {
3307             return $modulenode;
3308         }
3310         $function($this, $modulenode);
3312         // Remove the module node if there are no children
3313         if (empty($modulenode->children)) {
3314             $modulenode->remove();
3315         }
3317         return $modulenode;
3318     }
3320     /**
3321      * Loads the user settings block of the settings nav
3322      *
3323      * This function is simply works out the userid and whether we need to load
3324      * just the current users profile settings, or the current user and the user the
3325      * current user is viewing.
3326      *
3327      * This function has some very ugly code to work out the user, if anyone has
3328      * any bright ideas please feel free to intervene.
3329      *
3330      * @param int $courseid The course id of the current course
3331      * @return navigation_node|false
3332      */
3333     protected function load_user_settings($courseid=SITEID) {
3334         global $USER, $FULLME, $CFG;
3336         if (isguestuser() || !isloggedin()) {
3337             return false;
3338         }
3340         $navusers = $this->page->navigation->get_extending_users();
3342         if (count($this->userstoextendfor) > 0 || count($navusers) > 0) {
3343             $usernode = null;
3344             foreach ($this->userstoextendfor as $userid) {
3345                 if ($userid == $USER->id) {
3346                     continue;
3347                 }
3348                 $node = $this->generate_user_settings($courseid, $userid, 'userviewingsettings');
3349                 if (is_null($usernode)) {
3350                     $usernode = $node;
3351                 }
3352             }
3353             foreach ($navusers as $user) {
3354                 if ($user->id == $USER->id) {
3355                     continue;
3356                 }
3357                 $node = $this->generate_user_settings($courseid, $user->id, 'userviewingsettings');
3358                 if (is_null($usernode)) {
3359                     $usernode = $node;
3360                 }
3361             }
3362             $this->generate_user_settings($courseid, $USER->id);
3363         } else {
3364             $usernode = $this->generate_user_settings($courseid, $USER->id);
3365         }
3366         return $usernode;
3367     }
3369     /**
3370      * Extends the settings navigation for the given user.
3371      *
3372      * Note: This method gets called automatically if you call
3373      * $PAGE->navigation->extend_for_user($userid)
3374      *
3375      * @param int $userid
3376      */
3377     public function extend_for_user($userid) {
3378         global $CFG;
3380         if (!in_array($userid, $this->userstoextendfor)) {
3381             $this->userstoextendfor[] = $userid;
3382             if ($this->initialised) {
3383                 $this->generate_user_settings($this->page->course->id, $userid, 'userviewingsettings');
3384                 $children = array();
3385                 foreach ($this->children as $child) {
3386                     $children[] = $child;
3387                 }
3388                 array_unshift($children, array_pop($children));
3389                 $this->children = new navigation_node_collection();
3390                 foreach ($children as $child) {
3391                     $this->children->add($child);
3392                 }
3393             }
3394         }
3395     }
3397     /**
3398      * This function gets called by {@link load_user_settings()} and actually works out
3399      * what can be shown/done
3400      *
3401      * @param int $courseid The current course' id
3402      * @param int $userid The user id to load for
3403      * @param string $gstitle The string to pass to get_string for the branch title
3404      * @return navigation_node|false
3405      */
3406     protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') {
3407         global $DB, $CFG, $USER, $SITE;
3409         if ($courseid != SITEID) {
3410             if (!empty($this->page->course->id) && $this->page->course->id == $courseid) {
3411                 $course = $this->page->course;
3412             } else {
3413                 $course = $DB->get_record("course", array("id"=>$courseid), '*', MUST_EXIST);
3414             }
3415         } else {
3416             $course = $SITE;
3417         }
3419         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);   // Course context
3420         $systemcontext   = get_system_context();
3421         $currentuser = ($USER->id == $userid);
3423         if ($currentuser) {
3424             $user = $USER;
3425             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
3426         } else {
3427             if (!$user = $DB->get_record('user', array('id'=>$userid))) {
3428                 return false;
3429             }
3430             // Check that the user can view the profile
3431             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
3432             if ($course->id==SITEID) {
3433                 if ($CFG->forceloginforprofiles && !has_coursecontact_role($user->id) && !has_capability('moodle/user:viewdetails', $usercontext)) {  // Reduce possibility of "browsing" userbase at site level
3434                     // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366)
3435                     return false;
3436                 }
3437             } else {
3438                 if ((!has_capability('moodle/user:viewdetails', $coursecontext) && !has_capability('moodle/user:viewdetails', $usercontext)) || !can_access_course($coursecontext, $user->id)) {
3439                     return false;
3440                 }
3441                 if (groups_get_course_groupmode($course) == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $coursecontext)) {
3442                     // If groups are in use, make sure we can see that group
3443                     return false;
3444                 }
3445             }
3446         }
3448         $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $this->page->context));
3450         $key = $gstitle;
3451         if ($gstitle != 'usercurrentsettings') {
3452             $key .= $userid;
3453         }
3455         // Add a user setting branch
3456         $usersetting = $this->add(get_string($gstitle, 'moodle', $fullname), null, self::TYPE_CONTAINER, null, $key);
3457         $usersetting->id = 'usersettings';
3458         if ($this->page->context->contextlevel == CONTEXT_USER && $this->page->context->instanceid == $user->id) {
3459             // Automatically start by making it active
3460             $usersetting->make_active();
3461         }
3463         // Check if the user has been deleted
3464         if ($user->deleted) {
3465             if (!has_capability('moodle/user:update', $coursecontext)) {
3466                 // We can't edit the user so just show the user deleted message
3467                 $usersetting->add(get_string('userdeleted'), null, self::TYPE_SETTING);
3468             } else {
3469                 // We can edit the user so show the user deleted message and link it to the profile
3470                 if ($course->id == SITEID) {
3471                     $profileurl = new moodle_url('/user/profile.php', array('id'=>$user->id));
3472                 } else {
3473                     $profileurl = new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$course->id));
3474                 }
3475                 $usersetting->add(get_string('userdeleted'), $profileurl, self::TYPE_SETTING);
3476             }
3477             return true;
3478         }
3480         // Add the profile edit link
3481         if (isloggedin() && !isguestuser($user) && !is_mnet_remote_user($user)) {
3482             if (($currentuser || is_siteadmin($USER) || !is_siteadmin($user)) && has_capability('moodle/user:update', $systemcontext)) {
3483                 $url = new moodle_url('/user/editadvanced.php', array('id'=>$user->id, 'course'=>$course->id));
3484                 $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
3485             } else if ((has_capability('moodle/user:editprofile', $usercontext) && !is_siteadmin($user)) || ($currentuser && has_capability('moodle/user:editownprofile', $systemcontext))) {
3486                 if (!empty($user->auth)) {
3487                     $userauth = get_auth_plugin($user->auth);
3488                     if ($userauth->can_edit_profile()) {
3489                         $url = $userauth->edit_profile_url();
3490                         if (empty($url)) {
3491                             $url = new moodle_url('/user/edit.php', array('id'=>$user->id, 'course'=>$course->id));
3492                         }
3493                         $usersetting->add(get_string('editmyprofile'), $url, self::TYPE_SETTING);
3494                     }
3495                 }
3496             }
3497         }
3499         // Change password link
3500         if (!empty($user->auth)) {
3501             $userauth = get_auth_plugin($user->auth);
3502             if ($currentuser && !session_is_loggedinas() && $userauth->can_change_password() && !isguestuser() && has_capability('moodle/user:changeownpassword', $systemcontext)) {
3503                 $passwordchangeurl = $userauth->change_password_url();
3504                 if (empty($passwordchangeurl)) {
3505                     $passwordchangeurl = new moodle_url('/login/change_password.php', array('id'=>$course->id));
3506                 }
3507                 $usersetting->add(get_string("changepassword"), $passwordchangeurl, self::TYPE_SETTING);
3508             }
3509         }
3511         // View the roles settings
3512         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:manage'), $usercontext)) {
3513             $roles = $usersetting->add(get_string('roles'), null, self::TYPE_SETTING);
3515             $url = new moodle_url('/admin/roles/usersroles.php', array('userid'=>$user->id, 'courseid'=>$course->id));
3516             $roles->add(get_string('thisusersroles', 'role'), $url, self::TYPE_SETTING);
3518             $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH);
3520             if (!empty($assignableroles)) {
3521                 $url = new moodle_url('/admin/roles/assign.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
3522                 $roles->add(get_string('assignrolesrelativetothisuser', 'role'), $url, self::TYPE_SETTING);
3523             }
3525             if (has_capability('moodle/role:review', $usercontext) || count(get_overridable_roles($usercontext, ROLENAME_BOTH))>0) {
3526                 $url = new moodle_url('/admin/roles/permissions.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
3527                 $roles->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
3528             }
3530             $url = new moodle_url('/admin/roles/check.php', array('contextid'=>$usercontext->id,'userid'=>$user->id, 'courseid'=>$course->id));
3531             $roles->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
3532         }
3534         // Portfolio
3535         if ($currentuser && !empty($CFG->enableportfolios) && has_capability('moodle/portfolio:export', $systemcontext)) {
3536             require_once($CFG->libdir . '/portfoliolib.php');
3537             if (portfolio_instances(true, false)) {
3538                 $portfolio = $usersetting->add(get_string('portfolios', 'portfolio'), null, self::TYPE_SETTING);
3540                 $url = new moodle_url('/user/portfolio.php', array('courseid'=>$course->id));
3541                 $portfolio->add(get_string('configure', 'portfolio'), $url, self::TYPE_SETTING);
3543                 $url = new moodle_url('/user/portfoliologs.php', array('courseid'=>$course->id));
3544                 $portfolio->add(get_string('logs', 'portfolio'), $url, self::TYPE_SETTING);
3545             }
3546         }
3548         $enablemanagetokens = false;
3549         if (!empty($CFG->enablerssfeeds)) {
3550             $enablemanagetokens = true;
3551         } else if (!is_siteadmin($USER->id)
3552              && !empty($CFG->enablewebservices)
3553              && has_capability('moodle/webservice:createtoken', get_system_context()) ) {
3554             $enablemanagetokens = true;
3555         }
3556         // Security keys
3557         if ($currentuser && $enablemanagetokens) {
3558             $url = new moodle_url('/user/managetoken.php', array('sesskey'=>sesskey()));
3559             $usersetting->add(get_string('securitykeys', 'webservice'), $url, self::TYPE_SETTING);
3560         }
3562         // Repository
3563         if (!$currentuser) {
3564             require_once($CFG->dirroot . '/repository/lib.php');
3565             $editabletypes = repository::get_editable_types($usercontext);
3566             if ($usercontext->contextlevel == CONTEXT_USER && !empty($editabletypes)) {
3567                 $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$usercontext->id));
3568                 $usersetting->add(get_string('repositories', 'repository'), $url, self::TYPE_SETTING);
3569             }
3570         }
3572         // Messaging
3573         if (($currentuser && has_capability('moodle/user:editownmessageprofile', $systemcontext)) || (!isguestuser($user) && has_capability('moodle/user:editmessageprofile', $usercontext) && !is_primary_admin($user->id))) {
3574             $url = new moodle_url('/message/edit.php', array('id'=>$user->id, 'course'=>$course->id));
3575             // Hide the node if messaging disabled
3576             $usersetting->add(get_string('editmymessage', 'message'), $url, self::TYPE_SETTING)->display = !empty($CFG->messaging);
3577         }
3579         // Blogs
3580         if ($currentuser && !empty($CFG->bloglevel)) {
3581             $blog = $usersetting->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER, null, 'blogs');
3582             $blog->add(get_string('preferences', 'blog'), new moodle_url('/blog/preferences.php'), navigation_node::TYPE_SETTING);
3583             if (!empty($CFG->useexternalblogs) && $CFG->maxexternalblogsperuser > 0 && has_capability('moodle/blog:manageexternal', get_context_instance(CONTEXT_SYSTEM))) {
3584                 $blog->add(get_string('externalblogs', 'blog'), new moodle_url('/blog/external_blogs.php'), navigation_node::TYPE_SETTING);
3585                 $blog->add(get_string('addnewexternalblog', 'blog'), new moodle_url('/blog/external_blog_edit.php'), navigation_node::TYPE_SETTING);
3586             }
3587         }
3589         // Login as ...
3590         if (!$user->deleted and !$currentuser && !session_is_loggedinas() && has_capability('moodle/user:loginas', $coursecontext) && !is_siteadmin($user->id)) {
3591             $url = new moodle_url('/course/loginas.php', array('id'=>$course->id, 'user'=>$user->id, 'sesskey'=>sesskey()));
3592             $usersetting->add(get_string('loginas'), $url, self::TYPE_SETTING);
3593         }
3595         return $usersetting;
3596     }
3598     /**
3599      * Loads block specific settings in the navigation
3600      *
3601      * @return navigation_node
3602      */
3603     protected function load_block_settings() {
3604         global $CFG;
3606         $blocknode = $this->add(print_context_name($this->context));
3607         $blocknode->force_open();
3609         // Assign local roles
3610         $assignurl = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->context->id));
3611         $blocknode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING);
3613         // Override roles
3614         if (has_capability('moodle/role:review', $this->context) or  count(get_overridable_roles($this->context))>0) {
3615             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->context->id));
3616             $blocknode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
3617         }
3618         // Check role permissions
3619         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context)) {
3620             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->context->id));
3621             $blocknode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
3622         }
3624         return $blocknode;
3625     }
3627     /**
3628      * Loads category specific settings in the navigation
3629      *
3630      * @return navigation_node
3631      */
3632     protected function load_category_settings() {
3633         global $CFG;
3635         $categorynode = $this->add(print_context_name($this->context));
3636         $categorynode->force_open();
3638         if (has_any_capability(array('moodle/category:manage', 'moodle/course:create'), $this->context)) {
3639             $url = new moodle_url('/course/category.php', array('id'=>$this->context->instanceid, 'sesskey'=>sesskey()));
3640             if ($this->page->user_is_editing()) {
3641                 $url->param('categoryedit', '0');
3642                 $editstring = get_string('turneditingoff');
3643             } else {
3644                 $url->param('categoryedit', '1');
3645                 $editstring = get_string('turneditingon');
3646             }
3647             $categorynode->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
3648         }
3650         if ($this->page->user_is_editing() && has_capability('moodle/category:manage', $this->context)) {
3651             $editurl = new moodle_url('/course/editcategory.php', array('id' => $this->context->instanceid));
3652             $categorynode->add(get_string('editcategorythis'), $editurl, self::TYPE_SETTING, null, 'edit', new pix_icon('i/edit', ''));
3654             $addsubcaturl = new moodle_url('/course/editcategory.php', array('parent' => $this->context->instanceid));
3655             $categorynode->add(get_string('addsubcategory'), $addsubcaturl, self::TYPE_SETTING, null, 'addsubcat', new pix_icon('i/withsubcat', ''));
3656         }
3658         // Assign local roles
3659         if (has_capability('moodle/role:assign', $this->context)) {
3660             $assignurl = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->context->id));
3661             $categorynode->add(get_string('assignroles', 'role'), $assignurl, self::TYPE_SETTING, null, 'roles', new pix_icon('i/roles', ''));
3662         }
3664         // Override roles
3665         if (has_capability('moodle/role:review', $this->context) or count(get_overridable_roles($this->context))>0) {
3666             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->context->id));
3667             $categorynode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING, null, 'permissions', new pix_icon('i/permissions', ''));
3668         }
3669         // Check role permissions
3670         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->context)) {
3671             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->context->id));
3672             $categorynode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING, null, 'checkpermissions', new pix_icon('i/checkpermissions', ''));
3673         }
3675         // Cohorts
3676         if (has_capability('moodle/cohort:manage', $this->context) or has_capability('moodle/cohort:view', $this->context)) {
3677             $categorynode->add(get_string('cohorts', 'cohort'), new moodle_url('/cohort/index.php', array('contextid' => $this->context->id)), self::TYPE_SETTING, null, 'cohort', new pix_icon('i/cohort', ''));
3678         }
3680         // Manage filters
3681         if (has_capability('moodle/filter:manage', $this->context) && count(filter_get_available_in_context($this->context))>0) {
3682             $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->context->id));
3683             $categorynode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, 'filters', new pix_icon('i/filter', ''));
3684         }
3686         return $categorynode;
3687     }
3689     /**
3690      * Determine whether the user is assuming another role
3691      *
3692      * This function checks to see if the user is assuming another role by means of
3693      * role switching. In doing this we compare each RSW key (context path) against
3694      * the current context path. This ensures that we can provide the switching
3695      * options against both the course and any page shown under the course.
3696      *
3697      * @return bool|int The role(int) if the user is in another role, false otherwise
3698      */
3699     protected function in_alternative_role() {
3700         global $USER;
3701         if (!empty($USER->access['rsw']) && is_array($USER->access['rsw'])) {
3702             if (!empty($this->page->context) && !empty($USER->access['rsw'][$this->page->context->path])) {
3703                 return $USER->access['rsw'][$this->page->context->path];
3704             }
3705             foreach ($USER->access['rsw'] as $key=>$role) {
3706                 if (strpos($this->context->path,$key)===0) {
3707                     return $role;
3708                 }
3709             }
3710         }
3711         return false;
3712     }
3714     /**
3715      * This function loads all of the front page settings into the settings navigation.
3716      * This function is called when the user is on the front page, or $COURSE==$SITE
3717      * @return navigation_node
3718      */
3719     protected function load_front_page_settings($forceopen = false) {
3720         global $SITE, $CFG;
3722         $course = clone($SITE);
3723         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);   // Course context
3725         $frontpage = $this->add(get_string('frontpagesettings'), null, self::TYPE_SETTING, null, 'frontpage');
3726         if ($forceopen) {
3727             $frontpage->force_open();
3728         }
3729         $frontpage->id = 'frontpagesettings';
3731         if (has_capability('moodle/course:update', $coursecontext)) {
3733             // Add the turn on/off settings
3734             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
3735             if ($this->page->user_is_editing()) {
3736                 $url->param('edit', 'off');
3737                 $editstring = get_string('turneditingoff');
3738             } else {
3739                 $url->param('edit', 'on');
3740                 $editstring = get_string('turneditingon');
3741             }
3742             $frontpage->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
3744             // Add the course settings link
3745             $url = new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings'));
3746             $frontpage->add(get_string('editsettings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
3747         }
3749         // add enrol nodes
3750         enrol_add_course_navigation($frontpage, $course);
3752         // Manage filters
3753         if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
3754             $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
3755             $frontpage->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
3756         }
3758         // Backup this course
3759         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
3760             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
3761             $frontpage->add(get_string('backup'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/backup', ''));
3762         }
3764         // Restore to this course
3765         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
3766             $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id));
3767             $frontpage->add(get_string('restore'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/restore', ''));
3768         }
3770         // Manage questions
3771         $questioncaps = array('moodle/question:add',
3772                               'moodle/question:editmine',
3773                               'moodle/question:editall',
3774                               'moodle/question:viewmine',
3775                               'moodle/question:viewall',
3776                               'moodle/question:movemine',
3777                               'moodle/question:moveall');
3778         if (has_any_capability($questioncaps, $this->context)) {
3779             $questionlink = $CFG->wwwroot.'/question/edit.php';
3780         } else if (has_capability('moodle/question:managecategory', $this->context)) {
3781             $questionlink = $CFG->wwwroot.'/question/category.php';
3782         }
3783         if (isset($questionlink)) {
3784             $url = new moodle_url($questionlink, array('courseid'=>$course->id));
3785             $frontpage->add(get_string('questions','quiz'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/questions', ''));
3786         }
3788         // Manage files
3789         if ($course->legacyfiles == 2 and has_capability('moodle/course:managefiles', $this->context)) {
3790             //hiden in new installs
3791             $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id, 'itemid'=>0, 'component' => 'course', 'filearea'=>'legacy'));
3792             $frontpage->add(get_string('sitelegacyfiles'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/files', ''));
3793         }
3794         return $frontpage;
3795     }
3797     /**
3798      * This function marks the cache as volatile so it is cleared during shutdown
3799      */
3800     public function clear_cache() {
3801         $this->cache->volatile();
3802     }
3805 /**
3806  * Simple class used to output a navigation branch in XML
3807  *
3808  * @package moodlecore
3809  * @subpackage navigation
3810  * @copyright 2009 Sam Hemelryk
3811  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3812  */
3813 class navigation_json {
3814     /** @var array */
3815     protected $nodetype = array('node','branch');
3816     /** @var array */
3817     protected $expandable = array();
3818     /**
3819      * Turns a branch and all of its children into XML
3820      *
3821      * @param navigation_node $branch
3822      * @return string XML string
3823      */
3824     public function convert($branch) {
3825         $xml = $this->convert_child($branch);
3826         return $xml;
3827     }
3828     /**
3829      * Set the expandable items in the array so that we have enough information
3830      * to attach AJAX events
3831      * @param array $expandable
3832      */
3833     public function set_expandable($expandable) {
3834         foreach ($expandable as $node) {
3835             $this->expandable[$node['key'].':'.$node['type']] = $node;
3836         }
3837     }
3838     /**
3839      * Recusively converts a child node and its children to XML for output
3840      *
3841      * @param navigation_node $child The child to convert
3842      * @param int $depth Pointlessly used to track the depth of the XML structure
3843      * @return string JSON
3844      */
3845     protected function convert_child($child, $depth=1) {
3846         global $OUTPUT;
3848         if (!$child->display) {
3849             return '';
3850         }
3851         $attributes = array();
3852         $attributes['id'] = $child->id;
3853         $attributes['name'] = $child->text;
3854         $attributes['type'] =