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