Merge branch 'MDL-26266' of git://github.com/samhemelryk/moodle
[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         foreach ($this->children as &$child) {
540             if ($child->nodetype == self::NODETYPE_BRANCH && $child->children->count() == 0 && $child->display) {
541                 $child->id = 'expandable_branch_'.(count($expandable)+1);
542                 $this->add_class('canexpand');
543                 $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type);
544             }
545             $child->find_expandable($expandable);
546         }
547     }
549     /**
550      * Finds all nodes of a given type (recursive)
551      *
552      * @param int $type On of navigation_node::TYPE_*
553      * @return array
554      */
555     public function find_all_of_type($type) {
556         $nodes = $this->children->type($type);
557         foreach ($this->children as &$node) {
558             $childnodes = $node->find_all_of_type($type);
559             $nodes = array_merge($nodes, $childnodes);
560         }
561         return $nodes;
562     }
564     /**
565      * Removes this node if it is empty
566      */
567     public function trim_if_empty() {
568         if ($this->children->count() == 0) {
569             $this->remove();
570         }
571     }
573     /**
574      * Creates a tab representation of this nodes children that can be used
575      * with print_tabs to produce the tabs on a page.
576      *
577      * call_user_func_array('print_tabs', $node->get_tabs_array());
578      *
579      * @param array $inactive
580      * @param bool $return
581      * @return array Array (tabs, selected, inactive, activated, return)
582      */
583     public function get_tabs_array(array $inactive=array(), $return=false) {
584         $tabs = array();
585         $rows = array();
586         $selected = null;
587         $activated = array();
588         foreach ($this->children as $node) {
589             $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title());
590             if ($node->contains_active_node()) {
591                 if ($node->children->count() > 0) {
592                     $activated[] = $node->key;
593                     foreach ($node->children as $child) {
594                         if ($child->contains_active_node()) {
595                             $selected = $child->key;
596                         }
597                         $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title());
598                     }
599                 } else {
600                     $selected = $node->key;
601                 }
602             }
603         }
604         return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
605     }
608 /**
609  * Navigation node collection
610  *
611  * This class is responsible for managing a collection of navigation nodes.
612  * It is required because a node's unique identifier is a combination of both its
613  * key and its type.
614  *
615  * Originally an array was used with a string key that was a combination of the two
616  * however it was decided that a better solution would be to use a class that
617  * implements the standard IteratorAggregate interface.
618  *
619  * @package moodlecore
620  * @subpackage navigation
621  * @copyright 2010 Sam Hemelryk
622  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
623  */
624 class navigation_node_collection implements IteratorAggregate {
625     /**
626      * A multidimensional array to where the first key is the type and the second
627      * key is the nodes key.
628      * @var array
629      */
630     protected $collection = array();
631     /**
632      * An array that contains references to nodes in the same order they were added.
633      * This is maintained as a progressive array.
634      * @var array
635      */
636     protected $orderedcollection = array();
637     /**
638      * A reference to the last node that was added to the collection
639      * @var navigation_node
640      */
641     protected $last = null;
642     /**
643      * The total number of items added to this array.
644      * @var int
645      */
646     protected $count = 0;
647     /**
648      * Adds a navigation node to the collection
649      *
650      * @param navigation_node $node
651      * @return navigation_node
652      */
653     public function add(navigation_node $node) {
654         global $CFG;
655         $key = $node->key;
656         $type = $node->type;
657         // First check we have a 2nd dimension for this type
658         if (!array_key_exists($type, $this->orderedcollection)) {
659             $this->orderedcollection[$type] = array();
660         }
661         // Check for a collision and report if debugging is turned on
662         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
663             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
664         }
665         // Add the node to the appropriate place in the ordered structure.
666         $this->orderedcollection[$type][$key] = $node;
667         // Add a reference to the node to the progressive collection.
668         $this->collection[$this->count] = &$this->orderedcollection[$type][$key];
669         // Update the last property to a reference to this new node.
670         $this->last = &$this->orderedcollection[$type][$key];
671         $this->count++;
672         // Return the reference to the now added node
673         return $this->last;
674     }
676     /**
677      * Fetches a node from this collection.
678      *
679      * @param string|int $key The key of the node we want to find.
680      * @param int $type One of navigation_node::TYPE_*.
681      * @return navigation_node|null
682      */
683     public function get($key, $type=null) {
684         if ($type !== null) {
685             // If the type is known then we can simply check and fetch
686             if (!empty($this->orderedcollection[$type][$key])) {
687                 return $this->orderedcollection[$type][$key];
688             }
689         } else {
690             // Because we don't know the type we look in the progressive array
691             foreach ($this->collection as $node) {
692                 if ($node->key === $key) {
693                     return $node;
694                 }
695             }
696         }
697         return false;
698     }
699     /**
700      * Searches for a node with matching key and type.
701      *
702      * This function searches both the nodes in this collection and all of
703      * the nodes in each collection belonging to the nodes in this collection.
704      *
705      * Recursive.
706      *
707      * @param string|int $key  The key of the node we want to find.
708      * @param int $type  One of navigation_node::TYPE_*.
709      * @return navigation_node|null
710      */
711     public function find($key, $type=null) {
712         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
713             return $this->orderedcollection[$type][$key];
714         } else {
715             $nodes = $this->getIterator();
716             // Search immediate children first
717             foreach ($nodes as &$node) {
718                 if ($node->key === $key && ($type === null || $type === $node->type)) {
719                     return $node;
720                 }
721             }
722             // Now search each childs children
723             foreach ($nodes as &$node) {
724                 $result = $node->children->find($key, $type);
725                 if ($result !== false) {
726                     return $result;
727                 }
728             }
729         }
730         return false;
731     }
733     /**
734      * Fetches the last node that was added to this collection
735      *
736      * @return navigation_node
737      */
738     public function last() {
739         return $this->last;
740     }
741     /**
742      * Fetches all nodes of a given type from this collection
743      */
744     public function type($type) {
745         if (!array_key_exists($type, $this->orderedcollection)) {
746             $this->orderedcollection[$type] = array();
747         }
748         return $this->orderedcollection[$type];
749     }
750     /**
751      * Removes the node with the given key and type from the collection
752      *
753      * @param string|int $key
754      * @param int $type
755      * @return bool
756      */
757     public function remove($key, $type=null) {
758         $child = $this->get($key, $type);
759         if ($child !== false) {
760             foreach ($this->collection as $colkey => $node) {
761                 if ($node->key == $key && $node->type == $type) {
762                     unset($this->collection[$colkey]);
763                     break;
764                 }
765             }
766             unset($this->orderedcollection[$child->type][$child->key]);
767             $this->count--;
768             return true;
769         }
770         return false;
771     }
773     /**
774      * Gets the number of nodes in this collection
775      * @return int
776      */
777     public function count() {
778         return count($this->collection);
779     }
780     /**
781      * Gets an array iterator for the collection.
782      *
783      * This is required by the IteratorAggregator interface and is used by routines
784      * such as the foreach loop.
785      *
786      * @return ArrayIterator
787      */
788     public function getIterator() {
789         return new ArrayIterator($this->collection);
790     }
793 /**
794  * The global navigation class used for... the global navigation
795  *
796  * This class is used by PAGE to store the global navigation for the site
797  * and is then used by the settings nav and navbar to save on processing and DB calls
798  *
799  * See
800  * <ul>
801  * <li><b>{@link lib/pagelib.php}</b> {@link moodle_page::initialise_theme_and_output()}<li>
802  * <li><b>{@link lib/ajax/getnavbranch.php}</b> Called by ajax<li>
803  * </ul>
804  *
805  * @package moodlecore
806  * @subpackage navigation
807  * @copyright 2009 Sam Hemelryk
808  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
809  */
810 class global_navigation extends navigation_node {
811     /**
812      * The Moodle page this navigation object belongs to.
813      * @var moodle_page
814      */
815     protected $page;
816     /** @var bool */
817     protected $initialised = false;
818     /** @var array */
819     protected $mycourses = array();
820     /** @var array */
821     protected $rootnodes = array();
822     /** @var bool */
823     protected $showemptysections = false;
824     /** @var array */
825     protected $extendforuser = array();
826     /** @var navigation_cache */
827     protected $cache;
828     /** @var array */
829     protected $addedcourses = array();
830     /** @var int */
831     protected $expansionlimit = 0;
833     /**
834      * Constructs a new global navigation
835      *
836      * @param moodle_page $page The page this navigation object belongs to
837      */
838     public function __construct(moodle_page $page) {
839         global $CFG, $SITE, $USER;
841         if (during_initial_install()) {
842             return;
843         }
845         if (get_home_page() == HOMEPAGE_SITE) {
846             // We are using the site home for the root element
847             $properties = array(
848                 'key' => 'home',
849                 'type' => navigation_node::TYPE_SYSTEM,
850                 'text' => get_string('home'),
851                 'action' => new moodle_url('/')
852             );
853         } else {
854             // We are using the users my moodle for the root element
855             $properties = array(
856                 'key' => 'myhome',
857                 'type' => navigation_node::TYPE_SYSTEM,
858                 'text' => get_string('myhome'),
859                 'action' => new moodle_url('/my/')
860             );
861         }
863         // Use the parents consturctor.... good good reuse
864         parent::__construct($properties);
866         // Initalise and set defaults
867         $this->page = $page;
868         $this->forceopen = true;
869         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
871         // Check if we need to clear the cache
872         $regenerate = optional_param('regenerate', null, PARAM_TEXT);
873         if ($regenerate === 'navigation') {
874             $this->cache->clear();
875         }
876     }
878     /**
879      * Initialises the navigation object.
880      *
881      * This causes the navigation object to look at the current state of the page
882      * that it is associated with and then load the appropriate content.
883      *
884      * This should only occur the first time that the navigation structure is utilised
885      * which will normally be either when the navbar is called to be displayed or
886      * when a block makes use of it.
887      *
888      * @return bool
889      */
890     public function initialise() {
891         global $CFG, $SITE, $USER, $DB;
892         // Check if it has alread been initialised
893         if ($this->initialised || during_initial_install()) {
894             return true;
895         }
896         $this->initialised = true;
898         // Set up the five base root nodes. These are nodes where we will put our
899         // content and are as follows:
900         // site:        Navigation for the front page.
901         // myprofile:     User profile information goes here.
902         // mycourses:   The users courses get added here.
903         // courses:     Additional courses are added here.
904         // users:       Other users information loaded here.
905         $this->rootnodes = array();
906         if (get_home_page() == HOMEPAGE_SITE) {
907             // The home element should be my moodle because the root element is the site
908             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
909                 $this->rootnodes['home']      = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
910             }
911         } else {
912             // The home element should be the site because the root node is my moodle
913             $this->rootnodes['home']      = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
914             if ($CFG->defaulthomepage == HOMEPAGE_MY) {
915                 // We need to stop automatic redirection
916                 $this->rootnodes['home']->action->param('redirect', '0');
917             }
918         }
919         $this->rootnodes['site']      = $this->add_course($SITE);
920         $this->rootnodes['myprofile']   = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
921         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), null, self::TYPE_ROOTNODE, null, 'mycourses');
922         $this->rootnodes['courses']   = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
923         $this->rootnodes['users']     = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
925         // Fetch all of the users courses.
926         $limit = 20;
927         if (!empty($CFG->navcourselimit)) {
928             $limit = $CFG->navcourselimit;
929         }
931         if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') == 1) {
932             // There is only one category so we don't want to show categories
933             $CFG->navshowcategories = false;
934         }
936         $this->mycourses = enrol_get_my_courses(NULL, 'visible DESC,sortorder ASC', $limit);
937         $showallcourses = (count($this->mycourses) == 0 || !empty($CFG->navshowallcourses));
938         $showcategories = ($showallcourses && !empty($CFG->navshowcategories));
940         // Check if any courses were returned.
941         if (count($this->mycourses) > 0) {
942             // Add all of the users courses to the navigation
943             foreach ($this->mycourses as &$course) {
944                 $course->coursenode = $this->add_course($course);
945             }
946         }
948         if ($showcategories) {
949             // Load all categories (ensures we get the base categories)
950             $this->load_all_categories();
951         } else if ($showallcourses) {
952             // Load all courses
953             $this->load_all_courses();
954         }
956         // We always load the frontpage course to ensure it is available without
957         // JavaScript enabled.
958         $frontpagecourse = $this->load_course($SITE);
959         $this->add_front_page_course_essentials($frontpagecourse, $SITE);
961         $canviewcourseprofile = true;
963         // Next load context specific content into the navigation
964         switch ($this->page->context->contextlevel) {
965             case CONTEXT_SYSTEM :
966                 // This has already been loaded we just need to map the variable
967                 $coursenode = $frontpagecourse;
968                 break;
969             case CONTEXT_COURSECAT :
970                 // This has already been loaded we just need to map the variable
971                 $coursenode = $frontpagecourse;
972                 $this->load_all_categories($this->page->context->instanceid);
973                 break;
974             case CONTEXT_BLOCK :
975             case CONTEXT_COURSE :
976                 // Load the course associated with the page into the navigation
977                 $course = $this->page->course;
978                 $coursenode = $this->load_course($course);
980                 // If the course wasn't added then don't try going any further.
981                 if (!$coursenode) {
982                     $canviewcourseprofile = false;
983                     break;
984                 }
986                 // If the user is not enrolled then we only want to show the
987                 // course node and not populate it.
988                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
989                 // Not enrolled, can't view, and hasn't switched roles
991                 if (!can_access_course($coursecontext)) {
992                     $coursenode->make_active();
993                     $canviewcourseprofile = false;
994                     break;
995                 }
996                 // Add the essentials such as reports etc...
997                 $this->add_course_essentials($coursenode, $course);
998                 if ($this->format_display_course_content($course->format)) {
999                     // Load the course sections
1000                     $sections = $this->load_course_sections($course, $coursenode);
1001                 }
1002                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1003                     $coursenode->make_active();
1004                 }
1005                 break;
1006             case CONTEXT_MODULE :
1007                 $course = $this->page->course;
1008                 $cm = $this->page->cm;
1009                 // Load the course associated with the page into the navigation
1010                 $coursenode = $this->load_course($course);
1012                 // If the user is not enrolled then we only want to show the
1013                 // course node and not populate it.
1014                 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1015                 if (!can_access_course($coursecontext)) {
1016                     if ($coursenode) {
1017                         $coursenode->make_active();
1018                     }
1019                     $canviewcourseprofile = false;
1020                     break;
1021                 }
1023                 $this->add_course_essentials($coursenode, $course);
1024                 // Load the course sections into the page
1025                 $sections = $this->load_course_sections($course, $coursenode);
1026                 if ($course->id !== SITEID) {
1027                     // Find the section for the $CM associated with the page and collect
1028                     // its section number.
1029                     if (isset($cm->sectionnum)) {
1030                         $cm->sectionnumber = $cm->sectionnum;
1031                     } else {
1032                         foreach ($sections as $section) {
1033                             if ($section->id == $cm->section) {
1034                                 $cm->sectionnumber = $section->section;
1035                                 break;
1036                             }
1037                         }
1038                     }
1040                     // Load all of the section activities for the section the cm belongs to.
1041                     if (isset($cm->sectionnumber) and !empty($sections[$cm->sectionnumber])) {
1042                         $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course));
1043                     } else {
1044                         $activities = array();
1045                         if ($activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course))) {
1046                             // "stealth" activity from unavailable section
1047                             $activities[$cm->id] = $activity;
1048                         }
1049                     }
1050                 } else {
1051                     $activities = array();
1052                     $activities[$cm->id] = $coursenode->get($cm->id, navigation_node::TYPE_ACTIVITY);
1053                 }
1054                 if (!empty($activities[$cm->id])) {
1055                     // Finally load the cm specific navigaton information
1056                     $this->load_activity($cm, $course, $activities[$cm->id]);
1057                     // Check if we have an active ndoe
1058                     if (!$activities[$cm->id]->contains_active_node() && !$activities[$cm->id]->search_for_active_node()) {
1059                         // And make the activity node active.
1060                         $activities[$cm->id]->make_active();
1061                     }
1062                 } else {
1063                     //TODO: something is wrong, what to do? (Skodak)
1064                 }
1065                 break;
1066             case CONTEXT_USER :
1067                 $course = $this->page->course;
1068                 if ($course->id != SITEID) {
1069                     // Load the course associated with the user into the navigation
1070                     $coursenode = $this->load_course($course);
1071                     // If the user is not enrolled then we only want to show the
1072                     // course node and not populate it.
1073                     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1074                     if (!can_access_course($coursecontext)) {
1075                         $coursenode->make_active();
1076                         $canviewcourseprofile = false;
1077                         break;
1078                     }
1079                     $this->add_course_essentials($coursenode, $course);
1080                     $sections = $this->load_course_sections($course, $coursenode);
1081                 }
1082                 break;
1083         }
1085         $limit = 20;
1086         if (!empty($CFG->navcourselimit)) {
1087             $limit = $CFG->navcourselimit;
1088         }
1089         if ($showcategories) {
1090             $categories = $this->find_all_of_type(self::TYPE_CATEGORY);
1091             foreach ($categories as &$category) {
1092                 if ($category->children->count() >= $limit) {
1093                     $url = new moodle_url('/course/category.php', array('id'=>$category->key));
1094                     $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1095                 }
1096             }
1097         } else if ($this->rootnodes['courses']->children->count() >= $limit) {
1098             $this->rootnodes['courses']->add(get_string('viewallcoursescategories'), new moodle_url('/course/index.php'), self::TYPE_SETTING);
1099         }
1101         // Load for the current user
1102         $this->load_for_user();
1103         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != SITEID && $canviewcourseprofile) {
1104             $this->load_for_user(null, true);
1105         }
1106         // Load each extending user into the navigation.
1107         foreach ($this->extendforuser as $user) {
1108             if ($user->id !== $USER->id) {
1109                 $this->load_for_user($user);
1110             }
1111         }
1113         // Give the local plugins a chance to include some navigation if they want.
1114         foreach (get_list_of_plugins('local') as $plugin) {
1115             if (!file_exists($CFG->dirroot.'/local/'.$plugin.'/lib.php')) {
1116                 continue;
1117             }
1118             require_once($CFG->dirroot.'/local/'.$plugin.'/lib.php');
1119             $function = $plugin.'_extends_navigation';
1120             if (function_exists($function)) {
1121                 $function($this);
1122             }
1123         }
1125         // Remove any empty root nodes
1126         foreach ($this->rootnodes as $node) {
1127             // Dont remove the home node
1128             if ($node->key !== 'home' && !$node->has_children()) {
1129                 $node->remove();
1130             }
1131         }
1133         if (!$this->contains_active_node()) {
1134             $this->search_for_active_node();
1135         }
1137         // If the user is not logged in modify the navigation structure as detailed
1138         // in {@link http://docs.moodle.org/en/Development:Navigation_2.0_structure}
1139         if (!isloggedin()) {
1140             $activities = clone($this->rootnodes['site']->children);
1141             $this->rootnodes['site']->remove();
1142             $children = clone($this->children);
1143             $this->children = new navigation_node_collection();
1144             foreach ($activities as $child) {
1145                 $this->children->add($child);
1146             }
1147             foreach ($children as $child) {
1148                 $this->children->add($child);
1149             }
1150         }
1151         return true;
1152     }
1153     /**
1154      * Checks the course format to see whether it wants the navigation to load
1155      * additional information for the course.
1156      *
1157      * This function utilises a callback that can exist within the course format lib.php file
1158      * The callback should be a function called:
1159      * callback_{formatname}_display_content()
1160      * It doesn't get any arguments and should return true if additional content is
1161      * desired. If the callback doesn't exist we assume additional content is wanted.
1162      *
1163      * @param string $format The course format
1164      * @return bool
1165      */
1166     protected function format_display_course_content($format) {
1167         global $CFG;
1168         $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
1169         if (file_exists($formatlib)) {
1170             require_once($formatlib);
1171             $displayfunc = 'callback_'.$format.'_display_content';
1172             if (function_exists($displayfunc) && !$displayfunc()) {
1173                 return $displayfunc();
1174             }
1175         }
1176         return true;
1177     }
1179     /**
1180      * Loads of the the courses in Moodle into the navigation.
1181      *
1182      * @param string|array $categoryids Either a string or array of category ids to load courses for
1183      * @return array An array of navigation_node
1184      */
1185     protected function load_all_courses($categoryids=null) {
1186         global $CFG, $DB, $USER;
1188         if ($categoryids !== null) {
1189             if (is_array($categoryids)) {
1190                 list ($select, $params) = $DB->get_in_or_equal($categoryids);
1191             } else {
1192                 $select = '= ?';
1193                 $params = array($categoryids);
1194             }
1195             array_unshift($params, SITEID);
1196             $select = ' AND c.category '.$select;
1197         } else {
1198             $params = array(SITEID);
1199             $select = '';
1200         }
1202         list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1203         $sql = "SELECT c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.category,cat.path AS categorypath $ccselect
1204                 FROM {course} c
1205                 $ccjoin
1206                 LEFT JOIN {course_categories} cat ON cat.id=c.category
1207                 WHERE c.id <> ?$select
1208                 ORDER BY c.sortorder ASC";
1209         $limit = 20;
1210         if (!empty($CFG->navcourselimit)) {
1211             $limit = $CFG->navcourselimit;
1212         }
1213         $courses = $DB->get_records_sql($sql, $params, 0, $limit);
1215         $coursenodes = array();
1216         foreach ($courses as $course) {
1217             context_instance_preload($course);
1218             $coursenodes[$course->id] = $this->add_course($course);
1219         }
1220         return $coursenodes;
1221     }
1223     /**
1224      * Loads all categories (top level or if an id is specified for that category)
1225      *
1226      * @param int $categoryid
1227      * @return void
1228      */
1229     protected function load_all_categories($categoryid=null) {
1230         global $DB;
1231         if ($categoryid == null)  {
1232             $categories = $DB->get_records('course_categories', array('parent'=>'0'), 'sortorder');
1233         } else {
1234             $category = $DB->get_record('course_categories', array('id'=>$categoryid), '*', MUST_EXIST);
1235             $wantedids = explode('/', trim($category->path, '/'));
1236             list($select, $params) = $DB->get_in_or_equal($wantedids);
1237             $select = 'id '.$select.' OR parent '.$select;
1238             $params = array_merge($params, $params);
1239             $categories = $DB->get_records_select('course_categories', $select, $params, 'sortorder');
1240         }
1241         $structured = array();
1242         $categoriestoload = array();
1243         foreach ($categories as $category) {
1244             if ($category->parent == '0') {
1245                 $structured[$category->id] = array('category'=>$category, 'children'=>array());
1246             } else {
1247                 if ($category->parent == $categoryid) {
1248                     $categoriestoload[] = $category->id;
1249                 }
1250                 $parents = array();
1251                 $id = $category->parent;
1252                 while ($id != '0') {
1253                     $parents[] = $id;
1254                     if (!array_key_exists($id, $categories)) {
1255                         $categories[$id] = $DB->get_record('course_categories', array('id'=>$id), '*', MUST_EXIST);
1256                     }
1257                     $id = $categories[$id]->parent;
1258                 }
1259                 $parents = array_reverse($parents);
1260                 $parentref = &$structured[array_shift($parents)];
1261                 foreach ($parents as $parent) {
1262                     if (!array_key_exists($parent, $parentref['children'])) {
1263                         $parentref['children'][$parent] = array('category'=>$categories[$parent], 'children'=>array());
1264                     }
1265                     $parentref = &$parentref['children'][$parent];
1266                 }
1267                 if (!array_key_exists($category->id, $parentref['children'])) {
1268                     $parentref['children'][$category->id] = array('category'=>$category, 'children'=>array());
1269                 }
1270             }
1271         }
1273         foreach ($structured as $category) {
1274             $this->add_category($category, $this->rootnodes['courses']);
1275         }
1277         if ($categoryid !== null && count($wantedids)) {
1278             foreach ($wantedids as $catid) {
1279                 $this->load_all_courses($catid);
1280             }
1281         }
1282     }
1284     /**
1285      * Adds a structured category to the navigation in the correct order/place
1286      *
1287      * @param object $cat
1288      * @param navigation_node $parent
1289      */
1290     protected function add_category($cat, navigation_node $parent) {
1291         $categorynode = $parent->get($cat['category']->id, navigation_node::TYPE_CATEGORY);
1292         if (!$categorynode) {
1293             $category = $cat['category'];
1294             $url = new moodle_url('/course/category.php', array('id'=>$category->id));
1295             $categorynode = $parent->add($category->name, $url, self::TYPE_CATEGORY, $category->name, $category->id);
1296             if (empty($category->visible)) {
1297                 if (has_capability('moodle/category:viewhiddencategories', get_system_context())) {
1298                     $categorynode->hidden = true;
1299                 } else {
1300                     $categorynode->display = false;
1301                 }
1302             }
1303         }
1304         foreach ($cat['children'] as $child) {
1305             $this->add_category($child, $categorynode);
1306         }
1307     }
1309     /**
1310      * Loads the given course into the navigation
1311      *
1312      * @param stdClass $course
1313      * @return navigation_node
1314      */
1315     protected function load_course(stdClass $course) {
1316         if ($course->id == SITEID) {
1317             $coursenode = $this->rootnodes['site'];
1318         } else if (array_key_exists($course->id, $this->mycourses)) {
1319             if (!isset($this->mycourses[$course->id]->coursenode)) {
1320                 $this->mycourses[$course->id]->coursenode = $this->add_course($course);
1321             }
1322             $coursenode = $this->mycourses[$course->id]->coursenode;
1323         } else {
1324             $coursenode = $this->add_course($course);
1325         }
1326         return $coursenode;
1327     }
1329     /**
1330      * Loads all of the courses section into the navigation.
1331      *
1332      * This function utilisies a callback that can be implemented within the course
1333      * formats lib.php file to customise the navigation that is generated at this
1334      * point for the course.
1335      *
1336      * By default (if not defined) the method {@see load_generic_course_sections} is
1337      * called instead.
1338      *
1339      * @param stdClass $course Database record for the course
1340      * @param navigation_node $coursenode The course node within the navigation
1341      * @return array Array of navigation nodes for the section with key = section id
1342      */
1343     protected function load_course_sections(stdClass $course, navigation_node $coursenode) {
1344         global $CFG;
1345         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
1346         $structurefunc = 'callback_'.$course->format.'_load_content';
1347         if (function_exists($structurefunc)) {
1348             return $structurefunc($this, $course, $coursenode);
1349         } else if (file_exists($structurefile)) {
1350             require_once $structurefile;
1351             if (function_exists($structurefunc)) {
1352                 return $structurefunc($this, $course, $coursenode);
1353             } else {
1354                 return $this->load_generic_course_sections($course, $coursenode);
1355             }
1356         } else {
1357             return $this->load_generic_course_sections($course, $coursenode);
1358         }
1359     }
1361     /**
1362      * Generically loads the course sections into the course's navigation.
1363      *
1364      * @param stdClass $course
1365      * @param navigation_node $coursenode
1366      * @param string $name The string that identifies each section. e.g Topic, or Week
1367      * @param string $activeparam The url used to identify the active section
1368      * @return array An array of course section nodes
1369      */
1370     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $courseformat='unknown') {
1371         global $CFG, $DB, $USER;
1373         require_once($CFG->dirroot.'/course/lib.php');
1375         if (!$this->cache->cached('modinfo'.$course->id)) {
1376             $this->cache->set('modinfo'.$course->id, get_fast_modinfo($course));
1377         }
1378         $modinfo = $this->cache->{'modinfo'.$course->id};
1380         if (!$this->cache->cached('coursesections'.$course->id)) {
1381             $this->cache->set('coursesections'.$course->id, array_slice(get_all_sections($course->id), 0, $course->numsections+1, true));
1382         }
1383         $sections = $this->cache->{'coursesections'.$course->id};
1385         $viewhiddensections = has_capability('moodle/course:viewhiddensections', $this->page->context);
1387         if (isloggedin() && !isguestuser()) {
1388             $activesection = $DB->get_field("course_display", "display", array("userid"=>$USER->id, "course"=>$course->id));
1389         } else {
1390             $activesection = null;
1391         }
1393         $namingfunction = 'callback_'.$courseformat.'_get_section_name';
1394         $namingfunctionexists = (function_exists($namingfunction));
1396         $activeparamfunction = 'callback_'.$courseformat.'_request_key';
1397         if (function_exists($activeparamfunction)) {
1398             $activeparam = $activeparamfunction();
1399         } else {
1400             $activeparam = 'section';
1401         }
1402         $navigationsections = array();
1403         foreach ($sections as $sectionid=>$section) {
1404             $section = clone($section);
1405             if ($course->id == SITEID) {
1406                 $this->load_section_activities($coursenode, $section->section, $modinfo);
1407             } else {
1408                 if ((!$viewhiddensections && !$section->visible) || (!$this->showemptysections && !array_key_exists($section->section, $modinfo->sections))) {
1409                     continue;
1410                 }
1411                 if ($namingfunctionexists) {
1412                     $sectionname = $namingfunction($course, $section, $sections);
1413                 } else {
1414                     $sectionname = get_string('section').' '.$section->section;
1415                 }
1416                 //$url = new moodle_url('/course/view.php', array('id'=>$course->id));
1417                 $url = null;
1418                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1419                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1420                 $sectionnode->hidden = (!$section->visible);
1421                 if ($this->page->context->contextlevel != CONTEXT_MODULE && ($sectionnode->isactive || ($activesection != null && $section->section == $activesection))) {
1422                     $sectionnode->force_open();
1423                     $this->load_section_activities($sectionnode, $section->section, $modinfo);
1424                 }
1425                 $section->sectionnode = $sectionnode;
1426                 $navigationsections[$sectionid] = $section;
1427             }
1428         }
1429         return $navigationsections;
1430     }
1431     /**
1432      * Loads all of the activities for a section into the navigation structure.
1433      *
1434      * @param navigation_node $sectionnode
1435      * @param int $sectionnumber
1436      * @param course_modinfo $modinfo Object returned from {@see get_fast_modinfo()}
1437      * @return array Array of activity nodes
1438      */
1439     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, course_modinfo $modinfo) {
1440         if (!array_key_exists($sectionnumber, $modinfo->sections)) {
1441             return true;
1442         }
1444         $activities = array();
1446         foreach ($modinfo->sections[$sectionnumber] as $cmid) {
1447             $cm = $modinfo->cms[$cmid];
1448             if (!$cm->uservisible) {
1449                 continue;
1450             }
1451             if ($cm->icon) {
1452                 $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
1453             } else {
1454                 $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
1455             }
1456             $url = $cm->get_url();
1457             $activitynode = $sectionnode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
1458             $activitynode->title(get_string('modulename', $cm->modname));
1459             $activitynode->hidden = (!$cm->visible);
1460             if (!$url) {
1461                 // Do not show activities that don't have links!
1462                 $activitynode->display = false;
1463             } else if ($this->module_extends_navigation($cm->modname)) {
1464                 $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
1465             }
1466             $activities[$cmid] = $activitynode;
1467         }
1469         return $activities;
1470     }
1471     /**
1472      * Loads a stealth module from unavailable section
1473      * @param navigation_node $coursenode
1474      * @param stdClass $modinfo
1475      * @return navigation_node or null if not accessible
1476      */
1477     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
1478         if (empty($modinfo->cms[$this->page->cm->id])) {
1479             return null;
1480         }
1481         $cm = $modinfo->cms[$this->page->cm->id];
1482         if (!$cm->uservisible) {
1483             return null;
1484         }
1485         if ($cm->icon) {
1486             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
1487         } else {
1488             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
1489         }
1490         $url = $cm->get_url();
1491         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
1492         $activitynode->title(get_string('modulename', $cm->modname));
1493         $activitynode->hidden = (!$cm->visible);
1494         if (!$url) {
1495             // Don't show activities that don't have links!
1496             $activitynode->display = false;
1497         } else if ($this->module_extends_navigation($cm->modname)) {
1498             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
1499         }
1500         return $activitynode;
1501     }
1502     /**
1503      * Loads the navigation structure for the given activity into the activities node.
1504      *
1505      * This method utilises a callback within the modules lib.php file to load the
1506      * content specific to activity given.
1507      *
1508      * The callback is a method: {modulename}_extend_navigation()
1509      * Examples:
1510      *  * {@see forum_extend_navigation()}
1511      *  * {@see workshop_extend_navigation()}
1512      *
1513      * @param cm_info|stdClass $cm
1514      * @param stdClass $course
1515      * @param navigation_node $activity
1516      * @return bool
1517      */
1518     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
1519         global $CFG, $DB;
1520         
1521         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
1522         if (!($cm instanceof cm_info)) {
1523             $modinfo = get_fast_modinfo($course);
1524             $cm = $modinfo->get_cm($cm->id);
1525         }
1527         $activity->make_active();
1528         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
1529         $function = $cm->modname.'_extend_navigation';
1531         if (file_exists($file)) {
1532             require_once($file);
1533             if (function_exists($function)) {
1534                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
1535                 $function($activity, $course, $activtyrecord, $cm);
1536                 return true;
1537             }
1538         }
1539         $activity->nodetype = navigation_node::NODETYPE_LEAF;
1540         return false;
1541     }
1542     /**
1543      * Loads user specific information into the navigation in the appopriate place.
1544      *
1545      * If no user is provided the current user is assumed.
1546      *
1547      * @param stdClass $user
1548      * @return bool
1549      */
1550     protected function load_for_user($user=null, $forceforcontext=false) {
1551         global $DB, $CFG, $USER;
1553         if ($user === null) {
1554             // We can't require login here but if the user isn't logged in we don't
1555             // want to show anything
1556             if (!isloggedin() || isguestuser()) {
1557                 return false;
1558             }
1559             $user = $USER;
1560         } else if (!is_object($user)) {
1561             // If the user is not an object then get them from the database
1562             $user = $DB->get_record('user', array('id'=>(int)$user), '*', MUST_EXIST);
1563         }
1565         $iscurrentuser = ($user->id == $USER->id);
1567         $usercontext = get_context_instance(CONTEXT_USER, $user->id);
1569         // Get the course set against the page, by default this will be the site
1570         $course = $this->page->course;
1571         $baseargs = array('id'=>$user->id);
1572         if ($course->id !== SITEID && (!$iscurrentuser || $forceforcontext)) {
1573             if (array_key_exists($course->id, $this->mycourses)) {
1574                 $coursenode = $this->mycourses[$course->id]->coursenode;
1575             } else {
1576                 $coursenode = $this->rootnodes['courses']->find($course->id, navigation_node::TYPE_COURSE);
1577                 if (!$coursenode) {
1578                     $coursenode = $this->load_course($course);
1579                 }
1580             }
1581             $baseargs['course'] = $course->id;
1582             $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
1583             $issitecourse = false;
1584         } else {
1585             // Load all categories and get the context for the system
1586             $coursecontext = get_context_instance(CONTEXT_SYSTEM);
1587             $issitecourse = true;
1588         }
1590         // Create a node to add user information under.
1591         if ($iscurrentuser && !$forceforcontext) {
1592             // If it's the current user the information will go under the profile root node
1593             $usernode = $this->rootnodes['myprofile'];
1594         } else {
1595             if (!$issitecourse) {
1596                 // Not the current user so add it to the participants node for the current course
1597                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
1598                 $userviewurl = new moodle_url('/user/view.php', $baseargs);
1599             } else {
1600                 // This is the site so add a users node to the root branch
1601                 $usersnode = $this->rootnodes['users'];
1602                 $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
1603                 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
1604             }
1605             if (!$usersnode) {
1606                 // We should NEVER get here, if the course hasn't been populated
1607                 // with a participants node then the navigaiton either wasn't generated
1608                 // for it (you are missing a require_login or set_context call) or
1609                 // you don't have access.... in the interests of no leaking informatin
1610                 // we simply quit...
1611                 return false;
1612             }
1613             // Add a branch for the current user
1614             $usernode = $usersnode->add(fullname($user, true), $userviewurl, self::TYPE_USER, null, $user->id);
1616             if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
1617                 $usernode->make_active();
1618             }
1619         }
1621         // If the user is the current user or has permission to view the details of the requested
1622         // user than add a view profile link.
1623         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
1624             if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
1625                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
1626             } else {
1627                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
1628             }
1629         }
1631         // Add nodes for forum posts and discussions if the user can view either or both
1632         // There are no capability checks here as the content of the page is based
1633         // purely on the forums the current user has access too.
1634         $forumtab = $usernode->add(get_string('forumposts', 'forum'));
1635         $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
1636         $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
1638         // Add blog nodes
1639         if (!empty($CFG->bloglevel)) {
1640             require_once($CFG->dirroot.'/blog/lib.php');
1641             // Get all options for the user
1642             $options = blog_get_options_for_user($user);
1643             if (count($options) > 0) {
1644                 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
1645                 foreach ($options as $option) {
1646                     $blogs->add($option['string'], $option['link']);
1647                 }
1648             }
1649         }
1651         if (!empty($CFG->messaging)) {
1652             $messageargs = null;
1653             if ($USER->id!=$user->id) {
1654                 $messageargs = array('id'=>$user->id);
1655             }
1656             $url = new moodle_url('/message/index.php',$messageargs);
1657             $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
1658         }
1660         // TODO: Private file capability check
1661         if ($iscurrentuser) {
1662             $url = new moodle_url('/user/files.php');
1663             $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
1664         }
1666         // Add a node to view the users notes if permitted
1667         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
1668             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
1669             if ($coursecontext->instanceid) {
1670                 $url->param('course', $coursecontext->instanceid);
1671             }
1672             $usernode->add(get_string('notes', 'notes'), $url);
1673         }
1675         // Add a reports tab and then add reports the the user has permission to see.
1676         $anyreport  = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
1678         $viewreports = ($anyreport || ($course->showreports && $iscurrentuser && $forceforcontext));
1679         if ($viewreports) {
1680             $reporttab = $usernode->add(get_string('activityreports'));
1681             $reportargs = array('user'=>$user->id);
1682             if (!empty($course->id)) {
1683                 $reportargs['id'] = $course->id;
1684             } else {
1685                 $reportargs['id'] = SITEID;
1686             }
1687             if ($viewreports || has_capability('coursereport/outline:view', $coursecontext)) {
1688                 $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
1689                 $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
1690             }
1692             if ($viewreports || has_capability('coursereport/log:viewtoday', $coursecontext)) {
1693                 $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
1694             }
1696             if ($viewreports || has_capability('coursereport/log:view', $coursecontext)) {
1697                 $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
1698             }
1700             if (!empty($CFG->enablestats)) {
1701                 if ($viewreports || has_capability('coursereport/stats:view', $coursecontext)) {
1702                     $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
1703                 }
1704             }
1706             $gradeaccess = false;
1707             if (has_capability('moodle/grade:viewall', $coursecontext)) {
1708                 //ok - can view all course grades
1709                 $gradeaccess = true;
1710             } else if ($course->showgrades) {
1711                 if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) {
1712                     //ok - can view own grades
1713                     $gradeaccess = true;
1714                 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
1715                     // ok - can view grades of this user - parent most probably
1716                     $gradeaccess = true;
1717                 } else if ($anyreport) {
1718                     // ok - can view grades of this user - parent most probably
1719                     $gradeaccess = true;
1720                 }
1721             }
1722             if ($gradeaccess) {
1723                 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'grade'))));
1724             }
1726             // Check the number of nodes in the report node... if there are none remove
1727             // the node
1728             if (count($reporttab->children)===0) {
1729                 $usernode->remove_child($reporttab);
1730             }
1731         }
1733         // If the user is the current user add the repositories for the current user
1734         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
1735         if ($iscurrentuser) {
1736             require_once($CFG->dirroot . '/repository/lib.php');
1737             $editabletypes = repository::get_editable_types($usercontext);
1738             if (!empty($editabletypes)) {
1739                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
1740             }
1741         } else if ($course->id == SITEID && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
1743             // Add view grade report is permitted
1744             $reports = get_plugin_list('gradereport');
1745             arsort($reports); // user is last, we want to test it first
1747             $userscourses = enrol_get_users_courses($user->id);
1748             $userscoursesnode = $usernode->add(get_string('courses'));
1750             foreach ($userscourses as $usercourse) {
1751                 $usercoursecontext = get_context_instance(CONTEXT_COURSE, $usercourse->id);
1752                 $usercoursenode = $userscoursesnode->add($usercourse->shortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
1754                 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
1755                 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
1756                     foreach ($reports as $plugin => $plugindir) {
1757                         if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
1758                             //stop when the first visible plugin is found
1759                             $gradeavailable = true;
1760                             break;
1761                         }
1762                     }
1763                 }
1765                 if ($gradeavailable) {
1766                     $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
1767                     $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
1768                 }
1770                 // Add a node to view the users notes if permitted
1771                 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
1772                     $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
1773                     $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
1774                 }
1776                 if (can_access_course(get_context_instance(CONTEXT_COURSE, $usercourse->id), $user->id)) {
1777                     $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', ''));
1778                 }
1780                 $outlinetreport = ($anyreport || has_capability('coursereport/outline:view', $usercoursecontext));
1781                 $logtodayreport = ($anyreport || has_capability('coursereport/log:viewtoday', $usercoursecontext));
1782                 $logreport =      ($anyreport || has_capability('coursereport/log:view', $usercoursecontext));
1783                 $statsreport =    ($anyreport || has_capability('coursereport/stats:view', $usercoursecontext));
1784                 if ($outlinetreport || $logtodayreport || $logreport || $statsreport) {
1785                     $reporttab = $usercoursenode->add(get_string('activityreports'));
1786                     $reportargs = array('user'=>$user->id, 'id'=>$usercourse->id);
1787                     if ($outlinetreport) {
1788                         $reporttab->add(get_string('outlinereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'outline'))));
1789                         $reporttab->add(get_string('completereport'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'complete'))));
1790                     }
1792                     if ($logtodayreport) {
1793                         $reporttab->add(get_string('todaylogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'todaylogs'))));
1794                     }
1796                     if ($logreport) {
1797                         $reporttab->add(get_string('alllogs'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'alllogs'))));
1798                     }
1800                     if (!empty($CFG->enablestats) && $statsreport) {
1801                         $reporttab->add(get_string('stats'), new moodle_url('/course/user.php', array_merge($reportargs, array('mode'=>'stats'))));
1802                     }
1803                 }
1804             }
1805         }
1806         return true;
1807     }
1809     /**
1810      * This method simply checks to see if a given module can extend the navigation.
1811      *
1812      * @param string $modname
1813      * @return bool
1814      */
1815     protected function module_extends_navigation($modname) {
1816         global $CFG;
1817         if ($this->cache->cached($modname.'_extends_navigation')) {
1818             return $this->cache->{$modname.'_extends_navigation'};
1819         }
1820         $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
1821         $function = $modname.'_extend_navigation';
1822         if (function_exists($function)) {
1823             $this->cache->{$modname.'_extends_navigation'} = true;
1824             return true;
1825         } else if (file_exists($file)) {
1826             require_once($file);
1827             if (function_exists($function)) {
1828                 $this->cache->{$modname.'_extends_navigation'} = true;
1829                 return true;
1830             }
1831         }
1832         $this->cache->{$modname.'_extends_navigation'} = false;
1833         return false;
1834     }
1835     /**
1836      * Extends the navigation for the given user.
1837      *
1838      * @param stdClass $user A user from the database
1839      */
1840     public function extend_for_user($user) {
1841         $this->extendforuser[] = $user;
1842     }
1844     /**
1845      * Returns all of the users the navigation is being extended for
1846      *
1847      * @return array
1848      */
1849     public function get_extending_users() {
1850         return $this->extendforuser;
1851     }
1852     /**
1853      * Adds the given course to the navigation structure.
1854      *
1855      * @param stdClass $course
1856      * @return navigation_node
1857      */
1858     public function add_course(stdClass $course, $forcegeneric = false) {
1859         global $CFG;
1860         $canviewhidden = has_capability('moodle/course:viewhiddencourses', $this->page->context);
1861         if ($course->id !== SITEID && !$canviewhidden && !$course->visible) {
1862             return false;
1863         }
1865         $issite = ($course->id == SITEID);
1866         $ismycourse = (array_key_exists($course->id, $this->mycourses) && !$forcegeneric);
1867         $displaycategories = (!$ismycourse && !$issite && !empty($CFG->navshowcategories));
1868         $shortname = $course->shortname;
1870         if ($issite) {
1871             $parent = $this;
1872             $url = null;
1873             $shortname = get_string('sitepages');
1874         } else if ($ismycourse) {
1875             $parent = $this->rootnodes['mycourses'];
1876             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
1877         } else {
1878             $parent = $this->rootnodes['courses'];
1879             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
1880         }
1882         if ($displaycategories) {
1883             // We need to load the category structure for this course
1884             $categoryfound = false;
1885             if (!empty($course->categorypath)) {
1886                 $categories = explode('/', trim($course->categorypath, '/'));
1887                 $category = $parent;
1888                 while ($category && $categoryid = array_shift($categories)) {
1889                     $category = $category->get($categoryid, self::TYPE_CATEGORY);
1890                 }
1891                 if ($category instanceof navigation_node) {
1892                     $parent = $category;
1893                     $categoryfound = true;
1894                 }
1895                 if (!$categoryfound && $forcegeneric) {
1896                     $this->load_all_categories($course->category);
1897                     if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) {
1898                         $parent = $category;
1899                         $categoryfound = true;
1900                     }
1901                 }
1902             } else if (!empty($course->category)) {
1903                 $this->load_all_categories($course->category);
1904                 if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) {
1905                     $parent = $category;
1906                     $categoryfound = true;
1907                 }
1908                 if (!$categoryfound && !$forcegeneric) {
1909                     $this->load_all_categories($course->category);
1910                     if ($category = $parent->find($course->category, self::TYPE_CATEGORY)) {
1911                         $parent = $category;
1912                         $categoryfound = true;
1913                     }
1914                 }
1915             }
1916         }
1918         // We found the course... we can return it now :)
1919         if ($coursenode = $parent->get($course->id, self::TYPE_COURSE)) {
1920             return $coursenode;
1921         }
1923         $coursenode = $parent->add($shortname, $url, self::TYPE_COURSE, $shortname, $course->id);
1924         $coursenode->nodetype = self::NODETYPE_BRANCH;
1925         $coursenode->hidden = (!$course->visible);
1926         $coursenode->title($course->fullname);
1927         $this->addedcourses[$course->id] = &$coursenode;
1928         if ($ismycourse && !empty($CFG->navshowallcourses)) {
1929             // We need to add this course to the general courses node as well as the
1930             // my courses node, rerun the function with the kill param
1931             $genericcourse = $this->add_course($course, true);
1932             if ($genericcourse->isactive) {
1933                 $genericcourse->make_inactive();
1934                 $genericcourse->collapse = true;
1935                 if ($genericcourse->parent && $genericcourse->parent->type == self::TYPE_CATEGORY) {
1936                     $parent = $genericcourse->parent;
1937                     while ($parent && $parent->type == self::TYPE_CATEGORY) {
1938                         $parent->collapse = true;
1939                         $parent = $parent->parent;
1940                     }
1941                 }
1942             }
1943         }
1944         return $coursenode;
1945     }
1946     /**
1947      * Adds essential course nodes to the navigation for the given course.
1948      *
1949      * This method adds nodes such as reports, blogs and participants
1950      *
1951      * @param navigation_node $coursenode
1952      * @param stdClass $course
1953      * @return bool
1954      */
1955     public function add_course_essentials(navigation_node $coursenode, stdClass $course) {
1956         global $CFG;
1958         if ($course->id == SITEID) {
1959             return $this->add_front_page_course_essentials($coursenode, $course);
1960         }
1962         if ($coursenode == false || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
1963             return true;
1964         }
1966         //Participants
1967         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
1968             require_once($CFG->dirroot.'/blog/lib.php');
1969             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
1970             $currentgroup = groups_get_course_group($course, true);
1971             if ($course->id == SITEID) {
1972                 $filterselect = '';
1973             } else if ($course->id && !$currentgroup) {
1974                 $filterselect = $course->id;
1975             } else {
1976                 $filterselect = $currentgroup;
1977             }
1978             $filterselect = clean_param($filterselect, PARAM_INT);
1979             if ($CFG->bloglevel >= 3) {
1980                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
1981                 $participants->add(get_string('blogs','blog'), $blogsurls->out());
1982             }
1983             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
1984                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
1985             }
1986         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
1987             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
1988         }
1990         // View course reports
1991         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
1992             $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', ''));
1993             $coursereports = get_plugin_list('coursereport');
1994             foreach ($coursereports as $report=>$dir) {
1995                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
1996                 if (file_exists($libfile)) {
1997                     require_once($libfile);
1998                     $reportfunction = $report.'_report_extend_navigation';
1999                     if (function_exists($report.'_report_extend_navigation')) {
2000                         $reportfunction($reportnav, $course, $this->page->context);
2001                     }
2002                 }
2003             }
2004         }
2005         return true;
2006     }
2007     /**
2008      * This generates the the structure of the course that won't be generated when
2009      * the modules and sections are added.
2010      *
2011      * Things such as the reports branch, the participants branch, blogs... get
2012      * added to the course node by this method.
2013      *
2014      * @param navigation_node $coursenode
2015      * @param stdClass $course
2016      * @return bool True for successfull generation
2017      */
2018     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2019         global $CFG;
2021         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2022             return true;
2023         }
2025         // Hidden node that we use to determine if the front page navigation is loaded.
2026         // This required as there are not other guaranteed nodes that may be loaded.
2027         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2029         //Participants
2030         if (has_capability('moodle/course:viewparticipants',  get_system_context())) {
2031             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2032         }
2034         $filterselect = 0;
2036         // Blogs
2037         if (has_capability('moodle/blog:view', $this->page->context)) {
2038             require_once($CFG->dirroot.'/blog/lib.php');
2039             if (blog_is_enabled_for_user()) {
2040                 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2041                 $coursenode->add(get_string('blogs','blog'), $blogsurls->out());
2042             }
2043         }
2045         // Notes
2046         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2047             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2048         }
2050         // Tags
2051         if (!empty($CFG->usetags) && isloggedin()) {
2052             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2053         }
2056         // View course reports
2057         if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
2058             $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', ''));
2059             $coursereports = get_plugin_list('coursereport');
2060             foreach ($coursereports as $report=>$dir) {
2061                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2062                 if (file_exists($libfile)) {
2063                     require_once($libfile);
2064                     $reportfunction = $report.'_report_extend_navigation';
2065                     if (function_exists($report.'_report_extend_navigation')) {
2066                         $reportfunction($reportnav, $course, $this->page->context);
2067                     }
2068                 }
2069             }
2070         }
2071         return true;
2072     }
2074     /**
2075      * Clears the navigation cache
2076      */
2077     public function clear_cache() {
2078         $this->cache->clear();
2079     }
2081     /**
2082      * Sets an expansion limit for the navigation
2083      *
2084      * The expansion limit is used to prevent the display of content that has a type
2085      * greater than the provided $type.
2086      *
2087      * Can be used to ensure things such as activities or activity content don't get
2088      * shown on the navigation.
2089      * They are still generated in order to ensure the navbar still makes sense.
2090      *
2091      * @param int $type One of navigation_node::TYPE_*
2092      * @return <type>
2093      */
2094     public function set_expansion_limit($type) {
2095         $nodes = $this->find_all_of_type($type);
2096         foreach ($nodes as &$node) {
2097             // We need to generate the full site node
2098             if ($type == self::TYPE_COURSE && $node->key == SITEID) {
2099                 continue;
2100             }
2101             foreach ($node->children as &$child) {
2102                 // We still want to show course reports and participants containers
2103                 // or there will be navigation missing.
2104                 if ($type == self::TYPE_COURSE && $child->type === self::TYPE_CONTAINER) {
2105                     continue;
2106                 }
2107                 $child->display = false;
2108             }
2109         }
2110         return true;
2111     }
2112     /**
2113      * Attempts to get the navigation with the given key from this nodes children.
2114      *
2115      * This function only looks at this nodes children, it does NOT look recursivily.
2116      * If the node can't be found then false is returned.
2117      *
2118      * If you need to search recursivily then use the {@see find()} method.
2119      *
2120      * Note: If you are trying to set the active node {@see navigation_node::override_active_url()}
2121      * may be of more use to you.
2122      *
2123      * @param string|int $key The key of the node you wish to receive.
2124      * @param int $type One of navigation_node::TYPE_*
2125      * @return navigation_node|false
2126      */
2127     public function get($key, $type = null) {
2128         if (!$this->initialised) {
2129             $this->initialise();
2130         }
2131         return parent::get($key, $type);
2132     }
2134     /**
2135      * Searches this nodes children and thier children to find a navigation node
2136      * with the matching key and type.
2137      *
2138      * This method is recursive and searches children so until either a node is
2139      * found of there are no more nodes to search.
2140      *
2141      * If you know that the node being searched for is a child of this node
2142      * then use the {@see get()} method instead.
2143      *
2144      * Note: If you are trying to set the active node {@see navigation_node::override_active_url()}
2145      * may be of more use to you.
2146      *
2147      * @param string|int $key The key of the node you wish to receive.
2148      * @param int $type One of navigation_node::TYPE_*
2149      * @return navigation_node|false
2150      */
2151     public function find($key, $type) {
2152         if (!$this->initialised) {
2153             $this->initialise();
2154         }
2155         return parent::find($key, $type);
2156     }
2159 /**
2160  * The limited global navigation class used for the AJAX extension of the global
2161  * navigation class.
2162  *
2163  * The primary methods that are used in the global navigation class have been overriden
2164  * to ensure that only the relevant branch is generated at the root of the tree.
2165  * This can be done because AJAX is only used when the backwards structure for the
2166  * requested branch exists.
2167  * This has been done only because it shortens the amounts of information that is generated
2168  * which of course will speed up the response time.. because no one likes laggy AJAX.
2169  *
2170  * @package moodlecore
2171  * @subpackage navigation
2172  * @copyright 2009 Sam Hemelryk
2173  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2174  */
2175 class global_navigation_for_ajax extends global_navigation {
2177     protected $branchtype;
2178     protected $instanceid;
2180     /** @var array */
2181     protected $expandable = array();
2183     /**
2184      * Constructs the navigation for use in AJAX request
2185      */
2186     public function __construct($page, $branchtype, $id) {
2187         $this->page = $page;
2188         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2189         $this->children = new navigation_node_collection();
2190         $this->branchtype = $branchtype;
2191         $this->instanceid = $id;
2192         $this->initialise();
2193     }
2194     /**
2195      * Initialise the navigation given the type and id for the branch to expand.
2196      *
2197      * @return array The expandable nodes
2198      */
2199     public function initialise() {
2200         global $CFG, $DB, $SITE;
2202         if ($this->initialised || during_initial_install()) {
2203             return $this->expandable;
2204         }
2205         $this->initialised = true;
2207         $this->rootnodes = array();
2208         $this->rootnodes['site']      = $this->add_course($SITE);
2209         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2211         // Branchtype will be one of navigation_node::TYPE_*
2212         switch ($this->branchtype) {
2213             case self::TYPE_CATEGORY :
2214                 $this->load_all_categories($this->instanceid);
2215                 $limit = 20;
2216                 if (!empty($CFG->navcourselimit)) {
2217                     $limit = (int)$CFG->navcourselimit;
2218                 }
2219                 $courses = $DB->get_records('course', array('category' => $this->instanceid), 'sortorder','*', 0, $limit);
2220                 foreach ($courses as $course) {
2221                     $this->add_course($course);
2222                 }
2223                 break;
2224             case self::TYPE_COURSE :
2225                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
2226                 require_course_login($course);
2227                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2228                 $coursenode = $this->add_course($course);
2229                 $this->add_course_essentials($coursenode, $course);
2230                 if ($this->format_display_course_content($course->format)) {
2231                     $this->load_course_sections($course, $coursenode);
2232                 }
2233                 break;
2234             case self::TYPE_SECTION :
2235                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2236                         FROM {course} c
2237                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2238                         WHERE cs.id = ?';
2239                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
2240                 require_course_login($course);
2241                 $this->page->set_context(get_context_instance(CONTEXT_COURSE, $course->id));
2242                 $coursenode = $this->add_course($course);
2243                 $this->add_course_essentials($coursenode, $course);
2244                 $sections = $this->load_course_sections($course, $coursenode);
2245                 $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, get_fast_modinfo($course));
2246                 break;
2247             case self::TYPE_ACTIVITY :
2248                 $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
2249                 $modinfo = get_fast_modinfo($course);
2250                 $cm = $modinfo->get_cm($this->instanceid);
2251                 require_course_login($course, true, $cm);
2252                 $this->page->set_context(get_context_instance(CONTEXT_MODULE, $cm->id));
2253                 $coursenode = $this->load_course($course);
2254                 $sections = $this->load_course_sections($course, $coursenode);
2255                 foreach ($sections as $section) {
2256                     if ($section->id == $cm->section) {
2257                         $cm->sectionnumber = $section->section;
2258                         break;
2259                     }
2260                 }
2261                 if ($course->id == SITEID) {
2262                     $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY));
2263                 } else {
2264                     $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, get_fast_modinfo($course));
2265                     $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]);
2266                 }
2267                 break;
2268             default:
2269                 throw new Exception('Unknown type');
2270                 return $this->expandable;
2271         }
2273         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != SITEID) {
2274             $this->load_for_user(null, true);
2275         }
2277         $this->find_expandable($this->expandable);
2278         return $this->expandable;
2279     }
2281     /**
2282      * Returns an array of expandable nodes
2283      * @return array
2284      */
2285     public function get_expandable() {
2286         return $this->expandable;
2287     }
2290 /**
2291  * Navbar class
2292  *
2293  * This class is used to manage the navbar, which is initialised from the navigation
2294  * object held by PAGE
2295  *
2296  * @package moodlecore
2297  * @subpackage navigation
2298  * @copyright 2009 Sam Hemelryk
2299  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2300  */
2301 class navbar extends navigation_node {
2302     /** @var bool */
2303     protected $initialised = false;
2304     /** @var mixed */
2305     protected $keys = array();
2306     /** @var null|string */
2307     protected $content = null;
2308     /** @var moodle_page object */
2309     protected $page;
2310     /** @var bool */
2311     protected $ignoreactive = false;
2312     /** @var bool */
2313     protected $duringinstall = false;
2314     /** @var bool */
2315     protected $hasitems = false;
2316     /** @var array */
2317     protected $items;
2318     /** @var array */
2319     public $children = array();
2320     /** @var bool */
2321     public $includesettingsbase = false;
2322     /**
2323      * The almighty constructor
2324      *
2325      * @param moodle_page $page
2326      */
2327     public function __construct(moodle_page $page) {
2328         global $CFG;
2329         if (during_initial_install()) {
2330             $this->duringinstall = true;
2331             return false;
2332         }
2333         $this->page = $page;
2334         $this->text = get_string('home');
2335         $this->shorttext = get_string('home');
2336         $this->action = new moodle_url($CFG->wwwroot);
2337         $this->nodetype = self::NODETYPE_BRANCH;
2338         $this->type = self::TYPE_SYSTEM;
2339     }
2341     /**
2342      * Quick check to see if the navbar will have items in.
2343      *
2344      * @return bool Returns true if the navbar will have items, false otherwise
2345      */
2346     public function has_items() {
2347         if ($this->duringinstall) {
2348             return false;
2349         } else if ($this->hasitems !== false) {
2350             return true;
2351         }
2352         $this->page->navigation->initialise($this->page);
2354         $activenodefound = ($this->page->navigation->contains_active_node() ||
2355                             $this->page->settingsnav->contains_active_node());
2357         $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
2358         $this->hasitems = $outcome;
2359         return $outcome;
2360     }
2362     /**
2363      * Turn on/off ignore active
2364      *
2365      * @param bool $setting
2366      */
2367     public function ignore_active($setting=true) {
2368         $this->ignoreactive = ($setting);
2369     }
2370     public function get($key, $type = null) {
2371         foreach ($this->children as &$child) {
2372             if ($child->key === $key && ($type == null || $type == $child->type)) {
2373                 return $child;
2374             }
2375         }
2376         return false;
2377     }
2378     /**
2379      * Returns an array of navigation_node's that make up the navbar.
2380      *
2381      * @return array
2382      */
2383     public function get_items() {
2384         $items = array();
2385         // Make sure that navigation is initialised
2386         if (!$this->has_items()) {
2387             return $items;
2388         }
2389         if ($this->items !== null) {
2390             return $this->items;
2391         }
2393         if (count($this->children) > 0) {
2394             // Add the custom children
2395             $items = array_reverse($this->children);
2396         }
2398         $navigationactivenode = $this->page->navigation->find_active_node();
2399         $settingsactivenode = $this->page->settingsnav->find_active_node();
2401         // Check if navigation contains the active node
2402         if (!$this->ignoreactive) {
2404             if ($navigationactivenode && $settingsactivenode) {
2405                 // Parse a combined navigation tree
2406                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
2407                     if (!$settingsactivenode->mainnavonly) {
2408                         $items[] = $settingsactivenode;
2409                     }
2410                     $settingsactivenode = $settingsactivenode->parent;
2411                 }
2412                 if (!$this->includesettingsbase) {
2413                     // Removes the first node from the settings (root node) from the list
2414                     array_pop($items);
2415                 }
2416                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
2417                     if (!$navigationactivenode->mainnavonly) {
2418                         $items[] = $navigationactivenode;
2419                     }
2420                     $navigationactivenode = $navigationactivenode->parent;
2421                 }
2422             } else if ($navigationactivenode) {
2423                 // Parse the navigation tree to get the active node
2424                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
2425                     if (!$navigationactivenode->mainnavonly) {
2426                         $items[] = $navigationactivenode;
2427                     }
2428                     $navigationactivenode = $navigationactivenode->parent;
2429                 }
2430             } else if ($settingsactivenode) {
2431                 // Parse the settings navigation to get the active node
2432                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
2433                     if (!$settingsactivenode->mainnavonly) {
2434                         $items[] = $settingsactivenode;
2435                     }
2436                     $settingsactivenode = $settingsactivenode->parent;
2437                 }
2438             }
2439         }
2441         $items[] = new navigation_node(array(
2442             'text'=>$this->page->navigation->text,
2443             'shorttext'=>$this->page->navigation->shorttext,
2444             'key'=>$this->page->navigation->key,
2445             'action'=>$this->page->navigation->action
2446         ));
2448         $this->items = array_reverse($items);
2449         return $this->items;
2450     }
2452     /**
2453      * Add a new navigation_node to the navbar, overrides parent::add
2454      *
2455      * This function overrides {@link navigation_node::add()} so that we can change
2456      * the way nodes get added to allow us to simply call add and have the node added to the
2457      * end of the navbar
2458      *
2459      * @param string $text
2460      * @param string|moodle_url $action
2461      * @param int $type
2462      * @param string|int $key
2463      * @param string $shorttext
2464      * @param string $icon
2465      * @return navigation_node
2466      */
2467     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
2468         if ($this->content !== null) {
2469             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
2470         }
2472         // Properties array used when creating the new navigation node
2473         $itemarray = array(
2474             'text' => $text,
2475             'type' => $type
2476         );
2477         // Set the action if one was provided
2478         if ($action!==null) {
2479             $itemarray['action'] = $action;
2480         }
2481         // Set the shorttext if one was provided
2482         if ($shorttext!==null) {
2483             $itemarray['shorttext'] = $shorttext;
2484         }
2485         // Set the icon if one was provided
2486         if ($icon!==null) {
2487             $itemarray['icon'] = $icon;
2488         }
2489         // Default the key to the number of children if not provided
2490         if ($key === null) {
2491             $key = count($this->children);
2492         }
2493         // Set the key
2494         $itemarray['key'] = $key;
2495         // Set the parent to this node
2496         $itemarray['parent'] = $this;
2497         // Add the child using the navigation_node_collections add method
2498         $this->children[] = new navigation_node($itemarray);
2499         return $this;
2500     }
2503 /**
2504  * Class used to manage the settings option for the current page
2505  *
2506  * This class is used to manage the settings options in a tree format (recursively)
2507  * and was created initially for use with the settings blocks.
2508  *
2509  * @package moodlecore
2510  * @subpackage navigation
2511  * @copyright 2009 Sam Hemelryk
2512  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2513  */
2514 class settings_navigation extends navigation_node {
2515     /** @var stdClass */
2516     protected $context;
2517     /** @var navigation_cache */
2518     protected $cache;
2519     /** @var moodle_page */
2520     protected $page;
2521     /** @var string */
2522     protected $adminsection;
2523     /** @var bool */
2524     protected $initialised = false;
2525     /** @var array */
2526     protected $userstoextendfor = array();
2528     /**
2529      * Sets up the object with basic settings and preparse it for use
2530      *
2531      * @param moodle_page $page
2532      */
2533     public function __construct(moodle_page &$page) {
2534         if (during_initial_install()) {
2535             return false;
2536         }
2537         $this->page = $page;
2538         // Initialise the main navigation. It is most important that this is done
2539         // before we try anything
2540         $this->page->navigation->initialise();
2541         // Initialise the navigation cache
2542         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2543         $this->children = new navigation_node_collection();
2544     }
2545     /**
2546      * Initialise the settings navigation based on the current context
2547      *
2548      * This function initialises the settings navigation tree for a given context
2549      * by calling supporting functions to generate major parts of the tree.
2550      *
2551      */
2552     public function initialise() {
2553         global $DB, $SESSION;
2555         if (during_initial_install()) {
2556             return false;
2557         } else if ($this->initialised) {
2558             return true;
2559         }
2560         $this->id = 'settingsnav';
2561         $this->context = $this->page->context;
2563         $context = $this->context;
2564         if ($context->contextlevel == CONTEXT_BLOCK) {
2565             $this->load_block_settings();
2566             $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));
2567         }
2569         switch ($context->contextlevel) {
2570             case CONTEXT_SYSTEM:
2571                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
2572                     $this->load_front_page_settings(($context->id == $this->context->id));
2573                 }
2574                 break;
2575             case CONTEXT_COURSECAT:
2576                 $this->load_category_settings();
2577                 break;
2578             case CONTEXT_COURSE:
2579                 if ($this->page->course->id != SITEID) {
2580                     $this->load_course_settings(($context->id == $this->context->id));
2581                 } else {
2582                     $this->load_front_page_settings(($context->id == $this->context->id));
2583                 }
2584                 break;
2585             case CONTEXT_MODULE:
2586                 $this->load_module_settings();
2587                 $this->load_course_settings();
2588                 break;
2589             case CONTEXT_USER:
2590                 if ($this->page->course->id != SITEID) {
2591                     $this->load_course_settings();
2592                 }
2593                 break;
2594         }
2596         $settings = $this->load_user_settings($this->page->course->id);
2598         if (isloggedin() && !isguestuser() && (!property_exists($SESSION, 'load_navigation_admin') || $SESSION->load_navigation_admin)) {
2599             $admin = $this->load_administration_settings();
2600             $SESSION->load_navigation_admin = ($admin->has_children());
2601         } else {
2602             $admin = false;
2603         }
2605         if ($context->contextlevel == CONTEXT_SYSTEM && $admin) {
2606             $admin->force_open();
2607         } else if ($context->contextlevel == CONTEXT_USER && $settings) {
2608             $settings->force_open();
2609         }
2611         // Check if the user is currently logged in as another user
2612         if (session_is_loggedinas()) {
2613             // Get the actual user, we need this so we can display an informative return link
2614             $realuser = session_get_realuser();
2615             // Add the informative return to original user link
2616             $url = new moodle_url('/course/loginas.php',array('id'=>$this->page->course->id, 'return'=>1,'sesskey'=>sesskey()));
2617             $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self::TYPE_SETTING, null, null, new pix_icon('t/left', ''));
2618         }
2620         foreach ($this->children as $key=>$node) {
2621             if ($node->nodetype != self::NODETYPE_BRANCH || $node->children->count()===0) {
2622                 $node->remove();
2623             }
2624         }
2625         $this->initialised = true;
2626     }
2627     /**
2628      * Override the parent function so that we can add preceeding hr's and set a
2629      * root node class against all first level element
2630      *
2631      * It does this by first calling the parent's add method {@link navigation_node::add()}
2632      * and then proceeds to use the key to set class and hr
2633      *
2634      * @param string $text
2635      * @param sting|moodle_url $url
2636      * @param string $shorttext
2637      * @param string|int $key
2638      * @param int $type
2639      * @param string $icon
2640      * @return navigation_node
2641      */
2642     public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
2643         $node = parent::add($text, $url, $type, $shorttext, $key, $icon);
2644         $node->add_class('root_node');
2645         return $node;
2646     }
2648     /**
2649      * This function allows the user to add something to the start of the settings
2650      * navigation, which means it will be at the top of the settings navigation block
2651      *
2652      * @param string $text
2653      * @param sting|moodle_url $url
2654      * @param string $shorttext
2655      * @param string|int $key
2656      * @param int $type
2657      * @param string $icon
2658      * @return navigation_node
2659      */
2660     public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
2661         $children = $this->children;
2662         $childrenclass = get_class($children);
2663         $this->children = new $childrenclass;
2664         $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
2665         foreach ($children as $child) {
2666             $this->children->add($child);
2667         }
2668         return $node;
2669     }
2670     /**
2671      * Load the site administration tree
2672      *
2673      * This function loads the site administration tree by using the lib/adminlib library functions
2674      *
2675      * @param navigation_node $referencebranch A reference to a branch in the settings
2676      *      navigation tree
2677      * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
2678      *      tree and start at the beginning
2679      * @return mixed A key to access the admin tree by
2680      */
2681     protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) {
2682         global $CFG;
2684         // Check if we are just starting to generate this navigation.
2685         if ($referencebranch === null) {
2687             // Require the admin lib then get an admin structure
2688             if (!function_exists('admin_get_root')) {
2689                 require_once($CFG->dirroot.'/lib/adminlib.php');
2690             }
2691             $adminroot = admin_get_root(false, false);
2692             // This is the active section identifier
2693             $this->adminsection = $this->page->url->param('section');
2695             // Disable the navigation from automatically finding the active node
2696             navigation_node::$autofindactive = false;
2697             $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SETTING, null, 'root');
2698             foreach ($adminroot->children as $adminbranch) {
2699                 $this->load_administration_settings($referencebranch, $adminbranch);
2700             }
2701             navigation_node::$autofindactive = true;
2703             // Use the admin structure to locate the active page
2704             if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) {
2705                 $currentnode = $this;
2706                 while (($pathkey = array_pop($current->path))!==null && $currentnode) {
2707                     $currentnode = $currentnode->get($pathkey);
2708                 }
2709                 if ($currentnode) {
2710                     $currentnode->make_active();
2711                 }
2712             } else {
2713                 $this->scan_for_active_node($referencebranch);
2714             }
2715             return $referencebranch;
2716         } else if ($adminbranch->check_access()) {
2717             // We have a reference branch that we can access and is not hidden `hurrah`
2718             // Now we need to display it and any children it may have
2719             $url = null;
2720             $icon = null;
2721             if ($adminbranch instanceof admin_settingpage) {
2722                 $url = new moodle_url('/admin/settings.php', array('section'=>$adminbranch->name));
2723             } else if ($adminbranch instanceof admin_externalpage) {
2724                 $url = $adminbranch->url;
2725             }
2727             // Add the branch
2728             $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon);
2730             if ($adminbranch->is_hidden()) {
2731                 if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) {
2732                     $reference->add_class('hidden');
2733                 } else {
2734                     $reference->display = false;
2735                 }
2736             }
2738             // Check if we are generating the admin notifications and whether notificiations exist
2739             if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) {
2740                 $reference->add_class('criticalnotification');
2741             }
2742             // Check if this branch has children
2743             if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) {
2744                 foreach ($adminbranch->children as $branch) {
2745                     // Generate the child branches as well now using this branch as the reference
2746                     $this->load_administration_settings($reference, $branch);
2747                 }
2748             } else {
2749                 $reference->icon = new pix_icon('i/settings', '');
2750             }
2751         }
2752     }
2754     /**
2755      * This function recursivily scans nodes until it finds the active node or there
2756      * are no more nodes.
2757      * @param navigation_node $node
2758      */
2759     protected function scan_for_active_node(navigation_node $node) {
2760         if (!$node->check_if_active() && $node->children->count()>0) {
2761             foreach ($node->children as &$child) {
2762                 $this->scan_for_active_node($child);
2763             }
2764         }
2765     }
2767     /**
2768      * Gets a navigation node given an array of keys that represent the path to
2769      * the desired node.
2770      *
2771      * @param array $path
2772      * @return navigation_node|false
2773      */
2774     protected function get_by_path(array $path) {
2775         $node = $this->get(array_shift($path));
2776         foreach ($path as $key) {
2777             $node->get($key);
2778         }
2779         return $node;
2780     }
2782     /**
2783      * Generate the list of modules for the given course.
2784      *
2785      * The array of resources and activities that can be added to a course is then
2786      * stored in the cache so that we can access it for anywhere.
2787      * It saves us generating it all the time
2788      *
2789      * <code php>
2790      * // To get resources:
2791      * $this->cache->{'course'.$courseid.'resources'}
2792      * // To get activities:
2793      * $this->cache->{'course'.$courseid.'activities'}
2794      * </code>
2795      *
2796      * @param stdClass $course The course to get modules for
2797      */
2798     protected function get_course_modules($course) {
2799         global $CFG;
2800         $mods = $modnames = $modnamesplural = $modnamesused = array();
2801         // This function is included when we include course/lib.php at the top
2802         // of this file
2803         get_all_mods($course->id, $mods, $modnames, $modnamesplural, $modnamesused);
2804         $resources = array();
2805         $activities = array();
2806         foreach($modnames as $modname=>$modnamestr) {
2807             if (!course_allowed_module($course, $modname)) {
2808                 continue;
2809             }
2811             $libfile = "$CFG->dirroot/mod/$modname/lib.php";
2812             if (!file_exists($libfile)) {
2813                 continue;
2814             }
2815             include_once($libfile);
2816             $gettypesfunc =  $modname.'_get_types';
2817             if (function_exists($gettypesfunc)) {
2818                 $types = $gettypesfunc();
2819                 foreach($types as $type) {
2820                     if (!isset($type->modclass) || !isset($type->typestr)) {
2821                         debugging('Incorrect activity type in '.$modname);
2822                         continue;
2823                     }
2824                     if ($type->modclass == MOD_CLASS_RESOURCE) {
2825                         $resources[html_entity_decode($type->type)] = $type->typestr;
2826                     } else {
2827                         $activities[html_entity_decode($type->type)] = $type->typestr;
2828                     }
2829                 }
2830             } else {
2831                 $archetype = plugin_supports('mod', $modname, FEATURE_MOD_ARCHETYPE, MOD_ARCHETYPE_OTHER);
2832                 if ($archetype == MOD_ARCHETYPE_RESOURCE) {
2833                     $resources[$modname] = $modnamestr;
2834                 } else {
2835                     // all other archetypes are considered activity
2836                     $activities[$modname] = $modnamestr;
2837                 }
2838             }
2839         }
2840         $this->cache->{'course'.$course->id.'resources'} = $resources;
2841         $this->cache->{'course'.$course->id.'activities'} = $activities;
2842     }
2844     /**
2845      * This function loads the course settings that are available for the user
2846      *
2847      * @param bool $forceopen If set to true the course node will be forced open
2848      * @return navigation_node|false
2849      */
2850     protected function load_course_settings($forceopen = false) {
2851         global $CFG, $USER, $SESSION, $OUTPUT;
2853         $course = $this->page->course;
2854         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
2856         // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
2858         $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin');
2859         if ($forceopen) {
2860             $coursenode->force_open();
2861         }
2863         if (has_capability('moodle/course:update', $coursecontext)) {
2864             // Add the turn on/off settings
2865             $url = new moodle_url('/course/view.php', array('id'=>$course->id, 'sesskey'=>sesskey()));
2866             if ($this->page->user_is_editing()) {
2867                 $url->param('edit', 'off');
2868                 $editstring = get_string('turneditingoff');
2869             } else {
2870                 $url->param('edit', 'on');
2871                 $editstring = get_string('turneditingon');
2872             }
2873             $coursenode->add($editstring, $url, self::TYPE_SETTING, null, null, new pix_icon('i/edit', ''));
2875             if ($this->page->user_is_editing()) {
2876                 // Removed as per MDL-22732
2877                 // $this->add_course_editing_links($course);
2878             }
2880             // Add the course settings link
2881             $url = new moodle_url('/course/edit.php', array('id'=>$course->id));
2882             $coursenode->add(get_string('editsettings'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
2884             // Add the course completion settings link
2885             if ($CFG->enablecompletion && $course->enablecompletion) {
2886                 $url = new moodle_url('/course/completion.php', array('id'=>$course->id));
2887                 $coursenode->add(get_string('completion', 'completion'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
2888             }
2889         }
2891         // add enrol nodes
2892         enrol_add_course_navigation($coursenode, $course);
2894         // Manage filters
2895         if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
2896             $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
2897             $coursenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
2898         }
2900         // Add view grade report is permitted
2901         $reportavailable = false;
2902         if (has_capability('moodle/grade:viewall', $coursecontext)) {
2903             $reportavailable = true;
2904         } else if (!empty($course->showgrades)) {
2905             $reports = get_plugin_list('gradereport');
2906             if (is_array($reports) && count($reports)>0) {     // Get all installed reports
2907                 arsort($reports); // user is last, we want to test it first
2908                 foreach ($reports as $plugin => $plugindir) {
2909                     if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {
2910                         //stop when the first visible plugin is found
2911                         $reportavailable = true;
2912                         break;
2913                     }
2914                 }
2915             }
2916         }
2917         if ($reportavailable) {
2918             $url = new moodle_url('/grade/report/index.php', array('id'=>$course->id));
2919             $gradenode = $coursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, 'grades', new pix_icon('i/grades', ''));
2920         }
2922         //  Add outcome if permitted
2923         if (!empty($CFG->enableoutcomes) && has_capability('moodle/course:update', $coursecontext)) {
2924             $url = new moodle_url('/grade/edit/outcome/course.php', array('id'=>$course->id));
2925             $coursenode->add(get_string('outcomes', 'grades'), $url, self::TYPE_SETTING, null, 'outcomes', new pix_icon('i/outcomes', ''));
2926         }
2928         // Backup this course
2929         if (has_capability('moodle/backup:backupcourse', $coursecontext)) {
2930             $url = new moodle_url('/backup/backup.php', array('id'=>$course->id));
2931             $coursenode->add(get_string('backup'), $url, self::TYPE_SETTING, null, 'backup', new pix_icon('i/backup', ''));
2932         }
2934         // Restore to this course
2935         if (has_capability('moodle/restore:restorecourse', $coursecontext)) {
2936             $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$coursecontext->id));
2937             $coursenode->add(get_string('restore'), $url, self::TYPE_SETTING, null, 'restore', new pix_icon('i/restore', ''));
2938         }
2940         // Import data from other courses
2941         if (has_capability('moodle/restore:restoretargetimport', $coursecontext)) {
2942             $url = new moodle_url('/backup/import.php', array('id'=>$course->id));
2943             $coursenode->add(get_string('import'), $url, self::TYPE_SETTING, null, 'import', new pix_icon('i/restore', ''));
2944         }
2946         // Publish course on a hub
2947         if (has_capability('moodle/course:publish', $coursecontext)) {
2948             $url = new moodle_url('/course/publish/index.php', array('id'=>$course->id));
2949             $coursenode->add(get_string('publish'), $url, self::TYPE_SETTING, null, 'publish', new pix_icon('i/publish', ''));
2950         }
2952         // Reset this course
2953         if (has_capability('moodle/course:reset', $coursecontext)) {
2954             $url = new moodle_url('/course/reset.php', array('id'=>$course->id));
2955             $coursenode->add(get_string('reset'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/return', ''));
2956         }
2958         // Questions
2959         require_once($CFG->dirroot.'/question/editlib.php');
2960         question_extend_settings_navigation($coursenode, $coursecontext)->trim_if_empty();
2962         // Repository Instances
2963         require_once($CFG->dirroot.'/repository/lib.php');
2964         $editabletypes = repository::get_editable_types($coursecontext);
2965         if (has_capability('moodle/course:update', $coursecontext) && !empty($editabletypes)) {
2966             $url = new moodle_url('/repository/manage_instances.php', array('contextid'=>$coursecontext->id));
2967             $coursenode->add(get_string('repositories'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/repository', ''));
2968         }
2970         // Manage files
2971         if ($course->legacyfiles == 2 and has_capability('moodle/course:managefiles', $coursecontext)) {
2972             // hidden in new courses and courses where legacy files were turned off
2973             $url = new moodle_url('/files/index.php', array('contextid'=>$coursecontext->id));
2974             $coursenode->add(get_string('courselegacyfiles'), $url, self::TYPE_SETTING, null, 'coursefiles', new pix_icon('i/files', ''));
2975         }
2977         // Switch roles
2978         $roles = array();
2979         $assumedrole = $this->in_alternative_role();
2980         if ($assumedrole!==false) {
2981             $roles[0] = get_string('switchrolereturn');
2982         }
2983         if (has_capability('moodle/role:switchroles', $coursecontext)) {
2984             $availableroles = get_switchable_roles($coursecontext);
2985             if (is_array($availableroles)) {
2986                 foreach ($availableroles as $key=>$role) {
2987                     if ($assumedrole===(int)$key) {
2988                         continue;
2989                     }
2990                     $roles[$key] = $role;
2991                 }
2992             }
2993         }
2994         if (is_array($roles) && count($roles)>0) {
2995             $switchroles = $this->add(get_string('switchroleto'));
2996             if ((count($roles)==1 && array_key_exists(0, $roles))|| $assumedrole!==false) {
2997                 $switchroles->force_open();
2998             }
2999             $returnurl = $this->page->url;
3000             $returnurl->param('sesskey', sesskey());
3001             $SESSION->returnurl = serialize($returnurl);
3002             foreach ($roles as $key=>$name) {
3003                 $url = new moodle_url('/course/switchrole.php', array('id'=>$course->id,'sesskey'=>sesskey(), 'switchrole'=>$key, 'returnurl'=>'1'));
3004                 $switchroles->add($name, $url, self::TYPE_SETTING, null, $key, new pix_icon('i/roles', ''));
3005             }
3006         }
3007         // Return we are done
3008         return $coursenode;
3009     }
3011     /**
3012      * Adds branches and links to the settings navigation to add course activities
3013      * and resources.
3014      *
3015      * @param stdClass $course
3016      */
3017     protected function add_course_editing_links($course) {
3018         global $CFG;
3020         require_once($CFG->dirroot.'/course/lib.php');
3022         // Add `add` resources|activities branches
3023         $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
3024         if (file_exists($structurefile)) {
3025             require_once($structurefile);
3026             $requestkey = call_user_func('callback_'.$course->format.'_request_key');
3027             $formatidentifier = optional_param($requestkey, 0, PARAM_INT);
3028         } else {
3029             $requestkey = get_string('section');
3030             $formatidentifier = optional_param($requestkey, 0, PARAM_INT);
3031         }
3033         $sections = get_all_sections($course->id);
3035         $addresource = $this->add(get_string('addresource'));
3036         $addactivity = $this->add(get_string('addactivity'));
3037         if ($formatidentifier!==0) {
3038             $addresource->force_open();
3039             $addactivity->force_open();
3040         }
3042         if (!$this->cache->cached('course'.$course->id.'resources')) {
3043             $this->get_course_modules($course);
3044         }
3045         $resources = $this->cache->{'course'.$course->id.'resources'};
3046         $activities = $this->cache->{'course'.$course->id.'activities'};
3048         $textlib = textlib_get_instance();
3050         foreach ($sections as $section) {
3051             if ($formatidentifier !== 0 && $section->section != $formatidentifier) {
3052                 continue;
3053             }
3054             $sectionurl = new moodle_url('/course/view.php', array('id'=>$course->id, $requestkey=>$section->section));
3055             if ($section->section == 0) {
3056                 $sectionresources = $addresource->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
3057                 $sectionactivities = $addactivity->add(get_string('course'), $sectionurl, self::TYPE_SETTING);
3058             } else {
3059                 $sectionname = get_section_name($course, $section);
3060                 $sectionresources = $addresource->add($sectionname, $sectionurl, self::TYPE_SETTING);
3061                 $sectionactivities = $addactivity->add($sectionname, $sectionurl, self::TYPE_SETTING);
3062             }
3063             foreach ($resources as $value=>$resource) {
3064                 $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
3065                 $pos = strpos($value, '&type=');
3066                 if ($pos!==false) {
3067                     $url->param('add', $textlib->substr($value, 0,$pos));
3068                     $url->param('type', $textlib->substr($value, $pos+6));
3069                 } else {
3070                     $url->param('add', $value);
3071                 }
3072                 $sectionresources->add($resource, $url, self::TYPE_SETTING);
3073             }
3074             $subbranch = false;
3075             foreach ($activities as $activityname=>$activity) {
3076                 if ($activity==='--') {
3077                     $subbranch = false;
3078                     continue;
3079                 }
3080                 if (strpos($activity, '--')===0) {
3081                     $subbranch = $sectionactivities->add(trim($activity, '-'));
3082                     continue;
3083                 }
3084                 $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'sesskey'=>sesskey(), 'section'=>$section->section));
3085                 $pos = strpos($activityname, '&type=');
3086                 if ($pos!==false) {
3087                     $url->param('add', $textlib->substr($activityname, 0,$pos));
3088                     $url->param('type', $textlib->substr($activityname, $pos+6));
3089                 } else {
3090                     $url->param('add', $activityname);
3091                 }
3092                 if ($subbranch !== false) {
3093                     $subbranch->add($activity, $url, self::TYPE_SETTING);
3094                 } else {
3095                     $sectionactivities->add($activity, $url, self::TYPE_SETTING);
3096                 }
3097             }
3098         }
3099     }
3101     /**
3102      * This function calls the module function to inject module settings into the
3103      * settings navigation tree.
3104      *
3105      * This only gets called if there is a corrosponding function in the modules
3106      * lib file.
3107      *
3108      * For examples mod/forum/lib.php ::: forum_extend_settings_navigation()
3109      *
3110      * @return navigation_node|false
3111      */
3112     protected function load_module_settings() {
3113         global $CFG;
3115         if (!$this->page->cm && $this->context->contextlevel == CONTEXT_MODULE && $this->context->instanceid) {
3116             $cm = get_coursemodule_from_id(false, $this->context->instanceid, 0, false, MUST_EXIST);
3117             $this->page->set_cm($cm, $this->page->course);
3118         }
3120         $file = $CFG->dirroot.'/mod/'.$this->page->activityname.'/lib.php';
3121         if (file_exists($file)) {
3122             require_once($file);
3123         }
3125         $modulenode = $this->add(get_string('pluginadministration', $this->page->activityname));
3126         $modulenode->force_open();
3128         // Settings for the module
3129         if (has_capability('moodle/course:manageactivities', $this->page->cm->context)) {
3130             $url = new moodle_url('/course/modedit.php', array('update' => $this->page->cm->id, 'return' => true, 'sesskey' => sesskey()));
3131             $modulenode->add(get_string('editsettings'), $url, navigation_node::TYPE_SETTING);
3132         }
3133         // Assign local roles
3134         if (count(get_assignable_roles($this->page->cm->context))>0) {
3135             $url = new moodle_url('/'.$CFG->admin.'/roles/assign.php', array('contextid'=>$this->page->cm->context->id));
3136             $modulenode->add(get_string('localroles', 'role'), $url, self::TYPE_SETTING);
3137         }
3138         // Override roles
3139         if (has_capability('moodle/role:review', $this->page->cm->context) or count(get_overridable_roles($this->page->cm->context))>0) {
3140             $url = new moodle_url('/'.$CFG->admin.'/roles/permissions.php', array('contextid'=>$this->page->cm->context->id));
3141             $modulenode->add(get_string('permissions', 'role'), $url, self::TYPE_SETTING);
3142         }
3143         // Check role permissions
3144         if (has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride','moodle/role:override', 'moodle/role:assign'), $this->page->cm->context)) {
3145             $url = new moodle_url('/'.$CFG->admin.'/roles/check.php', array('contextid'=>$this->page->cm->context->id));
3146             $modulenode->add(get_string('checkpermissions', 'role'), $url, self::TYPE_SETTING);
3147         }
3148         // Manage filters
3149         if (has_capability('moodle/filter:manage', $this->page->cm->context) && count(filter_get_available_in_context($this->page->cm->context))>0) {
3150             $url = new moodle_url('/filter/manage.php', array('contextid'=>$this->page->cm->context->id));
3151             $modulenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING);
3152         }
3154         if (has_capability('coursereport/log:view', get_context_instance(CONTEXT_COURSE, $this->page->cm->course))) {
3155             $url = new moodle_url('/course/report/log/index.php', array('chooselog'=>'1','id'=>$this->page->cm->course,'modid'=>$this->page->cm->id));
3156             $modulenode->add(get_string('logs'), $url, self::TYPE_SETTING);
3157         }
3159         // Add a backup link
3160         $featuresfunc = $this->page->activityname.'_supports';
3161         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2) && has_capability('moodle/backup:backupactivity', $this->page->cm->context)) {
3162             $url = new moodle_url('/backup/backup.php', array('id'=>$this->page->cm->course, 'cm'=>$this->page->cm->id));
3163             $modulenode->add(get_string('backup'), $url, self::TYPE_SETTING);
3164         }
3166         // Restore this activity
3167         $featuresfunc = $this->page->activityname.'_supports';
3168         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_BACKUP_MOODLE2) && has_capability('moodle/restore:restoreactivity', $this->page->cm->context)) {
3169             $url = new moodle_url('/backup/restorefile.php', array('contextid'=>$this->page->cm->context->id));
3170             $modulenode->add(get_string('restore'), $url, self::TYPE_SETTING);
3171         }
3173         $function = $this->page->activityname.'_extend_settings_navigation';
3174         if (!function_exists($function)) {
3175             return $modulenode;
3176         }
3178         $function($this, $modulenode);
3180         // Remove the module node if there are no children
3181         if (empty($modulenode->children)) {
3182             $modulenode->remove();
3183         }
3185         return $modulenode;
3186     }
3188     /**
3189      * Loads the user settings block of the settings nav
3190      *
3191      * This function is simply works out the userid and whether we need to load
3192      * just the current users profile settings, or the current user and the user the
3193      * current user is viewing.
3194      *
3195      * This function has some very ugly code to work out the user, if anyone has
3196      * any bright ideas please feel free to intervene.
3197      *
3198      * @param int $courseid The course id of the current course
3199      * @return navigation_node|false
3200      */
3201     protected function load_user_settings($courseid=SITEID) {
3202         global $USER, $FULLME, $CFG;
3204         if (isguestuser() || !isloggedin()) {
3205             return false;
3206         }
3208         $navusers = $this->page->navigation->get_extending_users();
3210         if (count($this->userstoextendfor) > 0 || count($navusers) > 0) {
3211             $usernode = null;
3212             foreach ($this->userstoextendfor as $userid) {
3213                 if ($userid == $USER->id) {
3214                     continue;
3215                 }
3216                 $node = $this->generate_user_settings($courseid, $userid, 'userviewingsettings');
3217                 if (is_null($usernode)) {
3218                     $usernode = $node;
3219                 }
3220             }
3221             foreach ($navusers as $user) {
3222                 if ($user->id == $USER->id) {
3223                     continue;
3224                 }
3225                 $node = $this->generate_user_settings($courseid, $user->id, 'userviewingsettings');
3226                 if (is_null($usernode)) {
3227                     $usernode = $node;
3228                 }
3229             }
3230             $this->generate_user_settings($courseid, $USER->id);
3231         } else {
3232             $usernode = $this->generate_user_settings($courseid, $USER->id);
3233         }
3234         return $usernode;
3235     }
3237     /**
3238      * Extends the settings navigation for the given user.
3239      *
3240      * Note: This method gets called automatically if you call
3241      * $PAGE->navigation->extend_for_user($userid)
3242      *
3243      * @param int $userid
3244      */
3245     public function extend_for_user($userid) {
3246         global $CFG;
3248         if (!in_array($userid, $this->userstoextendfor)) {
3249             $this->userstoextendfor[] = $userid;
3250             if ($this->initialised) {
3251                 $this->generate_user_settings($this->page->course->id, $userid, 'userviewingsettings');
3252                 $children = array();
3253                 foreach ($this->children as $child) {
3254                     $children[] = $child;
3255                 }
3256                 array_unshift($children, array_pop($children));
3257                 $this->children = new navigation_node_collection();
3258                 foreach ($children as $child) {
3259                     $this->children->add($child);
3260                 }
3261             }
3262         }
3263     }
3265     /**
3266      * This function gets called by {@link load_user_settings()} and actually works out
3267      * what can be shown/done
3268      *
3269      * @param int $courseid The current course' id
3270      * @param int $userid The user id to load for
3271      * @param string $gstitle The string to pass to get_string for the branch title
3272      * @return navigation_node|false
3273      */
3274     protected function generate_user_settings($courseid, $userid, $gstitle='usercurrentsettings') {
3275         global $DB, $CFG, $USER, $SITE;
3277         if ($courseid != SITEID) {
3278             if (!empty($this->page->course->id) && $this->page->course->id == $courseid) {
3279                 $course = $this->page->course;
3280             } else {
3281                 $course = $DB->get_record("course", array("id"=>$courseid), '*', MUST_EXIST);
3282             }
3283         } else {
3284             $course = $SITE;
3285         }
3287         $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);   // Course context
3288         $systemcontext   = get_system_context();
3289         $currentuser = ($USER->id == $userid);
3291         if ($currentuser) {
3292             $user = $USER;
3293             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
3294         } else {
3295             if (!$user = $DB->get_record('user', array('id'=>$userid))) {
3296                 return false;
3297             }
3298             // Check that the user can view the profile
3299             $usercontext = get_context_instance(CONTEXT_USER, $user->id);       // User context
3300             if ($course->id==SITEID) {
3301                 if ($CFG->forceloginforprofiles && !has_coursecontact_role($user->id) && !has_capability('moodle/user:viewdetails', $usercontext)) {  // Reduce possibility of "browsing" userbase at site level
3302                     // Teachers can browse and be browsed at site level. If not forceloginforprofiles, allow access (bug #4366)
3303                     return false;
3304                 }
3305             } else {
3306                 if ((!has_capability('moodle/user:viewdetails', $coursecontext) && !has_capability('moodle/user:viewdetails', $usercontext)) || !can_access_course($coursecontext, $user->id)) {
3307                     return false;
3308                 }
3309                 if (groups_get_course_groupmode($course) == SEPARATEGROUPS && !has_capability('moodle/site:accessallgroups', $coursecontext)) {
3310                     // If groups are in use, make sure we can see that group
3311                     return false;
3312                 }
3313             }
3314         }
3316         $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $this->page->context));
3318         $key = $gstitle;
3319         if ($gstitle != 'usercurrentsettings') {
3320             $key .= $userid;
3321         }
3323         // Add a user setting branch
3324         $usersetting = $this->add(get_string($gstitle, 'moodle', $fullname), null, self::TYPE_CONTAINER, null, $key);