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