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