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