MDL-35415 completely remove add activity in settings (MDL-22732)
[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) {
111938ab
EL
1134 // Let's decide the context where viewhidden cap checks will happen.
1135 if ($category->parent == '0') {
1136 $contexttocheck = context_system::instance();
1137 } else {
1138 $contexttocheck = context_coursecat::instance($category->parent);
1139 }
1140 if (!has_capability('moodle/category:viewhiddencategories', $contexttocheck)) {
b0712163
SH
1141 $addedcategories[$category->id]->display = false;
1142 } else {
1143 $addedcategories[$category->id]->hidden = true;
1144 }
1145 }
1146 }
1147 }
1148
1149 // Add all of the users courses to the navigation.
8e8de15f 1150 // First up we need to add to the mycourses section.
e26507b3
SH
1151 foreach ($mycourses as $course) {
1152 $course->coursenode = $this->add_course($course, false, true);
3406acde 1153 }
4766a50c 1154
ee03fe79 1155 if (!empty($CFG->navshowallcourses)) {
8e8de15f
SH
1156 // Load all courses
1157 $this->load_all_courses();
1158 }
1159
1160 // Next if nasvshowallcourses is enabled then we need to add courses
1161 // to the courses branch as well.
1162 if (!empty($CFG->navshowallcourses)) {
1163 foreach ($mycourses as $course) {
1164 if (!empty($course->category) && !$this->can_add_more_courses_to_category($course->category)) {
1165 continue;
1166 }
1167 $genericcoursenode = $this->add_course($course, true);
1168 if ($genericcoursenode->isactive) {
1169 // We don't want this node to be active because we want the
1170 // node in the mycourses branch to be active.
1171 $genericcoursenode->make_inactive();
1172 $genericcoursenode->collapse = true;
1173 if ($genericcoursenode->parent && $genericcoursenode->parent->type == self::TYPE_CATEGORY) {
1174 $parent = $genericcoursenode->parent;
1175 while ($parent && $parent->type == self::TYPE_CATEGORY) {
1176 $parent->collapse = true;
1177 $parent = $parent->parent;
1178 }
1179 }
1180 }
1181 }
1182 }
ee03fe79 1183 } else if (!empty($CFG->navshowallcourses) || !$this->show_categories()) {
ba2789c1
SH
1184 // Load all courses
1185 $this->load_all_courses();
3406acde
SH
1186 }
1187
cede87e0
SH
1188 $canviewcourseprofile = true;
1189
6a16e136
SH
1190 // Next load context specific content into the navigation
1191 switch ($this->page->context->contextlevel) {
1192 case CONTEXT_SYSTEM :
1193 // This has already been loaded we just need to map the variable
80c69522
SH
1194 if ($showcategories) {
1195 $this->load_all_categories(self::LOAD_ROOT_CATEGORIES, true);
8e8de15f 1196 }
6a16e136
SH
1197 break;
1198 case CONTEXT_COURSECAT :
1199 // This has already been loaded we just need to map the variable
80c69522
SH
1200 if ($showcategories) {
1201 $this->load_all_categories($this->page->context->instanceid, true);
6a16e136
SH
1202 }
1203 break;
1204 case CONTEXT_BLOCK :
1205 case CONTEXT_COURSE :
1206 if ($issite) {
1207 // If it is the front page course, or a block on it then
d4bb6462 1208 // all we need to do is load the root categories if required
80c69522
SH
1209 if ($showcategories) {
1210 $this->load_all_categories(self::LOAD_ROOT_CATEGORIES, true);
d4bb6462 1211 }
56c062a4 1212 break;
6a16e136
SH
1213 }
1214 // Load the course associated with the page into the navigation
1215 $course = $this->page->course;
8e8de15f 1216 if ($this->show_categories() && !$ismycourse) {
80c69522
SH
1217 // The user isn't enrolled in the course and we need to show categories in which case we need
1218 // to load the category relating to the course and depending up $showcategories all of the root categories as well.
6a16e136
SH
1219 $this->load_all_categories($course->category, $showcategories);
1220 }
1221 $coursenode = $this->load_course($course);
b9bcad24 1222
6a16e136
SH
1223 // If the course wasn't added then don't try going any further.
1224 if (!$coursenode) {
1225 $canviewcourseprofile = false;
1226 break;
1227 }
e26507b3 1228
6a16e136
SH
1229 // If the user is not enrolled then we only want to show the
1230 // course node and not populate it.
1231
1232 // Not enrolled, can't view, and hasn't switched roles
1233 if (!can_access_course($course)) {
1234 // TODO: very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1235 // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1236 $isparent = false;
1237 if ($this->useridtouseforparentchecks) {
1238 if ($this->useridtouseforparentchecks != $USER->id) {
b0c6dc1c 1239 $usercontext = context_user::instance($this->useridtouseforparentchecks, MUST_EXIST);
6a16e136
SH
1240 if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))
1241 and has_capability('moodle/user:viewdetails', $usercontext)) {
1242 $isparent = true;
56c062a4
SH
1243 }
1244 }
56c062a4 1245 }
6a16e136
SH
1246
1247 if (!$isparent) {
56c062a4 1248 $coursenode->make_active();
6a16e136
SH
1249 $canviewcourseprofile = false;
1250 break;
1251 }
1252 }
1253 // Add the essentials such as reports etc...
1254 $this->add_course_essentials($coursenode, $course);
1255 if ($this->format_display_course_content($course->format)) {
1256 // Load the course sections
1257 $sections = $this->load_course_sections($course, $coursenode);
1258 }
1259 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1260 $coursenode->make_active();
1261 }
1262 break;
1263 case CONTEXT_MODULE :
1264 if ($issite) {
1265 // If this is the site course then most information will have
1266 // already been loaded.
1267 // However we need to check if there is more content that can
1268 // yet be loaded for the specific module instance.
1269 $activitynode = $this->rootnodes['site']->get($this->page->cm->id, navigation_node::TYPE_ACTIVITY);
1270 if ($activitynode) {
1271 $this->load_activity($this->page->cm, $this->page->course, $activitynode);
56c062a4 1272 }
2027c10e 1273 break;
6a16e136 1274 }
2027c10e 1275
6a16e136
SH
1276 $course = $this->page->course;
1277 $cm = $this->page->cm;
cede87e0 1278
8e8de15f 1279 if ($this->show_categories() && !$ismycourse) {
6a16e136
SH
1280 $this->load_all_categories($course->category, $showcategories);
1281 }
56c062a4 1282
6a16e136
SH
1283 // Load the course associated with the page into the navigation
1284 $coursenode = $this->load_course($course);
56c062a4 1285
6a16e136
SH
1286 // If the course wasn't added then don't try going any further.
1287 if (!$coursenode) {
1288 $canviewcourseprofile = false;
1289 break;
1290 }
1291
1292 // If the user is not enrolled then we only want to show the
1293 // course node and not populate it.
1294 if (!can_access_course($course)) {
1295 $coursenode->make_active();
1296 $canviewcourseprofile = false;
1297 break;
1298 }
56c062a4 1299
6a16e136 1300 $this->add_course_essentials($coursenode, $course);
56c062a4 1301
6a16e136
SH
1302 // Get section number from $cm (if provided) - we need this
1303 // before loading sections in order to tell it to load this section
1304 // even if it would not normally display (=> it contains only
1305 // a label, which we are now editing)
1306 $sectionnum = isset($cm->sectionnum) ? $cm->sectionnum : 0;
1307 if ($sectionnum) {
1308 // This value has to be stored in a member variable because
1309 // otherwise we would have to pass it through a public API
1310 // to course formats and they would need to change their
1311 // functions to pass it along again...
1312 $this->includesectionnum = $sectionnum;
1313 } else {
1314 $this->includesectionnum = false;
1315 }
d67e4821 1316
6a16e136
SH
1317 // Load the course sections into the page
1318 $sections = $this->load_course_sections($course, $coursenode);
98556b23 1319 if ($course->id != $SITE->id) {
6a16e136
SH
1320 // Find the section for the $CM associated with the page and collect
1321 // its section number.
d67e4821 1322 if ($sectionnum) {
6a16e136 1323 $cm->sectionnumber = $sectionnum;
d67e4821 1324 } else {
6a16e136
SH
1325 foreach ($sections as $section) {
1326 if ($section->id == $cm->section) {
1327 $cm->sectionnumber = $section->section;
1328 break;
0d8b6a69 1329 }
3406acde 1330 }
6a16e136 1331 }
3406acde 1332
6a16e136
SH
1333 // Load all of the section activities for the section the cm belongs to.
1334 if (isset($cm->sectionnumber) and !empty($sections[$cm->sectionnumber])) {
1335 list($sectionarray, $activityarray) = $this->generate_sections_and_activities($course);
1336 $activities = $this->load_section_activities($sections[$cm->sectionnumber]->sectionnode, $cm->sectionnumber, $activityarray);
2a62743c
PS
1337 } else {
1338 $activities = array();
6a16e136
SH
1339 if ($activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course))) {
1340 // "stealth" activity from unavailable section
1341 $activities[$cm->id] = $activity;
56c062a4 1342 }
2a62743c 1343 }
6a16e136
SH
1344 } else {
1345 $activities = array();
1346 $activities[$cm->id] = $coursenode->get($cm->id, navigation_node::TYPE_ACTIVITY);
1347 }
1348 if (!empty($activities[$cm->id])) {
1349 // Finally load the cm specific navigaton information
1350 $this->load_activity($cm, $course, $activities[$cm->id]);
1351 // Check if we have an active ndoe
1352 if (!$activities[$cm->id]->contains_active_node() && !$activities[$cm->id]->search_for_active_node()) {
1353 // And make the activity node active.
1354 $activities[$cm->id]->make_active();
e26507b3 1355 }
6a16e136
SH
1356 } else {
1357 //TODO: something is wrong, what to do? (Skodak)
1358 }
1359 break;
1360 case CONTEXT_USER :
1361 if ($issite) {
1362 // The users profile information etc is already loaded
1363 // for the front page.
96e78552 1364 break;
6a16e136
SH
1365 }
1366 $course = $this->page->course;
8e8de15f 1367 if ($this->show_categories() && !$ismycourse) {
6a16e136
SH
1368 $this->load_all_categories($course->category, $showcategories);
1369 }
1370 // Load the course associated with the user into the navigation
1371 $coursenode = $this->load_course($course);
2027c10e 1372
6a16e136
SH
1373 // If the course wasn't added then don't try going any further.
1374 if (!$coursenode) {
1375 $canviewcourseprofile = false;
1376 break;
1377 }
2027c10e 1378
6a16e136
SH
1379 // If the user is not enrolled then we only want to show the
1380 // course node and not populate it.
1381 if (!can_access_course($course)) {
1382 $coursenode->make_active();
1383 $canviewcourseprofile = false;
56c062a4 1384 break;
e52a5d3a 1385 }
6a16e136
SH
1386 $this->add_course_essentials($coursenode, $course);
1387 $sections = $this->load_course_sections($course, $coursenode);
1388 break;
7d2a0492 1389 }
7a7e209d 1390
80c69522 1391 // Look for all categories which have been loaded
ba2789c1
SH
1392 if ($showcategories) {
1393 $categories = $this->find_all_of_type(self::TYPE_CATEGORY);
8e8de15f
SH
1394 if (count($categories) !== 0) {
1395 $categoryids = array();
1396 foreach ($categories as $category) {
1397 $categoryids[] = $category->key;
1398 }
1399 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED);
1400 $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20;
1401 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1402 FROM {course_categories} cc
1403 JOIN {course} c ON c.category = cc.id
1404 WHERE cc.id {$categoriessql}
1405 GROUP BY cc.id
1406 HAVING COUNT(c.id) > :limit";
1407 $excessivecategories = $DB->get_records_sql($sql, $params);
1408 foreach ($categories as &$category) {
1409 if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1410 $url = new moodle_url('/course/category.php', array('id'=>$category->key));
1411 $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1412 }
ba2789c1
SH
1413 }
1414 }
8e8de15f 1415 } else if ((!empty($CFG->navshowallcourses) || empty($mycourses)) && !$this->can_add_more_courses_to_category($this->rootnodes['courses'])) {
ba2789c1
SH
1416 $this->rootnodes['courses']->add(get_string('viewallcoursescategories'), new moodle_url('/course/index.php'), self::TYPE_SETTING);
1417 }
1418
3406acde
SH
1419 // Load for the current user
1420 $this->load_for_user();
98556b23 1421 if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) {
87c215de
SH
1422 $this->load_for_user(null, true);
1423 }
7a7e209d
SH
1424 // Load each extending user into the navigation.
1425 foreach ($this->extendforuser as $user) {
44303ca6 1426 if ($user->id != $USER->id) {
7a7e209d
SH
1427 $this->load_for_user($user);
1428 }
1429 }
7a7e209d 1430
a683da3c 1431 // Give the local plugins a chance to include some navigation if they want.
5c1f0d1f
SH
1432 foreach (get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $file) {
1433 $function = "local_{$plugin}_extends_navigation";
1434 $oldfunction = "{$plugin}_extends_navigation";
a683da3c 1435 if (function_exists($function)) {
5c1f0d1f 1436 // This is the preferred function name as there is less chance of conflicts
a683da3c 1437 $function($this);
5c1f0d1f
SH
1438 } else if (function_exists($oldfunction)) {
1439 // We continue to support the old function name to ensure backwards compatability
22ba3f08 1440 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 1441 $oldfunction($this);
a683da3c
SH
1442 }
1443 }
1444
3406acde
SH
1445 // Remove any empty root nodes
1446 foreach ($this->rootnodes as $node) {
4766a50c
SH
1447 // Dont remove the home node
1448 if ($node->key !== 'home' && !$node->has_children()) {
3406acde
SH
1449 $node->remove();
1450 }
1451 }
1452
7c4efe3b
SH
1453 if (!$this->contains_active_node()) {
1454 $this->search_for_active_node();
1455 }
1456
3406acde 1457 // If the user is not logged in modify the navigation structure as detailed
728ebac7 1458 // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
3406acde
SH
1459 if (!isloggedin()) {
1460 $activities = clone($this->rootnodes['site']->children);
1461 $this->rootnodes['site']->remove();
1462 $children = clone($this->children);
1463 $this->children = new navigation_node_collection();
1464 foreach ($activities as $child) {
1465 $this->children->add($child);
1466 }
1467 foreach ($children as $child) {
1468 $this->children->add($child);
1469 }
3406acde 1470 }
7d2a0492 1471 return true;
1472 }
9bf5af21
SH
1473
1474 /**
31fde54f 1475 * Returns true if courses should be shown within categories on the navigation.
9bf5af21
SH
1476 *
1477 * @return bool
1478 */
1479 protected function show_categories() {
1480 global $CFG, $DB;
1481 if ($this->showcategories === null) {
6a16e136
SH
1482 $show = $this->page->context->contextlevel == CONTEXT_COURSECAT;
1483 $show = $show || (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1);
1484 $this->showcategories = $show;
9bf5af21
SH
1485 }
1486 return $this->showcategories;
1487 }
1488
7d2a0492 1489 /**
3406acde
SH
1490 * Checks the course format to see whether it wants the navigation to load
1491 * additional information for the course.
1492 *
1493 * This function utilises a callback that can exist within the course format lib.php file
1494 * The callback should be a function called:
1495 * callback_{formatname}_display_content()
1496 * It doesn't get any arguments and should return true if additional content is
1497 * desired. If the callback doesn't exist we assume additional content is wanted.
1498 *
3406acde
SH
1499 * @param string $format The course format
1500 * @return bool
1501 */
1502 protected function format_display_course_content($format) {
1503 global $CFG;
1504 $formatlib = $CFG->dirroot.'/course/format/'.$format.'/lib.php';
1505 if (file_exists($formatlib)) {
1506 require_once($formatlib);
1507 $displayfunc = 'callback_'.$format.'_display_content';
1508 if (function_exists($displayfunc) && !$displayfunc()) {
1509 return $displayfunc();
1510 }
1511 }
1512 return true;
1513 }
1514
1515 /**
31fde54f 1516 * Loads the courses in Moodle into the navigation.
3406acde 1517 *
8e8de15f
SH
1518 * @global moodle_database $DB
1519 * @param string|array $categoryids An array containing categories to load courses
1520 * for, OR null to load courses for all categories.
1521 * @return array An array of navigation_nodes one for each course
3406acde 1522 */
8e8de15f 1523 protected function load_all_courses($categoryids = null) {
98556b23 1524 global $CFG, $DB, $SITE;
4766a50c 1525
8e8de15f 1526 // Work out the limit of courses.
4766a50c
SH
1527 $limit = 20;
1528 if (!empty($CFG->navcourselimit)) {
1529 $limit = $CFG->navcourselimit;
1530 }
4766a50c 1531
8e8de15f
SH
1532 $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES;
1533
1534 // If we are going to show all courses AND we are showing categories then
1535 // to save us repeated DB calls load all of the categories now
1536 if ($this->show_categories()) {
1537 $this->load_all_categories($toload);
1538 }
1539
1540 // Will be the return of our efforts
3406acde 1541 $coursenodes = array();
8e8de15f 1542
f7ee4baa
SH
1543 // Check if we need to show categories.
1544 if ($this->show_categories()) {
1545 // Hmmm we need to show categories... this is going to be painful.
1546 // We now need to fetch up to $limit courses for each category to
1547 // be displayed.
1548 if ($categoryids !== null) {
1549 if (!is_array($categoryids)) {
1550 $categoryids = array($categoryids);
8e8de15f 1551 }
f7ee4baa
SH
1552 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc');
1553 $categorywhere = 'WHERE cc.id '.$categorywhere;
1554 } else if ($toload == self::LOAD_ROOT_CATEGORIES) {
1555 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1556 $categoryparams = array();
1557 } else {
1558 $categorywhere = '';
1559 $categoryparams = array();
1560 }
8e8de15f 1561
f7ee4baa
SH
1562 // First up we are going to get the categories that we are going to
1563 // need so that we can determine how best to load the courses from them.
1564 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1565 FROM {course_categories} cc
1566 LEFT JOIN {course} c ON c.category = cc.id
1567 {$categorywhere}
1568 GROUP BY cc.id";
1569 $categories = $DB->get_recordset_sql($sql, $categoryparams);
1570 $fullfetch = array();
1571 $partfetch = array();
1572 foreach ($categories as $category) {
1573 if (!$this->can_add_more_courses_to_category($category->id)) {
1574 continue;
1575 }
1576 if ($category->coursecount > $limit * 5) {
1577 $partfetch[] = $category->id;
1578 } else if ($category->coursecount > 0) {
1579 $fullfetch[] = $category->id;
1580 }
1581 }
1582 $categories->close();
1583
1584 if (count($fullfetch)) {
1585 // First up fetch all of the courses in categories where we know that we are going to
1586 // need the majority of courses.
1587 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
f7ee4baa
SH
1588 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory');
1589 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1590 FROM {course} c
1591 $ccjoin
fca2d3d7 1592 WHERE c.category {$categoryids}
f7ee4baa 1593 ORDER BY c.sortorder ASC";
fca2d3d7 1594 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
f7ee4baa 1595 foreach ($coursesrs as $course) {
fca2d3d7
PS
1596 if ($course->id == $SITE->id) {
1597 // This should not be necessary, frontpage is not in any category.
1598 continue;
1599 }
1600 if (array_key_exists($course->id, $this->addedcourses)) {
1601 // It is probably better to not include the already loaded courses
1602 // directly in SQL because inequalities may confuse query optimisers
1603 // and may interfere with query caching.
1604 continue;
1605 }
f7ee4baa 1606 if (!$this->can_add_more_courses_to_category($course->category)) {
8e8de15f
SH
1607 continue;
1608 }
f7ee4baa 1609 context_instance_preload($course);
b0c6dc1c 1610 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
f7ee4baa 1611 continue;
8e8de15f 1612 }
f7ee4baa 1613 $coursenodes[$course->id] = $this->add_course($course);
8e8de15f 1614 }
f7ee4baa
SH
1615 $coursesrs->close();
1616 }
8e8de15f 1617
f7ee4baa
SH
1618 if (count($partfetch)) {
1619 // Next we will work our way through the categories where we will likely only need a small
1620 // proportion of the courses.
1621 foreach ($partfetch as $categoryid) {
8e8de15f 1622 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
8e8de15f 1623 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
f7ee4baa
SH
1624 FROM {course} c
1625 $ccjoin
fca2d3d7 1626 WHERE c.category = :categoryid
f7ee4baa 1627 ORDER BY c.sortorder ASC";
fca2d3d7 1628 $courseparams = array('categoryid' => $categoryid);
f7ee4baa 1629 $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
8e8de15f 1630 foreach ($coursesrs as $course) {
fca2d3d7
PS
1631 if ($course->id == $SITE->id) {
1632 // This should not be necessary, frontpage is not in any category.
1633 continue;
1634 }
1635 if (array_key_exists($course->id, $this->addedcourses)) {
1636 // It is probably better to not include the already loaded courses
1637 // directly in SQL because inequalities may confuse query optimisers
1638 // and may interfere with query caching.
1639 // This also helps to respect expected $limit on repeated executions.
1640 continue;
1641 }
8e8de15f 1642 if (!$this->can_add_more_courses_to_category($course->category)) {
f7ee4baa 1643 break;
8e8de15f
SH
1644 }
1645 context_instance_preload($course);
b0c6dc1c 1646 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
8e8de15f
SH
1647 continue;
1648 }
1649 $coursenodes[$course->id] = $this->add_course($course);
1650 }
1651 $coursesrs->close();
1652 }
8e8de15f 1653 }
8e8de15f 1654 } else {
8e8de15f
SH
1655 // Prepare the SQL to load the courses and their contexts
1656 list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
f7ee4baa 1657 list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false);
8e8de15f 1658 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
f7ee4baa
SH
1659 FROM {course} c
1660 $ccjoin
1661 WHERE c.id {$courseids}
1662 ORDER BY c.sortorder ASC";
8e8de15f
SH
1663 $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1664 foreach ($coursesrs as $course) {
fca2d3d7
PS
1665 if ($course->id == $SITE->id) {
1666 // frotpage is not wanted here
1667 continue;
1668 }
8e8de15f 1669 context_instance_preload($course);
b0c6dc1c 1670 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
f7ee4baa
SH
1671 continue;
1672 }
8e8de15f 1673 $coursenodes[$course->id] = $this->add_course($course);
f7ee4baa
SH
1674 if (count($coursenodes) >= $limit) {
1675 break;
1676 }
8e8de15f
SH
1677 }
1678 $coursesrs->close();
3406acde 1679 }
f7ee4baa 1680
3406acde
SH
1681 return $coursenodes;
1682 }
1683
8e8de15f
SH
1684 /**
1685 * Returns true if more courses can be added to the provided category.
1686 *
98556b23
SH
1687 * @param int|navigation_node|stdClass $category
1688 * @return bool
8e8de15f
SH
1689 */
1690 protected function can_add_more_courses_to_category($category) {
1691 global $CFG;
1692 $limit = 20;
1693 if (!empty($CFG->navcourselimit)) {
1694 $limit = (int)$CFG->navcourselimit;
1695 }
1696 if (is_numeric($category)) {
1697 if (!array_key_exists($category, $this->addedcategories)) {
1698 return true;
1699 }
1700 $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE));
1701 } else if ($category instanceof navigation_node) {
ee03fe79 1702 if ($category->type != self::TYPE_CATEGORY) {
8e8de15f
SH
1703 return false;
1704 }
1705 $coursecount = count($category->children->type(self::TYPE_COURSE));
1706 } else if (is_object($category) && property_exists($category,'id')) {
1707 $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE));
1708 }
d4bb6462 1709 return ($coursecount <= $limit);
8e8de15f
SH
1710 }
1711
4766a50c
SH
1712 /**
1713 * Loads all categories (top level or if an id is specified for that category)
1714 *
e26507b3
SH
1715 * @param int $categoryid The category id to load or null/0 to load all base level categories
1716 * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1717 * as the requested category and any parent categories.
31fde54f 1718 * @return navigation_node|void returns a navigation node if a category has been loaded.
4766a50c 1719 */
8e8de15f 1720 protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) {
4766a50c 1721 global $DB;
e26507b3
SH
1722
1723 // Check if this category has already been loaded
8e8de15f
SH
1724 if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1725 return true;
e26507b3
SH
1726 }
1727
176b75b5
SH
1728 $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
1729 $sqlselect = "SELECT cc.*, $catcontextsql
1730 FROM {course_categories} cc
1731 JOIN {context} ctx ON cc.id = ctx.instanceid";
1732 $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT;
957983b7 1733 $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
176b75b5
SH
1734 $params = array();
1735
8e8de15f
SH
1736 $categoriestoload = array();
1737 if ($categoryid == self::LOAD_ALL_CATEGORIES) {
176b75b5
SH
1738 // We are going to load all categories regardless... prepare to fire
1739 // on the database server!
8e8de15f 1740 } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0
e26507b3 1741 // We are going to load all of the first level categories (categories without parents)
176b75b5 1742 $sqlwhere .= " AND cc.parent = 0";
e26507b3
SH
1743 } else if (array_key_exists($categoryid, $this->addedcategories)) {
1744 // The category itself has been loaded already so we just need to ensure its subcategories
1745 // have been loaded
1746 list($sql, $params) = $DB->get_in_or_equal(array_keys($this->addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1747 if ($showbasecategories) {
1748 // We need to include categories with parent = 0 as well
d4bb6462 1749 $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
e26507b3 1750 } else {
176b75b5 1751 // All we need is categories that match the parent
d4bb6462 1752 $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
e26507b3
SH
1753 }
1754 $params['categoryid'] = $categoryid;
4766a50c 1755 } else {
e26507b3
SH
1756 // This category hasn't been loaded yet so we need to fetch it, work out its category path
1757 // and load this category plus all its parents and subcategories
3992a46e 1758 $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
8e8de15f
SH
1759 $categoriestoload = explode('/', trim($category->path, '/'));
1760 list($select, $params) = $DB->get_in_or_equal($categoriestoload);
176b75b5 1761 // We are going to use select twice so double the params
4766a50c 1762 $params = array_merge($params, $params);
d4bb6462
SH
1763 $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':'';
1764 $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
176b75b5
SH
1765 }
1766
1767 $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1768 $categories = array();
1769 foreach ($categoriesrs as $category) {
1770 // Preload the context.. we'll need it when adding the category in order
1771 // to format the category name.
1772 context_helper::preload_from_record($category);
1773 if (array_key_exists($category->id, $this->addedcategories)) {
1774 // Do nothing, its already been added.
1775 } else if ($category->parent == '0') {
1776 // This is a root category lets add it immediately
1777 $this->add_category($category, $this->rootnodes['courses']);
1778 } else if (array_key_exists($category->parent, $this->addedcategories)) {
1779 // This categories parent has already been added we can add this immediately
1780 $this->add_category($category, $this->addedcategories[$category->parent]);
1781 } else {
1782 $categories[] = $category;
1783 }
4766a50c 1784 }
176b75b5 1785 $categoriesrs->close();
e26507b3
SH
1786
1787 // Now we have an array of categories we need to add them to the navigation.
1788 while (!empty($categories)) {
1789 $category = reset($categories);
1790 if (array_key_exists($category->id, $this->addedcategories)) {
1791 // Do nothing
1792 } else if ($category->parent == '0') {
1793 $this->add_category($category, $this->rootnodes['courses']);
1794 } else if (array_key_exists($category->parent, $this->addedcategories)) {
1795 $this->add_category($category, $this->addedcategories[$category->parent]);
4766a50c 1796 } else {
e26507b3
SH
1797 // This category isn't in the navigation and niether is it's parent (yet).
1798 // We need to go through the category path and add all of its components in order.
1799 $path = explode('/', trim($category->path, '/'));
1800 foreach ($path as $catid) {
1801 if (!array_key_exists($catid, $this->addedcategories)) {
1802 // This category isn't in the navigation yet so add it.
1803 $subcategory = $categories[$catid];
c4afcf84
SH
1804 if ($subcategory->parent == '0') {
1805 // Yay we have a root category - this likely means we will now be able
1806 // to add categories without problems.
1807 $this->add_category($subcategory, $this->rootnodes['courses']);
1808 } else if (array_key_exists($subcategory->parent, $this->addedcategories)) {
e26507b3
SH
1809 // The parent is in the category (as we'd expect) so add it now.
1810 $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1811 // Remove the category from the categories array.
1812 unset($categories[$catid]);
1813 } else {
1814 // We should never ever arrive here - if we have then there is a bigger
1815 // problem at hand.
5607036a 1816 throw new coding_exception('Category path order is incorrect and/or there are missing categories');
e26507b3 1817 }
4766a50c 1818 }
4766a50c
SH
1819 }
1820 }
e26507b3
SH
1821 // Remove the category from the categories array now that we know it has been added.
1822 unset($categories[$category->id]);
4766a50c 1823 }
8e8de15f
SH
1824 if ($categoryid === self::LOAD_ALL_CATEGORIES) {
1825 $this->allcategoriesloaded = true;
1826 }
e26507b3 1827 // Check if there are any categories to load.
8e8de15f
SH
1828 if (count($categoriestoload) > 0) {
1829 $readytoloadcourses = array();
1830 foreach ($categoriestoload as $category) {
1831 if ($this->can_add_more_courses_to_category($category)) {
1832 $readytoloadcourses[] = $category;
1833 }
1834 }
1835 if (count($readytoloadcourses)) {
1836 $this->load_all_courses($readytoloadcourses);
1837 }
4766a50c
SH
1838 }
1839 }
1840
1841 /**
1842 * Adds a structured category to the navigation in the correct order/place
1843 *
e26507b3 1844 * @param stdClass $category
435a512e 1845 * @param navigation_node $parent
4766a50c 1846 */
e26507b3
SH
1847 protected function add_category(stdClass $category, navigation_node $parent) {
1848 if (array_key_exists($category->id, $this->addedcategories)) {
563329e8 1849 return;
e26507b3
SH
1850 }
1851 $url = new moodle_url('/course/category.php', array('id' => $category->id));
b0c6dc1c 1852 $context = context_coursecat::instance($category->id);
63390481
SH
1853 $categoryname = format_string($category->name, true, array('context' => $context));
1854 $categorynode = $parent->add($categoryname, $url, self::TYPE_CATEGORY, $categoryname, $category->id);
e26507b3
SH
1855 if (empty($category->visible)) {
1856 if (has_capability('moodle/category:viewhiddencategories', get_system_context())) {
1857 $categorynode->hidden = true;
1858 } else {
1859 $categorynode->display = false;
14337688 1860 }
4766a50c 1861 }
082513ba 1862 $this->addedcategories[$category->id] = $categorynode;
4766a50c
SH
1863 }
1864
3406acde
SH
1865 /**
1866 * Loads the given course into the navigation
7d2a0492 1867 *
3406acde
SH
1868 * @param stdClass $course
1869 * @return navigation_node
1870 */
1871 protected function load_course(stdClass $course) {
98556b23
SH
1872 global $SITE;
1873 if ($course->id == $SITE->id) {
80c69522 1874 // This is always loaded during initialisation
e26507b3
SH
1875 return $this->rootnodes['site'];
1876 } else if (array_key_exists($course->id, $this->addedcourses)) {
80c69522 1877 // The course has already been loaded so return a reference
e26507b3 1878 return $this->addedcourses[$course->id];
3406acde 1879 } else {
80c69522 1880 // Add the course
e26507b3 1881 return $this->add_course($course);
3406acde 1882 }
3406acde
SH
1883 }
1884
1885 /**
1886 * Loads all of the courses section into the navigation.
1887 *
1888 * This function utilisies a callback that can be implemented within the course
1889 * formats lib.php file to customise the navigation that is generated at this
1890 * point for the course.
1891 *
93123b17 1892 * By default (if not defined) the method {@link global_navigation::load_generic_course_sections()} is
3406acde
SH
1893 * called instead.
1894 *
3406acde
SH
1895 * @param stdClass $course Database record for the course
1896 * @param navigation_node $coursenode The course node within the navigation
1897 * @return array Array of navigation nodes for the section with key = section id
1898 */
1899 protected function load_course_sections(stdClass $course, navigation_node $coursenode) {
1900 global $CFG;
1901 $structurefile = $CFG->dirroot.'/course/format/'.$course->format.'/lib.php';
1902 $structurefunc = 'callback_'.$course->format.'_load_content';
1903 if (function_exists($structurefunc)) {
1904 return $structurefunc($this, $course, $coursenode);
1905 } else if (file_exists($structurefile)) {
1906 require_once $structurefile;
1907 if (function_exists($structurefunc)) {
1908 return $structurefunc($this, $course, $coursenode);
1909 } else {
0f4ab67d 1910 return $this->load_generic_course_sections($course, $coursenode);
3406acde
SH
1911 }
1912 } else {
0f4ab67d 1913 return $this->load_generic_course_sections($course, $coursenode);
3406acde
SH
1914 }
1915 }
1916
e26507b3
SH
1917 /**
1918 * Generates an array of sections and an array of activities for the given course.
1919 *
1920 * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1921 *
1922 * @param stdClass $course
1923 * @return array Array($sections, $activities)
1924 */
1925 protected function generate_sections_and_activities(stdClass $course) {
1926 global $CFG;
1927 require_once($CFG->dirroot.'/course/lib.php');
1928
c18facf2 1929 $modinfo = get_fast_modinfo($course);
ce4dfd27 1930 $sections = array_slice($modinfo->get_section_info_all(), 0, $course->numsections+1, true);
c18facf2 1931 $activities = array();
e26507b3 1932
c18facf2 1933 foreach ($sections as $key => $section) {
2d9c0d11 1934 // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
51591b2c
AO
1935 $sections[$key] = clone($section);
1936 unset($sections[$key]->summary);
c18facf2
SH
1937 $sections[$key]->hasactivites = false;
1938 if (!array_key_exists($section->section, $modinfo->sections)) {
1939 continue;
1940 }
1941 foreach ($modinfo->sections[$section->section] as $cmid) {
1942 $cm = $modinfo->cms[$cmid];
1943 if (!$cm->uservisible) {
e26507b3
SH
1944 continue;
1945 }
c18facf2
SH
1946 $activity = new stdClass;
1947 $activity->id = $cm->id;
1948 $activity->course = $course->id;
1949 $activity->section = $section->section;
1950 $activity->name = $cm->name;
1951 $activity->icon = $cm->icon;
1952 $activity->iconcomponent = $cm->iconcomponent;
1953 $activity->hidden = (!$cm->visible);
1954 $activity->modname = $cm->modname;
1955 $activity->nodetype = navigation_node::NODETYPE_LEAF;
1956 $activity->onclick = $cm->get_on_click();
1957 $url = $cm->get_url();
1958 if (!$url) {
1959 $activity->url = null;
1960 $activity->display = false;
1961 } else {
1962 $activity->url = $cm->get_url()->out();
1963 $activity->display = true;
1964 if (self::module_extends_navigation($cm->modname)) {
1965 $activity->nodetype = navigation_node::NODETYPE_BRANCH;
d67e4821 1966 }
e26507b3 1967 }
c18facf2
SH
1968 $activities[$cmid] = $activity;
1969 if ($activity->display) {
1970 $sections[$key]->hasactivites = true;
1971 }
e26507b3 1972 }
e26507b3 1973 }
c18facf2 1974
e26507b3
SH
1975 return array($sections, $activities);
1976 }
1977
3406acde
SH
1978 /**
1979 * Generically loads the course sections into the course's navigation.
1980 *
1981 * @param stdClass $course
1982 * @param navigation_node $coursenode
e26507b3 1983 * @param string $courseformat The course format
3406acde
SH
1984 * @return array An array of course section nodes
1985 */
0f4ab67d 1986 public function load_generic_course_sections(stdClass $course, navigation_node $coursenode, $courseformat='unknown') {
98556b23 1987 global $CFG, $DB, $USER, $SITE;
df997f84 1988 require_once($CFG->dirroot.'/course/lib.php');
435a512e 1989
e26507b3 1990 list($sections, $activities) = $this->generate_sections_and_activities($course);
0f4ab67d
SH
1991
1992 $namingfunction = 'callback_'.$courseformat.'_get_section_name';
1993 $namingfunctionexists = (function_exists($namingfunction));
ad470097 1994
ad470097 1995 $urlfunction = 'callback_'.$courseformat.'_get_section_url';
d9e13265 1996 if (function_exists($urlfunction)) {
10cdacfe
DP
1997 // This code path is deprecated but we decided not to warn developers as
1998 // major changes are likely to follow in 2.4. See MDL-32504.
d9e13265 1999 } else {
ad470097
SH
2000 $urlfunction = null;
2001 }
2002
b9bcdb54 2003 $key = 0;
f7558683
DP
2004 if (defined('AJAX_SCRIPT') && AJAX_SCRIPT == '0' && $this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
2005 $key = optional_param('section', $key, PARAM_INT);
ad470097
SH
2006 }
2007
7487c856 2008 $navigationsections = array();
e26507b3 2009 foreach ($sections as $sectionid => $section) {
7487c856 2010 $section = clone($section);
98556b23 2011 if ($course->id == $SITE->id) {
e26507b3 2012 $this->load_section_activities($coursenode, $section->section, $activities);
3406acde 2013 } else {
ce4dfd27 2014 if (!$section->uservisible || (!$this->showemptysections &&
d67e4821 2015 !$section->hasactivites && $this->includesectionnum !== $section->section)) {
3406acde
SH
2016 continue;
2017 }
ce4dfd27 2018
0f4ab67d
SH
2019 if ($namingfunctionexists) {
2020 $sectionname = $namingfunction($course, $section, $sections);
3406acde 2021 } else {
0f4ab67d 2022 $sectionname = get_string('section').' '.$section->section;
3406acde 2023 }
ad470097 2024
dbe5050d 2025 $url = null;
d9e13265
DP
2026 if ($urlfunction) {
2027 // pre 2.3 style format url
ad470097 2028 $url = $urlfunction($course->id, $section->section);
d9e13265
DP
2029 }else{
2030 if ($course->coursedisplay == COURSE_DISPLAY_MULTIPAGE) {
2031 $url = course_get_url($course, $section->section);
2032 }
ad470097 2033 }
3406acde
SH
2034 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
2035 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
ce4dfd27 2036 $sectionnode->hidden = (!$section->visible || !$section->available);
ad470097
SH
2037 if ($key != '0' && $section->section != '0' && $section->section == $key && $this->page->context->contextlevel != CONTEXT_MODULE && $section->hasactivites) {
2038 $sectionnode->make_active();
e26507b3 2039 $this->load_section_activities($sectionnode, $section->section, $activities);
3406acde
SH
2040 }
2041 $section->sectionnode = $sectionnode;
7487c856 2042 $navigationsections[$sectionid] = $section;
3406acde
SH
2043 }
2044 }
7487c856 2045 return $navigationsections;
3406acde
SH
2046 }
2047 /**
2048 * Loads all of the activities for a section into the navigation structure.
2049 *
2050 * @param navigation_node $sectionnode
2051 * @param int $sectionnumber
93123b17 2052 * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
1580cfdb 2053 * @param stdClass $course The course object the section and activities relate to.
3406acde
SH
2054 * @return array Array of activity nodes
2055 */
1580cfdb 2056 protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) {
98556b23 2057 global $CFG, $SITE;
dee1a0fd
SH
2058 // A static counter for JS function naming
2059 static $legacyonclickcounter = 0;
3406acde 2060
e26507b3 2061 $activitynodes = array();
4037098e
SH
2062 if (empty($activities)) {
2063 return $activitynodes;
2064 }
2065
2066 if (!is_object($course)) {
2067 $activity = reset($activities);
2068 $courseid = $activity->course;
2069 } else {
2070 $courseid = $course->id;
2071 }
98556b23 2072 $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods));
4037098e 2073
e26507b3
SH
2074 foreach ($activities as $activity) {
2075 if ($activity->section != $sectionnumber) {
3406acde
SH
2076 continue;
2077 }
e26507b3
SH
2078 if ($activity->icon) {
2079 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
3406acde 2080 } else {
e26507b3 2081 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
3406acde 2082 }
dee1a0fd
SH
2083
2084 // Prepare the default name and url for the node
b0c6dc1c 2085 $activityname = format_string($activity->name, true, array('context' => context_module::instance($activity->id)));
dee1a0fd
SH
2086 $action = new moodle_url($activity->url);
2087
2088 // Check if the onclick property is set (puke!)
2089 if (!empty($activity->onclick)) {
2090 // Increment the counter so that we have a unique number.
2091 $legacyonclickcounter++;
2092 // Generate the function name we will use
2093 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
2094 $propogrationhandler = '';
2095 // Check if we need to cancel propogation. Remember inline onclick
2096 // events would return false if they wanted to prevent propogation and the
2097 // default action.
2098 if (strpos($activity->onclick, 'return false')) {
2099 $propogrationhandler = 'e.halt();';
2100 }
2101 // Decode the onclick - it has already been encoded for display (puke)
2102 $onclick = htmlspecialchars_decode($activity->onclick);
2103 // Build the JS function the click event will call
2104 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2105 $this->page->requires->js_init_code($jscode);
2106 // Override the default url with the new action link
2107 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2108 }
2109
2110 $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
e26507b3
SH
2111 $activitynode->title(get_string('modulename', $activity->modname));
2112 $activitynode->hidden = $activity->hidden;
4037098e 2113 $activitynode->display = $showactivities && $activity->display;
e26507b3
SH
2114 $activitynode->nodetype = $activity->nodetype;
2115 $activitynodes[$activity->id] = $activitynode;
3406acde
SH
2116 }
2117
e26507b3 2118 return $activitynodes;
3406acde 2119 }
2a62743c
PS
2120 /**
2121 * Loads a stealth module from unavailable section
2122 * @param navigation_node $coursenode
2123 * @param stdClass $modinfo
2124 * @return navigation_node or null if not accessible
2125 */
2126 protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
2127 if (empty($modinfo->cms[$this->page->cm->id])) {
2128 return null;
2129 }
2130 $cm = $modinfo->cms[$this->page->cm->id];
2131 if (!$cm->uservisible) {
2132 return null;
2133 }
2134 if ($cm->icon) {
2135 $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
2136 } else {
2137 $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
2138 }
0d8b6a69 2139 $url = $cm->get_url();
2a62743c
PS
2140 $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
2141 $activitynode->title(get_string('modulename', $cm->modname));
2142 $activitynode->hidden = (!$cm->visible);
0d8b6a69 2143 if (!$url) {
2144 // Don't show activities that don't have links!
2a62743c 2145 $activitynode->display = false;
e26507b3 2146 } else if (self::module_extends_navigation($cm->modname)) {
2a62743c
PS
2147 $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
2148 }
2149 return $activitynode;
2150 }
3406acde
SH
2151 /**
2152 * Loads the navigation structure for the given activity into the activities node.
2153 *
2154 * This method utilises a callback within the modules lib.php file to load the
2155 * content specific to activity given.
2156 *
2157 * The callback is a method: {modulename}_extend_navigation()
2158 * Examples:
93123b17
EL
2159 * * {@link forum_extend_navigation()}
2160 * * {@link workshop_extend_navigation()}
3406acde 2161 *
f0dcc212 2162 * @param cm_info|stdClass $cm
3406acde
SH
2163 * @param stdClass $course
2164 * @param navigation_node $activity
2165 * @return bool
2166 */
0d8b6a69 2167 protected function load_activity($cm, stdClass $course, navigation_node $activity) {
3406acde 2168 global $CFG, $DB;
44303ca6 2169
f0dcc212
SH
2170 // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2171 if (!($cm instanceof cm_info)) {
2172 $modinfo = get_fast_modinfo($course);
2173 $cm = $modinfo->get_cm($cm->id);
2174 }
3406acde 2175
577c8964 2176 $activity->nodetype = navigation_node::NODETYPE_LEAF;
3406acde
SH
2177 $activity->make_active();
2178 $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
2179 $function = $cm->modname.'_extend_navigation';
2180
2181 if (file_exists($file)) {
2182 require_once($file);
2183 if (function_exists($function)) {
2184 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
2185 $function($activity, $course, $activtyrecord, $cm);
3406acde
SH
2186 }
2187 }
577c8964
MG
2188
2189 // Allow the active advanced grading method plugin to append module navigation
2190 $featuresfunc = $cm->modname.'_supports';
2191 if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) {
2192 require_once($CFG->dirroot.'/grade/grading/lib.php');
2193 $gradingman = get_grading_manager($cm->context, $cm->modname);
2194 $gradingman->extend_navigation($this, $activity);
2195 }
2196
2197 return $activity->has_children();
3406acde
SH
2198 }
2199 /**
4d00fded 2200 * Loads user specific information into the navigation in the appropriate place.
3406acde
SH
2201 *
2202 * If no user is provided the current user is assumed.
2203 *
3406acde 2204 * @param stdClass $user
4d00fded 2205 * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
3406acde 2206 * @return bool
7a7e209d 2207 */
87c215de 2208 protected function load_for_user($user=null, $forceforcontext=false) {
98556b23 2209 global $DB, $CFG, $USER, $SITE;
4f0c2d00 2210
7a7e209d
SH
2211 if ($user === null) {
2212 // We can't require login here but if the user isn't logged in we don't
2213 // want to show anything
b9d4c7d3 2214 if (!isloggedin() || isguestuser()) {
7a7e209d
SH
2215 return false;
2216 }
2217 $user = $USER;
7a7e209d
SH
2218 } else if (!is_object($user)) {
2219 // If the user is not an object then get them from the database
e141bc81
SH
2220 $select = context_helper::get_preload_record_columns_sql('ctx');
2221 $sql = "SELECT u.*, $select
2222 FROM {user} u
2223 JOIN {context} ctx ON u.id = ctx.instanceid
2224 WHERE u.id = :userid AND
2225 ctx.contextlevel = :contextlevel";
2226 $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST);
2227 context_helper::preload_from_record($user);
7a7e209d 2228 }
136ca7c8
SH
2229
2230 $iscurrentuser = ($user->id == $USER->id);
2231
b0c6dc1c 2232 $usercontext = context_user::instance($user->id);
7a7e209d
SH
2233
2234 // Get the course set against the page, by default this will be the site
3406acde
SH
2235 $course = $this->page->course;
2236 $baseargs = array('id'=>$user->id);
98556b23 2237 if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) {
e26507b3 2238 $coursenode = $this->load_course($course);
7a7e209d 2239 $baseargs['course'] = $course->id;
b0c6dc1c 2240 $coursecontext = context_course::instance($course->id);
7a7e209d 2241 $issitecourse = false;
7d2a0492 2242 } else {
7a7e209d 2243 // Load all categories and get the context for the system
b0c6dc1c 2244 $coursecontext = context_system::instance();
7a7e209d
SH
2245 $issitecourse = true;
2246 }
2247
2248 // Create a node to add user information under.
87c215de 2249 if ($iscurrentuser && !$forceforcontext) {
3406acde
SH
2250 // If it's the current user the information will go under the profile root node
2251 $usernode = $this->rootnodes['myprofile'];
e96bc3f9 2252 $course = get_site();
b0c6dc1c 2253 $coursecontext = context_course::instance($course->id);
e96bc3f9 2254 $issitecourse = true;
7a7e209d
SH
2255 } else {
2256 if (!$issitecourse) {
2257 // Not the current user so add it to the participants node for the current course
3406acde 2258 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
ad93ddd5 2259 $userviewurl = new moodle_url('/user/view.php', $baseargs);
7a7e209d
SH
2260 } else {
2261 // This is the site so add a users node to the root branch
3406acde 2262 $usersnode = $this->rootnodes['users'];
8b0614d9
DP
2263 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2264 $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
2265 }
ad93ddd5 2266 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
7a7e209d 2267 }
f5c1e621
SH
2268 if (!$usersnode) {
2269 // We should NEVER get here, if the course hasn't been populated
2270 // with a participants node then the navigaiton either wasn't generated
2271 // for it (you are missing a require_login or set_context call) or
2272 // you don't have access.... in the interests of no leaking informatin
2273 // we simply quit...
2274 return false;
2275 }
7a7e209d 2276 // Add a branch for the current user
76565fa1
AG
2277 $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2278 $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, $user->id);
3406acde 2279
5ac851fb
SH
2280 if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
2281 $usernode->make_active();
2282 }
7a7e209d
SH
2283 }
2284
2285 // If the user is the current user or has permission to view the details of the requested
2286 // user than add a view profile link.
507a7a9a 2287 if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
87c215de 2288 if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
03d9401e
MD
2289 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
2290 } else {
2291 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
2292 }
7a7e209d
SH
2293 }
2294
356a6de3
SH
2295 if (!empty($CFG->navadduserpostslinks)) {
2296 // Add nodes for forum posts and discussions if the user can view either or both
2297 // There are no capability checks here as the content of the page is based
2298 // purely on the forums the current user has access too.
2299 $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2300 $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2301 $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
2302 }
7a7e209d 2303
27bad0a6 2304 // Add blog nodes
850d2db8 2305 if (!empty($CFG->enableblogs)) {
e26507b3
SH
2306 if (!$this->cache->cached('userblogoptions'.$user->id)) {
2307 require_once($CFG->dirroot.'/blog/lib.php');
2308 // Get all options for the user
2309 $options = blog_get_options_for_user($user);
2310 $this->cache->set('userblogoptions'.$user->id, $options);
2311 } else {
2312 $options = $this->cache->{'userblogoptions'.$user->id};
2313 }
2314
27bad0a6
SH
2315 if (count($options) > 0) {
2316 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
c000545d
JF
2317 foreach ($options as $type => $option) {
2318 if ($type == "rss") {
2319 $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2320 } else {
2321 $blogs->add($option['string'], $option['link']);
2322 }
27bad0a6
SH
2323 }
2324 }
2325 }
2326
5ac851fb
SH
2327 if (!empty($CFG->messaging)) {
2328 $messageargs = null;
2329 if ($USER->id!=$user->id) {
2330 $messageargs = array('id'=>$user->id);
2331 }
2332 $url = new moodle_url('/message/index.php',$messageargs);
2333 $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
c81b9f69 2334 }
c81b9f69 2335
b0c6dc1c 2336 $context = context_user::instance($USER->id);
52d1a804 2337 if ($iscurrentuser && has_capability('moodle/user:manageownfiles', $context)) {
4c886459 2338 $url = new moodle_url('/user/files.php');
82af55d7 2339 $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
78765507
DC
2340 }
2341
7a7e209d 2342 // Add a node to view the users notes if permitted
507a7a9a 2343 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
3406acde
SH
2344 $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
2345 if ($coursecontext->instanceid) {
2346 $url->param('course', $coursecontext->instanceid);
2347 }
2348 $usernode->add(get_string('notes', 'notes'), $url);
7a7e209d
SH
2349 }
2350
beda8fa8 2351 // Add reports node
4d00fded 2352 $reporttab = $usernode->add(get_string('activityreports'));
4d00fded
PS
2353 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2354 foreach ($reports as $reportfunction) {
2355 $reportfunction($reporttab, $user, $course);
2356 }
beda8fa8
PS
2357 $anyreport = has_capability('moodle/user:viewuseractivitiesreport', $usercontext);
2358 if ($anyreport || ($course->showreports && $iscurrentuser && $forceforcontext)) {
2359 // Add grade hardcoded grade report if necessary
03d9401e
MD
2360 $gradeaccess = false;
2361 if (has_capability('moodle/grade:viewall', $coursecontext)) {
2362 //ok - can view all course grades
7a7e209d 2363 $gradeaccess = true;
03d9401e
MD
2364 } else if ($course->showgrades) {
2365 if ($iscurrentuser && has_capability('moodle/grade:view', $coursecontext)) {
2366 //ok - can view own grades
2367 $gradeaccess = true;
2368 } else if (has_capability('moodle/grade:viewall', $usercontext)) {
2369 // ok - can view grades of this user - parent most probably
2370 $gradeaccess = true;
2371 } else if ($anyreport) {
2372 // ok - can view grades of this user - parent most probably
2373 $gradeaccess = true;
2374 }
2375 }
2376 if ($gradeaccess) {
a0b15989 2377 $reporttab->add(get_string('grade'), new moodle_url('/course/user.php', array('mode'=>'grade', 'id'=>$course->id, 'user'=>$usercontext->instanceid)));
7a7e209d 2378 }
7a7e209d 2379 }
beda8fa8 2380 // Check the number of nodes in the report node... if there are none remove the node
4d00fded
PS
2381 $reporttab->trim_if_empty();
2382
7a7e209d 2383 // If the user is the current user add the repositories for the current user
9acb8241 2384 $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
7a7e209d 2385 if ($iscurrentuser) {
e26507b3
SH
2386 if (!$this->cache->cached('contexthasrepos'.$usercontext->id)) {
2387 require_once($CFG->dirroot . '/repository/lib.php');
2388 $editabletypes = repository::get_editable_types($usercontext);
2389 $haseditabletypes = !empty($editabletypes);
2390 unset($editabletypes);
2391 $this->cache->set('contexthasrepos'.$usercontext->id, $haseditabletypes);
2392 } else {
2393 $haseditabletypes = $this->cache->{'contexthasrepos'.$usercontext->id};
2394 }
2395 if ($haseditabletypes) {
ad70376c 2396 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
7a7e209d 2397 }
98556b23 2398 } else if ($course->id == $SITE->id && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
9acb8241
SH
2399
2400 // Add view grade report is permitted
2401 $reports = get_plugin_list('gradereport');
2402 arsort($reports); // user is last, we want to test it first
2403
2404 $userscourses = enrol_get_users_courses($user->id);
2405 $userscoursesnode = $usernode->add(get_string('courses'));
69816a5c 2406
9acb8241 2407 foreach ($userscourses as $usercourse) {
b0c6dc1c 2408 $usercoursecontext = context_course::instance($usercourse->id);
8ebbb06a
SH
2409 $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext));
2410 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
9acb8241
SH
2411
2412 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2413 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
2414 foreach ($reports as $plugin => $plugindir) {
2415 if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2416 //stop when the first visible plugin is found
2417 $gradeavailable = true;
2418 break;
deaf04c7 2419 }
9acb8241
SH
2420 }
2421 }
2422
2423 if ($gradeavailable) {
2424 $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
2425 $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
2426 }
2427
2428 // Add a node to view the users notes if permitted
2429 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2430 $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
2431 $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2432 }
2433
1344b0ca 2434 if (can_access_course($usercourse, $user->id)) {
9acb8241
SH
2435 $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', ''));
2436 }
2437
4d00fded
PS
2438 $reporttab = $usercoursenode->add(get_string('activityreports'));
2439
2440 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2441 foreach ($reports as $reportfunction) {
2442 $reportfunction($reporttab, $user, $usercourse);
2443 }
2444
4d00fded 2445 $reporttab->trim_if_empty();
9acb8241 2446 }
7a7e209d
SH
2447 }
2448 return true;
2449 }
2450
2451 /**
3406acde 2452 * This method simply checks to see if a given module can extend the navigation.
7d2a0492 2453 *
31fde54f 2454 * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
e26507b3 2455 *
7d2a0492 2456 * @param string $modname
2457 * @return bool
2458 */
e26507b3 2459 protected static function module_extends_navigation($modname) {
7d2a0492 2460 global $CFG;
e26507b3
SH
2461 static $extendingmodules = array();
2462 if (!array_key_exists($modname, $extendingmodules)) {
2463 $extendingmodules[$modname] = false;
2464 $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2465 if (file_exists($file)) {
2466 $function = $modname.'_extend_navigation';
2467 require_once($file);
2468 $extendingmodules[$modname] = (function_exists($function));
7d2a0492 2469 }
2470 }
e26507b3 2471 return $extendingmodules[$modname];
7d2a0492 2472 }
2473 /**
3406acde 2474 * Extends the navigation for the given user.
435a512e 2475 *
3406acde 2476 * @param stdClass $user A user from the database
7d2a0492 2477 */
3406acde
SH
2478 public function extend_for_user($user) {
2479 $this->extendforuser[] = $user;
5d07e957
SH
2480 }
2481
2482 /**
2483 * Returns all of the users the navigation is being extended for
2484 *
31fde54f 2485 * @return array An array of extending users.
5d07e957
SH
2486 */
2487 public function get_extending_users() {
2488 return $this->extendforuser;
7d2a0492 2489 }
7d2a0492 2490 /**
3406acde 2491 * Adds the given course to the navigation structure.
7d2a0492 2492 *
3406acde 2493 * @param stdClass $course
8e8de15f
SH
2494 * @param bool $forcegeneric
2495 * @param bool $ismycourse
3406acde 2496 * @return navigation_node
7d2a0492 2497 */
e26507b3 2498 public function add_course(stdClass $course, $forcegeneric = false, $ismycourse = false) {
98556b23 2499 global $CFG, $SITE;
44303ca6 2500
e26507b3
SH
2501 // We found the course... we can return it now :)
2502 if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2503 return $this->addedcourses[$course->id];
2504 }
2505
b0c6dc1c 2506 $coursecontext = context_course::instance($course->id);
8ebbb06a 2507
98556b23 2508 if ($course->id != $SITE->id && !$course->visible) {
e26507b3
SH
2509 if (is_role_switched($course->id)) {
2510 // user has to be able to access course in order to switch, let's skip the visibility test here
8ebbb06a 2511 } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
e26507b3 2512 return false;
44303ca6 2513 }
7d2a0492 2514 }
7d2a0492 2515
98556b23 2516 $issite = ($course->id == $SITE->id);
8ebbb06a 2517 $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
4766a50c
SH
2518
2519 if ($issite) {
3406acde 2520 $parent = $this;
4766a50c 2521 $url = null;
016ba638
SH
2522 if (empty($CFG->usesitenameforsitepages)) {
2523 $shortname = get_string('sitepages');
2524 }
8e8de15f 2525 } else if ($ismycourse && !$forcegeneric) {
b0712163
SH
2526 if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_CATEGORY))) {
2527 // Nothing to do here the above statement set $parent to the category within mycourses.
2528 } else {
2529 $parent = $this->rootnodes['mycourses'];
2530 }
3406acde 2531 $url = new moodle_url('/course/view.php', array('id'=>$course->id));
7a7e209d 2532 } else {
3406acde 2533 $parent = $this->rootnodes['courses'];
a6855934 2534 $url = new moodle_url('/course/view.php', array('id'=>$course->id));
8e8de15f
SH
2535 if (!empty($course->category) && $this->show_categories()) {
2536 if ($this->show_categories() && !$this->is_category_fully_loaded($course->category)) {
2537 // We need to load the category structure for this course
80c69522 2538 $this->load_all_categories($course->category, false);
8e8de15f
SH
2539 }
2540 if (array_key_exists($course->category, $this->addedcategories)) {
2541 $parent = $this->addedcategories[$course->category];
2542 // This could lead to the course being created so we should check whether it is the case again
2543 if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2544 return $this->addedcourses[$course->id];
2545 }
3992a46e 2546 }
4766a50c
SH
2547 }
2548 }
2549
95892197 2550 $coursenode = $parent->add($shortname, $url, self::TYPE_COURSE, $shortname, $course->id);
3406acde
SH
2551 $coursenode->nodetype = self::NODETYPE_BRANCH;
2552 $coursenode->hidden = (!$course->visible);
b0c6dc1c 2553 $coursenode->title(format_string($course->fullname, true, array('context' => context_course::instance($course->id))));
e26507b3 2554 if (!$forcegeneric) {
082513ba 2555 $this->addedcourses[$course->id] = $coursenode;
e26507b3 2556 }
e26507b3 2557
3406acde 2558 return $coursenode;
7d2a0492 2559 }
8e8de15f
SH
2560
2561 /**
2562 * Returns true if the category has already been loaded as have any child categories
2563 *
2564 * @param int $categoryid
2565 * @return bool
2566 */
2567 protected function is_category_fully_loaded($categoryid) {
2568 return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0));
2569 }
2570
7d2a0492 2571 /**
3406acde 2572 * Adds essential course nodes to the navigation for the given course.
7d2a0492 2573 *
3406acde 2574 * This method adds nodes such as reports, blogs and participants
7d2a0492 2575 *
3406acde
SH
2576 * @param navigation_node $coursenode
2577 * @param stdClass $course
31fde54f 2578 * @return bool returns true on successful addition of a node.
7d2a0492 2579 */
2027c10e 2580 public function add_course_essentials($coursenode, stdClass $course) {
98556b23 2581 global $CFG, $SITE;
7d2a0492 2582
98556b23 2583 if ($course->id == $SITE->id) {
3406acde 2584 return $this->add_front_page_course_essentials($coursenode, $course);
7d2a0492 2585 }
7d2a0492 2586
2027c10e 2587 if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
3406acde 2588 return true;
7d2a0492 2589 }
7d2a0492 2590
3406acde
SH
2591 //Participants
2592 if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
3406acde
SH
2593 $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
2594 $currentgroup = groups_get_course_group($course, true);
98556b23 2595 if ($course->id == $SITE->id) {
3406acde
SH
2596 $filterselect = '';
2597 } else if ($course->id && !$currentgroup) {
2598 $filterselect = $course->id;
2599 } else {
2600 $filterselect = $currentgroup;
2601 }
2602 $filterselect = clean_param($filterselect, PARAM_INT);
8f6c1f34 2603 if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
b0c6dc1c 2604 and has_capability('moodle/blog:view', context_system::instance())) {
3406acde 2605 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
ec21eaba 2606 $participants->add(get_string('blogscourse','blog'), $blogsurls->out());
3406acde
SH
2607 }
2608 if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
41eae0d9 2609 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id)));
3406acde 2610 }
533299cb 2611 } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
3406acde
SH
2612 $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2613 }
2614
2615 // View course reports
2616 if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
275cbac7
PS
2617 $reportnav = $coursenode->add(get_string('reports'), null, self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2618 $coursereports = get_plugin_list('coursereport'); // deprecated
3406acde
SH
2619 foreach ($coursereports as $report=>$dir) {
2620 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2621 if (file_exists($libfile)) {
2622 require_once($libfile);
2623 $reportfunction = $report.'_report_extend_navigation';
2624 if (function_exists($report.'_report_extend_navigation')) {
2625 $reportfunction($reportnav, $course, $this->page->context);
7d2a0492 2626 }
2627 }
2628 }
275cbac7
PS
2629
2630 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
2631 foreach ($reports as $reportfunction) {
2632 $reportfunction($reportnav, $course, $this->page->context);
2633 }
7d2a0492 2634 }
2635 return true;
2636 }
deaf04c7 2637 /**
31fde54f 2638 * This generates the structure of the course that won't be generated when
deaf04c7
SH
2639 * the modules and sections are added.
2640 *
2641 * Things such as the reports branch, the participants branch, blogs... get
2642 * added to the course node by this method.
2643 *
2644 * @param navigation_node $coursenode
2645 * @param stdClass $course
2646 * @return bool True for successfull generation
2647 */
3406acde
SH
2648 public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2649 global $CFG;
7d2a0492 2650
1fa692ed 2651 if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
3406acde 2652 return true;
7a7e209d
SH
2653 }
2654
1fa692ed
SH
2655 // Hidden node that we use to determine if the front page navigation is loaded.
2656 // This required as there are not other guaranteed nodes that may be loaded.
2657 $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2658
3406acde 2659 //Participants
b475cf4c 2660 if (has_capability('moodle/course:viewparticipants', get_system_context())) {
3406acde
SH
2661 $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2662 }
435a512e 2663
83a5e4fc 2664 $filterselect = 0;
593270c6
MD
2665
2666 // Blogs
850d2db8 2667 if (!empty($CFG->enableblogs)
8f6c1f34 2668 and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
b0c6dc1c 2669 and has_capability('moodle/blog:view', context_system::instance())) {
8f6c1f34 2670 $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
ec21eaba 2671 $coursenode->add(get_string('blogssite','blog'), $blogsurls->out());
7d2a0492 2672 }
593270c6
MD
2673
2674 // Notes
3406acde
SH
2675 if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2676 $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2677 }
593270c6
MD
2678
2679 // Tags
2680 if (!empty($CFG->usetags) && isloggedin()) {
3406acde 2681 $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
7d2a0492 2682 }
6644741d 2683
e7f9b7ab
SH
2684 if (isloggedin()) {
2685 // Calendar
2686 $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2687 $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self::TYPE_CUSTOM, null, 'calendar');
2688 }
6644741d 2689
3406acde
SH
2690 // View course reports
2691 if (has_capability('moodle/site:viewreports', $this->page->context)) { // basic capability for listing of reports
275cbac7
PS
2692 $reportnav = $coursenode->add(get_string('reports'), null, self::TYPE_CONTAINER, null, null, new pix_icon('i/stats', ''));
2693 $coursereports = get_plugin_list('coursereport'); // deprecated
3406acde
SH
2694 foreach ($coursereports as $report=>$dir) {
2695 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
2696 if (file_exists($libfile)) {
2697 require_once($libfile);
2698 $reportfunction = $report.'_report_extend_navigation';
2699 if (function_exists($report.'_report_extend_navigation')) {
2700 $reportfunction($reportnav, $course, $this->page->context);
2701 }
6644741d 2702 }
6644741d 2703 }
275cbac7
PS
2704
2705 $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
2706 foreach ($reports as $reportfunction) {
2707 $reportfunction($reportnav, $course, $this->page->context);
2708 }
6644741d 2709 }
3406acde 2710 return true;
6644741d 2711 }
da3ab9c4 2712
3406acde
SH
2713 /**
2714 * Clears the navigation cache
2715 */
2716 public function clear_cache() {
2717 $this->cache->clear();
da3ab9c4 2718 }
88f77c3c 2719
deaf04c7
SH
2720 /**
2721 * Sets an expansion limit for the navigation
2722 *
2723 * The expansion limit is used to prevent the display of content that has a type
2724 * greater than the provided $type.
2725 *
2726 * Can be used to ensure things such as activities or activity content don't get
2727 * shown on the navigation.
2728 * They are still generated in order to ensure the navbar still makes sense.
2729 *
2730 * @param int $type One of navigation_node::TYPE_*
31fde54f 2731 * @return bool true when complete.
deaf04c7 2732 */
88f77c3c 2733 public function set_expansion_limit($type) {
98556b23 2734 global $SITE;
88f77c3c
SH
2735 $nodes = $this->find_all_of_type($type);
2736 foreach ($nodes as &$node) {
1af67ecb 2737 // We need to generate the full site node
98556b23 2738 if ($type == self::TYPE_COURSE && $node->key == $SITE->id) {
1af67ecb
SH
2739 continue;
2740 }
88f77c3c 2741 foreach ($node->children as &$child) {
1af67ecb
SH
2742 // We still want to show course reports and participants containers
2743 // or there will be navigation missing.
2744 if ($type == self::TYPE_COURSE && $child->type === self::TYPE_CONTAINER) {
2745 continue;
2746 }
88f77c3c
SH
2747 $child->display = false;
2748 }
2749 }
2750 return true;
2751 }
deaf04c7
SH
2752 /**
2753 * Attempts to get the navigation with the given key from this nodes children.
2754 *
2755 * This function only looks at this nodes children, it does NOT look recursivily.
2756 * If the node can't be found then false is returned.
2757 *
93123b17 2758 * If you need to search recursivily then use the {@link global_navigation::find()} method.
deaf04c7 2759 *
93123b17 2760 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
deaf04c7
SH
2761 * may be of more use to you.
2762 *
2763 * @param string|int $key The key of the node you wish to receive.
2764 * @param int $type One of navigation_node::TYPE_*
2765 * @return navigation_node|false
2766 */
e2b436d0 2767 public function get($key, $type = null) {
246a9b05
SH
2768 if (!$this->initialised) {
2769 $this->initialise();
2770 }
54dc15ab 2771 return parent::get($key, $type);
e2b436d0
SH
2772 }
2773
deaf04c7 2774 /**
31fde54f 2775 * Searches this nodes children and their children to find a navigation node
deaf04c7
SH
2776 * with the matching key and type.
2777 *
2778 * This method is recursive and searches children so until either a node is
31fde54f 2779 * found or there are no more nodes to search.
deaf04c7
SH
2780 *
2781 * If you know that the node being searched for is a child of this node
93123b17 2782 * then use the {@link global_navigation::get()} method instead.
deaf04c7 2783 *
93123b17 2784 * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
deaf04c7
SH
2785 * may be of more use to you.
2786 *
2787 * @param string|int $key The key of the node you wish to receive.
2788 * @param int $type One of navigation_node::TYPE_*
2789 * @return navigation_node|false
2790 */
e2b436d0 2791 public function find($key, $type) {
246a9b05
SH
2792 if (!$this->initialised) {
2793 $this->initialise();
2794 }
54dc15ab 2795 return parent::find($key, $type);
e2b436d0 2796 }
7d2a0492 2797}
2798
2799/**
98556b23 2800 * The global navigation class used especially for AJAX requests.
7d2a0492 2801 *
2802 * The primary methods that are used in the global navigation class have been overriden
2803 * to ensure that only the relevant branch is generated at the root of the tree.
2804 * This can be done because AJAX is only used when the backwards structure for the
2805 * requested branch exists.
2806 * This has been done only because it shortens the amounts of information that is generated
2807 * which of course will speed up the response time.. because no one likes laggy AJAX.
2808 *
31fde54f
AG
2809 * @package core
2810 * @category navigation
7d2a0492 2811 * @copyright 2009 Sam Hemelryk
2812 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2813 */
507a7a9a 2814class global_navigation_for_ajax extends global_navigation {
3406acde 2815
31fde54f 2816 /** @var int used for determining what type of navigation_node::TYPE_* is being used */
39ae5e54 2817 protected $branchtype;
31fde54f
AG
2818
2819 /** @var int the instance id */
39ae5e54
SH
2820 protected $instanceid;
2821
31fde54f 2822 /** @var array Holds an array of expandable nodes */
3406acde
SH
2823 protected $expandable = array();
2824
7d2a0492 2825 /**
31fde54f
AG
2826 * Constructs the navigation for use in an AJAX request
2827 *
2828 * @param moodle_page $page moodle_page object
2829 * @param int $branchtype
2830 * @param int $id
3406acde 2831 */
246a9b05 2832 public function __construct($page, $branchtype, $id) {
4766a50c 2833 $this->page = $page;
3406acde
SH
2834 $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2835 $this->children = new navigation_node_collection();
39ae5e54
SH
2836 $this->branchtype = $branchtype;
2837 $this->instanceid = $id;
2838 $this->initialise();
3406acde
SH
2839 }
2840 /**
2841 * Initialise the navigation given the type and id for the branch to expand.
7d2a0492 2842 *
31fde54f 2843 * @return array An array of the expandable nodes
7d2a0492 2844 */
39ae5e54
SH
2845 public function initialise() {
2846 global $CFG, $DB, $SITE;
507a7a9a 2847
7d2a0492 2848 if ($this->initialised || during_initial_install()) {
95b97515 2849 return $this->expandable;
7d2a0492 2850 }
246a9b05
SH
2851 $this->initialised = true;
2852
2853 $this->rootnodes = array();
e26507b3 2854 $this->rootnodes['site'] = $this->add_course($SITE);
246a9b05 2855 $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
507a7a9a
SH
2856
2857 // Branchtype will be one of navigation_node::TYPE_*
39ae5e54 2858 switch ($this->branchtype) {
4766a50c 2859 case self::TYPE_CATEGORY :
d4bb6462 2860 $this->load_category($this->instanceid);
4766a50c 2861 break;
507a7a9a 2862 case self::TYPE_COURSE :
39ae5e54 2863 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
04bcd1ce 2864 require_course_login($course, true, null, false, true);
b0c6dc1c 2865 $this->page->set_context(context_course::instance($course->id));
3406acde
SH
2866 $coursenode = $this->add_course($course);
2867 $this->add_course_essentials($coursenode, $course);
2868 if ($this->format_display_course_content($course->format)) {
2869 $this->load_course_sections($course, $coursenode);
2870 }
7d2a0492 2871 break;
507a7a9a 2872 case self::TYPE_SECTION :
3406acde 2873 $sql = 'SELECT c.*, cs.section AS sectionnumber
507a7a9a
SH
2874 FROM {course} c
2875 LEFT JOIN {course_sections} cs ON cs.course = c.id
2876 WHERE cs.id = ?';
39ae5e54 2877 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
04bcd1ce 2878 require_course_login($course, true, null, false, true);
b0c6dc1c 2879 $this->page->set_context(context_course::instance($course->id));
3406acde
SH
2880 $coursenode = $this->add_course($course);
2881 $this->add_course_essentials($coursenode, $course);
2882 $sections = $this->load_course_sections($course, $coursenode);
e26507b3
SH
2883 list($sectionarray, $activities) = $this->generate_sections_and_activities($course);
2884 $this->load_section_activities($sections[$course->sectionnumber]->sectionnode, $course->sectionnumber, $activities);
7d2a0492 2885 break;
507a7a9a 2886 case self::TYPE_ACTIVITY :
c78262b5
SH
2887 $sql = "SELECT c.*
2888 FROM {course} c
2889 JOIN {course_modules} cm ON cm.course = c.id
2890 WHERE cm.id = :cmid";
2891 $params = array('cmid' => $this->instanceid);
2892 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
f0dcc212
SH
2893 $modinfo = get_fast_modinfo($course);
2894 $cm = $modinfo->get_cm($this->instanceid);
04bcd1ce 2895 require_course_login($course, true, $cm, false, true);
b0c6dc1c 2896 $this->page->set_context(context_module::instance($cm->id));
3406acde 2897 $coursenode = $this->load_course($course);
98556b23 2898 if ($course->id == $SITE->id) {
1aa1e9b5
SH
2899 $modulenode = $this->load_activity($cm, $course, $coursenode->find($cm->id, self::TYPE_ACTIVITY));
2900 } else {
c78262b5 2901 $sections = $this->load_course_sections($course, $coursenode);
e26507b3
SH
2902 list($sectionarray, $activities) = $this->generate_sections_and_activities($course);
2903 $activities = $this->load_section_activities($sections[$cm->sectionnum]->sectionnode, $cm->sectionnum, $activities);
1aa1e9b5
SH
2904 $modulenode = $this->load_activity($cm, $course, $activities[$cm->id]);
2905 }
7d2a0492 2906 break;
507a7a9a 2907 default:
3406acde 2908 throw new Exception('Unknown type');
507a7a9a 2909 return $this->expandable;
7d2a0492 2910 }
588a3953 2911
98556b23 2912 if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) {
588a3953
SH
2913 $this->load_for_user(null, true);
2914 }
2915
507a7a9a 2916 $this->find_expandable($this->expandable);
507a7a9a 2917 return $this->expandable;
246a9b05
SH
2918 }
2919
d4bb6462
SH
2920 /**
2921 * Loads a single category into the AJAX navigation.
2922 *
2923 * This function is special in that it doesn't concern itself with the parent of
2924 * the requested category or its siblings.
2925 * This is because with the AJAX navigation we know exactly what is wanted and only need to
2926 * request that.
2927 *
2928 * @global moodle_database $DB
2929 * @param int $categoryid
2930 */
2931 protected function load_category($categoryid) {
2932 global $CFG, $DB;
2933
2934 $limit = 20;
2935 if (!empty($CFG->navcourselimit)) {
2936 $limit = (int)$CFG->navcourselimit;
2937 }
2938
2939 $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
2940 $sql = "SELECT cc.*, $catcontextsql
2941 FROM {course_categories} cc
2942 JOIN {context} ctx ON cc.id = ctx.instanceid
2943 WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND
2944 (cc.id = :categoryid1 OR cc.parent = :categoryid2)
957983b7 2945 ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
d4bb6462
SH
2946 $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2947 $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2948 $subcategories = array();
2949 $basecategory = null;
2950 foreach ($categories as $category) {
2951 context_helper::preload_from_record($category);
2952 if ($category->id == $categoryid) {
2953 $this->add_category($category, $this);
2954 $basecategory = $this->addedcategories[$category->id];
2955 } else {
2956 $subcategories[] = $category;
2957 }
2958 }
2959 $categories->close();
2960
2961 if (!is_null($basecategory)) {
2962 //echo "<pre>".print_r($subcategories, true).'</pre>';
2963 foreach ($subcategories as $category) {
2964 $this->add_category($category, $basecategory);
2965 }
2966 }
2967
98556b23 2968 $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
d4bb6462
SH
2969 foreach ($courses as $course) {
2970 $this->add_course($course);
2971 }
2972 $courses->close();
2973 }
2974
deaf04c7
SH
2975 /**
2976 * Returns an array of expandable nodes
2977 * @return array
2978 */
246a9b05
SH
2979 public function get_expandable() {
2980 return $this->expandable;
7d2a0492 2981 }
7d2a0492 2982}
2983
2984/**
2985 * Navbar class
2986 *
2987 * This class is used to manage the navbar, which is initialised from the navigation
2988 * object held by PAGE
2989 *
31fde54f
AG
2990 * @package core
2991 * @category navigation
7d2a0492 2992 * @copyright 2009 Sam Hemelryk
2993 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2994 */
2995class navbar extends navigation_node {
31fde54f 2996 /** @var bool A switch for whether the navbar is initialised or not */
7d2a0492 2997 protected $initialised = false;
31fde54f 2998 /** @var mixed keys used to reference the nodes on the navbar */
7d2a0492 2999 protected $keys = array();
31fde54f 3000 /** @var null|string content of the navbar */
7d2a0492 3001 protected $content = null;
31fde54f 3002 /** @var moodle_page object the moodle page that this navbar belongs to */
7d2a0492 3003 protected $page;
31fde54f 3004 /** @var bool A switch for whether to ignore the active navigation information */
31759089 3005 protected $ignoreactive = false;
31fde54f 3006 /** @var bool A switch to let us know if we are in the middle of an install */
7d2a0492 3007 protected $duringinstall = false;
31fde54f 3008 /** @var bool A switch for whether the navbar has items */
7a7e209d 3009 protected $hasitems = false;
31fde54f 3010 /** @var array An array of navigation nodes for the navbar */
3406acde 3011 protected $items;
31fde54f 3012 /** @var array An array of child node objects */
3406acde 3013 public $children = array();
31fde54f 3014 /** @var bool A switch for whether we want to include the root node in the navbar */
4d5059d4 3015 public $includesettingsbase = false;
7d2a0492 3016 /**
3017 * The almighty constructor
3406acde
SH
3018 *
3019 * @param moodle_page $page
7d2a0492 3020 */
3406acde 3021 public function __construct(moodle_page $page) {
507a7a9a 3022 global $CFG;
7d2a0492 3023 if (during_initial_install()) {
3024 $this->duringinstall = true;
3025 return false;
3026 }
3027 $this->page = $page;
3028 $this->text = get_string('home');
3029 $this->shorttext = get_string('home');
3030 $this->action = new moodle_url($CFG->wwwroot);
3031 $this->nodetype = self::NODETYPE_BRANCH;
3032 $this->type = self::TYPE_SYSTEM;
3033 }
3034
3035 /**
3036 * Quick check to see if the navbar will have items in.
3037 *
3038 * @return bool Returns true if the navbar will have items, false otherwise
3039 */
3040 public function has_items() {
3041 if ($this->duringinstall) {
3042 return false;
7a7e209d
SH
3043 } else if ($this->hasitems !== false) {
3044 return true;
7d2a0492 3045 }
3406acde 3046 $this->page->navigation->initialise($this->page);
bf6c37c7 3047
7a7e209d 3048 $activenodefound = ($this->page->navigation->contains_active_node() ||
3406acde 3049 $this->page->settingsnav->contains_active_node());
bf6c37c7 3050
3406acde 3051 $outcome = (count($this->children)>0 || (!$this->ignoreactive && $activenodefound));
7a7e209d 3052 $this->hasitems = $outcome;
bf6c37c7 3053 return $outcome;
31759089 3054 }
3055
3406acde
SH
3056 /**
3057 * Turn on/off ignore active
3058 *
3059 * @param bool $setting
3060 */
31759089 3061 public function ignore_active($setting=true) {
3062 $this->ignoreactive = ($setting);
7d2a0492 3063 }
31fde54f
AG
3064
3065 /**
3066 * Gets a navigation node
3067 *
3068 * @param string|int $key for referencing the navbar nodes
3069 * @param int $type navigation_node::TYPE_*
3070 * @return navigation_node|bool
3071 */
3406acde
SH
3072 public function get($key, $type = null) {
3073 foreach ($this->children as &$child) {
3074 if ($child->key === $key && ($type == null || $type == $child->type)) {
3075 return $child;
3076 }
3077 }
3078 return false;
3079 }
7d2a0492 3080 /**
3406acde 3081 * Returns an array of navigation_node's that make up the navbar.
435a512e 3082 *
3406acde 3083 * @return array
7d2a0492 3084 */
3406acde
SH
3085 public function get_items() {
3086 $items = array();
7d2a0492 3087 // Make sure that navigation is initialised
7a7e209d 3088 if (!$this->has_items()) {
3406acde 3089 return $items;