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