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