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