lib/navigationlib.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * This file contains classes used to manage the navigation structures within Moodle.
  19  *
  20  * @since      Moodle 2.0
  21  * @package    core
  22  * @copyright  2009 Sam Hemelryk
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 /**
  29  * The name that will be used to separate the navigation cache within SESSION
  30  */
  31 define('NAVIGATION_CACHE_NAME', 'navigation');
  32 define('NAVIGATION_SITE_ADMIN_CACHE_NAME', 'navigationsiteadmin');
  33
  34 /**
  35  * This class is used to represent a node in a navigation tree
  36  *
  37  * This class is used to represent a node in a navigation tree within Moodle,
  38  * the tree could be one of global navigation, settings navigation, or the navbar.
  39  * Each node can be one of two types either a Leaf (default) or a branch.
  40  * When a node is first created it is created as a leaf, when/if children are added
  41  * the node then becomes a branch.
  42  *
  43  * @package   core
  44  * @category  navigation
  45  * @copyright 2009 Sam Hemelryk
  46  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  47  */
  48 class navigation_node implements renderable {
  49     /** @var int Used to identify this node a leaf (default) 0 */
  50     const NODETYPE_LEAF =   0;
  51     /** @var int Used to identify this node a branch, happens with children  1 */
  52     const NODETYPE_BRANCH = 1;
  53     /** @var null Unknown node type null */
  54     const TYPE_UNKNOWN =    null;
  55     /** @var int System node type 0 */
  56     const TYPE_ROOTNODE =   0;
  57     /** @var int System node type 1 */
  58     const TYPE_SYSTEM =     1;
  59     /** @var int Category node type 10 */
  60     const TYPE_CATEGORY =   10;
  61     /** var int Category displayed in MyHome navigation node */
  62     const TYPE_MY_CATEGORY = 11;
  63     /** @var int Course node type 20 */
  64     const TYPE_COURSE =     20;
  65     /** @var int Course Structure node type 30 */
  66     const TYPE_SECTION =    30;
  67     /** @var int Activity node type, e.g. Forum, Quiz 40 */
  68     const TYPE_ACTIVITY =   40;
  69     /** @var int Resource node type, e.g. Link to a file, or label 50 */
  70     const TYPE_RESOURCE =   50;
  71     /** @var int A custom node type, default when adding without specifing type 60 */
  72     const TYPE_CUSTOM =     60;
  73     /** @var int Setting node type, used only within settings nav 70 */
  74     const TYPE_SETTING =    70;
  75     /** @var int site admin branch node type, used only within settings nav 71 */
  76     const TYPE_SITE_ADMIN = 71;
  77     /** @var int Setting node type, used only within settings nav 80 */
  78     const TYPE_USER =       80;
  79     /** @var int Setting node type, used for containers of no importance 90 */
  80     const TYPE_CONTAINER =  90;
  81     /** var int Course the current user is not enrolled in */
  82     const COURSE_OTHER = 0;
  83     /** var int Course the current user is enrolled in but not viewing */
  84     const COURSE_MY = 1;
  85     /** var int Course the current user is currently viewing */
  86     const COURSE_CURRENT = 2;
  87
  88     /** @var int Parameter to aid the coder in tracking [optional] */
  89     public $id = null;
  90     /** @var string|int The identifier for the node, used to retrieve the node */
  91     public $key = null;
  92     /** @var string The text to use for the node */
  93     public $text = null;
  94     /** @var string Short text to use if requested [optional] */
  95     public $shorttext = null;
  96     /** @var string The title attribute for an action if one is defined */
  97     public $title = null;
  98     /** @var string A string that can be used to build a help button */
  99     public $helpbutton = null;
 100     /** @var moodle_url|action_link|null An action for the node (link) */
 101     public $action = null;
 102     /** @var pix_icon The path to an icon to use for this node */
 103     public $icon = null;
 104     /** @var int See TYPE_* constants defined for this class */
 105     public $type = self::TYPE_UNKNOWN;
 106     /** @var int See NODETYPE_* constants defined for this class */
 107     public $nodetype = self::NODETYPE_LEAF;
 108     /** @var bool If set to true the node will be collapsed by default */
 109     public $collapse = false;
 110     /** @var bool If set to true the node will be expanded by default */
 111     public $forceopen = false;
 112     /** @var array An array of CSS classes for the node */
 113     public $classes = array();
 114     /** @var navigation_node_collection An array of child nodes */
 115     public $children = array();
 116     /** @var bool If set to true the node will be recognised as active */
 117     public $isactive = false;
 118     /** @var bool If set to true the node will be dimmed */
 119     public $hidden = false;
 120     /** @var bool If set to false the node will not be displayed */
 121     public $display = true;
 122     /** @var bool If set to true then an HR will be printed before the node */
 123     public $preceedwithhr = false;
 124     /** @var bool If set to true the the navigation bar should ignore this node */
 125     public $mainnavonly = false;
 126     /** @var bool If set to true a title will be added to the action no matter what */
 127     public $forcetitle = false;
 128     /** @var navigation_node A reference to the node parent, you should never set this directly you should always call set_parent */
 129     public $parent = null;
 130     /** @var bool Override to not display the icon even if one is provided **/
 131     public $hideicon = false;
 132     /** @var bool Set to true if we KNOW that this node can be expanded.  */
 133     public $isexpandable = false;
 134     /** @var array */
 135     protected $namedtypes = array(0=>'system',10=>'category',20=>'course',30=>'structure',40=>'activity',50=>'resource',60=>'custom',70=>'setting',71=>'siteadmin', 80=>'user');
 136     /** @var moodle_url */
 137     protected static $fullmeurl = null;
 138     /** @var bool toogles auto matching of active node */
 139     public static $autofindactive = true;
 140     /** @var bool should we load full admin tree or rely on AJAX for performance reasons */
 141     protected static $loadadmintree = false;
 142     /** @var mixed If set to an int, that section will be included even if it has no activities */
 143     public $includesectionnum = false;
 144
 145     /**
 146      * Constructs a new navigation_node
 147      *
 148      * @param array|string $properties Either an array of properties or a string to use
 149      *                     as the text for the node
 150      */
 151     public function __construct($properties) {
 152         if (is_array($properties)) {
 153             // Check the array for each property that we allow to set at construction.
 154             // text         - The main content for the node
 155             // shorttext    - A short text if required for the node
 156             // icon         - The icon to display for the node
 157             // type         - The type of the node
 158             // key          - The key to use to identify the node
 159             // parent       - A reference to the nodes parent
 160             // action       - The action to attribute to this node, usually a URL to link to
 161             if (array_key_exists('text', $properties)) {
 162                 $this->text = $properties['text'];
 163             }
 164             if (array_key_exists('shorttext', $properties)) {
 165                 $this->shorttext = $properties['shorttext'];
 166             }
 167             if (!array_key_exists('icon', $properties)) {
 168                 $properties['icon'] = new pix_icon('i/navigationitem', '');
 169             }
 170             $this->icon = $properties['icon'];
 171             if ($this->icon instanceof pix_icon) {
 172                 if (empty($this->icon->attributes['class'])) {
 173                     $this->icon->attributes['class'] = 'navicon';
 174                 } else {
 175                     $this->icon->attributes['class'] .= ' navicon';
 176                 }
 177             }
 178             if (array_key_exists('type', $properties)) {
 179                 $this->type = $properties['type'];
 180             } else {
 181                 $this->type = self::TYPE_CUSTOM;
 182             }
 183             if (array_key_exists('key', $properties)) {
 184                 $this->key = $properties['key'];
 185             }
 186             // This needs to happen last because of the check_if_active call that occurs
 187             if (array_key_exists('action', $properties)) {
 188                 $this->action = $properties['action'];
 189                 if (is_string($this->action)) {
 190                     $this->action = new moodle_url($this->action);
 191                 }
 192                 if (self::$autofindactive) {
 193                     $this->check_if_active();
 194                 }
 195             }
 196             if (array_key_exists('parent', $properties)) {
 197                 $this->set_parent($properties['parent']);
 198             }
 199         } else if (is_string($properties)) {
 200             $this->text = $properties;
 201         }
 202         if ($this->text === null) {
 203             throw new coding_exception('You must set the text for the node when you create it.');
 204         }
 205         // Instantiate a new navigation node collection for this nodes children
 206         $this->children = new navigation_node_collection();
 207     }
 208
 209     /**
 210      * Checks if this node is the active node.
 211      *
 212      * This is determined by comparing the action for the node against the
 213      * defined URL for the page. A match will see this node marked as active.
 214      *
 215      * @param int $strength One of URL_MATCH_EXACT, URL_MATCH_PARAMS, or URL_MATCH_BASE
 216      * @return bool
 217      */
 218     public function check_if_active($strength=URL_MATCH_EXACT) {
 219         global $FULLME, $PAGE;
 220         // Set fullmeurl if it hasn't already been set
 221         if (self::$fullmeurl == null) {
 222             if ($PAGE->has_set_url()) {
 223                 self::override_active_url(new moodle_url($PAGE->url));
 224             } else {
 225                 self::override_active_url(new moodle_url($FULLME));
 226             }
 227         }
 228
 229         // Compare the action of this node against the fullmeurl
 230         if ($this->action instanceof moodle_url && $this->action->compare(self::$fullmeurl, $strength)) {
 231             $this->make_active();
 232             return true;
 233         }
 234         return false;
 235     }
 236
 237     /**
 238      * This sets the URL that the URL of new nodes get compared to when locating
 239      * the active node.
 240      *
 241      * The active node is the node that matches the URL set here. By default this
 242      * is either $PAGE->url or if that hasn't been set $FULLME.
 243      *
 244      * @param moodle_url $url The url to use for the fullmeurl.
 245      * @param bool $loadadmintree use true if the URL point to administration tree
 246      */
 247     public static function override_active_url(moodle_url $url, $loadadmintree = false) {
 248         // Clone the URL, in case the calling script changes their URL later.
 249         self::$fullmeurl = new moodle_url($url);
 250         // True means we do not want AJAX loaded admin tree, required for all admin pages.
 251         if ($loadadmintree) {
 252             // Do not change back to false if already set.
 253             self::$loadadmintree = true;
 254         }
 255     }
 256
 257     /**
 258      * Use when page is linked from the admin tree,
 259      * if not used navigation could not find the page using current URL
 260      * because the tree is not fully loaded.
 261      */
 262     public static function require_admin_tree() {
 263         self::$loadadmintree = true;
 264     }
 265
 266     /**
 267      * Creates a navigation node, ready to add it as a child using add_node
 268      * function. (The created node needs to be added before you can use it.)
 269      * @param string $text
 270      * @param moodle_url|action_link $action
 271      * @param int $type
 272      * @param string $shorttext
 273      * @param string|int $key
 274      * @param pix_icon $icon
 275      * @return navigation_node
 276      */
 277     public static function create($text, $action=null, $type=self::TYPE_CUSTOM,
 278             $shorttext=null, $key=null, pix_icon $icon=null) {
 279         // Properties array used when creating the new navigation node
 280         $itemarray = array(
 281             'text' => $text,
 282             'type' => $type
 283         );
 284         // Set the action if one was provided
 285         if ($action!==null) {
 286             $itemarray['action'] = $action;
 287         }
 288         // Set the shorttext if one was provided
 289         if ($shorttext!==null) {
 290             $itemarray['shorttext'] = $shorttext;
 291         }
 292         // Set the icon if one was provided
 293         if ($icon!==null) {
 294             $itemarray['icon'] = $icon;
 295         }
 296         // Set the key
 297         $itemarray['key'] = $key;
 298         // Construct and return
 299         return new navigation_node($itemarray);
 300     }
 301
 302     /**
 303      * Adds a navigation node as a child of this node.
 304      *
 305      * @param string $text
 306      * @param moodle_url|action_link $action
 307      * @param int $type
 308      * @param string $shorttext
 309      * @param string|int $key
 310      * @param pix_icon $icon
 311      * @return navigation_node
 312      */
 313     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
 314         // Create child node
 315         $childnode = self::create($text, $action, $type, $shorttext, $key, $icon);
 316
 317         // Add the child to end and return
 318         return $this->add_node($childnode);
 319     }
 320
 321     /**
 322      * Adds a navigation node as a child of this one, given a $node object
 323      * created using the create function.
 324      * @param navigation_node $childnode Node to add
 325      * @param string $beforekey
 326      * @return navigation_node The added node
 327      */
 328     public function add_node(navigation_node $childnode, $beforekey=null) {
 329         // First convert the nodetype for this node to a branch as it will now have children
 330         if ($this->nodetype !== self::NODETYPE_BRANCH) {
 331             $this->nodetype = self::NODETYPE_BRANCH;
 332         }
 333         // Set the parent to this node
 334         $childnode->set_parent($this);
 335
 336         // Default the key to the number of children if not provided
 337         if ($childnode->key === null) {
 338             $childnode->key = $this->children->count();
 339         }
 340
 341         // Add the child using the navigation_node_collections add method
 342         $node = $this->children->add($childnode, $beforekey);
 343
 344         // If added node is a category node or the user is logged in and it's a course
 345         // then mark added node as a branch (makes it expandable by AJAX)
 346         $type = $childnode->type;
 347         if (($type == self::TYPE_CATEGORY) || (isloggedin() && ($type == self::TYPE_COURSE)) || ($type == self::TYPE_MY_CATEGORY) ||
 348                 ($type === self::TYPE_SITE_ADMIN)) {
 349             $node->nodetype = self::NODETYPE_BRANCH;
 350         }
 351         // If this node is hidden mark it's children as hidden also
 352         if ($this->hidden) {
 353             $node->hidden = true;
 354         }
 355         // Return added node (reference returned by $this->children->add()
 356         return $node;
 357     }
 358
 359     /**
 360      * Return a list of all the keys of all the child nodes.
 361      * @return array the keys.
 362      */
 363     public function get_children_key_list() {
 364         return $this->children->get_key_list();
 365     }
 366
 367     /**
 368      * Searches for a node of the given type with the given key.
 369      *
 370      * This searches this node plus all of its children, and their children....
 371      * If you know the node you are looking for is a child of this node then please
 372      * use the get method instead.
 373      *
 374      * @param int|string $key The key of the node we are looking for
 375      * @param int $type One of navigation_node::TYPE_*
 376      * @return navigation_node|false
 377      */
 378     public function find($key, $type) {
 379         return $this->children->find($key, $type);
 380     }
 381
 382     /**
 383      * Get the child of this node that has the given key + (optional) type.
 384      *
 385      * If you are looking for a node and want to search all children + thier children
 386      * then please use the find method instead.
 387      *
 388      * @param int|string $key The key of the node we are looking for
 389      * @param int $type One of navigation_node::TYPE_*
 390      * @return navigation_node|false
 391      */
 392     public function get($key, $type=null) {
 393         return $this->children->get($key, $type);
 394     }
 395
 396     /**
 397      * Removes this node.
 398      *
 399      * @return bool
 400      */
 401     public function remove() {
 402         return $this->parent->children->remove($this->key, $this->type);
 403     }
 404
 405     /**
 406      * Checks if this node has or could have any children
 407      *
 408      * @return bool Returns true if it has children or could have (by AJAX expansion)
 409      */
 410     public function has_children() {
 411         return ($this->nodetype === navigation_node::NODETYPE_BRANCH || $this->children->count()>0 || $this->isexpandable);
 412     }
 413
 414     /**
 415      * Marks this node as active and forces it open.
 416      *
 417      * Important: If you are here because you need to mark a node active to get
 418      * the navigation to do what you want have you looked at {@link navigation_node::override_active_url()}?
 419      * You can use it to specify a different URL to match the active navigation node on
 420      * rather than having to locate and manually mark a node active.
 421      */
 422     public function make_active() {
 423         $this->isactive = true;
 424         $this->add_class('active_tree_node');
 425         $this->force_open();
 426         if ($this->parent !== null) {
 427             $this->parent->make_inactive();
 428         }
 429     }
 430
 431     /**
 432      * Marks a node as inactive and recusised back to the base of the tree
 433      * doing the same to all parents.
 434      */
 435     public function make_inactive() {
 436         $this->isactive = false;
 437         $this->remove_class('active_tree_node');
 438         if ($this->parent !== null) {
 439             $this->parent->make_inactive();
 440         }
 441     }
 442
 443     /**
 444      * Forces this node to be open and at the same time forces open all
 445      * parents until the root node.
 446      *
 447      * Recursive.
 448      */
 449     public function force_open() {
 450         $this->forceopen = true;
 451         if ($this->parent !== null) {
 452             $this->parent->force_open();
 453         }
 454     }
 455
 456     /**
 457      * Adds a CSS class to this node.
 458      *
 459      * @param string $class
 460      * @return bool
 461      */
 462     public function add_class($class) {
 463         if (!in_array($class, $this->classes)) {
 464             $this->classes[] = $class;
 465         }
 466         return true;
 467     }
 468
 469     /**
 470      * Removes a CSS class from this node.
 471      *
 472      * @param string $class
 473      * @return bool True if the class was successfully removed.
 474      */
 475     public function remove_class($class) {
 476         if (in_array($class, $this->classes)) {
 477             $key = array_search($class,$this->classes);
 478             if ($key!==false) {
 479                 unset($this->classes[$key]);
 480                 return true;
 481             }
 482         }
 483         return false;
 484     }
 485
 486     /**
 487      * Sets the title for this node and forces Moodle to utilise it.
 488      * @param string $title
 489      */
 490     public function title($title) {
 491         $this->title = $title;
 492         $this->forcetitle = true;
 493     }
 494
 495     /**
 496      * Resets the page specific information on this node if it is being unserialised.
 497      */
 498     public function __wakeup(){
 499         $this->forceopen = false;
 500         $this->isactive = false;
 501         $this->remove_class('active_tree_node');
 502     }
 503
 504     /**
 505      * Checks if this node or any of its children contain the active node.
 506      *
 507      * Recursive.
 508      *
 509      * @return bool
 510      */
 511     public function contains_active_node() {
 512         if ($this->isactive) {
 513             return true;
 514         } else {
 515             foreach ($this->children as $child) {
 516                 if ($child->isactive || $child->contains_active_node()) {
 517                     return true;
 518                 }
 519             }
 520         }
 521         return false;
 522     }
 523
 524     /**
 525      * Finds the active node.
 526      *
 527      * Searches this nodes children plus all of the children for the active node
 528      * and returns it if found.
 529      *
 530      * Recursive.
 531      *
 532      * @return navigation_node|false
 533      */
 534     public function find_active_node() {
 535         if ($this->isactive) {
 536             return $this;
 537         } else {
 538             foreach ($this->children as &$child) {
 539                 $outcome = $child->find_active_node();
 540                 if ($outcome !== false) {
 541                     return $outcome;
 542                 }
 543             }
 544         }
 545         return false;
 546     }
 547
 548     /**
 549      * Searches all children for the best matching active node
 550      * @return navigation_node|false
 551      */
 552     public function search_for_active_node() {
 553         if ($this->check_if_active(URL_MATCH_BASE)) {
 554             return $this;
 555         } else {
 556             foreach ($this->children as &$child) {
 557                 $outcome = $child->search_for_active_node();
 558                 if ($outcome !== false) {
 559                     return $outcome;
 560                 }
 561             }
 562         }
 563         return false;
 564     }
 565
 566     /**
 567      * Gets the content for this node.
 568      *
 569      * @param bool $shorttext If true shorttext is used rather than the normal text
 570      * @return string
 571      */
 572     public function get_content($shorttext=false) {
 573         if ($shorttext && $this->shorttext!==null) {
 574             return format_string($this->shorttext);
 575         } else {
 576             return format_string($this->text);
 577         }
 578     }
 579
 580     /**
 581      * Gets the title to use for this node.
 582      *
 583      * @return string
 584      */
 585     public function get_title() {
 586         if ($this->forcetitle || $this->action != null){
 587             return $this->title;
 588         } else {
 589             return '';
 590         }
 591     }
 592
 593     /**
 594      * Gets the CSS class to add to this node to describe its type
 595      *
 596      * @return string
 597      */
 598     public function get_css_type() {
 599         if (array_key_exists($this->type, $this->namedtypes)) {
 600             return 'type_'.$this->namedtypes[$this->type];
 601         }
 602         return 'type_unknown';
 603     }
 604
 605     /**
 606      * Finds all nodes that are expandable by AJAX
 607      *
 608      * @param array $expandable An array by reference to populate with expandable nodes.
 609      */
 610     public function find_expandable(array &$expandable) {
 611         foreach ($this->children as &$child) {
 612             if ($child->display && $child->has_children() && $child->children->count() == 0) {
 613                 $child->id = 'expandable_branch_'.$child->type.'_'.clean_param($child->key, PARAM_ALPHANUMEXT);
 614                 $this->add_class('canexpand');
 615                 $expandable[] = array('id' => $child->id, 'key' => $child->key, 'type' => $child->type);
 616             }
 617             $child->find_expandable($expandable);
 618         }
 619     }
 620
 621     /**
 622      * Finds all nodes of a given type (recursive)
 623      *
 624      * @param int $type One of navigation_node::TYPE_*
 625      * @return array
 626      */
 627     public function find_all_of_type($type) {
 628         $nodes = $this->children->type($type);
 629         foreach ($this->children as &$node) {
 630             $childnodes = $node->find_all_of_type($type);
 631             $nodes = array_merge($nodes, $childnodes);
 632         }
 633         return $nodes;
 634     }
 635
 636     /**
 637      * Removes this node if it is empty
 638      */
 639     public function trim_if_empty() {
 640         if ($this->children->count() == 0) {
 641             $this->remove();
 642         }
 643     }
 644
 645     /**
 646      * Creates a tab representation of this nodes children that can be used
 647      * with print_tabs to produce the tabs on a page.
 648      *
 649      * call_user_func_array('print_tabs', $node->get_tabs_array());
 650      *
 651      * @param array $inactive
 652      * @param bool $return
 653      * @return array Array (tabs, selected, inactive, activated, return)
 654      */
 655     public function get_tabs_array(array $inactive=array(), $return=false) {
 656         $tabs = array();
 657         $rows = array();
 658         $selected = null;
 659         $activated = array();
 660         foreach ($this->children as $node) {
 661             $tabs[] = new tabobject($node->key, $node->action, $node->get_content(), $node->get_title());
 662             if ($node->contains_active_node()) {
 663                 if ($node->children->count() > 0) {
 664                     $activated[] = $node->key;
 665                     foreach ($node->children as $child) {
 666                         if ($child->contains_active_node()) {
 667                             $selected = $child->key;
 668                         }
 669                         $rows[] = new tabobject($child->key, $child->action, $child->get_content(), $child->get_title());
 670                     }
 671                 } else {
 672                     $selected = $node->key;
 673                 }
 674             }
 675         }
 676         return array(array($tabs, $rows), $selected, $inactive, $activated, $return);
 677     }
 678
 679     /**
 680      * Sets the parent for this node and if this node is active ensures that the tree is properly
 681      * adjusted as well.
 682      *
 683      * @param navigation_node $parent
 684      */
 685     public function set_parent(navigation_node $parent) {
 686         // Set the parent (thats the easy part)
 687         $this->parent = $parent;
 688         // Check if this node is active (this is checked during construction)
 689         if ($this->isactive) {
 690             // Force all of the parent nodes open so you can see this node
 691             $this->parent->force_open();
 692             // Make all parents inactive so that its clear where we are.
 693             $this->parent->make_inactive();
 694         }
 695     }
 696
 697     /**
 698      * Hides the node and any children it has.
 699      *
 700      * @since Moodle 2.5
 701      * @param array $typestohide Optional. An array of node types that should be hidden.
 702      *      If null all nodes will be hidden.
 703      *      If an array is given then nodes will only be hidden if their type mtatches an element in the array.
 704      *          e.g. array(navigation_node::TYPE_COURSE) would hide only course nodes.
 705      */
 706     public function hide(array $typestohide = null) {
 707         if ($typestohide === null || in_array($this->type, $typestohide)) {
 708             $this->display = false;
 709             if ($this->has_children()) {
 710                 foreach ($this->children as $child) {
 711                     $child->hide($typestohide);
 712                 }
 713             }
 714         }
 715     }
 716 }
 717
 718 /**
 719  * Navigation node collection
 720  *
 721  * This class is responsible for managing a collection of navigation nodes.
 722  * It is required because a node's unique identifier is a combination of both its
 723  * key and its type.
 724  *
 725  * Originally an array was used with a string key that was a combination of the two
 726  * however it was decided that a better solution would be to use a class that
 727  * implements the standard IteratorAggregate interface.
 728  *
 729  * @package   core
 730  * @category  navigation
 731  * @copyright 2010 Sam Hemelryk
 732  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 733  */
 734 class navigation_node_collection implements IteratorAggregate {
 735     /**
 736      * A multidimensional array to where the first key is the type and the second
 737      * key is the nodes key.
 738      * @var array
 739      */
 740     protected $collection = array();
 741     /**
 742      * An array that contains references to nodes in the same order they were added.
 743      * This is maintained as a progressive array.
 744      * @var array
 745      */
 746     protected $orderedcollection = array();
 747     /**
 748      * A reference to the last node that was added to the collection
 749      * @var navigation_node
 750      */
 751     protected $last = null;
 752     /**
 753      * The total number of items added to this array.
 754      * @var int
 755      */
 756     protected $count = 0;
 757
 758     /**
 759      * Adds a navigation node to the collection
 760      *
 761      * @param navigation_node $node Node to add
 762      * @param string $beforekey If specified, adds before a node with this key,
 763      *   otherwise adds at end
 764      * @return navigation_node Added node
 765      */
 766     public function add(navigation_node $node, $beforekey=null) {
 767         global $CFG;
 768         $key = $node->key;
 769         $type = $node->type;
 770
 771         // First check we have a 2nd dimension for this type
 772         if (!array_key_exists($type, $this->orderedcollection)) {
 773             $this->orderedcollection[$type] = array();
 774         }
 775         // Check for a collision and report if debugging is turned on
 776         if ($CFG->debug && array_key_exists($key, $this->orderedcollection[$type])) {
 777             debugging('Navigation node intersect: Adding a node that already exists '.$key, DEBUG_DEVELOPER);
 778         }
 779
 780         // Find the key to add before
 781         $newindex = $this->count;
 782         $last = true;
 783         if ($beforekey !== null) {
 784             foreach ($this->collection as $index => $othernode) {
 785                 if ($othernode->key === $beforekey) {
 786                     $newindex = $index;
 787                     $last = false;
 788                     break;
 789                 }
 790             }
 791             if ($newindex === $this->count) {
 792                 debugging('Navigation node add_before: Reference node not found ' . $beforekey .
 793                         ', options: ' . implode(' ', $this->get_key_list()), DEBUG_DEVELOPER);
 794             }
 795         }
 796
 797         // Add the node to the appropriate place in the by-type structure (which
 798         // is not ordered, despite the variable name)
 799         $this->orderedcollection[$type][$key] = $node;
 800         if (!$last) {
 801             // Update existing references in the ordered collection (which is the
 802             // one that isn't called 'ordered') to shuffle them along if required
 803             for ($oldindex = $this->count; $oldindex > $newindex; $oldindex--) {
 804                 $this->collection[$oldindex] = $this->collection[$oldindex - 1];
 805             }
 806         }
 807         // Add a reference to the node to the progressive collection.
 808         $this->collection[$newindex] = $this->orderedcollection[$type][$key];
 809         // Update the last property to a reference to this new node.
 810         $this->last = $this->orderedcollection[$type][$key];
 811
 812         // Reorder the array by index if needed
 813         if (!$last) {
 814             ksort($this->collection);
 815         }
 816         $this->count++;
 817         // Return the reference to the now added node
 818         return $node;
 819     }
 820
 821     /**
 822      * Return a list of all the keys of all the nodes.
 823      * @return array the keys.
 824      */
 825     public function get_key_list() {
 826         $keys = array();
 827         foreach ($this->collection as $node) {
 828             $keys[] = $node->key;
 829         }
 830         return $keys;
 831     }
 832
 833     /**
 834      * Fetches a node from this collection.
 835      *
 836      * @param string|int $key The key of the node we want to find.
 837      * @param int $type One of navigation_node::TYPE_*.
 838      * @return navigation_node|null
 839      */
 840     public function get($key, $type=null) {
 841         if ($type !== null) {
 842             // If the type is known then we can simply check and fetch
 843             if (!empty($this->orderedcollection[$type][$key])) {
 844                 return $this->orderedcollection[$type][$key];
 845             }
 846         } else {
 847             // Because we don't know the type we look in the progressive array
 848             foreach ($this->collection as $node) {
 849                 if ($node->key === $key) {
 850                     return $node;
 851                 }
 852             }
 853         }
 854         return false;
 855     }
 856
 857     /**
 858      * Searches for a node with matching key and type.
 859      *
 860      * This function searches both the nodes in this collection and all of
 861      * the nodes in each collection belonging to the nodes in this collection.
 862      *
 863      * Recursive.
 864      *
 865      * @param string|int $key  The key of the node we want to find.
 866      * @param int $type  One of navigation_node::TYPE_*.
 867      * @return navigation_node|null
 868      */
 869     public function find($key, $type=null) {
 870         if ($type !== null && array_key_exists($type, $this->orderedcollection) && array_key_exists($key, $this->orderedcollection[$type])) {
 871             return $this->orderedcollection[$type][$key];
 872         } else {
 873             $nodes = $this->getIterator();
 874             // Search immediate children first
 875             foreach ($nodes as &$node) {
 876                 if ($node->key === $key && ($type === null || $type === $node->type)) {
 877                     return $node;
 878                 }
 879             }
 880             // Now search each childs children
 881             foreach ($nodes as &$node) {
 882                 $result = $node->children->find($key, $type);
 883                 if ($result !== false) {
 884                     return $result;
 885                 }
 886             }
 887         }
 888         return false;
 889     }
 890
 891     /**
 892      * Fetches the last node that was added to this collection
 893      *
 894      * @return navigation_node
 895      */
 896     public function last() {
 897         return $this->last;
 898     }
 899
 900     /**
 901      * Fetches all nodes of a given type from this collection
 902      *
 903      * @param string|int $type  node type being searched for.
 904      * @return array ordered collection
 905      */
 906     public function type($type) {
 907         if (!array_key_exists($type, $this->orderedcollection)) {
 908             $this->orderedcollection[$type] = array();
 909         }
 910         return $this->orderedcollection[$type];
 911     }
 912     /**
 913      * Removes the node with the given key and type from the collection
 914      *
 915      * @param string|int $key The key of the node we want to find.
 916      * @param int $type
 917      * @return bool
 918      */
 919     public function remove($key, $type=null) {
 920         $child = $this->get($key, $type);
 921         if ($child !== false) {
 922             foreach ($this->collection as $colkey => $node) {
 923                 if ($node->key === $key && $node->type == $type) {
 924                     unset($this->collection[$colkey]);
 925                     $this->collection = array_values($this->collection);
 926                     break;
 927                 }
 928             }
 929             unset($this->orderedcollection[$child->type][$child->key]);
 930             $this->count--;
 931             return true;
 932         }
 933         return false;
 934     }
 935
 936     /**
 937      * Gets the number of nodes in this collection
 938      *
 939      * This option uses an internal count rather than counting the actual options to avoid
 940      * a performance hit through the count function.
 941      *
 942      * @return int
 943      */
 944     public function count() {
 945         return $this->count;
 946     }
 947     /**
 948      * Gets an array iterator for the collection.
 949      *
 950      * This is required by the IteratorAggregator interface and is used by routines
 951      * such as the foreach loop.
 952      *
 953      * @return ArrayIterator
 954      */
 955     public function getIterator() {
 956         return new ArrayIterator($this->collection);
 957     }
 958 }
 959
 960 /**
 961  * The global navigation class used for... the global navigation
 962  *
 963  * This class is used by PAGE to store the global navigation for the site
 964  * and is then used by the settings nav and navbar to save on processing and DB calls
 965  *
 966  * See
 967  * {@link lib/pagelib.php} {@link moodle_page::initialise_theme_and_output()}
 968  * {@link lib/ajax/getnavbranch.php} Called by ajax
 969  *
 970  * @package   core
 971  * @category  navigation
 972  * @copyright 2009 Sam Hemelryk
 973  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 974  */
 975 class global_navigation extends navigation_node {
 976     /** @var moodle_page The Moodle page this navigation object belongs to. */
 977     protected $page;
 978     /** @var bool switch to let us know if the navigation object is initialised*/
 979     protected $initialised = false;
 980     /** @var array An array of course information */
 981     protected $mycourses = array();
 982     /** @var navigation_node[] An array for containing  root navigation nodes */
 983     protected $rootnodes = array();
 984     /** @var bool A switch for whether to show empty sections in the navigation */
 985     protected $showemptysections = true;
 986     /** @var bool A switch for whether courses should be shown within categories on the navigation. */
 987     protected $showcategories = null;
 988     /** @var null@var bool A switch for whether or not to show categories in the my courses branch. */
 989     protected $showmycategories = null;
 990     /** @var array An array of stdClasses for users that the navigation is extended for */
 991     protected $extendforuser = array();
 992     /** @var navigation_cache */
 993     protected $cache;
 994     /** @var array An array of course ids that are present in the navigation */
 995     protected $addedcourses = array();
 996     /** @var bool */
 997     protected $allcategoriesloaded = false;
 998     /** @var array An array of category ids that are included in the navigation */
 999     protected $addedcategories = array();
1000     /** @var int expansion limit */
1001     protected $expansionlimit = 0;
1002     /** @var int userid to allow parent to see child's profile page navigation */
1003     protected $useridtouseforparentchecks = 0;
1004     /** @var cache_session A cache that stores information on expanded courses */
1005     protected $cacheexpandcourse = null;
1006
1007     /** Used when loading categories to load all top level categories [parent = 0] **/
1008     const LOAD_ROOT_CATEGORIES = 0;
1009     /** Used when loading categories to load all categories **/
1010     const LOAD_ALL_CATEGORIES = -1;
1011
1012     /**
1013      * Constructs a new global navigation
1014      *
1015      * @param moodle_page $page The page this navigation object belongs to
1016      */
1017     public function __construct(moodle_page $page) {
1018         global $CFG, $SITE, $USER;
1019
1020         if (during_initial_install()) {
1021             return;
1022         }
1023
1024         if (get_home_page() == HOMEPAGE_SITE) {
1025             // We are using the site home for the root element
1026             $properties = array(
1027                 'key' => 'home',
1028                 'type' => navigation_node::TYPE_SYSTEM,
1029                 'text' => get_string('home'),
1030                 'action' => new moodle_url('/')
1031             );
1032         } else {
1033             // We are using the users my moodle for the root element
1034             $properties = array(
1035                 'key' => 'myhome',
1036                 'type' => navigation_node::TYPE_SYSTEM,
1037                 'text' => get_string('myhome'),
1038                 'action' => new moodle_url('/my/')
1039             );
1040         }
1041
1042         // Use the parents constructor.... good good reuse
1043         parent::__construct($properties);
1044
1045         // Initalise and set defaults
1046         $this->page = $page;
1047         $this->forceopen = true;
1048         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
1049     }
1050
1051     /**
1052      * Mutator to set userid to allow parent to see child's profile
1053      * page navigation. See MDL-25805 for initial issue. Linked to it
1054      * is an issue explaining why this is a REALLY UGLY HACK thats not
1055      * for you to use!
1056      *
1057      * @param int $userid userid of profile page that parent wants to navigate around.
1058      */
1059     public function set_userid_for_parent_checks($userid) {
1060         $this->useridtouseforparentchecks = $userid;
1061     }
1062
1063
1064     /**
1065      * Initialises the navigation object.
1066      *
1067      * This causes the navigation object to look at the current state of the page
1068      * that it is associated with and then load the appropriate content.
1069      *
1070      * This should only occur the first time that the navigation structure is utilised
1071      * which will normally be either when the navbar is called to be displayed or
1072      * when a block makes use of it.
1073      *
1074      * @return bool
1075      */
1076     public function initialise() {
1077         global $CFG, $SITE, $USER;
1078         // Check if it has already been initialised
1079         if ($this->initialised || during_initial_install()) {
1080             return true;
1081         }
1082         $this->initialised = true;
1083
1084         // Set up the five base root nodes. These are nodes where we will put our
1085         // content and are as follows:
1086         // site: Navigation for the front page.
1087         // myprofile: User profile information goes here.
1088         // currentcourse: The course being currently viewed.
1089         // mycourses: The users courses get added here.
1090         // courses: Additional courses are added here.
1091         // users: Other users information loaded here.
1092         $this->rootnodes = array();
1093         if (get_home_page() == HOMEPAGE_SITE) {
1094             // The home element should be my moodle because the root element is the site
1095             if (isloggedin() && !isguestuser()) {  // Makes no sense if you aren't logged in
1096                 $this->rootnodes['home'] = $this->add(get_string('myhome'), new moodle_url('/my/'), self::TYPE_SETTING, null, 'home');
1097             }
1098         } else {
1099             // The home element should be the site because the root node is my moodle
1100             $this->rootnodes['home'] = $this->add(get_string('sitehome'), new moodle_url('/'), self::TYPE_SETTING, null, 'home');
1101             if (!empty($CFG->defaulthomepage) && ($CFG->defaulthomepage == HOMEPAGE_MY)) {
1102                 // We need to stop automatic redirection
1103                 $this->rootnodes['home']->action->param('redirect', '0');
1104             }
1105         }
1106         $this->rootnodes['site'] = $this->add_course($SITE);
1107         $this->rootnodes['myprofile'] = $this->add(get_string('myprofile'), null, self::TYPE_USER, null, 'myprofile');
1108         $this->rootnodes['currentcourse'] = $this->add(get_string('currentcourse'), null, self::TYPE_ROOTNODE, null, 'currentcourse');
1109         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my/'), self::TYPE_ROOTNODE, null, 'mycourses');
1110         $this->rootnodes['courses'] = $this->add(get_string('courses'), new moodle_url('/course/index.php'), self::TYPE_ROOTNODE, null, 'courses');
1111         $this->rootnodes['users'] = $this->add(get_string('users'), null, self::TYPE_ROOTNODE, null, 'users');
1112
1113         // We always load the frontpage course to ensure it is available without
1114         // JavaScript enabled.
1115         $this->add_front_page_course_essentials($this->rootnodes['site'], $SITE);
1116         $this->load_course_sections($SITE, $this->rootnodes['site']);
1117
1118         $course = $this->page->course;
1119
1120         // $issite gets set to true if the current pages course is the sites frontpage course
1121         $issite = ($this->page->course->id == $SITE->id);
1122         // Determine if the user is enrolled in any course.
1123         $enrolledinanycourse = enrol_user_sees_own_courses();
1124
1125         $this->rootnodes['currentcourse']->mainnavonly = true;
1126         if ($enrolledinanycourse) {
1127             $this->rootnodes['mycourses']->isexpandable = true;
1128             if ($CFG->navshowallcourses) {
1129                 // When we show all courses we need to show both the my courses and the regular courses branch.
1130                 $this->rootnodes['courses']->isexpandable = true;
1131             }
1132         } else {
1133             $this->rootnodes['courses']->isexpandable = true;
1134         }
1135
1136         // Load the users enrolled courses if they are viewing the My Moodle page AND the admin has not
1137         // set that they wish to keep the My Courses branch collapsed by default.
1138         if (!empty($CFG->navexpandmycourses) && $this->rootnodes['mycourses']->isactive){
1139             $this->load_courses_enrolled();
1140         } else {
1141             $this->rootnodes['mycourses']->collapse = true;
1142             $this->rootnodes['mycourses']->make_inactive();
1143         }
1144
1145         $canviewcourseprofile = true;
1146
1147         // Next load context specific content into the navigation
1148         switch ($this->page->context->contextlevel) {
1149             case CONTEXT_SYSTEM :
1150                 // Nothing left to do here I feel.
1151                 break;
1152             case CONTEXT_COURSECAT :
1153                 // This is essential, we must load categories.
1154                 $this->load_all_categories($this->page->context->instanceid, true);
1155                 break;
1156             case CONTEXT_BLOCK :
1157             case CONTEXT_COURSE :
1158                 if ($issite) {
1159                     // Nothing left to do here.
1160                     break;
1161                 }
1162
1163                 // Load the course associated with the current page into the navigation.
1164                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1165                 // If the course wasn't added then don't try going any further.
1166                 if (!$coursenode) {
1167                     $canviewcourseprofile = false;
1168                     break;
1169                 }
1170
1171                 // If the user is not enrolled then we only want to show the
1172                 // course node and not populate it.
1173
1174                 // Not enrolled, can't view, and hasn't switched roles
1175                 if (!can_access_course($course)) {
1176                     if ($coursenode->isexpandable === true) {
1177                         // Obviously the situation has changed, update the cache and adjust the node.
1178                         // This occurs if the user access to a course has been revoked (one way or another) after
1179                         // initially logging in for this session.
1180                         $this->get_expand_course_cache()->set($course->id, 1);
1181                         $coursenode->isexpandable = true;
1182                         $coursenode->nodetype = self::NODETYPE_BRANCH;
1183                     }
1184                     // Very ugly hack - do not force "parents" to enrol into course their child is enrolled in,
1185                     // this hack has been propagated from user/view.php to display the navigation node. (MDL-25805)
1186                     if (!$this->current_user_is_parent_role()) {
1187                         $coursenode->make_active();
1188                         $canviewcourseprofile = false;
1189                         break;
1190                     }
1191                 }
1192
1193                 if ($coursenode->isexpandable === false) {
1194                     // Obviously the situation has changed, update the cache and adjust the node.
1195                     // This occurs if the user has been granted access to a course (one way or another) after initially
1196                     // logging in for this session.
1197                     $this->get_expand_course_cache()->set($course->id, 1);
1198                     $coursenode->isexpandable = true;
1199                     $coursenode->nodetype = self::NODETYPE_BRANCH;
1200                 }
1201
1202                 // Add the essentials such as reports etc...
1203                 $this->add_course_essentials($coursenode, $course);
1204                 // Extend course navigation with it's sections/activities
1205                 $this->load_course_sections($course, $coursenode);
1206                 if (!$coursenode->contains_active_node() && !$coursenode->search_for_active_node()) {
1207                     $coursenode->make_active();
1208                 }
1209
1210                 break;
1211             case CONTEXT_MODULE :
1212                 if ($issite) {
1213                     // If this is the site course then most information will have
1214                     // already been loaded.
1215                     // However we need to check if there is more content that can
1216                     // yet be loaded for the specific module instance.
1217                     $activitynode = $this->rootnodes['site']->find($this->page->cm->id, navigation_node::TYPE_ACTIVITY);
1218                     if ($activitynode) {
1219                         $this->load_activity($this->page->cm, $this->page->course, $activitynode);
1220                     }
1221                     break;
1222                 }
1223
1224                 $course = $this->page->course;
1225                 $cm = $this->page->cm;
1226
1227                 // Load the course associated with the page into the navigation
1228                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1229
1230                 // If the course wasn't added then don't try going any further.
1231                 if (!$coursenode) {
1232                     $canviewcourseprofile = false;
1233                     break;
1234                 }
1235
1236                 // If the user is not enrolled then we only want to show the
1237                 // course node and not populate it.
1238                 if (!can_access_course($course)) {
1239                     $coursenode->make_active();
1240                     $canviewcourseprofile = false;
1241                     break;
1242                 }
1243
1244                 $this->add_course_essentials($coursenode, $course);
1245
1246                 // Load the course sections into the page
1247                 $this->load_course_sections($course, $coursenode, null, $cm);
1248                 $activity = $coursenode->find($cm->id, navigation_node::TYPE_ACTIVITY);
1249                 if (!empty($activity)) {
1250                     // Finally load the cm specific navigaton information
1251                     $this->load_activity($cm, $course, $activity);
1252                     // Check if we have an active ndoe
1253                     if (!$activity->contains_active_node() && !$activity->search_for_active_node()) {
1254                         // And make the activity node active.
1255                         $activity->make_active();
1256                     }
1257                 }
1258                 break;
1259             case CONTEXT_USER :
1260                 if ($issite) {
1261                     // The users profile information etc is already loaded
1262                     // for the front page.
1263                     break;
1264                 }
1265                 $course = $this->page->course;
1266                 // Load the course associated with the user into the navigation
1267                 $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
1268
1269                 // If the course wasn't added then don't try going any further.
1270                 if (!$coursenode) {
1271                     $canviewcourseprofile = false;
1272                     break;
1273                 }
1274
1275                 // If the user is not enrolled then we only want to show the
1276                 // course node and not populate it.
1277                 if (!can_access_course($course)) {
1278                     $coursenode->make_active();
1279                     $canviewcourseprofile = false;
1280                     break;
1281                 }
1282                 $this->add_course_essentials($coursenode, $course);
1283                 $this->load_course_sections($course, $coursenode);
1284                 break;
1285         }
1286
1287         // Load for the current user
1288         $this->load_for_user();
1289         if ($this->page->context->contextlevel >= CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id && $canviewcourseprofile) {
1290             $this->load_for_user(null, true);
1291         }
1292         // Load each extending user into the navigation.
1293         foreach ($this->extendforuser as $user) {
1294             if ($user->id != $USER->id) {
1295                 $this->load_for_user($user);
1296             }
1297         }
1298
1299         // Give the local plugins a chance to include some navigation if they want.
1300         foreach (core_component::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $unused) {
1301             $function = "local_{$plugin}_extend_navigation";
1302             $oldfunction = "local_{$plugin}_extends_navigation";
1303
1304             if (function_exists($function)) {
1305                 $function($this);
1306
1307             } else if (function_exists($oldfunction)) {
1308                 debugging("Deprecated local plugin navigation callback: Please rename '{$oldfunction}' to '{$function}'. ".
1309                     "Support for the old callback will be dropped in Moodle 3.1", DEBUG_DEVELOPER);
1310                 $oldfunction($this);
1311             }
1312         }
1313
1314         // Remove any empty root nodes
1315         foreach ($this->rootnodes as $node) {
1316             // Dont remove the home node
1317             /** @var navigation_node $node */
1318             if ($node->key !== 'home' && !$node->has_children() && !$node->isactive) {
1319                 $node->remove();
1320             }
1321         }
1322
1323         if (!$this->contains_active_node()) {
1324             $this->search_for_active_node();
1325         }
1326
1327         // If the user is not logged in modify the navigation structure as detailed
1328         // in {@link http://docs.moodle.org/dev/Navigation_2.0_structure}
1329         if (!isloggedin()) {
1330             $activities = clone($this->rootnodes['site']->children);
1331             $this->rootnodes['site']->remove();
1332             $children = clone($this->children);
1333             $this->children = new navigation_node_collection();
1334             foreach ($activities as $child) {
1335                 $this->children->add($child);
1336             }
1337             foreach ($children as $child) {
1338                 $this->children->add($child);
1339             }
1340         }
1341         return true;
1342     }
1343
1344     /**
1345      * Returns true if the current user is a parent of the user being currently viewed.
1346      *
1347      * If the current user is not viewing another user, or if the current user does not hold any parent roles over the
1348      * other user being viewed this function returns false.
1349      * In order to set the user for whom we are checking against you must call {@link set_userid_for_parent_checks()}
1350      *
1351      * @since Moodle 2.4
1352      * @return bool
1353      */
1354     protected function current_user_is_parent_role() {
1355         global $USER, $DB;
1356         if ($this->useridtouseforparentchecks && $this->useridtouseforparentchecks != $USER->id) {
1357             $usercontext = context_user::instance($this->useridtouseforparentchecks, MUST_EXIST);
1358             if (!has_capability('moodle/user:viewdetails', $usercontext)) {
1359                 return false;
1360             }
1361             if ($DB->record_exists('role_assignments', array('userid' => $USER->id, 'contextid' => $usercontext->id))) {
1362                 return true;
1363             }
1364         }
1365         return false;
1366     }
1367
1368     /**
1369      * Returns true if courses should be shown within categories on the navigation.
1370      *
1371      * @param bool $ismycourse Set to true if you are calculating this for a course.
1372      * @return bool
1373      */
1374     protected function show_categories($ismycourse = false) {
1375         global $CFG, $DB;
1376         if ($ismycourse) {
1377             return $this->show_my_categories();
1378         }
1379         if ($this->showcategories === null) {
1380             $show = false;
1381             if ($this->page->context->contextlevel == CONTEXT_COURSECAT) {
1382                 $show = true;
1383             } else if (!empty($CFG->navshowcategories) && $DB->count_records('course_categories') > 1) {
1384                 $show = true;
1385             }
1386             $this->showcategories = $show;
1387         }
1388         return $this->showcategories;
1389     }
1390
1391     /**
1392      * Returns true if we should show categories in the My Courses branch.
1393      * @return bool
1394      */
1395     protected function show_my_categories() {
1396         global $CFG, $DB;
1397         if ($this->showmycategories === null) {
1398             $this->showmycategories = !empty($CFG->navshowmycoursecategories) && $DB->count_records('course_categories') > 1;
1399         }
1400         return $this->showmycategories;
1401     }
1402
1403     /**
1404      * Loads the courses in Moodle into the navigation.
1405      *
1406      * @global moodle_database $DB
1407      * @param string|array $categoryids An array containing categories to load courses
1408      *                     for, OR null to load courses for all categories.
1409      * @return array An array of navigation_nodes one for each course
1410      */
1411     protected function load_all_courses($categoryids = null) {
1412         global $CFG, $DB, $SITE;
1413
1414         // Work out the limit of courses.
1415         $limit = 20;
1416         if (!empty($CFG->navcourselimit)) {
1417             $limit = $CFG->navcourselimit;
1418         }
1419
1420         $toload = (empty($CFG->navshowallcourses))?self::LOAD_ROOT_CATEGORIES:self::LOAD_ALL_CATEGORIES;
1421
1422         // If we are going to show all courses AND we are showing categories then
1423         // to save us repeated DB calls load all of the categories now
1424         if ($this->show_categories()) {
1425             $this->load_all_categories($toload);
1426         }
1427
1428         // Will be the return of our efforts
1429         $coursenodes = array();
1430
1431         // Check if we need to show categories.
1432         if ($this->show_categories()) {
1433             // Hmmm we need to show categories... this is going to be painful.
1434             // We now need to fetch up to $limit courses for each category to
1435             // be displayed.
1436             if ($categoryids !== null) {
1437                 if (!is_array($categoryids)) {
1438                     $categoryids = array($categoryids);
1439                 }
1440                 list($categorywhere, $categoryparams) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED, 'cc');
1441                 $categorywhere = 'WHERE cc.id '.$categorywhere;
1442             } else if ($toload == self::LOAD_ROOT_CATEGORIES) {
1443                 $categorywhere = 'WHERE cc.depth = 1 OR cc.depth = 2';
1444                 $categoryparams = array();
1445             } else {
1446                 $categorywhere = '';
1447                 $categoryparams = array();
1448             }
1449
1450             // First up we are going to get the categories that we are going to
1451             // need so that we can determine how best to load the courses from them.
1452             $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1453                         FROM {course_categories} cc
1454                     LEFT JOIN {course} c ON c.category = cc.id
1455                             {$categorywhere}
1456                     GROUP BY cc.id";
1457             $categories = $DB->get_recordset_sql($sql, $categoryparams);
1458             $fullfetch = array();
1459             $partfetch = array();
1460             foreach ($categories as $category) {
1461                 if (!$this->can_add_more_courses_to_category($category->id)) {
1462                     continue;
1463                 }
1464                 if ($category->coursecount > $limit * 5) {
1465                     $partfetch[] = $category->id;
1466                 } else if ($category->coursecount > 0) {
1467                     $fullfetch[] = $category->id;
1468                 }
1469             }
1470             $categories->close();
1471
1472             if (count($fullfetch)) {
1473                 // First up fetch all of the courses in categories where we know that we are going to
1474                 // need the majority of courses.
1475                 list($categoryids, $categoryparams) = $DB->get_in_or_equal($fullfetch, SQL_PARAMS_NAMED, 'lcategory');
1476                 $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1477                 $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1478                 $categoryparams['contextlevel'] = CONTEXT_COURSE;
1479                 $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1480                             FROM {course} c
1481                                 $ccjoin
1482                             WHERE c.category {$categoryids}
1483                         ORDER BY c.sortorder ASC";
1484                 $coursesrs = $DB->get_recordset_sql($sql, $categoryparams);
1485                 foreach ($coursesrs as $course) {
1486                     if ($course->id == $SITE->id) {
1487                         // This should not be necessary, frontpage is not in any category.
1488                         continue;
1489                     }
1490                     if (array_key_exists($course->id, $this->addedcourses)) {
1491                         // It is probably better to not include the already loaded courses
1492                         // directly in SQL because inequalities may confuse query optimisers
1493                         // and may interfere with query caching.
1494                         continue;
1495                     }
1496                     if (!$this->can_add_more_courses_to_category($course->category)) {
1497                         continue;
1498                     }
1499                     context_helper::preload_from_record($course);
1500                     if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1501                         continue;
1502                     }
1503                     $coursenodes[$course->id] = $this->add_course($course);
1504                 }
1505                 $coursesrs->close();
1506             }
1507
1508             if (count($partfetch)) {
1509                 // Next we will work our way through the categories where we will likely only need a small
1510                 // proportion of the courses.
1511                 foreach ($partfetch as $categoryid) {
1512                     $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1513                     $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1514                     $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1515                                 FROM {course} c
1516                                     $ccjoin
1517                                 WHERE c.category = :categoryid
1518                             ORDER BY c.sortorder ASC";
1519                     $courseparams = array('categoryid' => $categoryid, 'contextlevel' => CONTEXT_COURSE);
1520                     $coursesrs = $DB->get_recordset_sql($sql, $courseparams, 0, $limit * 5);
1521                     foreach ($coursesrs as $course) {
1522                         if ($course->id == $SITE->id) {
1523                             // This should not be necessary, frontpage is not in any category.
1524                             continue;
1525                         }
1526                         if (array_key_exists($course->id, $this->addedcourses)) {
1527                             // It is probably better to not include the already loaded courses
1528                             // directly in SQL because inequalities may confuse query optimisers
1529                             // and may interfere with query caching.
1530                             // This also helps to respect expected $limit on repeated executions.
1531                             continue;
1532                         }
1533                         if (!$this->can_add_more_courses_to_category($course->category)) {
1534                             break;
1535                         }
1536                         context_helper::preload_from_record($course);
1537                         if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1538                             continue;
1539                         }
1540                         $coursenodes[$course->id] = $this->add_course($course);
1541                     }
1542                     $coursesrs->close();
1543                 }
1544             }
1545         } else {
1546             // Prepare the SQL to load the courses and their contexts
1547             list($courseids, $courseparams) = $DB->get_in_or_equal(array_keys($this->addedcourses), SQL_PARAMS_NAMED, 'lc', false);
1548             $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1549             $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1550             $courseparams['contextlevel'] = CONTEXT_COURSE;
1551             $sql = "SELECT c.id, c.sortorder, c.visible, c.fullname, c.shortname, c.category $ccselect
1552                         FROM {course} c
1553                             $ccjoin
1554                         WHERE c.id {$courseids}
1555                     ORDER BY c.sortorder ASC";
1556             $coursesrs = $DB->get_recordset_sql($sql, $courseparams);
1557             foreach ($coursesrs as $course) {
1558                 if ($course->id == $SITE->id) {
1559                     // frotpage is not wanted here
1560                     continue;
1561                 }
1562                 if ($this->page->course && ($this->page->course->id == $course->id)) {
1563                     // Don't include the currentcourse in this nodelist - it's displayed in the Current course node
1564                     continue;
1565                 }
1566                 context_helper::preload_from_record($course);
1567                 if (!$course->visible && !is_role_switched($course->id) && !has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
1568                     continue;
1569                 }
1570                 $coursenodes[$course->id] = $this->add_course($course);
1571                 if (count($coursenodes) >= $limit) {
1572                     break;
1573                 }
1574             }
1575             $coursesrs->close();
1576         }
1577
1578         return $coursenodes;
1579     }
1580
1581     /**
1582      * Returns true if more courses can be added to the provided category.
1583      *
1584      * @param int|navigation_node|stdClass $category
1585      * @return bool
1586      */
1587     protected function can_add_more_courses_to_category($category) {
1588         global $CFG;
1589         $limit = 20;
1590         if (!empty($CFG->navcourselimit)) {
1591             $limit = (int)$CFG->navcourselimit;
1592         }
1593         if (is_numeric($category)) {
1594             if (!array_key_exists($category, $this->addedcategories)) {
1595                 return true;
1596             }
1597             $coursecount = count($this->addedcategories[$category]->children->type(self::TYPE_COURSE));
1598         } else if ($category instanceof navigation_node) {
1599             if (($category->type != self::TYPE_CATEGORY) || ($category->type != self::TYPE_MY_CATEGORY)) {
1600                 return false;
1601             }
1602             $coursecount = count($category->children->type(self::TYPE_COURSE));
1603         } else if (is_object($category) && property_exists($category,'id')) {
1604             $coursecount = count($this->addedcategories[$category->id]->children->type(self::TYPE_COURSE));
1605         }
1606         return ($coursecount <= $limit);
1607     }
1608
1609     /**
1610      * Loads all categories (top level or if an id is specified for that category)
1611      *
1612      * @param int $categoryid The category id to load or null/0 to load all base level categories
1613      * @param bool $showbasecategories If set to true all base level categories will be loaded as well
1614      *        as the requested category and any parent categories.
1615      * @return navigation_node|void returns a navigation node if a category has been loaded.
1616      */
1617     protected function load_all_categories($categoryid = self::LOAD_ROOT_CATEGORIES, $showbasecategories = false) {
1618         global $CFG, $DB;
1619
1620         // Check if this category has already been loaded
1621         if ($this->allcategoriesloaded || ($categoryid < 1 && $this->is_category_fully_loaded($categoryid))) {
1622             return true;
1623         }
1624
1625         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
1626         $sqlselect = "SELECT cc.*, $catcontextsql
1627                       FROM {course_categories} cc
1628                       JOIN {context} ctx ON cc.id = ctx.instanceid";
1629         $sqlwhere = "WHERE ctx.contextlevel = ".CONTEXT_COURSECAT;
1630         $sqlorder = "ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
1631         $params = array();
1632
1633         $categoriestoload = array();
1634         if ($categoryid == self::LOAD_ALL_CATEGORIES) {
1635             // We are going to load all categories regardless... prepare to fire
1636             // on the database server!
1637         } else if ($categoryid == self::LOAD_ROOT_CATEGORIES) { // can be 0
1638             // We are going to load all of the first level categories (categories without parents)
1639             $sqlwhere .= " AND cc.parent = 0";
1640         } else if (array_key_exists($categoryid, $this->addedcategories)) {
1641             // The category itself has been loaded already so we just need to ensure its subcategories
1642             // have been loaded
1643             $addedcategories = $this->addedcategories;
1644             unset($addedcategories[$categoryid]);
1645             if (count($addedcategories) > 0) {
1646                 list($sql, $params) = $DB->get_in_or_equal(array_keys($addedcategories), SQL_PARAMS_NAMED, 'parent', false);
1647                 if ($showbasecategories) {
1648                     // We need to include categories with parent = 0 as well
1649                     $sqlwhere .= " AND (cc.parent = :categoryid OR cc.parent = 0) AND cc.parent {$sql}";
1650                 } else {
1651                     // All we need is categories that match the parent
1652                     $sqlwhere .= " AND cc.parent = :categoryid AND cc.parent {$sql}";
1653                 }
1654             }
1655             $params['categoryid'] = $categoryid;
1656         } else {
1657             // This category hasn't been loaded yet so we need to fetch it, work out its category path
1658             // and load this category plus all its parents and subcategories
1659             $category = $DB->get_record('course_categories', array('id' => $categoryid), 'path', MUST_EXIST);
1660             $categoriestoload = explode('/', trim($category->path, '/'));
1661             list($select, $params) = $DB->get_in_or_equal($categoriestoload);
1662             // We are going to use select twice so double the params
1663             $params = array_merge($params, $params);
1664             $basecategorysql = ($showbasecategories)?' OR cc.depth = 1':'';
1665             $sqlwhere .= " AND (cc.id {$select} OR cc.parent {$select}{$basecategorysql})";
1666         }
1667
1668         $categoriesrs = $DB->get_recordset_sql("$sqlselect $sqlwhere $sqlorder", $params);
1669         $categories = array();
1670         foreach ($categoriesrs as $category) {
1671             // Preload the context.. we'll need it when adding the category in order
1672             // to format the category name.
1673             context_helper::preload_from_record($category);
1674             if (array_key_exists($category->id, $this->addedcategories)) {
1675                 // Do nothing, its already been added.
1676             } else if ($category->parent == '0') {
1677                 // This is a root category lets add it immediately
1678                 $this->add_category($category, $this->rootnodes['courses']);
1679             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1680                 // This categories parent has already been added we can add this immediately
1681                 $this->add_category($category, $this->addedcategories[$category->parent]);
1682             } else {
1683                 $categories[] = $category;
1684             }
1685         }
1686         $categoriesrs->close();
1687
1688         // Now we have an array of categories we need to add them to the navigation.
1689         while (!empty($categories)) {
1690             $category = reset($categories);
1691             if (array_key_exists($category->id, $this->addedcategories)) {
1692                 // Do nothing
1693             } else if ($category->parent == '0') {
1694                 $this->add_category($category, $this->rootnodes['courses']);
1695             } else if (array_key_exists($category->parent, $this->addedcategories)) {
1696                 $this->add_category($category, $this->addedcategories[$category->parent]);
1697             } else {
1698                 // This category isn't in the navigation and niether is it's parent (yet).
1699                 // We need to go through the category path and add all of its components in order.
1700                 $path = explode('/', trim($category->path, '/'));
1701                 foreach ($path as $catid) {
1702                     if (!array_key_exists($catid, $this->addedcategories)) {
1703                         // This category isn't in the navigation yet so add it.
1704                         $subcategory = $categories[$catid];
1705                         if ($subcategory->parent == '0') {
1706                             // Yay we have a root category - this likely means we will now be able
1707                             // to add categories without problems.
1708                             $this->add_category($subcategory, $this->rootnodes['courses']);
1709                         } else if (array_key_exists($subcategory->parent, $this->addedcategories)) {
1710                             // The parent is in the category (as we'd expect) so add it now.
1711                             $this->add_category($subcategory, $this->addedcategories[$subcategory->parent]);
1712                             // Remove the category from the categories array.
1713                             unset($categories[$catid]);
1714                         } else {
1715                             // We should never ever arrive here - if we have then there is a bigger
1716                             // problem at hand.
1717                             throw new coding_exception('Category path order is incorrect and/or there are missing categories');
1718                         }
1719                     }
1720                 }
1721             }
1722             // Remove the category from the categories array now that we know it has been added.
1723             unset($categories[$category->id]);
1724         }
1725         if ($categoryid === self::LOAD_ALL_CATEGORIES) {
1726             $this->allcategoriesloaded = true;
1727         }
1728         // Check if there are any categories to load.
1729         if (count($categoriestoload) > 0) {
1730             $readytoloadcourses = array();
1731             foreach ($categoriestoload as $category) {
1732                 if ($this->can_add_more_courses_to_category($category)) {
1733                     $readytoloadcourses[] = $category;
1734                 }
1735             }
1736             if (count($readytoloadcourses)) {
1737                 $this->load_all_courses($readytoloadcourses);
1738             }
1739         }
1740
1741         // Look for all categories which have been loaded
1742         if (!empty($this->addedcategories)) {
1743             $categoryids = array();
1744             foreach ($this->addedcategories as $category) {
1745                 if ($this->can_add_more_courses_to_category($category)) {
1746                     $categoryids[] = $category->key;
1747                 }
1748             }
1749             if ($categoryids) {
1750                 list($categoriessql, $params) = $DB->get_in_or_equal($categoryids, SQL_PARAMS_NAMED);
1751                 $params['limit'] = (!empty($CFG->navcourselimit))?$CFG->navcourselimit:20;
1752                 $sql = "SELECT cc.id, COUNT(c.id) AS coursecount
1753                           FROM {course_categories} cc
1754                           JOIN {course} c ON c.category = cc.id
1755                          WHERE cc.id {$categoriessql}
1756                       GROUP BY cc.id
1757                         HAVING COUNT(c.id) > :limit";
1758                 $excessivecategories = $DB->get_records_sql($sql, $params);
1759                 foreach ($categories as &$category) {
1760                     if (array_key_exists($category->key, $excessivecategories) && !$this->can_add_more_courses_to_category($category)) {
1761                         $url = new moodle_url('/course/index.php', array('categoryid' => $category->key));
1762                         $category->add(get_string('viewallcourses'), $url, self::TYPE_SETTING);
1763                     }
1764                 }
1765             }
1766         }
1767     }
1768
1769     /**
1770      * Adds a structured category to the navigation in the correct order/place
1771      *
1772      * @param stdClass $category category to be added in navigation.
1773      * @param navigation_node $parent parent navigation node
1774      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
1775      * @return void.
1776      */
1777     protected function add_category(stdClass $category, navigation_node $parent, $nodetype = self::TYPE_CATEGORY) {
1778         if (array_key_exists($category->id, $this->addedcategories)) {
1779             return;
1780         }
1781         $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
1782         $context = context_coursecat::instance($category->id);
1783         $categoryname = format_string($category->name, true, array('context' => $context));
1784         $categorynode = $parent->add($categoryname, $url, $nodetype, $categoryname, $category->id);
1785         if (empty($category->visible)) {
1786             if (has_capability('moodle/category:viewhiddencategories', context_system::instance())) {
1787                 $categorynode->hidden = true;
1788             } else {
1789                 $categorynode->display = false;
1790             }
1791         }
1792         $this->addedcategories[$category->id] = $categorynode;
1793     }
1794
1795     /**
1796      * Loads the given course into the navigation
1797      *
1798      * @param stdClass $course
1799      * @return navigation_node
1800      */
1801     protected function load_course(stdClass $course) {
1802         global $SITE;
1803         if ($course->id == $SITE->id) {
1804             // This is always loaded during initialisation
1805             return $this->rootnodes['site'];
1806         } else if (array_key_exists($course->id, $this->addedcourses)) {
1807             // The course has already been loaded so return a reference
1808             return $this->addedcourses[$course->id];
1809         } else {
1810             // Add the course
1811             return $this->add_course($course);
1812         }
1813     }
1814
1815     /**
1816      * Loads all of the courses section into the navigation.
1817      *
1818      * This function calls method from current course format, see
1819      * {@link format_base::extend_course_navigation()}
1820      * If course module ($cm) is specified but course format failed to create the node,
1821      * the activity node is created anyway.
1822      *
1823      * By default course formats call the method {@link global_navigation::load_generic_course_sections()}
1824      *
1825      * @param stdClass $course Database record for the course
1826      * @param navigation_node $coursenode The course node within the navigation
1827      * @param null|int $sectionnum If specified load the contents of section with this relative number
1828      * @param null|cm_info $cm If specified make sure that activity node is created (either
1829      *    in containg section or by calling load_stealth_activity() )
1830      */
1831     protected function load_course_sections(stdClass $course, navigation_node $coursenode, $sectionnum = null, $cm = null) {
1832         global $CFG, $SITE;
1833         require_once($CFG->dirroot.'/course/lib.php');
1834         if (isset($cm->sectionnum)) {
1835             $sectionnum = $cm->sectionnum;
1836         }
1837         if ($sectionnum !== null) {
1838             $this->includesectionnum = $sectionnum;
1839         }
1840         course_get_format($course)->extend_course_navigation($this, $coursenode, $sectionnum, $cm);
1841         if (isset($cm->id)) {
1842             $activity = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
1843             if (empty($activity)) {
1844                 $activity = $this->load_stealth_activity($coursenode, get_fast_modinfo($course));
1845             }
1846         }
1847    }
1848
1849     /**
1850      * Generates an array of sections and an array of activities for the given course.
1851      *
1852      * This method uses the cache to improve performance and avoid the get_fast_modinfo call
1853      *
1854      * @param stdClass $course
1855      * @return array Array($sections, $activities)
1856      */
1857     protected function generate_sections_and_activities(stdClass $course) {
1858         global $CFG;
1859         require_once($CFG->dirroot.'/course/lib.php');
1860
1861         $modinfo = get_fast_modinfo($course);
1862         $sections = $modinfo->get_section_info_all();
1863
1864         // For course formats using 'numsections' trim the sections list
1865         $courseformatoptions = course_get_format($course)->get_format_options();
1866         if (isset($courseformatoptions['numsections'])) {
1867             $sections = array_slice($sections, 0, $courseformatoptions['numsections']+1, true);
1868         }
1869
1870         $activities = array();
1871
1872         foreach ($sections as $key => $section) {
1873             // Clone and unset summary to prevent $SESSION bloat (MDL-31802).
1874             $sections[$key] = clone($section);
1875             unset($sections[$key]->summary);
1876             $sections[$key]->hasactivites = false;
1877             if (!array_key_exists($section->section, $modinfo->sections)) {
1878                 continue;
1879             }
1880             foreach ($modinfo->sections[$section->section] as $cmid) {
1881                 $cm = $modinfo->cms[$cmid];
1882                 $activity = new stdClass;
1883                 $activity->id = $cm->id;
1884                 $activity->course = $course->id;
1885                 $activity->section = $section->section;
1886                 $activity->name = $cm->name;
1887                 $activity->icon = $cm->icon;
1888                 $activity->iconcomponent = $cm->iconcomponent;
1889                 $activity->hidden = (!$cm->visible);
1890                 $activity->modname = $cm->modname;
1891                 $activity->nodetype = navigation_node::NODETYPE_LEAF;
1892                 $activity->onclick = $cm->onclick;
1893                 $url = $cm->url;
1894                 if (!$url) {
1895                     $activity->url = null;
1896                     $activity->display = false;
1897                 } else {
1898                     $activity->url = $url->out();
1899                     $activity->display = $cm->uservisible ? true : false;
1900                     if (self::module_extends_navigation($cm->modname)) {
1901                         $activity->nodetype = navigation_node::NODETYPE_BRANCH;
1902                     }
1903                 }
1904                 $activities[$cmid] = $activity;
1905                 if ($activity->display) {
1906                     $sections[$key]->hasactivites = true;
1907                 }
1908             }
1909         }
1910
1911         return array($sections, $activities);
1912     }
1913
1914     /**
1915      * Generically loads the course sections into the course's navigation.
1916      *
1917      * @param stdClass $course
1918      * @param navigation_node $coursenode
1919      * @return array An array of course section nodes
1920      */
1921     public function load_generic_course_sections(stdClass $course, navigation_node $coursenode) {
1922         global $CFG, $DB, $USER, $SITE;
1923         require_once($CFG->dirroot.'/course/lib.php');
1924
1925         list($sections, $activities) = $this->generate_sections_and_activities($course);
1926
1927         $navigationsections = array();
1928         foreach ($sections as $sectionid => $section) {
1929             $section = clone($section);
1930             if ($course->id == $SITE->id) {
1931                 $this->load_section_activities($coursenode, $section->section, $activities);
1932             } else {
1933                 if (!$section->uservisible || (!$this->showemptysections &&
1934                         !$section->hasactivites && $this->includesectionnum !== $section->section)) {
1935                     continue;
1936                 }
1937
1938                 $sectionname = get_section_name($course, $section);
1939                 $url = course_get_url($course, $section->section, array('navigation' => true));
1940
1941                 $sectionnode = $coursenode->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id);
1942                 $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
1943                 $sectionnode->hidden = (!$section->visible || !$section->available);
1944                 if ($this->includesectionnum !== false && $this->includesectionnum == $section->section) {
1945                     $this->load_section_activities($sectionnode, $section->section, $activities);
1946                 }
1947                 $section->sectionnode = $sectionnode;
1948                 $navigationsections[$sectionid] = $section;
1949             }
1950         }
1951         return $navigationsections;
1952     }
1953
1954     /**
1955      * Loads all of the activities for a section into the navigation structure.
1956      *
1957      * @param navigation_node $sectionnode
1958      * @param int $sectionnumber
1959      * @param array $activities An array of activites as returned by {@link global_navigation::generate_sections_and_activities()}
1960      * @param stdClass $course The course object the section and activities relate to.
1961      * @return array Array of activity nodes
1962      */
1963     protected function load_section_activities(navigation_node $sectionnode, $sectionnumber, array $activities, $course = null) {
1964         global $CFG, $SITE;
1965         // A static counter for JS function naming
1966         static $legacyonclickcounter = 0;
1967
1968         $activitynodes = array();
1969         if (empty($activities)) {
1970             return $activitynodes;
1971         }
1972
1973         if (!is_object($course)) {
1974             $activity = reset($activities);
1975             $courseid = $activity->course;
1976         } else {
1977             $courseid = $course->id;
1978         }
1979         $showactivities = ($courseid != $SITE->id || !empty($CFG->navshowfrontpagemods));
1980
1981         foreach ($activities as $activity) {
1982             if ($activity->section != $sectionnumber) {
1983                 continue;
1984             }
1985             if ($activity->icon) {
1986                 $icon = new pix_icon($activity->icon, get_string('modulename', $activity->modname), $activity->iconcomponent);
1987             } else {
1988                 $icon = new pix_icon('icon', get_string('modulename', $activity->modname), $activity->modname);
1989             }
1990
1991             // Prepare the default name and url for the node
1992             $activityname = format_string($activity->name, true, array('context' => context_module::instance($activity->id)));
1993             $action = new moodle_url($activity->url);
1994
1995             // Check if the onclick property is set (puke!)
1996             if (!empty($activity->onclick)) {
1997                 // Increment the counter so that we have a unique number.
1998                 $legacyonclickcounter++;
1999                 // Generate the function name we will use
2000                 $functionname = 'legacy_activity_onclick_handler_'.$legacyonclickcounter;
2001                 $propogrationhandler = '';
2002                 // Check if we need to cancel propogation. Remember inline onclick
2003                 // events would return false if they wanted to prevent propogation and the
2004                 // default action.
2005                 if (strpos($activity->onclick, 'return false')) {
2006                     $propogrationhandler = 'e.halt();';
2007                 }
2008                 // Decode the onclick - it has already been encoded for display (puke)
2009                 $onclick = htmlspecialchars_decode($activity->onclick, ENT_QUOTES);
2010                 // Build the JS function the click event will call
2011                 $jscode = "function {$functionname}(e) { $propogrationhandler $onclick }";
2012                 $this->page->requires->js_init_code($jscode);
2013                 // Override the default url with the new action link
2014                 $action = new action_link($action, $activityname, new component_action('click', $functionname));
2015             }
2016
2017             $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon);
2018             $activitynode->title(get_string('modulename', $activity->modname));
2019             $activitynode->hidden = $activity->hidden;
2020             $activitynode->display = $showactivities && $activity->display;
2021             $activitynode->nodetype = $activity->nodetype;
2022             $activitynodes[$activity->id] = $activitynode;
2023         }
2024
2025         return $activitynodes;
2026     }
2027     /**
2028      * Loads a stealth module from unavailable section
2029      * @param navigation_node $coursenode
2030      * @param stdClass $modinfo
2031      * @return navigation_node or null if not accessible
2032      */
2033     protected function load_stealth_activity(navigation_node $coursenode, $modinfo) {
2034         if (empty($modinfo->cms[$this->page->cm->id])) {
2035             return null;
2036         }
2037         $cm = $modinfo->cms[$this->page->cm->id];
2038         if ($cm->icon) {
2039             $icon = new pix_icon($cm->icon, get_string('modulename', $cm->modname), $cm->iconcomponent);
2040         } else {
2041             $icon = new pix_icon('icon', get_string('modulename', $cm->modname), $cm->modname);
2042         }
2043         $url = $cm->url;
2044         $activitynode = $coursenode->add(format_string($cm->name), $url, navigation_node::TYPE_ACTIVITY, null, $cm->id, $icon);
2045         $activitynode->title(get_string('modulename', $cm->modname));
2046         $activitynode->hidden = (!$cm->visible);
2047         if (!$cm->uservisible) {
2048             // Do not show any error here, let the page handle exception that activity is not visible for the current user.
2049             // Also there may be no exception at all in case when teacher is logged in as student.
2050             $activitynode->display = false;
2051         } else if (!$url) {
2052             // Don't show activities that don't have links!
2053             $activitynode->display = false;
2054         } else if (self::module_extends_navigation($cm->modname)) {
2055             $activitynode->nodetype = navigation_node::NODETYPE_BRANCH;
2056         }
2057         return $activitynode;
2058     }
2059     /**
2060      * Loads the navigation structure for the given activity into the activities node.
2061      *
2062      * This method utilises a callback within the modules lib.php file to load the
2063      * content specific to activity given.
2064      *
2065      * The callback is a method: {modulename}_extend_navigation()
2066      * Examples:
2067      *  * {@link forum_extend_navigation()}
2068      *  * {@link workshop_extend_navigation()}
2069      *
2070      * @param cm_info|stdClass $cm
2071      * @param stdClass $course
2072      * @param navigation_node $activity
2073      * @return bool
2074      */
2075     protected function load_activity($cm, stdClass $course, navigation_node $activity) {
2076         global $CFG, $DB;
2077
2078         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2079         if (!($cm instanceof cm_info)) {
2080             $modinfo = get_fast_modinfo($course);
2081             $cm = $modinfo->get_cm($cm->id);
2082         }
2083         $activity->nodetype = navigation_node::NODETYPE_LEAF;
2084         $activity->make_active();
2085         $file = $CFG->dirroot.'/mod/'.$cm->modname.'/lib.php';
2086         $function = $cm->modname.'_extend_navigation';
2087
2088         if (file_exists($file)) {
2089             require_once($file);
2090             if (function_exists($function)) {
2091                 $activtyrecord = $DB->get_record($cm->modname, array('id' => $cm->instance), '*', MUST_EXIST);
2092                 $function($activity, $course, $activtyrecord, $cm);
2093             }
2094         }
2095
2096         // Allow the active advanced grading method plugin to append module navigation
2097         $featuresfunc = $cm->modname.'_supports';
2098         if (function_exists($featuresfunc) && $featuresfunc(FEATURE_ADVANCED_GRADING)) {
2099             require_once($CFG->dirroot.'/grade/grading/lib.php');
2100             $gradingman = get_grading_manager($cm->context,  'mod_'.$cm->modname);
2101             $gradingman->extend_navigation($this, $activity);
2102         }
2103
2104         return $activity->has_children();
2105     }
2106     /**
2107      * Loads user specific information into the navigation in the appropriate place.
2108      *
2109      * If no user is provided the current user is assumed.
2110      *
2111      * @param stdClass $user
2112      * @param bool $forceforcontext probably force something to be loaded somewhere (ask SamH if not sure what this means)
2113      * @return bool
2114      */
2115     protected function load_for_user($user=null, $forceforcontext=false) {
2116         global $DB, $CFG, $USER, $SITE;
2117
2118         if ($user === null) {
2119             // We can't require login here but if the user isn't logged in we don't
2120             // want to show anything
2121             if (!isloggedin() || isguestuser()) {
2122                 return false;
2123             }
2124             $user = $USER;
2125         } else if (!is_object($user)) {
2126             // If the user is not an object then get them from the database
2127             $select = context_helper::get_preload_record_columns_sql('ctx');
2128             $sql = "SELECT u.*, $select
2129                       FROM {user} u
2130                       JOIN {context} ctx ON u.id = ctx.instanceid
2131                      WHERE u.id = :userid AND
2132                            ctx.contextlevel = :contextlevel";
2133             $user = $DB->get_record_sql($sql, array('userid' => (int)$user, 'contextlevel' => CONTEXT_USER), MUST_EXIST);
2134             context_helper::preload_from_record($user);
2135         }
2136
2137         $iscurrentuser = ($user->id == $USER->id);
2138
2139         $usercontext = context_user::instance($user->id);
2140
2141         // Get the course set against the page, by default this will be the site
2142         $course = $this->page->course;
2143         $baseargs = array('id'=>$user->id);
2144         if ($course->id != $SITE->id && (!$iscurrentuser || $forceforcontext)) {
2145             $coursenode = $this->add_course($course, false, self::COURSE_CURRENT);
2146             $baseargs['course'] = $course->id;
2147             $coursecontext = context_course::instance($course->id);
2148             $issitecourse = false;
2149         } else {
2150             // Load all categories and get the context for the system
2151             $coursecontext = context_system::instance();
2152             $issitecourse = true;
2153         }
2154
2155         // Create a node to add user information under.
2156         if ($iscurrentuser && !$forceforcontext) {
2157             // If it's the current user the information will go under the profile root node
2158             $usernode = $this->rootnodes['myprofile'];
2159             $course = get_site();
2160             $coursecontext = context_course::instance($course->id);
2161             $issitecourse = true;
2162         } else {
2163             if (!$issitecourse) {
2164                 // Not the current user so add it to the participants node for the current course
2165                 $usersnode = $coursenode->get('participants', navigation_node::TYPE_CONTAINER);
2166                 $userviewurl = new moodle_url('/user/view.php', $baseargs);
2167             } else {
2168                 // This is the site so add a users node to the root branch
2169                 $usersnode = $this->rootnodes['users'];
2170                 if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
2171                     $usersnode->action = new moodle_url('/user/index.php', array('id'=>$course->id));
2172                 }
2173                 $userviewurl = new moodle_url('/user/profile.php', $baseargs);
2174             }
2175             if (!$usersnode) {
2176                 // We should NEVER get here, if the course hasn't been populated
2177                 // with a participants node then the navigaiton either wasn't generated
2178                 // for it (you are missing a require_login or set_context call) or
2179                 // you don't have access.... in the interests of no leaking informatin
2180                 // we simply quit...
2181                 return false;
2182             }
2183             // Add a branch for the current user
2184             $canseefullname = has_capability('moodle/site:viewfullnames', $coursecontext);
2185             $usernode = $usersnode->add(fullname($user, $canseefullname), $userviewurl, self::TYPE_USER, null, $user->id);
2186
2187             if ($this->page->context->contextlevel == CONTEXT_USER && $user->id == $this->page->context->instanceid) {
2188                 $usernode->make_active();
2189             }
2190         }
2191
2192         // If the user is the current user or has permission to view the details of the requested
2193         // user than add a view profile link.
2194         if ($iscurrentuser || has_capability('moodle/user:viewdetails', $coursecontext) || has_capability('moodle/user:viewdetails', $usercontext)) {
2195             if ($issitecourse || ($iscurrentuser && !$forceforcontext)) {
2196                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/profile.php',$baseargs));
2197             } else {
2198                 $usernode->add(get_string('viewprofile'), new moodle_url('/user/view.php',$baseargs));
2199             }
2200         }
2201
2202         if (!empty($CFG->navadduserpostslinks)) {
2203             // Add nodes for forum posts and discussions if the user can view either or both
2204             // There are no capability checks here as the content of the page is based
2205             // purely on the forums the current user has access too.
2206             $forumtab = $usernode->add(get_string('forumposts', 'forum'));
2207             $forumtab->add(get_string('posts', 'forum'), new moodle_url('/mod/forum/user.php', $baseargs));
2208             $forumtab->add(get_string('discussions', 'forum'), new moodle_url('/mod/forum/user.php', array_merge($baseargs, array('mode'=>'discussions'))));
2209         }
2210
2211         // Add blog nodes
2212         if (!empty($CFG->enableblogs)) {
2213             if (!$this->cache->cached('userblogoptions'.$user->id)) {
2214                 require_once($CFG->dirroot.'/blog/lib.php');
2215                 // Get all options for the user
2216                 $options = blog_get_options_for_user($user);
2217                 $this->cache->set('userblogoptions'.$user->id, $options);
2218             } else {
2219                 $options = $this->cache->{'userblogoptions'.$user->id};
2220             }
2221
2222             if (count($options) > 0) {
2223                 $blogs = $usernode->add(get_string('blogs', 'blog'), null, navigation_node::TYPE_CONTAINER);
2224                 foreach ($options as $type => $option) {
2225                     if ($type == "rss") {
2226                         $blogs->add($option['string'], $option['link'], settings_navigation::TYPE_SETTING, null, null, new pix_icon('i/rss', ''));
2227                     } else {
2228                         $blogs->add($option['string'], $option['link']);
2229                     }
2230                 }
2231             }
2232         }
2233
2234         // Add the messages link.
2235         // It is context based so can appear in "My profile" and in course participants information.
2236         if (!empty($CFG->messaging)) {
2237             $messageargs = array('user1' => $USER->id);
2238             if ($USER->id != $user->id) {
2239                 $messageargs['user2'] = $user->id;
2240             }
2241             if ($course->id != $SITE->id) {
2242                 $messageargs['viewing'] = MESSAGE_VIEW_COURSE. $course->id;
2243             }
2244             $url = new moodle_url('/message/index.php',$messageargs);
2245             $usernode->add(get_string('messages', 'message'), $url, self::TYPE_SETTING, null, 'messages');
2246         }
2247
2248         // Add the "My private files" link.
2249         // This link doesn't have a unique display for course context so only display it under "My profile".
2250         if ($issitecourse && $iscurrentuser && has_capability('moodle/user:manageownfiles', $usercontext)) {
2251             $url = new moodle_url('/user/files.php');
2252             $usernode->add(get_string('myfiles'), $url, self::TYPE_SETTING);
2253         }
2254
2255         if (!empty($CFG->enablebadges) && $iscurrentuser &&
2256                 has_capability('moodle/badges:manageownbadges', $usercontext)) {
2257             $url = new moodle_url('/badges/mybadges.php');
2258             $usernode->add(get_string('mybadges', 'badges'), $url, self::TYPE_SETTING);
2259         }
2260
2261         // Add a node to view the users notes if permitted
2262         if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $coursecontext)) {
2263             $url = new moodle_url('/notes/index.php',array('user'=>$user->id));
2264             if ($coursecontext->instanceid != SITEID) {
2265                 $url->param('course', $coursecontext->instanceid);
2266             }
2267             $usernode->add(get_string('notes', 'notes'), $url);
2268         }
2269
2270         // If the user is the current user add the repositories for the current user
2271         $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
2272         if ($iscurrentuser) {
2273             if (!$this->cache->cached('contexthasrepos'.$usercontext->id)) {
2274                 require_once($CFG->dirroot . '/repository/lib.php');
2275                 $editabletypes = repository::get_editable_types($usercontext);
2276                 $haseditabletypes = !empty($editabletypes);
2277                 unset($editabletypes);
2278                 $this->cache->set('contexthasrepos'.$usercontext->id, $haseditabletypes);
2279             } else {
2280                 $haseditabletypes = $this->cache->{'contexthasrepos'.$usercontext->id};
2281             }
2282             if ($haseditabletypes) {
2283                 $usernode->add(get_string('repositories', 'repository'), new moodle_url('/repository/manage_instances.php', array('contextid' => $usercontext->id)));
2284             }
2285         } else if ($course->id == $SITE->id && has_capability('moodle/user:viewdetails', $usercontext) && (!in_array('mycourses', $hiddenfields) || has_capability('moodle/user:viewhiddendetails', $coursecontext))) {
2286
2287             // Add view grade report is permitted
2288             $reports = core_component::get_plugin_list('gradereport');
2289             arsort($reports); // user is last, we want to test it first
2290
2291             $userscourses = enrol_get_users_courses($user->id);
2292             $userscoursesnode = $usernode->add(get_string('courses'));
2293
2294             $count = 0;
2295             foreach ($userscourses as $usercourse) {
2296                 if ($count === (int)$CFG->navcourselimit) {
2297                     $url = new moodle_url('/user/profile.php', array('id' => $user->id, 'showallcourses' => 1));
2298                     $userscoursesnode->add(get_string('showallcourses'), $url);
2299                     break;
2300                 }
2301                 $count++;
2302                 $usercoursecontext = context_course::instance($usercourse->id);
2303                 $usercourseshortname = format_string($usercourse->shortname, true, array('context' => $usercoursecontext));
2304                 $usercoursenode = $userscoursesnode->add($usercourseshortname, new moodle_url('/user/view.php', array('id'=>$user->id, 'course'=>$usercourse->id)), self::TYPE_CONTAINER);
2305
2306                 $gradeavailable = has_capability('moodle/grade:viewall', $usercoursecontext);
2307                 if (!$gradeavailable && !empty($usercourse->showgrades) && is_array($reports) && !empty($reports)) {
2308                     foreach ($reports as $plugin => $plugindir) {
2309                         if (has_capability('gradereport/'.$plugin.':view', $usercoursecontext)) {
2310                             //stop when the first visible plugin is found
2311                             $gradeavailable = true;
2312                             break;
2313                         }
2314                     }
2315                 }
2316
2317                 if ($gradeavailable) {
2318                     $url = new moodle_url('/grade/report/index.php', array('id'=>$usercourse->id));
2319                     $usercoursenode->add(get_string('grades'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/grades', ''));
2320                 }
2321
2322                 // Add a node to view the users notes if permitted
2323                 if (!empty($CFG->enablenotes) && has_any_capability(array('moodle/notes:manage', 'moodle/notes:view'), $usercoursecontext)) {
2324                     $url = new moodle_url('/notes/index.php',array('user'=>$user->id, 'course'=>$usercourse->id));
2325                     $usercoursenode->add(get_string('notes', 'notes'), $url, self::TYPE_SETTING);
2326                 }
2327
2328                 if (can_access_course($usercourse, $user->id)) {
2329                     $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', ''));
2330                 }
2331
2332                 $reporttab = $usercoursenode->add(get_string('activityreports'));
2333
2334                 $reports = get_plugin_list_with_function('report', 'extend_navigation_user', 'lib.php');
2335                 foreach ($reports as $reportfunction) {
2336                     $reportfunction($reporttab, $user, $usercourse);
2337                 }
2338
2339                 $reporttab->trim_if_empty();
2340             }
2341         }
2342         return true;
2343     }
2344
2345     /**
2346      * This method simply checks to see if a given module can extend the navigation.
2347      *
2348      * @todo (MDL-25290) A shared caching solution should be used to save details on what extends navigation.
2349      *
2350      * @param string $modname
2351      * @return bool
2352      */
2353     public static function module_extends_navigation($modname) {
2354         global $CFG;
2355         static $extendingmodules = array();
2356         if (!array_key_exists($modname, $extendingmodules)) {
2357             $extendingmodules[$modname] = false;
2358             $file = $CFG->dirroot.'/mod/'.$modname.'/lib.php';
2359             if (file_exists($file)) {
2360                 $function = $modname.'_extend_navigation';
2361                 require_once($file);
2362                 $extendingmodules[$modname] = (function_exists($function));
2363             }
2364         }
2365         return $extendingmodules[$modname];
2366     }
2367     /**
2368      * Extends the navigation for the given user.
2369      *
2370      * @param stdClass $user A user from the database
2371      */
2372     public function extend_for_user($user) {
2373         $this->extendforuser[] = $user;
2374     }
2375
2376     /**
2377      * Returns all of the users the navigation is being extended for
2378      *
2379      * @return array An array of extending users.
2380      */
2381     public function get_extending_users() {
2382         return $this->extendforuser;
2383     }
2384     /**
2385      * Adds the given course to the navigation structure.
2386      *
2387      * @param stdClass $course
2388      * @param bool $forcegeneric
2389      * @param bool $ismycourse
2390      * @return navigation_node
2391      */
2392     public function add_course(stdClass $course, $forcegeneric = false, $coursetype = self::COURSE_OTHER) {
2393         global $CFG, $SITE;
2394
2395         // We found the course... we can return it now :)
2396         if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2397             return $this->addedcourses[$course->id];
2398         }
2399
2400         $coursecontext = context_course::instance($course->id);
2401
2402         if ($course->id != $SITE->id && !$course->visible) {
2403             if (is_role_switched($course->id)) {
2404                 // user has to be able to access course in order to switch, let's skip the visibility test here
2405             } else if (!has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2406                 return false;
2407             }
2408         }
2409
2410         $issite = ($course->id == $SITE->id);
2411         $shortname = format_string($course->shortname, true, array('context' => $coursecontext));
2412         $fullname = format_string($course->fullname, true, array('context' => $coursecontext));
2413         // This is the name that will be shown for the course.
2414         $coursename = empty($CFG->navshowfullcoursenames) ? $shortname : $fullname;
2415
2416         // Can the user expand the course to see its content.
2417         $canexpandcourse = true;
2418         if ($issite) {
2419             $parent = $this;
2420             $url = null;
2421             if (empty($CFG->usesitenameforsitepages)) {
2422                 $coursename = get_string('sitepages');
2423             }
2424         } else if ($coursetype == self::COURSE_CURRENT) {
2425             $parent = $this->rootnodes['currentcourse'];
2426             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2427         } else if ($coursetype == self::COURSE_MY && !$forcegeneric) {
2428             if (!empty($CFG->navshowmycoursecategories) && ($parent = $this->rootnodes['mycourses']->find($course->category, self::TYPE_MY_CATEGORY))) {
2429                 // Nothing to do here the above statement set $parent to the category within mycourses.
2430             } else {
2431                 $parent = $this->rootnodes['mycourses'];
2432             }
2433             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2434         } else {
2435             $parent = $this->rootnodes['courses'];
2436             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
2437             // They can only expand the course if they can access it.
2438             $canexpandcourse = $this->can_expand_course($course);
2439             if (!empty($course->category) && $this->show_categories($coursetype == self::COURSE_MY)) {
2440                 if (!$this->is_category_fully_loaded($course->category)) {
2441                     // We need to load the category structure for this course
2442                     $this->load_all_categories($course->category, false);
2443                 }
2444                 if (array_key_exists($course->category, $this->addedcategories)) {
2445                     $parent = $this->addedcategories[$course->category];
2446                     // This could lead to the course being created so we should check whether it is the case again
2447                     if (!$forcegeneric && array_key_exists($course->id, $this->addedcourses)) {
2448                         return $this->addedcourses[$course->id];
2449                     }
2450                 }
2451             }
2452         }
2453
2454         $coursenode = $parent->add($coursename, $url, self::TYPE_COURSE, $shortname, $course->id);
2455         $coursenode->hidden = (!$course->visible);
2456         // We need to decode &amp;'s here as they will have been added by format_string above and attributes will be encoded again
2457         // later.
2458         $coursenode->title(str_replace('&amp;', '&', $fullname));
2459         if ($canexpandcourse) {
2460             // This course can be expanded by the user, make it a branch to make the system aware that its expandable by ajax.
2461             $coursenode->nodetype = self::NODETYPE_BRANCH;
2462             $coursenode->isexpandable = true;
2463         } else {
2464             $coursenode->nodetype = self::NODETYPE_LEAF;
2465             $coursenode->isexpandable = false;
2466         }
2467         if (!$forcegeneric) {
2468             $this->addedcourses[$course->id] = $coursenode;
2469         }
2470
2471         return $coursenode;
2472     }
2473
2474     /**
2475      * Returns a cache instance to use for the expand course cache.
2476      * @return cache_session
2477      */
2478     protected function get_expand_course_cache() {
2479         if ($this->cacheexpandcourse === null) {
2480             $this->cacheexpandcourse = cache::make('core', 'navigation_expandcourse');
2481         }
2482         return $this->cacheexpandcourse;
2483     }
2484
2485     /**
2486      * Checks if a user can expand a course in the navigation.
2487      *
2488      * We use a cache here because in order to be accurate we need to call can_access_course which is a costly function.
2489      * Because this functionality is basic + non-essential and because we lack good event triggering this cache
2490      * permits stale data.
2491      * In the situation the user is granted access to a course after we've initialised this session cache the cache
2492      * will be stale.
2493      * It is brought up to date in only one of two ways.
2494      *   1. The user logs out and in again.
2495      *   2. The user browses to the course they've just being given access to.
2496      *
2497      * Really all this controls is whether the node is shown as expandable or not. It is uber un-important.
2498      *
2499      * @param stdClass $course
2500      * @return bool
2501      */
2502     protected function can_expand_course($course) {
2503         $cache = $this->get_expand_course_cache();
2504         $canexpand = $cache->get($course->id);
2505         if ($canexpand === false) {
2506             $canexpand = isloggedin() && can_access_course($course);
2507             $canexpand = (int)$canexpand;
2508             $cache->set($course->id, $canexpand);
2509         }
2510         return ($canexpand === 1);
2511     }
2512
2513     /**
2514      * Returns true if the category has already been loaded as have any child categories
2515      *
2516      * @param int $categoryid
2517      * @return bool
2518      */
2519     protected function is_category_fully_loaded($categoryid) {
2520         return (array_key_exists($categoryid, $this->addedcategories) && ($this->allcategoriesloaded || $this->addedcategories[$categoryid]->children->count() > 0));
2521     }
2522
2523     /**
2524      * Adds essential course nodes to the navigation for the given course.
2525      *
2526      * This method adds nodes such as reports, blogs and participants
2527      *
2528      * @param navigation_node $coursenode
2529      * @param stdClass $course
2530      * @return bool returns true on successful addition of a node.
2531      */
2532     public function add_course_essentials($coursenode, stdClass $course) {
2533         global $CFG, $SITE;
2534
2535         if ($course->id == $SITE->id) {
2536             return $this->add_front_page_course_essentials($coursenode, $course);
2537         }
2538
2539         if ($coursenode == false || !($coursenode instanceof navigation_node) || $coursenode->get('participants', navigation_node::TYPE_CONTAINER)) {
2540             return true;
2541         }
2542
2543         //Participants
2544         if (has_capability('moodle/course:viewparticipants', $this->page->context)) {
2545             $participants = $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CONTAINER, get_string('participants'), 'participants');
2546             if (!empty($CFG->enableblogs)) {
2547                 if (($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2548                    and has_capability('moodle/blog:view', context_system::instance())) {
2549                     $blogsurls = new moodle_url('/blog/index.php');
2550                     if ($course->id == $SITE->id) {
2551                         $blogsurls->param('courseid', 0);
2552                     } else if ($currentgroup = groups_get_course_group($course, true)) {
2553                         $blogsurls->param('groupid', $currentgroup);
2554                     } else {
2555                         $blogsurls->param('courseid', $course->id);
2556                     }
2557                     $participants->add(get_string('blogscourse','blog'), $blogsurls->out());
2558                 }
2559             }
2560             if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2561                 $participants->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$course->id)));
2562             }
2563         } else if (count($this->extendforuser) > 0 || $this->page->course->id == $course->id) {
2564             $participants = $coursenode->add(get_string('participants'), null, self::TYPE_CONTAINER, get_string('participants'), 'participants');
2565         }
2566
2567         // Badges.
2568         if (!empty($CFG->enablebadges) && !empty($CFG->badges_allowcoursebadges) &&
2569             has_capability('moodle/badges:viewbadges', $this->page->context)) {
2570             $url = new moodle_url('/badges/view.php', array('type' => 2, 'id' => $course->id));
2571
2572             $coursenode->add(get_string('coursebadges', 'badges'), null,
2573                     navigation_node::TYPE_CONTAINER, null, 'coursebadges');
2574             $coursenode->get('coursebadges')->add(get_string('badgesview', 'badges'), $url,
2575                     navigation_node::TYPE_SETTING, null, 'badgesview',
2576                     new pix_icon('i/badge', get_string('badgesview', 'badges')));
2577         }
2578
2579         return true;
2580     }
2581     /**
2582      * This generates the structure of the course that won't be generated when
2583      * the modules and sections are added.
2584      *
2585      * Things such as the reports branch, the participants branch, blogs... get
2586      * added to the course node by this method.
2587      *
2588      * @param navigation_node $coursenode
2589      * @param stdClass $course
2590      * @return bool True for successfull generation
2591      */
2592     public function add_front_page_course_essentials(navigation_node $coursenode, stdClass $course) {
2593         global $CFG;
2594
2595         if ($coursenode == false || $coursenode->get('frontpageloaded', navigation_node::TYPE_CUSTOM)) {
2596             return true;
2597         }
2598
2599         // Hidden node that we use to determine if the front page navigation is loaded.
2600         // This required as there are not other guaranteed nodes that may be loaded.
2601         $coursenode->add('frontpageloaded', null, self::TYPE_CUSTOM, null, 'frontpageloaded')->display = false;
2602
2603         //Participants
2604         if (has_capability('moodle/course:viewparticipants',  context_system::instance())) {
2605             $coursenode->add(get_string('participants'), new moodle_url('/user/index.php?id='.$course->id), self::TYPE_CUSTOM, get_string('participants'), 'participants');
2606         }
2607
2608         $filterselect = 0;
2609
2610         // Blogs
2611         if (!empty($CFG->enableblogs)
2612           and ($CFG->bloglevel == BLOG_GLOBAL_LEVEL or ($CFG->bloglevel == BLOG_SITE_LEVEL and (isloggedin() and !isguestuser())))
2613           and has_capability('moodle/blog:view', context_system::instance())) {
2614             $blogsurls = new moodle_url('/blog/index.php', array('courseid' => $filterselect));
2615             $coursenode->add(get_string('blogssite','blog'), $blogsurls->out());
2616         }
2617
2618         //Badges
2619         if (!empty($CFG->enablebadges) && has_capability('moodle/badges:viewbadges', $this->page->context)) {
2620             $url = new moodle_url($CFG->wwwroot . '/badges/view.php', array('type' => 1));
2621             $coursenode->add(get_string('sitebadges', 'badges'), $url, navigation_node::TYPE_CUSTOM);
2622         }
2623
2624         // Notes
2625         if (!empty($CFG->enablenotes) && (has_capability('moodle/notes:manage', $this->page->context) || has_capability('moodle/notes:view', $this->page->context))) {
2626             $coursenode->add(get_string('notes','notes'), new moodle_url('/notes/index.php', array('filtertype'=>'course', 'filterselect'=>$filterselect)));
2627         }
2628
2629         // Tags
2630         if (!empty($CFG->usetags) && isloggedin()) {
2631             $coursenode->add(get_string('tags', 'tag'), new moodle_url('/tag/search.php'));
2632         }
2633
2634         if (isloggedin()) {
2635             // Calendar
2636             $calendarurl = new moodle_url('/calendar/view.php', array('view' => 'month'));
2637             $coursenode->add(get_string('calendar', 'calendar'), $calendarurl, self::TYPE_CUSTOM, null, 'calendar');
2638         }
2639
2640         return true;
2641     }
2642
2643     /**
2644      * Clears the navigation cache
2645      */
2646     public function clear_cache() {
2647         $this->cache->clear();
2648     }
2649
2650     /**
2651      * Sets an expansion limit for the navigation
2652      *
2653      * The expansion limit is used to prevent the display of content that has a type
2654      * greater than the provided $type.
2655      *
2656      * Can be used to ensure things such as activities or activity content don't get
2657      * shown on the navigation.
2658      * They are still generated in order to ensure the navbar still makes sense.
2659      *
2660      * @param int $type One of navigation_node::TYPE_*
2661      * @return bool true when complete.
2662      */
2663     public function set_expansion_limit($type) {
2664         global $SITE;
2665         $nodes = $this->find_all_of_type($type);
2666
2667         // We only want to hide specific types of nodes.
2668         // Only nodes that represent "structure" in the navigation tree should be hidden.
2669         // If we hide all nodes then we risk hiding vital information.
2670         $typestohide = array(
2671             self::TYPE_CATEGORY,
2672             self::TYPE_COURSE,
2673             self::TYPE_SECTION,
2674             self::TYPE_ACTIVITY
2675         );
2676
2677         foreach ($nodes as $node) {
2678             // We need to generate the full site node
2679             if ($type == self::TYPE_COURSE && $node->key == $SITE->id) {
2680                 continue;
2681             }
2682             foreach ($node->children as $child) {
2683                 $child->hide($typestohide);
2684             }
2685         }
2686         return true;
2687     }
2688     /**
2689      * Attempts to get the navigation with the given key from this nodes children.
2690      *
2691      * This function only looks at this nodes children, it does NOT look recursivily.
2692      * If the node can't be found then false is returned.
2693      *
2694      * If you need to search recursivily then use the {@link global_navigation::find()} method.
2695      *
2696      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2697      * may be of more use to you.
2698      *
2699      * @param string|int $key The key of the node you wish to receive.
2700      * @param int $type One of navigation_node::TYPE_*
2701      * @return navigation_node|false
2702      */
2703     public function get($key, $type = null) {
2704         if (!$this->initialised) {
2705             $this->initialise();
2706         }
2707         return parent::get($key, $type);
2708     }
2709
2710     /**
2711      * Searches this nodes children and their children to find a navigation node
2712      * with the matching key and type.
2713      *
2714      * This method is recursive and searches children so until either a node is
2715      * found or there are no more nodes to search.
2716      *
2717      * If you know that the node being searched for is a child of this node
2718      * then use the {@link global_navigation::get()} method instead.
2719      *
2720      * Note: If you are trying to set the active node {@link navigation_node::override_active_url()}
2721      * may be of more use to you.
2722      *
2723      * @param string|int $key The key of the node you wish to receive.
2724      * @param int $type One of navigation_node::TYPE_*
2725      * @return navigation_node|false
2726      */
2727     public function find($key, $type) {
2728         if (!$this->initialised) {
2729             $this->initialise();
2730         }
2731         if ($type == self::TYPE_ROOTNODE && array_key_exists($key, $this->rootnodes)) {
2732             return $this->rootnodes[$key];
2733         }
2734         return parent::find($key, $type);
2735     }
2736
2737     /**
2738      * They've expanded the 'my courses' branch.
2739      */
2740     protected function load_courses_enrolled() {
2741         global $CFG, $DB;
2742         $sortorder = 'visible DESC';
2743         // Prevent undefined $CFG->navsortmycoursessort errors.
2744         if (empty($CFG->navsortmycoursessort)) {
2745             $CFG->navsortmycoursessort = 'sortorder';
2746         }
2747         // Append the chosen sortorder.
2748         $sortorder = $sortorder . ',' . $CFG->navsortmycoursessort . ' ASC';
2749         $courses = enrol_get_my_courses(null, $sortorder);
2750         if (count($courses) && $this->show_my_categories()) {
2751             // OK Actually we are loading categories. We only want to load categories that have a parent of 0.
2752             // In order to make sure we load everything required we must first find the categories that are not
2753             // base categories and work out the bottom category in thier path.
2754             $categoryids = array();
2755             foreach ($courses as $course) {
2756                 $categoryids[] = $course->category;
2757             }
2758             $categoryids = array_unique($categoryids);
2759             list($sql, $params) = $DB->get_in_or_equal($categoryids);
2760             $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent <> 0', $params, 'sortorder, id', 'id, path');
2761             foreach ($categories as $category) {
2762                 $bits = explode('/', trim($category->path,'/'));
2763                 $categoryids[] = array_shift($bits);
2764             }
2765             $categoryids = array_unique($categoryids);
2766             $categories->close();
2767
2768             // Now we load the base categories.
2769             list($sql, $params) = $DB->get_in_or_equal($categoryids);
2770             $categories = $DB->get_recordset_select('course_categories', 'id '.$sql.' AND parent = 0', $params, 'sortorder, id');
2771             foreach ($categories as $category) {
2772                 $this->add_category($category, $this->rootnodes['mycourses'], self::TYPE_MY_CATEGORY);
2773             }
2774             $categories->close();
2775         } else {
2776             foreach ($courses as $course) {
2777                 $this->add_course($course, false, self::COURSE_MY);
2778             }
2779         }
2780     }
2781 }
2782
2783 /**
2784  * The global navigation class used especially for AJAX requests.
2785  *
2786  * The primary methods that are used in the global navigation class have been overriden
2787  * to ensure that only the relevant branch is generated at the root of the tree.
2788  * This can be done because AJAX is only used when the backwards structure for the
2789  * requested branch exists.
2790  * This has been done only because it shortens the amounts of information that is generated
2791  * which of course will speed up the response time.. because no one likes laggy AJAX.
2792  *
2793  * @package   core
2794  * @category  navigation
2795  * @copyright 2009 Sam Hemelryk
2796  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2797  */
2798 class global_navigation_for_ajax extends global_navigation {
2799
2800     /** @var int used for determining what type of navigation_node::TYPE_* is being used */
2801     protected $branchtype;
2802
2803     /** @var int the instance id */
2804     protected $instanceid;
2805
2806     /** @var array Holds an array of expandable nodes */
2807     protected $expandable = array();
2808
2809     /**
2810      * Constructs the navigation for use in an AJAX request
2811      *
2812      * @param moodle_page $page moodle_page object
2813      * @param int $branchtype
2814      * @param int $id
2815      */
2816     public function __construct($page, $branchtype, $id) {
2817         $this->page = $page;
2818         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
2819         $this->children = new navigation_node_collection();
2820         $this->branchtype = $branchtype;
2821         $this->instanceid = $id;
2822         $this->initialise();
2823     }
2824     /**
2825      * Initialise the navigation given the type and id for the branch to expand.
2826      *
2827      * @return array An array of the expandable nodes
2828      */
2829     public function initialise() {
2830         global $DB, $SITE;
2831
2832         if ($this->initialised || during_initial_install()) {
2833             return $this->expandable;
2834         }
2835         $this->initialised = true;
2836
2837         $this->rootnodes = array();
2838         $this->rootnodes['site']    = $this->add_course($SITE);
2839         $this->rootnodes['mycourses'] = $this->add(get_string('mycourses'), new moodle_url('/my'), self::TYPE_ROOTNODE, null, 'mycourses');
2840         $this->rootnodes['courses'] = $this->add(get_string('courses'), null, self::TYPE_ROOTNODE, null, 'courses');
2841         // The courses branch is always displayed, and is always expandable (although may be empty).
2842         // This mimicks what is done during {@link global_navigation::initialise()}.
2843         $this->rootnodes['courses']->isexpandable = true;
2844
2845         // Branchtype will be one of navigation_node::TYPE_*
2846         switch ($this->branchtype) {
2847             case 0:
2848                 if ($this->instanceid === 'mycourses') {
2849                     $this->load_courses_enrolled();
2850                 } else if ($this->instanceid === 'courses') {
2851                     $this->load_courses_other();
2852                 }
2853                 break;
2854             case self::TYPE_CATEGORY :
2855                 $this->load_category($this->instanceid);
2856                 break;
2857             case self::TYPE_MY_CATEGORY :
2858                 $this->load_category($this->instanceid, self::TYPE_MY_CATEGORY);
2859                 break;
2860             case self::TYPE_COURSE :
2861                 $course = $DB->get_record('course', array('id' => $this->instanceid), '*', MUST_EXIST);
2862                 if (!can_access_course($course)) {
2863                     // Thats OK all courses are expandable by default. We don't need to actually expand it we can just
2864                     // add the course node and break. This leads to an empty node.
2865                     $this->add_course($course);
2866                     break;
2867                 }
2868                 require_course_login($course, true, null, false, true);
2869                 $this->page->set_context(context_course::instance($course->id));
2870                 $coursenode = $this->add_course($course);
2871                 $this->add_course_essentials($coursenode, $course);
2872                 $this->load_course_sections($course, $coursenode);
2873                 break;
2874             case self::TYPE_SECTION :
2875                 $sql = 'SELECT c.*, cs.section AS sectionnumber
2876                         FROM {course} c
2877                         LEFT JOIN {course_sections} cs ON cs.course = c.id
2878                         WHERE cs.id = ?';
2879                 $course = $DB->get_record_sql($sql, array($this->instanceid), MUST_EXIST);
2880                 require_course_login($course, true, null, false, true);
2881                 $this->page->set_context(context_course::instance($course->id));
2882                 $coursenode = $this->add_course($course);
2883                 $this->add_course_essentials($coursenode, $course);
2884                 $this->load_course_sections($course, $coursenode, $course->sectionnumber);
2885                 break;
2886             case self::TYPE_ACTIVITY :
2887                 $sql = "SELECT c.*
2888                           FROM {course} c
2889                           JOIN {course_modules} cm ON cm.course = c.id
2890                          WHERE cm.id = :cmid";
2891                 $params = array('cmid' => $this->instanceid);
2892                 $course = $DB->get_record_sql($sql, $params, MUST_EXIST);
2893                 $modinfo = get_fast_modinfo($course);
2894                 $cm = $modinfo->get_cm($this->instanceid);
2895                 require_course_login($course, true, $cm, false, true);
2896                 $this->page->set_context(context_module::instance($cm->id));
2897                 $coursenode = $this->load_course($course);
2898                 $this->load_course_sections($course, $coursenode, null, $cm);
2899                 $activitynode = $coursenode->find($cm->id, self::TYPE_ACTIVITY);
2900                 if ($activitynode) {
2901                     $modulenode = $this->load_activity($cm, $course, $activitynode);
2902                 }
2903                 break;
2904             default:
2905                 throw new Exception('Unknown type');
2906                 return $this->expandable;
2907         }
2908
2909         if ($this->page->context->contextlevel == CONTEXT_COURSE && $this->page->context->instanceid != $SITE->id) {
2910             $this->load_for_user(null, true);
2911         }
2912
2913         $this->find_expandable($this->expandable);
2914         return $this->expandable;
2915     }
2916
2917     /**
2918      * They've expanded the general 'courses' branch.
2919      */
2920     protected function load_courses_other() {
2921         $this->load_all_courses();
2922     }
2923
2924     /**
2925      * Loads a single category into the AJAX navigation.
2926      *
2927      * This function is special in that it doesn't concern itself with the parent of
2928      * the requested category or its siblings.
2929      * This is because with the AJAX navigation we know exactly what is wanted and only need to
2930      * request that.
2931      *
2932      * @global moodle_database $DB
2933      * @param int $categoryid id of category to load in navigation.
2934      * @param int $nodetype type of node, if category is under MyHome then it's TYPE_MY_CATEGORY
2935      * @return void.
2936      */
2937     protected function load_category($categoryid, $nodetype = self::TYPE_CATEGORY) {
2938         global $CFG, $DB;
2939
2940         $limit = 20;
2941         if (!empty($CFG->navcourselimit)) {
2942             $limit = (int)$CFG->navcourselimit;
2943         }
2944
2945         $catcontextsql = context_helper::get_preload_record_columns_sql('ctx');
2946         $sql = "SELECT cc.*, $catcontextsql
2947                   FROM {course_categories} cc
2948                   JOIN {context} ctx ON cc.id = ctx.instanceid
2949                  WHERE ctx.contextlevel = ".CONTEXT_COURSECAT." AND
2950                        (cc.id = :categoryid1 OR cc.parent = :categoryid2)
2951               ORDER BY cc.depth ASC, cc.sortorder ASC, cc.id ASC";
2952         $params = array('categoryid1' => $categoryid, 'categoryid2' => $categoryid);
2953         $categories = $DB->get_recordset_sql($sql, $params, 0, $limit);
2954         $categorylist = array();
2955         $subcategories = array();
2956         $basecategory = null;
2957         foreach ($categories as $category) {
2958             $categorylist[] = $category->id;
2959             context_helper::preload_from_record($category);
2960             if ($category->id == $categoryid) {
2961                 $this->add_category($category, $this, $nodetype);
2962                 $basecategory = $this->addedcategories[$category->id];
2963             } else {
2964                 $subcategories[$category->id] = $category;
2965             }
2966         }
2967         $categories->close();
2968
2969
2970         // If category is shown in MyHome then only show enrolled courses and hide empty subcategories,
2971         // else show all courses.
2972         if ($nodetype === self::TYPE_MY_CATEGORY) {
2973             $courses = enrol_get_my_courses();
2974             $categoryids = array();
2975
2976             // Only search for categories if basecategory was found.
2977             if (!is_null($basecategory)) {
2978                 // Get course parent category ids.
2979                 foreach ($courses as $course) {
2980                     $categoryids[] = $course->category;
2981                 }
2982
2983                 // Get a unique list of category ids which a part of the path
2984                 // to user's courses.
2985                 $coursesubcategories = array();
2986                 $addedsubcategories = array();
2987
2988                 list($sql, $params) = $DB->get_in_or_equal($categoryids);
2989                 $categories = $DB->get_recordset_select('course_categories', 'id '.$sql, $params, 'sortorder, id', 'id, path');
2990
2991                 foreach ($categories as $category){
2992                     $coursesubcategories = array_merge($coursesubcategories, explode('/', trim($category->path, "/")));
2993                 }
2994                 $coursesubcategories = array_unique($coursesubcategories);
2995
2996                 // Only add a subcategory if it is part of the path to user's course and
2997                 // wasn't already added.
2998                 foreach ($subcategories as $subid => $subcategory) {
2999                     if (in_array($subid, $coursesubcategories) &&
3000                             !in_array($subid, $addedsubcategories)) {
3001                             $this->add_category($subcategory, $basecategory, $nodetype);
3002                             $addedsubcategories[] = $subid;
3003                     }
3004                 }
3005             }
3006
3007             foreach ($courses as $course) {
3008                 // Add course if it's in category.
3009                 if (in_array($course->category, $categorylist)) {
3010                     $this->add_course($course, true, self::COURSE_MY);
3011                 }
3012             }
3013         } else {
3014             if (!is_null($basecategory)) {
3015                 foreach ($subcategories as $key=>$category) {
3016                     $this->add_category($category, $basecategory, $nodetype);
3017                 }
3018             }
3019             $courses = $DB->get_recordset('course', array('category' => $categoryid), 'sortorder', '*' , 0, $limit);
3020             foreach ($courses as $course) {
3021                 $this->add_course($course);
3022             }
3023             $courses->close();
3024         }
3025     }
3026
3027     /**
3028      * Returns an array of expandable nodes
3029      * @return array
3030      */
3031     public function get_expandable() {
3032         return $this->expandable;
3033     }
3034 }
3035
3036 /**
3037  * Navbar class
3038  *
3039  * This class is used to manage the navbar, which is initialised from the navigation
3040  * object held by PAGE
3041  *
3042  * @package   core
3043  * @category  navigation
3044  * @copyright 2009 Sam Hemelryk
3045  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3046  */
3047 class navbar extends navigation_node {
3048     /** @var bool A switch for whether the navbar is initialised or not */
3049     protected $initialised = false;
3050     /** @var mixed keys used to reference the nodes on the navbar */
3051     protected $keys = array();
3052     /** @var null|string content of the navbar */
3053     protected $content = null;
3054     /** @var moodle_page object the moodle page that this navbar belongs to */
3055     protected $page;
3056     /** @var bool A switch for whether to ignore the active navigation information */
3057     protected $ignoreactive = false;
3058     /** @var bool A switch to let us know if we are in the middle of an install */
3059     protected $duringinstall = false;
3060     /** @var bool A switch for whether the navbar has items */
3061     protected $hasitems = false;
3062     /** @var array An array of navigation nodes for the navbar */
3063     protected $items;
3064     /** @var array An array of child node objects */
3065     public $children = array();
3066     /** @var bool A switch for whether we want to include the root node in the navbar */
3067     public $includesettingsbase = false;
3068     /** @var navigation_node[] $prependchildren */
3069     protected $prependchildren = array();
3070     /**
3071      * The almighty constructor
3072      *
3073      * @param moodle_page $page
3074      */
3075     public function __construct(moodle_page $page) {
3076         global $CFG;
3077         if (during_initial_install()) {
3078             $this->duringinstall = true;
3079             return false;
3080         }
3081         $this->page = $page;
3082         $this->text = get_string('home');
3083         $this->shorttext = get_string('home');
3084         $this->action = new moodle_url($CFG->wwwroot);
3085         $this->nodetype = self::NODETYPE_BRANCH;
3086         $this->type = self::TYPE_SYSTEM;
3087     }
3088
3089     /**
3090      * Quick check to see if the navbar will have items in.
3091      *
3092      * @return bool Returns true if the navbar will have items, false otherwise
3093      */
3094     public function has_items() {
3095         if ($this->duringinstall) {
3096             return false;
3097         } else if ($this->hasitems !== false) {
3098             return true;
3099         }
3100         if (count($this->children) > 0 || count($this->prependchildren) > 0) {
3101             // There have been manually added items - there are definitely items.
3102             $outcome = true;
3103         } else if (!$this->ignoreactive) {
3104             // We will need to initialise the navigation structure to check if there are active items.
3105             $this->page->navigation->initialise($this->page);
3106             $outcome = ($this->page->navigation->contains_active_node() || $this->page->settingsnav->contains_active_node());
3107         }
3108         $this->hasitems = $outcome;
3109         return $outcome;
3110     }
3111
3112     /**
3113      * Turn on/off ignore active
3114      *
3115      * @param bool $setting
3116      */
3117     public function ignore_active($setting=true) {
3118         $this->ignoreactive = ($setting);
3119     }
3120
3121     /**
3122      * Gets a navigation node
3123      *
3124      * @param string|int $key for referencing the navbar nodes
3125      * @param int $type navigation_node::TYPE_*
3126      * @return navigation_node|bool
3127      */
3128     public function get($key, $type = null) {
3129         foreach ($this->children as &$child) {
3130             if ($child->key === $key && ($type == null || $type == $child->type)) {
3131                 return $child;
3132             }
3133         }
3134         foreach ($this->prependchildren as &$child) {
3135             if ($child->key === $key && ($type == null || $type == $child->type)) {
3136                 return $child;
3137             }
3138         }
3139         return false;
3140     }
3141     /**
3142      * Returns an array of navigation_node's that make up the navbar.
3143      *
3144      * @return array
3145      */
3146     public function get_items() {
3147         global $CFG;
3148         $items = array();
3149         // Make sure that navigation is initialised
3150         if (!$this->has_items()) {
3151             return $items;
3152         }
3153         if ($this->items !== null) {
3154             return $this->items;
3155         }
3156
3157         if (count($this->children) > 0) {
3158             // Add the custom children.
3159             $items = array_reverse($this->children);
3160         }
3161
3162         // Check if navigation contains the active node
3163         if (!$this->ignoreactive) {
3164             // We will need to ensure the navigation has been initialised.
3165             $this->page->navigation->initialise($this->page);
3166             // Now find the active nodes on both the navigation and settings.
3167             $navigationactivenode = $this->page->navigation->find_active_node();
3168             $settingsactivenode = $this->page->settingsnav->find_active_node();
3169
3170             if ($navigationactivenode && $settingsactivenode) {
3171                 // Parse a combined navigation tree
3172                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3173                     if (!$settingsactivenode->mainnavonly) {
3174                         $items[] = $settingsactivenode;
3175                     }
3176                     $settingsactivenode = $settingsactivenode->parent;
3177                 }
3178                 if (!$this->includesettingsbase) {
3179                     // Removes the first node from the settings (root node) from the list
3180                     array_pop($items);
3181                 }
3182                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3183                     if (!$navigationactivenode->mainnavonly) {
3184                         $items[] = $navigationactivenode;
3185                     }
3186                     if (!empty($CFG->navshowcategories) &&
3187                             $navigationactivenode->type === self::TYPE_COURSE &&
3188                             $navigationactivenode->parent->key === 'currentcourse') {
3189                         $items = array_merge($items, $this->get_course_categories());
3190                     }
3191                     $navigationactivenode = $navigationactivenode->parent;
3192                 }
3193             } else if ($navigationactivenode) {
3194                 // Parse the navigation tree to get the active node
3195                 while ($navigationactivenode && $navigationactivenode->parent !== null) {
3196                     if (!$navigationactivenode->mainnavonly) {
3197                         $items[] = $navigationactivenode;
3198                     }
3199                     if (!empty($CFG->navshowcategories) &&
3200                             $navigationactivenode->type === self::TYPE_COURSE &&
3201                             $navigationactivenode->parent->key === 'currentcourse') {
3202                         $items = array_merge($items, $this->get_course_categories());
3203                     }
3204                     $navigationactivenode = $navigationactivenode->parent;
3205                 }
3206             } else if ($settingsactivenode) {
3207                 // Parse the settings navigation to get the active node
3208                 while ($settingsactivenode && $settingsactivenode->parent !== null) {
3209                     if (!$settingsactivenode->mainnavonly) {
3210                         $items[] = $settingsactivenode;
3211                     }
3212                     $settingsactivenode = $settingsactivenode->parent;
3213                 }
3214             }
3215         }
3216
3217         $items[] = new navigation_node(array(
3218             'text'=>$this->page->navigation->text,
3219             'shorttext'=>$this->page->navigation->shorttext,
3220             'key'=>$this->page->navigation->key,
3221             'action'=>$this->page->navigation->action
3222         ));
3223
3224         if (count($this->prependchildren) > 0) {
3225             // Add the custom children
3226             $items = array_merge($items, array_reverse($this->prependchildren));
3227         }
3228
3229         $this->items = array_reverse($items);
3230         return $this->items;
3231     }
3232
3233     /**
3234      * Get the list of categories leading to this course.
3235      *
3236      * This function is used by {@link navbar::get_items()} to add back the "courses"
3237      * node and category chain leading to the current course.  Note that this is only ever
3238      * called for the current course, so we don't need to bother taking in any parameters.
3239      *
3240      * @return array
3241      */
3242     private function get_course_categories() {
3243         global $CFG;
3244         require_once($CFG->dirroot.'/course/lib.php');
3245         require_once($CFG->libdir.'/coursecatlib.php');
3246
3247         $categories = array();
3248         $cap = 'moodle/category:viewhiddencategories';
3249         $showcategories = coursecat::count_all() > 1;
3250
3251         if ($showcategories) {
3252             foreach ($this->page->categories as $category) {
3253                 if (!$category->visible && !has_capability($cap, get_category_or_system_context($category->parent))) {
3254                     continue;
3255                 }
3256                 $url = new moodle_url('/course/index.php', array('categoryid' => $category->id));
3257                 $name = format_string($category->name, true, array('context' => context_coursecat::instance($category->id)));
3258                 $categorynode = navigation_node::create($name, $url, self::TYPE_CATEGORY, null, $category->id);
3259                 if (!$category->visible) {
3260                     $categorynode->hidden = true;
3261                 }
3262                 $categories[] = $categorynode;
3263             }
3264         }
3265
3266         if (is_enrolled(context_course::instance($this->page->course->id))) {
3267             $courses = $this->page->navigation->get('mycourses');
3268         } else {
3269             $courses = $this->page->navigation->get('courses');
3270         }
3271         if (!$courses) {
3272             // Courses node may not be present.
3273             $courses = navigation_node::create(
3274                 get_string('courses'),
3275                 new moodle_url('/course/index.php'),
3276                 self::TYPE_CONTAINER
3277             );
3278         }
3279         $categories[] = $courses;
3280         return $categories;
3281     }
3282
3283     /**
3284      * Add a new navigation_node to the navbar, overrides parent::add
3285      *
3286      * This function overrides {@link navigation_node::add()} so that we can change
3287      * the way nodes get added to allow us to simply call add and have the node added to the
3288      * end of the navbar
3289      *
3290      * @param string $text
3291      * @param string|moodle_url|action_link $action An action to associate with this node.
3292      * @param int $type One of navigation_node::TYPE_*
3293      * @param string $shorttext
3294      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3295      * @param pix_icon $icon An optional icon to use for this node.
3296      * @return navigation_node
3297      */
3298     public function add($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3299         if ($this->content !== null) {
3300             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3301         }
3302
3303         // Properties array used when creating the new navigation node
3304         $itemarray = array(
3305             'text' => $text,
3306             'type' => $type
3307         );
3308         // Set the action if one was provided
3309         if ($action!==null) {
3310             $itemarray['action'] = $action;
3311         }
3312         // Set the shorttext if one was provided
3313         if ($shorttext!==null) {
3314             $itemarray['shorttext'] = $shorttext;
3315         }
3316         // Set the icon if one was provided
3317         if ($icon!==null) {
3318             $itemarray['icon'] = $icon;
3319         }
3320         // Default the key to the number of children if not provided
3321         if ($key === null) {
3322             $key = count($this->children);
3323         }
3324         // Set the key
3325         $itemarray['key'] = $key;
3326         // Set the parent to this node
3327         $itemarray['parent'] = $this;
3328         // Add the child using the navigation_node_collections add method
3329         $this->children[] = new navigation_node($itemarray);
3330         return $this;
3331     }
3332
3333     /**
3334      * Prepends a new navigation_node to the start of the navbar
3335      *
3336      * @param string $text
3337      * @param string|moodle_url|action_link $action An action to associate with this node.
3338      * @param int $type One of navigation_node::TYPE_*
3339      * @param string $shorttext
3340      * @param string|int $key A key to identify this node with. Key + type is unique to a parent.
3341      * @param pix_icon $icon An optional icon to use for this node.
3342      * @return navigation_node
3343      */
3344     public function prepend($text, $action=null, $type=self::TYPE_CUSTOM, $shorttext=null, $key=null, pix_icon $icon=null) {
3345         if ($this->content !== null) {
3346             debugging('Nav bar items must be printed before $OUTPUT->header() has been called', DEBUG_DEVELOPER);
3347         }
3348         // Properties array used when creating the new navigation node.
3349         $itemarray = array(
3350             'text' => $text,
3351             'type' => $type
3352         );
3353         // Set the action if one was provided.
3354         if ($action!==null) {
3355             $itemarray['action'] = $action;
3356         }
3357         // Set the shorttext if one was provided.
3358         if ($shorttext!==null) {
3359             $itemarray['shorttext'] = $shorttext;
3360         }
3361         // Set the icon if one was provided.
3362         if ($icon!==null) {
3363             $itemarray['icon'] = $icon;
3364         }
3365         // Default the key to the number of children if not provided.
3366         if ($key === null) {
3367             $key = count($this->children);
3368         }
3369         // Set the key.
3370         $itemarray['key'] = $key;
3371         // Set the parent to this node.
3372         $itemarray['parent'] = $this;
3373         // Add the child node to the prepend list.
3374         $this->prependchildren[] = new navigation_node($itemarray);
3375         return $this;
3376     }
3377 }
3378
3379 /**
3380  * Class used to manage the settings option for the current page
3381  *
3382  * This class is used to manage the settings options in a tree format (recursively)
3383  * and was created initially for use with the settings blocks.
3384  *
3385  * @package   core
3386  * @category  navigation
3387  * @copyright 2009 Sam Hemelryk
3388  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3389  */
3390 class settings_navigation extends navigation_node {
3391     /** @var stdClass the current context */
3392     protected $context;
3393     /** @var moodle_page the moodle page that the navigation belongs to */
3394     protected $page;
3395     /** @var string contains administration section navigation_nodes */
3396     protected $adminsection;
3397     /** @var bool A switch to see if the navigation node is initialised */
3398     protected $initialised = false;
3399     /** @var array An array of users that the nodes can extend for. */
3400     protected $userstoextendfor = array();
3401     /** @var navigation_cache **/
3402     protected $cache;
3403
3404     /**
3405      * Sets up the object with basic settings and preparse it for use
3406      *
3407      * @param moodle_page $page
3408      */
3409     public function __construct(moodle_page &$page) {
3410         if (during_initial_install()) {
3411             return false;
3412         }
3413         $this->page = $page;
3414         // Initialise the main navigation. It is most important that this is done
3415         // before we try anything
3416         $this->page->navigation->initialise();
3417         // Initialise the navigation cache
3418         $this->cache = new navigation_cache(NAVIGATION_CACHE_NAME);
3419         $this->children = new navigation_node_collection();
3420     }
3421     /**
3422      * Initialise the settings navigation based on the current context
3423      *
3424      * This function initialises the settings navigation tree for a given context
3425      * by calling supporting functions to generate major parts of the tree.
3426      *
3427      */
3428     public function initialise() {
3429         global $DB, $SESSION, $SITE;
3430
3431         if (during_initial_install()) {
3432             return false;
3433         } else if ($this->initialised) {
3434             return true;
3435         }
3436         $this->id = 'settingsnav';
3437         $this->context = $this->page->context;
3438
3439         $context = $this->context;
3440         if ($context->contextlevel == CONTEXT_BLOCK) {
3441             $this->load_block_settings();
3442             $context = $context->get_parent_context();
3443         }
3444         switch ($context->contextlevel) {
3445             case CONTEXT_SYSTEM:
3446                 if ($this->page->url->compare(new moodle_url('/admin/settings.php', array('section'=>'frontpagesettings')))) {
3447                     $this->load_front_page_settings(($context->id == $this->context->id));
3448                 }
3449                 break;
3450             case CONTEXT_COURSECAT:
3451                 $this->load_category_settings();
3452                 break;
3453             case CONTEXT_COURSE:
3454                 if ($this->page->course->id != $SITE->id) {
3455                     $this->load_course_settings(($context->id == $this->context->id));
3456                 } else {
3457                     $this->load_front_page_settings(($context->id == $this->context->id));
3458                 }
3459                 break;
3460             case CONTEXT_MODULE:
3461                 $this->load_module_settings();
3462                 $this->load_course_settings();
3463                 break;
3464             case CONTEXT_USER:
3465                 if ($this->page->course->id != $SITE->id) {
3466                     $this->load_course_settings();
3467                 }
3468                 break;
3469         }
3470
3471         $usersettings = $this->load_user_settings($this->page->course->id);
3472
3473         $adminsettings = false;
3474         if (isloggedin() && !isguestuser() && (!isset($SESSION->load_navigation_admin) || $SESSION->load_navigation_admin)) {
3475             $isadminpage = $this->is_admin_tree_needed();
3476
3477             if (has_capability('moodle/site:config', context_system::instance())) {
3478                 // Make sure this works even if config capability changes on the fly
3479                 // and also make it fast for admin right after login.
3480                 $SESSION->load_navigation_admin = 1;
3481                 if ($isadminpage) {
3482                     $adminsettings = $this->load_administration_settings();
3483                 }
3484
3485             } else if (!isset($SESSION->load_navigation_admin)) {
3486                 $adminsettings = $this->load_administration_settings();
3487                 $SESSION->load_navigation_admin = (int)($adminsettings->children->count() > 0);
3488
3489             } else if ($SESSION->load_navigation_admin) {
3490                 if ($isadminpage) {
3491                     $adminsettings = $this->load_administration_settings();
3492                 }
3493             }
3494
3495             // Print empty navigation node, if needed.
3496             if ($SESSION->load_navigation_admin && !$isadminpage) {
3497                 if ($adminsettings) {
3498                     // Do not print settings tree on pages that do not need it, this helps with performance.
3499                     $adminsettings->remove();
3500                     $adminsettings = false;
3501                 }
3502                 $siteadminnode = $this->add(get_string('administrationsite'), new moodle_url('/admin'), self::TYPE_SITE_ADMIN, null, 'siteadministration');
3503                 $siteadminnode->id = 'expandable_branch_'.$siteadminnode->type.'_'.clean_param($siteadminnode->key, PARAM_ALPHANUMEXT);
3504                 $this->page->requires->data_for_js('siteadminexpansion', $siteadminnode);
3505             }
3506         }
3507
3508         if ($context->contextlevel == CONTEXT_SYSTEM && $adminsettings) {
3509             $adminsettings->force_open();
3510         } else if ($context->contextlevel == CONTEXT_USER && $usersettings) {
3511             $usersettings->force_open();
3512         }
3513
3514         // Check if the user is currently logged in as another user
3515         if (\core\session\manager::is_loggedinas()) {
3516             // Get the actual user, we need this so we can display an informative return link
3517             $realuser = \core\session\manager::get_realuser();
3518             // Add the informative return to original user link
3519             $url = new moodle_url('/course/loginas.php',array('id'=>$this->page->course->id, 'return'=>1,'sesskey'=>sesskey()));
3520             $this->add(get_string('returntooriginaluser', 'moodle', fullname($realuser, true)), $url, self::TYPE_SETTING, null, null, new pix_icon('t/left', ''));
3521         }
3522
3523         // At this point we give any local plugins the ability to extend/tinker with the navigation settings.
3524         $this->load_local_plugin_settings();
3525
3526         foreach ($this->children as $key=>$node) {
3527             if ($node->nodetype != self::NODETYPE_BRANCH || $node->children->count()===0) {
3528                 // Site administration is shown as link.
3529                 if (!empty($SESSION->load_navigation_admin) && ($node->type === self::TYPE_SITE_ADMIN)) {
3530                     continue;
3531                 }
3532                 $node->remove();
3533             }
3534         }
3535         $this->initialised = true;
3536     }
3537     /**
3538      * Override the parent function so that we can add preceeding hr's and set a
3539      * root node class against all first level element
3540      *
3541      * It does this by first calling the parent's add method {@link navigation_node::add()}
3542      * and then proceeds to use the key to set class and hr
3543      *
3544      * @param string $text text to be used for the link.
3545      * @param string|moodle_url $url url for the new node
3546      * @param int $type the type of node navigation_node::TYPE_*
3547      * @param string $shorttext
3548      * @param string|int $key a key to access the node by.
3549      * @param pix_icon $icon An icon that appears next to the node.
3550      * @return navigation_node with the new node added to it.
3551      */
3552     public function add($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
3553         $node = parent::add($text, $url, $type, $shorttext, $key, $icon);
3554         $node->add_class('root_node');
3555         return $node;
3556     }
3557
3558     /**
3559      * This function allows the user to add something to the start of the settings
3560      * navigation, which means it will be at the top of the settings navigation block
3561      *
3562      * @param string $text text to be used for the link.
3563      * @param string|moodle_url $url url for the new node
3564      * @param int $type the type of node navigation_node::TYPE_*
3565      * @param string $shorttext
3566      * @param string|int $key a key to access the node by.
3567      * @param pix_icon $icon An icon that appears next to the node.
3568      * @return navigation_node $node with the new node added to it.
3569      */
3570     public function prepend($text, $url=null, $type=null, $shorttext=null, $key=null, pix_icon $icon=null) {
3571         $children = $this->children;
3572         $childrenclass = get_class($children);
3573         $this->children = new $childrenclass;
3574         $node = $this->add($text, $url, $type, $shorttext, $key, $icon);
3575         foreach ($children as $child) {
3576             $this->children->add($child);
3577         }
3578         return $node;
3579     }
3580
3581     /**
3582      * Does this page require loading of full admin tree or is
3583      * it enough rely on AJAX?
3584      *
3585      * @return bool
3586      */
3587     protected function is_admin_tree_needed() {
3588         if (self::$loadadmintree) {
3589             // Usually external admin page or settings page.
3590             return true;
3591         }
3592
3593         if ($this->page->pagelayout === 'admin' or strpos($this->page->pagetype, 'admin-') === 0) {
3594             // Admin settings tree is intended for system level settings and management only, use navigation for the rest!
3595             if ($this->page->context->contextlevel != CONTEXT_SYSTEM) {
3596                 return false;
3597             }
3598             return true;
3599         }
3600
3601         return false;
3602     }
3603
3604     /**
3605      * Load the site administration tree
3606      *
3607      * This function loads the site administration tree by using the lib/adminlib library functions
3608      *
3609      * @param navigation_node $referencebranch A reference to a branch in the settings
3610      *      navigation tree
3611      * @param part_of_admin_tree $adminbranch The branch to add, if null generate the admin
3612      *      tree and start at the beginning
3613      * @return mixed A key to access the admin tree by
3614      */
3615     protected function load_administration_settings(navigation_node $referencebranch=null, part_of_admin_tree $adminbranch=null) {
3616         global $CFG;
3617
3618         // Check if we are just starting to generate this navigation.
3619         if ($referencebranch === null) {
3620
3621             // Require the admin lib then get an admin structure
3622             if (!function_exists('admin_get_root')) {
3623                 require_once($CFG->dirroot.'/lib/adminlib.php');
3624             }
3625             $adminroot = admin_get_root(false, false);
3626             // This is the active section identifier
3627             $this->adminsection = $this->page->url->param('section');
3628
3629             // Disable the navigation from automatically finding the active node
3630             navigation_node::$autofindactive = false;
3631             $referencebranch = $this->add(get_string('administrationsite'), null, self::TYPE_SITE_ADMIN, null, 'root');
3632             foreach ($adminroot->children as $adminbranch) {
3633                 $this->load_administration_settings($referencebranch, $adminbranch);
3634             }
3635             navigation_node::$autofindactive = true;
3636
3637             // Use the admin structure to locate the active page
3638             if (!$this->contains_active_node() && $current = $adminroot->locate($this->adminsection, true)) {
3639                 $currentnode = $this;
3640                 while (($pathkey = array_pop($current->path))!==null && $currentnode) {
3641                     $currentnode = $currentnode->get($pathkey);
3642                 }
3643                 if ($currentnode) {
3644                     $currentnode->make_active();
3645                 }
3646             } else {
3647                 $this->scan_for_active_node($referencebranch);
3648             }
3649             return $referencebranch;
3650         } else if ($adminbranch->check_access()) {
3651             // We have a reference branch that we can access and is not hidden `hurrah`
3652             // Now we need to display it and any children it may have
3653             $url = null;
3654             $icon = null;
3655             if ($adminbranch instanceof admin_settingpage) {
3656                 $url = new moodle_url('/'.$CFG->admin.'/settings.php', array('section'=>$adminbranch->name));
3657             } else if ($adminbranch instanceof admin_externalpage) {
3658                 $url = $adminbranch->url;
3659             } else if (!empty($CFG->linkadmincategories) && $adminbranch instanceof admin_category) {
3660                 $url = new moodle_url('/'.$CFG->admin.'/category.php', array('category' => $adminbranch->name));
3661             }
3662
3663             // Add the branch
3664             $reference = $referencebranch->add($adminbranch->visiblename, $url, self::TYPE_SETTING, null, $adminbranch->name, $icon);
3665
3666             if ($adminbranch->is_hidden()) {
3667                 if (($adminbranch instanceof admin_externalpage || $adminbranch instanceof admin_settingpage) && $adminbranch->name == $this->adminsection) {
3668                     $reference->add_class('hidden');
3669                 } else {
3670                     $reference->display = false;
3671                 }
3672             }
3673
3674             // Check if we are generating the admin notifications and whether notificiations exist
3675             if ($adminbranch->name === 'adminnotifications' && admin_critical_warnings_present()) {
3676                 $reference->add_class('criticalnotification');
3677             }
3678             // Check if this branch has children
3679             if ($reference && isset($adminbranch->children) && is_array($adminbranch->children) && count($adminbranch->children)>0) {
3680                 foreach ($adminbranch->children as $branch) {
3681                     // Generate the child branches as well now using this branch as the reference
3682                     $this->load_administration_settings($reference, $branch);
3683                 }
3684             } else {
3685                 $reference->icon = new pix_icon('i/settings', '');
3686             }
3687         }
3688     }
3689
3690     /**
3691      * This function recursivily scans nodes until it finds the active node or there
3692      * are no more nodes.
3693      * @param navigation_node $node
3694      */
3695     protected function scan_for_active_node(navigation_node $node) {
3696         if (!$node->check_if_active() && $node->children->count()>0) {
3697             foreach ($node->children as &$child) {
3698                 $this->scan_for_active_node($child);
3699             }
3700         }
3701     }
3702
3703     /**
3704      * Gets a navigation node given an array of keys that represent the path to
3705      * the desired node.
3706      *
3707      * @param array $path
3708      * @return navigation_node|false
3709      */
3710     protected function get_by_path(array $path) {
3711         $node = $this->get(array_shift($path));
3712         foreach ($path as $key) {
3713             $node->get($key);
3714         }
3715         return $node;
3716     }
3717
3718     /**
3719      * This function loads the course settings that are available for the user
3720      *
3721      * @param bool $forceopen If set to true the course node will be forced open
3722      * @return navigation_node|false
3723      */
3724     protected function load_course_settings($forceopen = false) {
3725         global $CFG;
3726
3727         $course = $this->page->course;
3728         $coursecontext = context_course::instance($course->id);
3729
3730         // note: do not test if enrolled or viewing here because we need the enrol link in Course administration section
3731
3732         $coursenode = $this->add(get_string('courseadministration'), null, self::TYPE_COURSE, null, 'courseadmin');
3733         if ($forceopen) {
3734             $coursenode->force_open();
3735         }
3736
3737         if ($this->page->user_allowed_editing()) {
3738             // Add the turn on/off settings
3739
3740             if ($this->page->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
3741                 // We are on the course page, retain the current page params e.g. section.
3742                 $baseurl = clone($this->page->url);
3743                 $baseurl->param('sesskey', sesskey());
3744             } else {
3745                 // Edit on the main course page.
3746                 $baseurl = new moodle_url('/course/view.php', array('id'=>$course->id, 'return'=>$this->page->url->out_as_local_url(false), 'sesskey'=>sesskey()));
3747             }
3748
3749             $editurl = clone($baseurl);
3750             if ($this->page->user_is_editing()) {
3751                 $editurl->param('edit', 'off');
3752                 $editstring = get_string('turneditingoff');
3753             } else {
3754                 $editurl->param('edit', 'on');
3755                 $editstring = get_string('turneditingon');
3756             }
3757             $coursenode->add($editstring, $editurl, self::TYPE_SETTING, null, 'turneditingonoff', new pix_icon('i/edit', ''));
3758         }
3759
3760         if (has_capability('moodle/course:update', $coursecontext)) {
3761             // Add the course settings link
3762             $url = new moodle_url('/course/edit.php', array('id'=>$course->id));
3763             $coursenode->add(get_string('editsettings'), $url, self::TYPE_SETTING, null, 'editsettings', new pix_icon('i/settings', ''));
3764
3765             // Add the course completion settings link
3766             if ($CFG->enablecompletion && $course->enablecompletion) {
3767                 $url = new moodle_url('/course/completion.php', array('id'=>$course->id));
3768                 $coursenode->add(get_string('coursecompletion', 'completion'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/settings', ''));
3769             }
3770         }
3771
3772         // add enrol nodes
3773         enrol_add_course_navigation($coursenode, $course);
3774
3775         // Manage filters
3776         if (has_capability('moodle/filter:manage', $coursecontext) && count(filter_get_available_in_context($coursecontext))>0) {
3777             $url = new moodle_url('/filter/manage.php', array('contextid'=>$coursecontext->id));
3778             $coursenode->add(get_string('filters', 'admin'), $url, self::TYPE_SETTING, null, null, new pix_icon('i/filter', ''));
3779         }
3780
3781         // View course reports.
3782         if (has_capability('moodle/site:viewreports', $coursecontext)) { // Basic capability for listing of reports.
3783             $reportnav = $coursenode->add(get_string('reports'), null, self::TYPE_CONTAINER, null, 'coursereports',
3784                     new pix_icon('i/stats', ''));
3785             $coursereports = core_component::get_plugin_list('coursereport');
3786             foreach ($coursereports as $report => $dir) {
3787                 $libfile = $CFG->dirroot.'/course/report/'.$report.'/lib.php';
3788                 if (file_exists($libfile)) {
3789                     require_once($libfile);
3790                     $reportfunction = $report.'_report_extend_navigation';
3791                     if (function_exists($report.'_report_extend_navigation')) {
3792                         $reportfunction($reportnav, $course, $coursecontext);
3793                     }
3794                 }
3795             }
3796
3797             $reports = get_plugin_list_with_function('report', 'extend_navigation_course', 'lib.php');
3798             foreach ($reports as $reportfunction) {
3799                 $reportfunction($reportnav, $course, $coursecontext);
3800             }
3801         }
3802
3803         // Add view grade report is permitted
3804         $reportavailable = false;
3805         if (has_capability('moodle/grade:viewall', $coursecontext)) {
3806             $reportavailable = true;
3807         } else if (!empty($course->showgrades)) {
3808             $reports = core_component::get_plugin_list('gradereport');
3809             if (is_array($reports) && count($reports)>0) {     // Get all installed reports
3810                 arsort($reports); // user is last, we want to test it first
3811                 foreach ($reports as $plugin => $plugindir) {
3812                     if (has_capability('gradereport/'.$plugin.':view', $coursecontext)) {