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