lib/pagelib.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * This file contains the moodle_page class. There is normally a single instance
  20  * of this class in the $PAGE global variable. This class is a central repository
  21  * of information about the page we are building up to send back to the user.
  22  *
  23  * @package    core
  24  * @subpackage lib
  25  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
  26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27  */
  28
  29 defined('MOODLE_INTERNAL') || die();
  30
  31 /**
  32  * $PAGE is a central store of information about the current page we are
  33  * generating in response to the user's request.
  34  *
  35  * It does not do very much itself
  36  * except keep track of information, however, it serves as the access point to
  37  * some more significant components like $PAGE->theme, $PAGE->requires,
  38  * $PAGE->blocks, etc.
  39  *
  40  * @copyright 2009 Tim Hunt
  41  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42  * @since Moodle 2.0
  43  *
  44  * @property-read string $activityname The type of activity we are in, for example 'forum' or 'quiz'.
  45  *      Will be null if this page is not within a module.
  46  * @property-read object $activityrecord The row from the activities own database table (for example
  47  *      the forum or quiz table) that this page belongs to. Will be null
  48  *      if this page is not within a module.
  49  * @property-read array $alternativeversions Mime type => object with ->url and ->title.
  50  * @property-read blocks_manager $blocks The blocks manager object for this page.
  51  * @property-read string $bodyclasses Returns a string to use within the class attribute on the body tag.
  52  * @property-read string $button The HTML to go where the Turn editing on button normally goes.
  53  * @property-read bool $cacheable Defaults to true. Set to false to stop the page being cached at all.
  54  * @property-read array $categories An array of all the categories the page course belongs to,
  55  *      starting with the immediately containing category, and working out to
  56  *      the top-level category. This may be the empty array if we are in the
  57  *      front page course.
  58  * @property-read mixed $category The category that the page course belongs to. If there isn't one returns null.
  59  * @property-read object $cm The course_module that this page belongs to. Will be null
  60  *      if this page is not within a module. This is a full cm object, as loaded
  61  *      by get_coursemodule_from_id or get_coursemodule_from_instance,
  62  *      so the extra modname and name fields are present.
  63  * @property-read object $context The main context to which this page belongs.
  64  * @property-read object $course The current course that we are inside - a row from the
  65  *      course table. (Also available as $COURSE global.) If we are not inside
  66  *      an actual course, this will be the site course.
  67  * @property-read string $docspath The path to the Moodle docs for this page.
  68  * @property-read string $focuscontrol The id of the HTML element to be focused when the page has loaded.
  69  * @property-read bool $headerprinted
  70  * @property-read string $heading The main heading that should be displayed at the top of the <body>.
  71  * @property-read string $headingmenu The menu (or actions) to display in the heading
  72  * @property-read array $layout_options Returns arrays with options for layout file.
  73  * @property-read bool $legacythemeinuse Returns true if the legacy theme is being used.
  74  * @property-read navbar $navbar Returns the navbar object used to display the navbar
  75  * @property-read global_navigation $navigation Returns the global navigation structure
  76  * @property-read xml_container_stack $opencontainers Tracks XHTML tags on this page that have been opened but not closed.
  77  *      mainly for internal use by the rendering code.
  78  * @property-read string $pagelayout The general type of page this is. For example 'normal', 'popup', 'home'.
  79  *      Allows the theme to display things differently, if it wishes to.
  80  * @property-read string $pagetype Returns the page type string, should be used as the id for the body tag in the theme.
  81  * @property-read int $periodicrefreshdelay The periodic refresh delay to use with meta refresh
  82  * @property-read page_requirements_manager $requires Tracks the JavaScript, CSS files, etc. required by this page.
  83  * @property-read settings_navigation $settingsnav
  84  * @property-read int $state One of the STATE_... constants
  85  * @property-read string $subpage The subpage identifier, if any.
  86  * @property-read theme_config $theme Returns the initialised theme for this page.
  87  * @property-read string $title The title that should go in the <head> section of the HTML of this page.
  88  * @property-read moodle_url $url The moodle url object for this page.
  89  */
  90 class moodle_page {
  91     /**#@+ Tracks the where we are in the generation of the page. */
  92     const STATE_BEFORE_HEADER = 0;
  93     const STATE_PRINTING_HEADER = 1;
  94     const STATE_IN_BODY = 2;
  95     const STATE_DONE = 3;
  96     /**#@-*/
  97
  98 /// Field declarations =========================================================
  99
 100     protected $_state = self::STATE_BEFORE_HEADER;
 101
 102     protected $_course = null;
 103
 104     /**
 105      * If this page belongs to a module, this is the cm_info module description object.
 106      * @var cm_info
 107      */
 108     protected $_cm = null;
 109
 110     /**
 111      * If $_cm is not null, then this will hold the corresponding row from the
 112      * modname table. For example, if $_cm->modname is 'quiz', this will be a
 113      * row from the quiz table.
 114      */
 115     protected $_module = null;
 116
 117     /**
 118      * The context that this page belongs to.
 119      */
 120     protected $_context = null;
 121
 122     /**
 123      * This holds any categories that $_course belongs to, starting with the
 124      * particular category it belongs to, and working out through any parent
 125      * categories to the top level. These are loaded progressively, if needed.
 126      * There are three states. $_categories = null initially when nothing is
 127      * loaded; $_categories = array($id => $cat, $parentid => null) when we have
 128      * loaded $_course->category, but not any parents; and a complete array once
 129      * everything is loaded.
 130      */
 131     protected $_categories = null;
 132
 133     protected $_bodyclasses = array();
 134
 135     protected $_title = '';
 136
 137     protected $_heading = '';
 138
 139     protected $_pagetype = null;
 140
 141     protected $_pagelayout = 'base';
 142
 143     /**
 144      * List of theme layout options, these are ignored by core.
 145      * To be used in individual theme layout files only.
 146      * @var array
 147      */
 148     protected $_layout_options = array();
 149
 150     protected $_subpage = '';
 151
 152     protected $_docspath = null;
 153
 154     /** @var string|null A legacy class that will be added to the body tag */
 155     protected $_legacyclass = null;
 156
 157     protected $_url = null;
 158
 159     protected $_alternateversions = array();
 160
 161     protected $_blocks = null;
 162
 163     protected $_requires = null;
 164
 165     protected $_blockseditingcap = 'moodle/site:manageblocks';
 166
 167     protected $_block_actions_done = false;
 168
 169     protected $_othereditingcaps = array();
 170
 171     protected $_cacheable = true;
 172
 173     protected $_focuscontrol = '';
 174
 175     protected $_button = '';
 176
 177     protected $_theme = null;
 178     /** @var global_navigation Contains the global navigation structure*/
 179     protected $_navigation = null;
 180     /** @var null|settings_navigation Contains the settings navigation structure*/
 181     protected $_settingsnav = null;
 182     /** @var null|navbar Contains the navbar structure*/
 183     protected $_navbar = null;
 184     /** @var string */
 185     protected $_headingmenu = null;
 186
 187     /**
 188      * Then the theme is initialised, we save the stack trace, for use in error messages.
 189      * @var array stack trace.
 190      */
 191     protected $_wherethemewasinitialised = null;
 192
 193     /** @var xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed. */
 194     protected $_opencontainers;
 195
 196     /**
 197      * Sets the page to refresh after a given delay (in seconds) using meta refresh
 198      * in {@link standard_head_html()} in outputlib.php
 199      * If set to null(default) the page is not refreshed
 200      * @var int|null
 201      */
 202     protected $_periodicrefreshdelay = null;
 203
 204     /**
 205      * This is simply to improve backwards compatibility. If old code relies on
 206      * a page class that implements print_header, or complex logic in
 207      * user_allowed_editing then we stash an instance of that other class here,
 208      * and delegate to it in certain situations.
 209      */
 210     protected $_legacypageobject = null;
 211
 212     /**
 213      * Associative array of browser shortnames (as used by check_browser_version)
 214      * and their minimum required versions
 215      * @var array
 216      */
 217     protected $_legacybrowsers = array('MSIE' => 6.0);
 218
 219     /**
 220      * Is set to true if the chosen legacy theme is in use. False by default.
 221      * @var bool
 222      */
 223     protected $_legacythemeinuse = false;
 224
 225     protected $_https_login_required = false;
 226
 227     protected $_popup_notification_allowed = true;
 228
 229 /// Magic getter methods =============================================================
 230 /// Due to the __get magic below, you normally do not call these as $PAGE->magic_get_x
 231 /// methods, but instead use the $PAGE->x syntax.
 232
 233     /**
 234      * Please do not call this method directly, use the ->state syntax. {@link __get()}.
 235      * @return integer one of the STATE_... constants. You should not normally need
 236      * to use this in your code. It is intended for internal use by this class
 237      * and its friends like print_header, to check that everything is working as
 238      * expected. Also accessible as $PAGE->state.
 239      */
 240     protected function magic_get_state() {
 241         return $this->_state;
 242     }
 243
 244     /**
 245      * Please do not call this method directly, use the ->headerprinted syntax. {@link __get()}.
 246      * @return boolean has the header already been printed?
 247      */
 248     protected function magic_get_headerprinted() {
 249         return $this->_state >= self::STATE_IN_BODY;
 250     }
 251
 252     /**
 253      * Please do not call this method directly, use the ->course syntax. {@link __get()}.
 254      *
 255      * @global object
 256      * @return object the current course that we are inside - a row from the
 257      * course table. (Also available as $COURSE global.) If we are not inside
 258      * an actual course, this will be the site course.
 259      */
 260     protected function magic_get_course() {
 261         global $SITE;
 262         if (is_null($this->_course)) {
 263             return $SITE;
 264         }
 265         return $this->_course;
 266     }
 267
 268     /**
 269      * Please do not call this method directly, use the ->cm syntax. {@link __get()}.
 270      * @return object the course_module that this page belongs to. Will be null
 271      * if this page is not within a module. This is a full cm object, as loaded
 272      * by get_coursemodule_from_id or get_coursemodule_from_instance,
 273      * so the extra modname and name fields are present.
 274      * @return cm_info
 275      */
 276     protected function magic_get_cm() {
 277         return $this->_cm;
 278     }
 279
 280     /**
 281      * Please do not call this method directly, use the ->activityrecord syntax. {@link __get()}.
 282      * @return object the row from the activities own database table (for example
 283      * the forum or quiz table) that this page belongs to. Will be null
 284      * if this page is not within a module.
 285      */
 286     protected function magic_get_activityrecord() {
 287         if (is_null($this->_module) && !is_null($this->_cm)) {
 288             $this->load_activity_record();
 289         }
 290         return $this->_module;
 291     }
 292
 293     /**
 294      * Please do not call this method directly, use the ->activityname syntax. {@link __get()}.
 295      * @return string|null the The type of activity we are in, for example 'forum' or 'quiz'.
 296      * Will be null if this page is not within a module.
 297      */
 298     protected function magic_get_activityname() {
 299         if (is_null($this->_cm)) {
 300             return null;
 301         }
 302         return $this->_cm->modname;
 303     }
 304
 305     /**
 306      * Please do not call this method directly, use the ->category syntax. {@link __get()}.
 307      * @return mixed the category that the page course belongs to. If there isn't one
 308      * (that is, if this is the front page course) returns null.
 309      */
 310     protected function magic_get_category() {
 311         $this->ensure_category_loaded();
 312         if (!empty($this->_categories)) {
 313             return reset($this->_categories);
 314         } else {
 315             return null;
 316         }
 317     }
 318
 319     /**
 320      * Please do not call this method directly, use the ->categories syntax. {@link __get()}.
 321      * @return array an array of all the categories the page course belongs to,
 322      * starting with the immediately containing category, and working out to
 323      * the top-level category. This may be the empty array if we are in the
 324      * front page course.
 325      */
 326     protected function magic_get_categories() {
 327         $this->ensure_categories_loaded();
 328         return $this->_categories;
 329     }
 330
 331     /**
 332      * Please do not call this method directly, use the ->context syntax. {@link __get()}.
 333      * @return object the main context to which this page belongs.
 334      */
 335     protected function magic_get_context() {
 336         if (is_null($this->_context)) {
 337             if (CLI_SCRIPT or NO_MOODLE_COOKIES) {
 338                 // cli scripts work in system context, do not annoy devs with debug info
 339                 // very few scripts do not use cookies, we can safely use system as default context there
 340             } else {
 341                 debugging('Coding problem: this page does not set $PAGE->context properly.');
 342             }
 343             $this->_context = get_context_instance(CONTEXT_SYSTEM);
 344         }
 345         return $this->_context;
 346     }
 347
 348     /**
 349      * Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
 350      * @return string e.g. 'my-index' or 'mod-quiz-attempt'.
 351      */
 352     protected function magic_get_pagetype() {
 353         global $CFG;
 354         if (is_null($this->_pagetype) || isset($CFG->pagepath)) {
 355             $this->initialise_default_pagetype();
 356         }
 357         return $this->_pagetype;
 358     }
 359
 360     /**
 361      * Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
 362      * @return string The id to use on the body tag, uses {@link magic_get_pagetype()}.
 363      */
 364     protected function magic_get_bodyid() {
 365         return 'page-'.$this->pagetype;
 366     }
 367
 368     /**
 369      * Please do not call this method directly, use the ->pagelayout syntax. {@link __get()}.
 370      * @return string the general type of page this is. For example 'standard', 'popup', 'home'.
 371      *      Allows the theme to display things differently, if it wishes to.
 372      */
 373     protected function magic_get_pagelayout() {
 374         return $this->_pagelayout;
 375     }
 376
 377     /**
 378      * Please do not call this method directly, use the ->layout_tions syntax. {@link __get()}.
 379      * @return array returns arrys with options for layout file
 380      */
 381     protected function magic_get_layout_options() {
 382         return $this->_layout_options;
 383     }
 384
 385     /**
 386      * Please do not call this method directly, use the ->subpage syntax. {@link __get()}.
 387      * @return string|null The subpage identifier, if any.
 388      */
 389     protected function magic_get_subpage() {
 390         return $this->_subpage;
 391     }
 392
 393     /**
 394      * Please do not call this method directly, use the ->bodyclasses syntax. {@link __get()}.
 395      * @return string the class names to put on the body element in the HTML.
 396      */
 397     protected function magic_get_bodyclasses() {
 398         return implode(' ', array_keys($this->_bodyclasses));
 399     }
 400
 401     /**
 402      * Please do not call this method directly, use the ->title syntax. {@link __get()}.
 403      * @return string the title that should go in the <head> section of the HTML of this page.
 404      */
 405     protected function magic_get_title() {
 406         return $this->_title;
 407     }
 408
 409     /**
 410      * Please do not call this method directly, use the ->heading syntax. {@link __get()}.
 411      * @return string the main heading that should be displayed at the top of the <body>.
 412      */
 413     protected function magic_get_heading() {
 414         return $this->_heading;
 415     }
 416
 417     /**
 418      * Please do not call this method directly, use the ->heading syntax. {@link __get()}.
 419      * @return string The menu (or actions) to display in the heading
 420      */
 421     protected function magic_get_headingmenu() {
 422         return $this->_headingmenu;
 423     }
 424
 425     /**
 426      * Please do not call this method directly, use the ->docspath syntax. {@link __get()}.
 427      * @return string the path to the Moodle docs for this page.
 428      */
 429     protected function magic_get_docspath() {
 430         if (is_string($this->_docspath)) {
 431             return $this->_docspath;
 432         } else {
 433             return str_replace('-', '/', $this->pagetype);
 434         }
 435     }
 436
 437     /**
 438      * Please do not call this method directly, use the ->url syntax. {@link __get()}.
 439      * @return moodle_url the clean URL required to load the current page. (You
 440      * should normally use this in preference to $ME or $FULLME.)
 441      */
 442     protected function magic_get_url() {
 443         global $FULLME;
 444         if (is_null($this->_url)) {
 445             debugging('This page did not call $PAGE->set_url(...). Using '.s($FULLME), DEBUG_DEVELOPER);
 446             $this->_url = new moodle_url($FULLME);
 447             // Make sure the guessed URL cannot lead to dangerous redirects.
 448             $this->_url->remove_params('sesskey');
 449         }
 450         return new moodle_url($this->_url); // Return a clone for safety.
 451     }
 452
 453     /**
 454      * The list of alternate versions of this page.
 455      * @return array mime type => object with ->url and ->title.
 456      */
 457     protected function magic_get_alternateversions() {
 458         return $this->_alternateversions;
 459     }
 460
 461     /**
 462      * Please do not call this method directly, use the ->blocks syntax. {@link __get()}.
 463      * @return blocks_manager the blocks manager object for this page.
 464      */
 465     protected function magic_get_blocks() {
 466         global $CFG;
 467         if (is_null($this->_blocks)) {
 468             if (!empty($CFG->blockmanagerclass)) {
 469                 $classname = $CFG->blockmanagerclass;
 470             } else {
 471                 $classname = 'block_manager';
 472             }
 473             $this->_blocks = new $classname($this);
 474         }
 475         return $this->_blocks;
 476     }
 477
 478     /**
 479      * Please do not call this method directly, use the ->requires syntax. {@link __get()}.
 480      * @return page_requirements_manager tracks the JavaScript, CSS files, etc. required by this page.
 481      */
 482     protected function magic_get_requires() {
 483         global $CFG;
 484         if (is_null($this->_requires)) {
 485             $this->_requires = new page_requirements_manager();
 486         }
 487         return $this->_requires;
 488     }
 489
 490     /**
 491      * Please do not call this method directly, use the ->cacheable syntax. {@link __get()}.
 492      * @return boolean can this page be cached by the user's browser.
 493      */
 494     protected function magic_get_cacheable() {
 495         return $this->_cacheable;
 496     }
 497
 498     /**
 499      * Please do not call this method directly, use the ->focuscontrol syntax. {@link __get()}.
 500      * @return string the id of the HTML element to be focused when the page has loaded.
 501      */
 502     protected function magic_get_focuscontrol() {
 503         return $this->_focuscontrol;
 504     }
 505
 506     /**
 507      * Please do not call this method directly, use the ->button syntax. {@link __get()}.
 508      * @return string the HTML to go where the Turn editing on button normally goes.
 509      */
 510     protected function magic_get_button() {
 511         return $this->_button;
 512     }
 513
 514     /**
 515      * Please do not call this method directly, use the ->theme syntax. {@link __get()}.
 516      * @return theme_config the initialised theme for this page.
 517      */
 518     protected function magic_get_theme() {
 519         if (is_null($this->_theme)) {
 520             $this->initialise_theme_and_output();
 521         }
 522         return $this->_theme;
 523     }
 524
 525     /**
 526      * Please do not call this method directly, use the ->legacythemeinuse syntax. {@link __get()}.
 527      * @return bool
 528      */
 529     protected function magic_get_legacythemeinuse() {
 530         return ($this->_legacythemeinuse);
 531     }
 532
 533     /**
 534      * Please do not call this method directly use the ->periodicrefreshdelay syntax
 535      * {@link __get()}
 536      * @return int The periodic refresh delay to use with meta refresh
 537      */
 538     protected function magic_get_periodicrefreshdelay() {
 539         return $this->_periodicrefreshdelay;
 540     }
 541
 542     /**
 543      * Please do not call this method directly use the ->opencontainers syntax. {@link __get()}
 544      * @return xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed.
 545      *      mainly for internal use by the rendering code.
 546      */
 547     protected function magic_get_opencontainers() {
 548         if (is_null($this->_opencontainers)) {
 549             $this->_opencontainers = new xhtml_container_stack();
 550         }
 551         return $this->_opencontainers;
 552     }
 553
 554     /**
 555      * Return the navigation object
 556      * @return global_navigation
 557      */
 558     protected function magic_get_navigation() {
 559         if ($this->_navigation === null) {
 560             $this->_navigation = new global_navigation($this);
 561         }
 562         return $this->_navigation;
 563     }
 564
 565     /**
 566      * Return a navbar object
 567      * @return navbar
 568      */
 569     protected function magic_get_navbar() {
 570         if ($this->_navbar === null) {
 571             $this->_navbar = new navbar($this);
 572         }
 573         return $this->_navbar;
 574     }
 575
 576     /**
 577      * Returns the settings navigation object
 578      * @return settings_navigation
 579      */
 580     protected function magic_get_settingsnav() {
 581         if ($this->_settingsnav === null) {
 582             $this->_settingsnav = new settings_navigation($this);
 583             $this->_settingsnav->initialise();
 584         }
 585         return $this->_settingsnav;
 586     }
 587
 588     /**
 589      * PHP overloading magic to make the $PAGE->course syntax work by redirecting
 590      * it to the corresponding $PAGE->magic_get_course() method if there is one, and
 591      * throwing an exception if not.
 592      *
 593      * @param $name string property name
 594      * @return mixed
 595      */
 596     public function __get($name) {
 597         $getmethod = 'magic_get_' . $name;
 598         if (method_exists($this, $getmethod)) {
 599             return $this->$getmethod();
 600         } else {
 601             throw new coding_exception('Unknown property ' . $name . ' of $PAGE.');
 602         }
 603     }
 604
 605     /**
 606      * PHP overloading magic which prevents the $PAGE->context = $context; syntax
 607      *
 608      * @param $name string property name
 609      * @param $name mixed value
 610      * @return void, throws exception if field not defined in page class
 611      */
 612     public function __set($name, $value) {
 613         if (method_exists($this, 'set_' . $name)) {
 614             throw new coding_exception('Invalid attempt to modify page object', "Use \$PAGE->set_$name() instead.");
 615         } else {
 616             throw new coding_exception('Invalid attempt to modify page object', "Unknown property $name");
 617         }
 618     }
 619
 620 /// Other information getting methods ==========================================
 621
 622     /**
 623      * Returns instance of page renderer
 624      * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
 625      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
 626      * @param string $target one of rendering target constants
 627      * @return renderer_base
 628      */
 629     public function get_renderer($component, $subtype = null, $target = null) {
 630         return $this->magic_get_theme()->get_renderer($this, $component, $subtype, $target);
 631     }
 632
 633     /**
 634      * Checks to see if there are any items on the navbar object
 635      * @return bool true if there are, false if not
 636      */
 637     public function has_navbar() {
 638         if ($this->_navbar === null) {
 639             $this->_navbar = new navbar($this);
 640         }
 641         return $this->_navbar->has_items();
 642     }
 643
 644     /**
 645      * @return boolean should the current user see this page in editing mode.
 646      * That is, are they allowed to edit this page, and are they currently in
 647      * editing mode.
 648      */
 649     public function user_is_editing() {
 650         global $USER;
 651         return !empty($USER->editing) && $this->user_allowed_editing();
 652     }
 653
 654     /**
 655      * @return boolean does the user have permission to edit blocks on this page.
 656      */
 657     public function user_can_edit_blocks() {
 658         return has_capability($this->_blockseditingcap, $this->_context);
 659     }
 660
 661     /**
 662      * @return boolean does the user have permission to see this page in editing mode.
 663      */
 664     public function user_allowed_editing() {
 665         if ($this->_legacypageobject) {
 666             return $this->_legacypageobject->user_allowed_editing();
 667         }
 668         return has_any_capability($this->all_editing_caps(), $this->_context);
 669     }
 670
 671     /**
 672      * @return string a description of this page. Normally displayed in the footer in
 673      * developer debug mode.
 674      */
 675     public function debug_summary() {
 676         $summary = '';
 677         $summary .= 'General type: ' . $this->pagelayout . '. ';
 678         if (!during_initial_install()) {
 679             $summary .= 'Context ' . print_context_name($this->_context) . ' (context id ' . $this->_context->id . '). ';
 680         }
 681         $summary .= 'Page type ' . $this->pagetype .  '. ';
 682         if ($this->subpage) {
 683             'Sub-page ' . $this->subpage .  '. ';
 684         }
 685         return $summary;
 686     }
 687
 688 /// Setter methods =============================================================
 689
 690     /**
 691      * Set the state. The state must be one of that STATE_... constants, and
 692      * the state is only allowed to advance one step at a time.
 693      * @param integer $state the new state.
 694      */
 695     public function set_state($state) {
 696         if ($state != $this->_state + 1 || $state > self::STATE_DONE) {
 697             throw new coding_exception('Invalid state passed to moodle_page::set_state. We are in state ' .
 698                     $this->_state . ' and state ' . $state . ' was requested.');
 699         }
 700
 701         if ($state == self::STATE_PRINTING_HEADER) {
 702             $this->starting_output();
 703         }
 704
 705         $this->_state = $state;
 706     }
 707
 708     /**
 709      * Set the current course. This sets both $PAGE->course and $COURSE. It also
 710      * sets the right theme and locale.
 711      *
 712      * Normally you don't need to call this function yourself, require_login will
 713      * call it for you if you pass a $course to it. You can use this function
 714      * on pages that do need to call require_login().
 715      *
 716      * Sets $PAGE->context to the course context, if it is not already set.
 717      *
 718      * @param object the course to set as the global course.
 719      */
 720     public function set_course($course) {
 721         global $COURSE, $PAGE;
 722
 723         if (empty($course->id)) {
 724             throw new coding_exception('$course passed to moodle_page::set_course does not look like a proper course object.');
 725         }
 726
 727         $this->ensure_theme_not_set();
 728
 729         if (!empty($this->_course->id) && $this->_course->id != $course->id) {
 730             $this->_categories = null;
 731         }
 732
 733         $this->_course = clone($course);
 734
 735         if ($this === $PAGE) {
 736             $COURSE = $this->_course;
 737             moodle_setlocale();
 738         }
 739
 740         if (!$this->_context) {
 741             $this->set_context(get_context_instance(CONTEXT_COURSE, $this->_course->id));
 742         }
 743     }
 744
 745     /**
 746      * Set the main context to which this page belongs.
 747      * @param object $context a context object, normally obtained with get_context_instance.
 748      */
 749     public function set_context($context) {
 750         if ($context === null) {
 751             // extremely ugly hack which sets context to some value in order to prevent warnings,
 752             // use only for core error handling!!!!
 753             if (!$this->_context) {
 754                 $this->_context = get_context_instance(CONTEXT_SYSTEM);
 755             }
 756             return;
 757         }
 758
 759         // ideally we should set context only once
 760         if (isset($this->_context)) {
 761             if ($context->id == $this->_context->id) {
 762                 // fine - no change needed
 763             } else if ($this->_context->contextlevel == CONTEXT_SYSTEM or $this->_context->contextlevel == CONTEXT_COURSE) {
 764                 // hmm - not ideal, but it might produce too many warnings due to the design of require_login
 765             } else {
 766                 // we do not want devs to do weird switching of context levels on the fly,
 767                 // because we might have used the context already such as in text filter in page title
 768                 debugging('Coding problem: unsupported modification of PAGE->context from '.$this->_context->contextlevel.' to '.$context->contextlevel);
 769             }
 770         }
 771
 772         $this->_context = $context;
 773     }
 774
 775     /**
 776      * The course module that this page belongs to (if it does belong to one).
 777      *
 778      * @param stdClass|cm_info $cm a record from course_modules table or cm_info from get_fast_modinfo().
 779      * @param stdClass $course
 780      * @param stdClass $module
 781      * @return void
 782      */
 783     public function set_cm($cm, $course = null, $module = null) {
 784         global $DB;
 785
 786         if (!isset($cm->id) || !isset($cm->course)) {
 787             throw new coding_exception('Invalid $cm parameter for $PAGE object, it has to be instance of cm_info or record from the course_modules table.');
 788         }
 789
 790         if (!$this->_course || $this->_course->id != $cm->course) {
 791             if (!$course) {
 792                 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
 793             }
 794             if ($course->id != $cm->course) {
 795                 throw new coding_exception('The course you passed to $PAGE->set_cm does not correspond to the $cm.');
 796             }
 797             $this->set_course($course);
 798         }
 799
 800         // make sure we have a $cm from get_fast_modinfo as this contains activity access details
 801         if (!($cm instanceof cm_info)) {
 802             $modinfo = get_fast_modinfo($this->_course);
 803             $cm = $modinfo->get_cm($cm->id);
 804         }
 805         $this->_cm = $cm;
 806         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 807         $this->set_context($context); // the content of page MUST match the cm, this prints warning if there is any problem
 808
 809         if ($module) {
 810             $this->set_activity_record($module);
 811         }
 812     }
 813
 814     /**
 815      * @param $module a row from the main database table for the module that this
 816      * page belongs to. For example, if ->cm is a forum, then you can pass the
 817      * corresponding row from the forum table here if you have it (saves a database
 818      * query sometimes).
 819      */
 820     public function set_activity_record($module) {
 821         if (is_null($this->_cm)) {
 822             throw new coding_exception('You cannot call $PAGE->set_activity_record until after $PAGE->cm has been set.');
 823         }
 824         if ($module->id != $this->_cm->instance || $module->course != $this->_course->id) {
 825             throw new coding_exception('The activity record your are trying to set does not seem to correspond to the cm that has been set.');
 826         }
 827         $this->_module = $module;
 828     }
 829
 830     /**
 831      * @param string $pagetype e.g. 'my-index' or 'mod-quiz-attempt'. Normally
 832      * you do not need to set this manually, it is automatically created from the
 833      * script name. However, on some pages this is overridden. For example, the
 834      * page type for course/view.php includes the course format, for example
 835      * 'course-view-weeks'. This gets used as the id attribute on <body> and
 836      * also for determining which blocks are displayed.
 837      */
 838     public function set_pagetype($pagetype) {
 839         $this->_pagetype = $pagetype;
 840     }
 841
 842     /**
 843      * @param string $pagelayout the page layout this is. For example 'popup', 'home'.
 844      * This properly defaults to 'base', so you only need to call this function if
 845      * you want something different. The exact range of supported layouts is specified
 846      * in the standard theme.
 847      */
 848     public function set_pagelayout($pagelayout) {
 849         /**
 850          * Uncomment this to debug theme pagelayout issues like missing blocks.
 851          *
 852          * if (!empty($this->_wherethemewasinitialised) && $pagelayout != $this->_pagelayout) {
 853          *     debugging('Page layout has already been set and cannot be changed.', DEBUG_DEVELOPER);
 854          * }
 855          */
 856         $this->_pagelayout = $pagelayout;
 857     }
 858
 859     /**
 860      * If context->id and pagetype are not enough to uniquely identify this page,
 861      * then you can set a subpage id as well. For example, the tags page sets
 862      * @param string $subpage an arbitrary identifier that, along with context->id
 863      *      and pagetype, uniquely identifies this page.
 864      */
 865     public function set_subpage($subpage) {
 866         if (empty($subpage)) {
 867             $this->_subpage = '';
 868         } else {
 869             $this->_subpage = $subpage;
 870         }
 871     }
 872
 873     /**
 874      * @param string $class add this class name ot the class attribute on the body tag.
 875      */
 876     public function add_body_class($class) {
 877         if ($this->_state > self::STATE_BEFORE_HEADER) {
 878             throw new coding_exception('Cannot call moodle_page::add_body_class after output has been started.');
 879         }
 880         $this->_bodyclasses[$class] = 1;
 881     }
 882
 883     /**
 884      * @param array $classes this utility method calls add_body_class for each array element.
 885      */
 886     public function add_body_classes($classes) {
 887         foreach ($classes as $class) {
 888             $this->add_body_class($class);
 889         }
 890     }
 891
 892     /**
 893      * @param string $title the title that should go in the <head> section of the HTML of this page.
 894      */
 895     public function set_title($title) {
 896         $title = format_string($title);
 897         $title = str_replace('"', '&quot;', $title);
 898         $this->_title = $title;
 899     }
 900
 901     /**
 902      * @param string $heading the main heading that should be displayed at the top of the <body>.
 903      */
 904     public function set_heading($heading) {
 905         $this->_heading = format_string($heading);
 906     }
 907
 908     /**
 909      * @param string $menu The menu/content to show in the heading
 910      */
 911     public function set_headingmenu($menu) {
 912         $this->_headingmenu = $menu;
 913     }
 914
 915     /**
 916      * Set the course category this page belongs to manually. This automatically
 917      * sets $PAGE->course to be the site course. You cannot use this method if
 918      * you have already set $PAGE->course - in that case, the category must be
 919      * the one that the course belongs to. This also automatically sets the
 920      * page context to the category context.
 921      * @param integer $categoryid The id of the category to set.
 922      */
 923     public function set_category_by_id($categoryid) {
 924         global $SITE, $DB;
 925         if (!is_null($this->_course)) {
 926             throw new coding_exception('Attempt to manually set the course category when the course has been set. This is not allowed.');
 927         }
 928         if (is_array($this->_categories)) {
 929             throw new coding_exception('Course category has already been set. You are not allowed to change it.');
 930         }
 931         $this->ensure_theme_not_set();
 932         $this->set_course($SITE);
 933         $this->load_category($categoryid);
 934         $this->set_context(get_context_instance(CONTEXT_COURSECAT, $categoryid));
 935     }
 936
 937     /**
 938      * Set a different path to use for the 'Moodle docs for this page' link.
 939      * By default, it uses the pagetype, which is normally the same as the
 940      * script name. So, for example, for mod/quiz/attempt.php, pagetype is
 941      * mod-quiz-attempt, and so docspath is mod/quiz/attempt.
 942      * @param string $path the path to use at the end of the moodle docs URL.
 943      */
 944     public function set_docs_path($path) {
 945         $this->_docspath = $path;
 946     }
 947
 948     /**
 949      * You should call this method from every page to set the cleaned-up URL
 950      * that should be used to return to this page. Used, for example, by the
 951      * blocks editing UI to know where to return the user after an action.
 952      * For example, course/view.php does:
 953      *      $id = optional_param('id', 0, PARAM_INT);
 954      *      $PAGE->set_url('/course/view.php', array('id' => $id));
 955      * @param moodle_url|string $url URL relative to $CFG->wwwroot or {@link moodle_url} instance
 956      * @param array $params parameters to add to the URL
 957      */
 958     public function set_url($url, array $params = null) {
 959         global $CFG;
 960
 961         if (is_string($url)) {
 962             if (strpos($url, 'http') === 0) {
 963                 // ok
 964             } else if (strpos($url, '/') === 0) {
 965                 // we have to use httpswwwroot here, because of loginhttps pages
 966                 $url = $CFG->httpswwwroot . $url;
 967             } else {
 968                 throw new coding_exception('Invalid parameter $url, has to be full url or in shortened form starting with /.');
 969             }
 970         }
 971
 972         $this->_url = new moodle_url($url, $params);
 973
 974         $fullurl = $this->_url->out_omit_querystring();
 975         if (strpos($fullurl, "$CFG->httpswwwroot/") !== 0) {
 976             debugging('Most probably incorrect set_page() url argument, it does not match the httpswwwroot!');
 977         }
 978         $shorturl = str_replace("$CFG->httpswwwroot/", '', $fullurl);
 979
 980         if (is_null($this->_pagetype)) {
 981             $this->initialise_default_pagetype($shorturl);
 982         }
 983         if (!is_null($this->_legacypageobject)) {
 984             $this->_legacypageobject->set_url($url, $params);
 985         }
 986     }
 987
 988     /**
 989      * Make sure page URL does not contain the given URL parameter.
 990      *
 991      * This should not be necessary if the script has called set_url properly.
 992      * However, in some situations like the block editing actions; when the URL
 993      * has been guessed, it will contain dangerous block-related actions.
 994      * Therefore, the blocks code calls this function to clean up such parameters
 995      * before doing any redirect.
 996      *
 997      * @param string $param the name of the parameter to make sure is not in the
 998      * page URL.
 999      */
1000     public function ensure_param_not_in_url($param) {
1001         $discard = $this->url; // Make sure $this->url is lazy-loaded;
1002         $this->_url->remove_params($param);
1003     }
1004
1005     /**
1006      * There can be alternate versions of some pages (for example an RSS feed version).
1007      * If such other version exist, call this method, and a link to the alternate
1008      * version will be included in the <head> of the page.
1009      *
1010      * @param $title The title to give the alternate version.
1011      * @param $url The URL of the alternate version.
1012      * @param $mimetype The mime-type of the alternate version.
1013      */
1014     public function add_alternate_version($title, $url, $mimetype) {
1015         if ($this->_state > self::STATE_BEFORE_HEADER) {
1016             throw new coding_exception('Cannot call moodle_page::add_alternate_version after output has been started.');
1017         }
1018         $alt = new stdClass;
1019         $alt->title = $title;
1020         $alt->url = $url;
1021         $this->_alternateversions[$mimetype] = $alt;
1022     }
1023
1024     /**
1025      * Specify a form control should be focused when the page has loaded.
1026      *
1027      * @param string $controlid the id of the HTML element to be focused.
1028      */
1029     public function set_focuscontrol($controlid) {
1030         $this->_focuscontrol = $controlid;
1031     }
1032
1033     /**
1034      * Specify a fragment of HTML that goes where the 'Turn editing on' button normally goes.
1035      *
1036      * @param string $html the HTML to display there.
1037      */
1038     public function set_button($html) {
1039         $this->_button = $html;
1040     }
1041
1042     /**
1043      * Set the capability that allows users to edit blocks on this page. Normally
1044      * the default of 'moodle/site:manageblocks' is used, but a few pages like
1045      * the My Moodle page need to use a different capability like 'moodle/my:manageblocks'.
1046      * @param string $capability a capability.
1047      */
1048     public function set_blocks_editing_capability($capability) {
1049         $this->_blockseditingcap = $capability;
1050     }
1051
1052     /**
1053      * Some pages let you turn editing on for reasons other than editing blocks.
1054      * If that is the case, you can pass other capabilities that let the user
1055      * edit this page here.
1056      * @param string|array $capability either a capability, or an array of capabilities.
1057      */
1058     public function set_other_editing_capability($capability) {
1059         if (is_array($capability)) {
1060             $this->_othereditingcaps = array_unique($this->_othereditingcaps + $capability);
1061         } else {
1062             $this->_othereditingcaps[] = $capability;
1063         }
1064     }
1065
1066     /**
1067      * @return boolean $cacheable can this page be cached by the user's browser.
1068      */
1069     public function set_cacheable($cacheable) {
1070         $this->_cacheable = $cacheable;
1071     }
1072
1073     /**
1074      * Sets the page to periodically refresh
1075      *
1076      * This function must be called before $OUTPUT->header has been called or
1077      * a coding exception will be thrown.
1078      *
1079      * @param int $delay Sets the delay before refreshing the page, if set to null
1080      *                    refresh is cancelled
1081      */
1082     public function set_periodic_refresh_delay($delay=null) {
1083         if ($this->_state > self::STATE_BEFORE_HEADER) {
1084             throw new coding_exception('You cannot set a periodic refresh delay after the header has been printed');
1085         }
1086         if ($delay===null) {
1087             $this->_periodicrefreshdelay = null;
1088         } else if (is_int($delay)) {
1089             $this->_periodicrefreshdelay = $delay;
1090         }
1091     }
1092
1093     /**
1094      * Force this page to use a particular theme.
1095      *
1096      * Please use this cautiously. It is only intended to be used by the themes selector admin page.
1097      *
1098      * @param $themename the name of the theme to use.
1099      */
1100     public function force_theme($themename) {
1101         $this->ensure_theme_not_set();
1102         $this->_theme = theme_config::load($themename);
1103     }
1104
1105     /**
1106      * This function indicates that current page requires the https
1107      * when $CFG->loginhttps enabled.
1108      *
1109      * By using this function properly, we can ensure 100% https-ized pages
1110      * at our entire discretion (login, forgot_password, change_password)
1111      * @return void
1112      */
1113     public function https_required() {
1114         global $CFG;
1115
1116         if (!is_null($this->_url)) {
1117             throw new coding_exception('https_required() must be used before setting page url!');
1118         }
1119
1120         $this->ensure_theme_not_set();
1121
1122         $this->_https_login_required = true;
1123
1124         if (!empty($CFG->loginhttps)) {
1125             $CFG->httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
1126         } else {
1127             $CFG->httpswwwroot = $CFG->wwwroot;
1128         }
1129     }
1130
1131     /**
1132      * Makes sure that page previously marked with https_required()
1133      * is really using https://, if not it redirects to https://
1134      *
1135      * @return void (may redirect to https://self)
1136      */
1137     public function verify_https_required() {
1138         global $CFG, $FULLME;
1139
1140         if (is_null($this->_url)) {
1141             throw new coding_exception('verify_https_required() must be called after setting page url!');
1142         }
1143
1144         if (!$this->_https_login_required) {
1145             throw new coding_exception('verify_https_required() must be called only after https_required()!');
1146         }
1147
1148         if (empty($CFG->loginhttps)) {
1149             // https not required, so stop checking
1150             return;
1151         }
1152
1153         if (strpos($this->_url, 'https://')) {
1154             // detect if incorrect PAGE->set_url() used, it is recommended to use root-relative paths there
1155             throw new coding_exception('Invalid page url specified, it must start with https:// for pages that set https_required()!');
1156         }
1157
1158         if (!empty($CFG->sslproxy)) {
1159             // it does not make much sense to use sslproxy and loginhttps at the same time
1160             return;
1161         }
1162
1163         // now the real test and redirect!
1164         if (strpos($FULLME, 'https:') !== 0) {
1165             // this may lead to infinite redirect on misconfigured sites, in that case use $CFG->loginhttps=0; in /config.php
1166             redirect($this->_url);
1167         }
1168     }
1169
1170 /// Initialisation methods =====================================================
1171 /// These set various things up in a default way.
1172
1173     /**
1174      * This method is called when the page first moves out of the STATE_BEFORE_HEADER
1175      * state. This is our last change to initialise things.
1176      */
1177     protected function starting_output() {
1178         global $CFG;
1179
1180         if (!during_initial_install()) {
1181             $this->blocks->load_blocks();
1182             if (empty($this->_block_actions_done)) {
1183                 $this->_block_actions_done = true;
1184                 if ($this->blocks->process_url_actions($this)) {
1185                     redirect($this->url->out(false));
1186                 }
1187             }
1188             $this->blocks->create_all_block_instances();
1189         }
1190
1191         // If maintenance mode is on, change the page header.
1192         if (!empty($CFG->maintenance_enabled)) {
1193             $this->set_button('<a href="' . $CFG->wwwroot . '/' . $CFG->admin .
1194                     '/settings.php?section=maintenancemode">' . get_string('maintenancemode', 'admin') .
1195                     '</a> ' . $this->button);
1196
1197             $title = $this->title;
1198             if ($title) {
1199                 $title .= ' - ';
1200             }
1201             $this->set_title($title . get_string('maintenancemode', 'admin'));
1202         } else {
1203             // Show the messaging popup if there are messages
1204             message_popup_window();
1205         }
1206
1207         $this->initialise_standard_body_classes();
1208     }
1209
1210     /**
1211      * Method for use by Moodle core to set up the theme. Do not
1212      * use this in your own code.
1213      *
1214      * Make sure the right theme for this page is loaded. Tell our
1215      * blocks_manager about the theme block regions, and then, if
1216      * we are $PAGE, set up the global $OUTPUT.
1217      */
1218     public function initialise_theme_and_output() {
1219         global $OUTPUT, $PAGE, $SITE;
1220
1221         if (!empty($this->_wherethemewasinitialised)) {
1222             return;
1223         }
1224
1225         if (!during_initial_install()) {
1226             // detect PAGE->context mess
1227             $this->magic_get_context();
1228         }
1229
1230         if (!$this->_course && !during_initial_install()) {
1231             $this->set_course($SITE);
1232         }
1233
1234         if (is_null($this->_theme)) {
1235             $themename = $this->resolve_theme();
1236             $this->_theme = theme_config::load($themename);
1237             $this->_layout_options = $this->_theme->pagelayout_options($this->pagelayout);
1238         }
1239
1240         $this->_theme->setup_blocks($this->pagelayout, $this->blocks);
1241
1242         if ($this === $PAGE) {
1243             $OUTPUT = $this->get_renderer('core');
1244         }
1245
1246         $this->_wherethemewasinitialised = debug_backtrace();
1247     }
1248
1249     /**
1250      * Work out the theme this page should use.
1251      *
1252      * This depends on numerous $CFG settings, and the properties of this page.
1253      *
1254      * @return string the name of the theme that should be used on this page.
1255      */
1256     protected function resolve_theme() {
1257         global $CFG, $USER, $SESSION;
1258
1259         if (empty($CFG->themeorder)) {
1260             $themeorder = array('course', 'category', 'session', 'user', 'site');
1261         } else {
1262             $themeorder = $CFG->themeorder;
1263             // Just in case, make sure we always use the site theme if nothing else matched.
1264             $themeorder[] = 'site';
1265         }
1266
1267         $mnetpeertheme = '';
1268         if (isloggedin() and isset($CFG->mnet_localhost_id) and $USER->mnethostid != $CFG->mnet_localhost_id) {
1269             require_once($CFG->dirroot.'/mnet/peer.php');
1270             $mnetpeer = new mnet_peer();
1271             $mnetpeer->set_id($USER->mnethostid);
1272             if ($mnetpeer->force_theme == 1 && $mnetpeer->theme != '') {
1273                 $mnetpeertheme = $mnetpeer->theme;
1274             }
1275         }
1276
1277         $theme = '';
1278         foreach ($themeorder as $themetype) {
1279             switch ($themetype) {
1280                 case 'course':
1281                     if (!empty($CFG->allowcoursethemes) and !empty($this->course->theme)) {
1282                         return $this->course->theme;
1283                     }
1284
1285                 case 'category':
1286                     if (!empty($CFG->allowcategorythemes)) {
1287                         $categories = $this->categories;
1288                         foreach ($categories as $category) {
1289                             if (!empty($category->theme)) {
1290                                 return $category->theme;
1291                             }
1292                         }
1293                     }
1294
1295                 case 'session':
1296                     if (!empty($SESSION->theme)) {
1297                         return $SESSION->theme;
1298                     }
1299
1300                 case 'user':
1301                     if (!empty($CFG->allowuserthemes) and !empty($USER->theme)) {
1302                         if ($mnetpeertheme) {
1303                             return $mnetpeertheme;
1304                         } else {
1305                             return $USER->theme;
1306                         }
1307                     }
1308
1309                 case 'site':
1310                     if ($mnetpeertheme) {
1311                         return $mnetpeertheme;
1312                     } else if(!empty($CFG->themelegacy) && $this->browser_is_outdated()) {
1313                         $this->_legacythemeinuse = true;
1314                         return $CFG->themelegacy;
1315                     } else {
1316                         return $CFG->theme;
1317                     }
1318             }
1319         }
1320     }
1321
1322     /**
1323      * Determines whether the current browser should
1324      * default to the admin-selected legacy theme
1325      *
1326      * @return  true if legacy theme should be used, otherwise false
1327      *
1328      */
1329     protected function browser_is_outdated() {
1330         foreach($this->_legacybrowsers as $browser => $version) {
1331             // Check the browser is valid first then that its version is suitable
1332             if(check_browser_version($browser, '0') &&
1333                !check_browser_version($browser, $version)) {
1334                 return true;
1335             }
1336         }
1337         return false;
1338     }
1339
1340     /**
1341      * Sets ->pagetype from the script name. For example, if the script that was
1342      * run is mod/quiz/view.php, ->pagetype will be set to 'mod-quiz-view'.
1343      * @param string $script the path to the script that should be used to
1344      * initialise ->pagetype. If not passed the $SCRIPT global will be used.
1345      * If legacy code has set $CFG->pagepath that will be used instead, and a
1346      * developer warning issued.
1347      */
1348     protected function initialise_default_pagetype($script = null) {
1349         global $CFG, $SCRIPT;
1350
1351         if (isset($CFG->pagepath)) {
1352             debugging('Some code appears to have set $CFG->pagepath. That was a horrible deprecated thing. ' .
1353                     'Don\'t do it! Try calling $PAGE->set_pagetype() instead.');
1354             $script = $CFG->pagepath;
1355             unset($CFG->pagepath);
1356         }
1357
1358         if (is_null($script)) {
1359             $script = ltrim($SCRIPT, '/');
1360             $len = strlen($CFG->admin);
1361             if (substr($script, 0, $len) == $CFG->admin) {
1362                 $script = 'admin' . substr($script, $len);
1363             }
1364         }
1365
1366         $path = str_replace('.php', '', $script);
1367         if (substr($path, -1) == '/') {
1368             $path .= 'index';
1369         }
1370
1371         if (empty($path) || $path == 'index') {
1372             $this->_pagetype = 'site-index';
1373         } else {
1374             $this->_pagetype = str_replace('/', '-', $path);
1375         }
1376     }
1377
1378     protected function initialise_standard_body_classes() {
1379         global $CFG, $USER;
1380
1381         $pagetype = $this->pagetype;
1382         if ($pagetype == 'site-index') {
1383             $this->_legacyclass = 'course';
1384         } else if (substr($pagetype, 0, 6) == 'admin-') {
1385             $this->_legacyclass = 'admin';
1386         }
1387         $this->add_body_class($this->_legacyclass);
1388
1389         $pathbits = explode('-', trim($pagetype));
1390         for ($i=1;$i<count($pathbits);$i++) {
1391             $this->add_body_class('path-'.join('-',array_slice($pathbits, 0, $i)));
1392         }
1393
1394         $this->add_body_classes(get_browser_version_classes());
1395         $this->add_body_class('dir-' . get_string('thisdirection', 'langconfig'));
1396         $this->add_body_class('lang-' . current_language());
1397         $this->add_body_class('yui-skin-sam'); // Make YUI happy, if it is used.
1398         $this->add_body_class('yui3-skin-sam'); // Make YUI3 happy, if it is used.
1399         $this->add_body_class($this->url_to_class_name($CFG->wwwroot));
1400
1401         $this->add_body_class('pagelayout-' . $this->_pagelayout); // extra class describing current page layout
1402
1403         if (!during_initial_install()) {
1404             $this->add_body_class('course-' . $this->_course->id);
1405             $this->add_body_class('context-' . $this->_context->id);
1406         }
1407
1408         if (!empty($this->_cm)) {
1409             $this->add_body_class('cmid-' . $this->_cm->id);
1410         }
1411
1412         if (!empty($CFG->allowcategorythemes)) {
1413             $this->ensure_category_loaded();
1414             foreach ($this->_categories as $catid => $notused) {
1415                 $this->add_body_class('category-' . $catid);
1416             }
1417         } else {
1418             $catid = 0;
1419             if (is_array($this->_categories)) {
1420                 $catids = array_keys($this->_categories);
1421                 $catid = reset($catids);
1422             } else if (!empty($this->_course->category)) {
1423                 $catid = $this->_course->category;
1424             }
1425             if ($catid) {
1426                 $this->add_body_class('category-' . $catid);
1427             }
1428         }
1429
1430         if (!isloggedin()) {
1431             $this->add_body_class('notloggedin');
1432         }
1433
1434         if (!empty($USER->editing)) {
1435             $this->add_body_class('editing');
1436             if (optional_param('bui_moveid', false, PARAM_INT)) {
1437                $this->add_body_class('blocks-moving');
1438         }
1439         }
1440
1441         if (!empty($CFG->blocksdrag)) {
1442             $this->add_body_class('drag');
1443         }
1444
1445         if ($this->_legacythemeinuse) {
1446             $this->add_body_class('legacytheme');
1447         }
1448     }
1449
1450     protected function load_activity_record() {
1451         global $DB;
1452         if (is_null($this->_cm)) {
1453             return;
1454         }
1455         $this->_module = $DB->get_record($this->_cm->modname, array('id' => $this->_cm->instance));
1456     }
1457
1458     protected function ensure_category_loaded() {
1459         if (is_array($this->_categories)) {
1460             return; // Already done.
1461         }
1462         if (is_null($this->_course)) {
1463             throw new coding_exception('Attempt to get the course category for this page before the course was set.');
1464         }
1465         if ($this->_course->category == 0) {
1466             $this->_categories = array();
1467         } else {
1468             $this->load_category($this->_course->category);
1469         }
1470     }
1471
1472     protected function load_category($categoryid) {
1473         global $DB;
1474         $category = $DB->get_record('course_categories', array('id' => $categoryid));
1475         if (!$category) {
1476             throw new moodle_exception('unknowncategory');
1477         }
1478         $this->_categories[$category->id] = $category;
1479         $parentcategoryids = explode('/', trim($category->path, '/'));
1480         array_pop($parentcategoryids);
1481         foreach (array_reverse($parentcategoryids) as $catid) {
1482             $this->_categories[$catid] = null;
1483         }
1484     }
1485
1486     protected function ensure_categories_loaded() {
1487         global $DB;
1488         $this->ensure_category_loaded();
1489         if (!is_null(end($this->_categories))) {
1490             return; // Already done.
1491         }
1492         $idstoload = array_keys($this->_categories);
1493         array_shift($idstoload);
1494         $categories = $DB->get_records_list('course_categories', 'id', $idstoload);
1495         foreach ($idstoload as $catid) {
1496             $this->_categories[$catid] = $categories[$catid];
1497         }
1498     }
1499
1500     protected function ensure_theme_not_set() {
1501         if (!is_null($this->_theme)) {
1502             throw new coding_exception('The theme has already been set up for this page ready for output. ' .
1503                     'Therefore, you can no longer change the theme, or anything that might affect what ' .
1504                     'the current theme is, for example, the course.',
1505                     'Stack trace when the theme was set up: ' . format_backtrace($this->_wherethemewasinitialised));
1506         }
1507     }
1508
1509     protected function url_to_class_name($url) {
1510         $bits = parse_url($url);
1511         $class = str_replace('.', '-', $bits['host']);
1512         if (!empty($bits['port'])) {
1513             $class .= '--' . $bits['port'];
1514         }
1515         if (!empty($bits['path'])) {
1516             $path = trim($bits['path'], '/');
1517             if ($path) {
1518                 $class .= '--' . str_replace('/', '-', $path);
1519             }
1520         }
1521         return $class;
1522     }
1523
1524     protected function all_editing_caps() {
1525         $caps = $this->_othereditingcaps;
1526         $caps[] = $this->_blockseditingcap;
1527         return $caps;
1528     }
1529
1530 /// Deprecated fields and methods for backwards compatibility ==================
1531
1532     /**
1533      * @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
1534      * @return string page type.
1535      */
1536     public function get_type() {
1537         debugging('Call to deprecated method moodle_page::get_type. Please use $PAGE->pagetype instead.');
1538         return $this->get_pagetype();
1539     }
1540
1541     /**
1542      * @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
1543      * @return string this is what page_id_and_class used to return via the $getclass parameter.
1544      */
1545     function get_format_name() {
1546         return $this->get_pagetype();
1547     }
1548
1549     /**
1550      * @deprecated since Moodle 2.0 - use $PAGE->course instead.
1551      * @return object course.
1552      */
1553     public function get_courserecord() {
1554         debugging('Call to deprecated method moodle_page::get_courserecord. Please use $PAGE->course instead.');
1555         return $this->get_course();
1556     }
1557
1558     /**
1559      * @deprecated since Moodle 2.0
1560      * @return string this is what page_id_and_class used to return via the $getclass parameter.
1561      */
1562     public function get_legacyclass() {
1563         if (is_null($this->_legacyclass)) {
1564             $this->initialise_standard_body_classes();
1565         }
1566         debugging('Call to deprecated method moodle_page::get_legacyclass.');
1567         return $this->_legacyclass;
1568     }
1569
1570     /**
1571      * @deprecated since Moodle 2.0 - use $PAGE->blocks->get_regions() instead
1572      * @return string the places on this page where blocks can go.
1573      */
1574     function blocks_get_positions() {
1575         debugging('Call to deprecated method moodle_page::blocks_get_positions. Use $PAGE->blocks->get_regions() instead.');
1576         return $this->blocks->get_regions();
1577     }
1578
1579     /**
1580      * @deprecated since Moodle 2.0 - use $PAGE->blocks->get_default_region() instead
1581      * @return string the default place for blocks on this page.
1582      */
1583     function blocks_default_position() {
1584         debugging('Call to deprecated method moodle_page::blocks_default_position. Use $PAGE->blocks->get_default_region() instead.');
1585         return $this->blocks->get_default_region();
1586     }
1587
1588     /**
1589      * @deprecated since Moodle 2.0 - no longer used.
1590      */
1591     function blocks_get_default() {
1592         debugging('Call to deprecated method moodle_page::blocks_get_default. This method has no function any more.');
1593     }
1594
1595     /**
1596      * @deprecated since Moodle 2.0 - no longer used.
1597      */
1598     function blocks_move_position(&$instance, $move) {
1599         debugging('Call to deprecated method moodle_page::blocks_move_position. This method has no function any more.');
1600     }
1601
1602     /**
1603      * @deprecated since Moodle 2.0 - use $this->url->params() instead.
1604      * @return array URL parameters for this page.
1605      */
1606     function url_get_parameters() {
1607         debugging('Call to deprecated method moodle_page::url_get_parameters. Use $this->url->params() instead.');
1608         return $this->url->params();
1609     }
1610
1611     /**
1612      * @deprecated since Moodle 2.0 - use $this->url->params() instead.
1613      * @return string URL for this page without parameters.
1614      */
1615     function url_get_path() {
1616         debugging('Call to deprecated method moodle_page::url_get_path. Use $this->url->out() instead.');
1617         return $this->url->out();
1618     }
1619
1620     /**
1621      * @deprecated since Moodle 2.0 - use $this->url->out() instead.
1622      * @return string full URL for this page.
1623      */
1624     function url_get_full($extraparams = array()) {
1625         debugging('Call to deprecated method moodle_page::url_get_full. Use $this->url->out() instead.');
1626         return $this->url->out(true, $extraparams);
1627     }
1628
1629     /**
1630      * @deprecated since Moodle 2.0 - just a backwards compatibility hook.
1631      */
1632     function set_legacy_page_object($pageobject) {
1633         return $this->_legacypageobject = $pageobject;
1634     }
1635
1636     /**
1637      * @deprecated since Moodle 2.0 - page objects should no longer be doing print_header.
1638      * @param $_,...
1639      */
1640     function print_header($_) {
1641         if (is_null($this->_legacypageobject)) {
1642             throw new coding_exception('You have called print_header on $PAGE when there is not a legacy page class present.');
1643         }
1644         debugging('You should not longer be doing print_header via a page class.', DEBUG_DEVELOPER);
1645         $args = func_get_args();
1646         call_user_func_array(array($this->_legacypageobject, 'print_header'), $args);
1647     }
1648
1649     /**
1650      * @deprecated since Moodle 2.0
1651      * @return the 'page id'. This concept no longer exists.
1652      */
1653     function get_id() {
1654         debugging('Call to deprecated method moodle_page::get_id(). It should not be necessary any more.', DEBUG_DEVELOPER);
1655         if (!is_null($this->_legacypageobject)) {
1656             return $this->_legacypageobject->get_id();
1657         }
1658         return 0;
1659     }
1660
1661     /**
1662      * @deprecated since Moodle 2.0
1663      * @return the 'page id'. This concept no longer exists.
1664      */
1665     function get_pageid() {
1666         debugging('Call to deprecated method moodle_page::get_pageid(). It should not be necessary any more.', DEBUG_DEVELOPER);
1667         if (!is_null($this->_legacypageobject)) {
1668             return $this->_legacypageobject->get_id();
1669         }
1670         return 0;
1671     }
1672
1673     /**
1674      * @deprecated since Moodle 2.0 - user $PAGE->cm instead.
1675      * @return $this->cm;
1676      */
1677     function get_modulerecord() {
1678         return $this->cm;
1679     }
1680
1681     public function has_set_url() {
1682         return ($this->_url!==null);
1683     }
1684
1685     public function set_block_actions_done($setting = true) {
1686         $this->_block_actions_done = $setting;
1687     }
1688
1689     /**
1690      * Are popup notifications allowed on this page?
1691      * Popup notifications may be disallowed in situations such as while upgrading or completing a quiz
1692      * @return boolean true if popup notifications may be displayed
1693      */
1694     public function get_popup_notification_allowed() {
1695         return $this->_popup_notification_allowed;
1696     }
1697
1698     /**
1699      * Allow or disallow popup notifications on this page. Popups are allowed by default.
1700      * @param boolean true if notifications are allowed. False if not allowed. They are allowed by default.
1701      * @return null
1702      */
1703     public function set_popup_notification_allowed($allowed) {
1704         $this->_popup_notification_allowed = $allowed;
1705     }
1706 }
1707
1708 /**
1709  * @deprecated since Moodle 2.0
1710  * Not needed any more.
1711  * @param $path the folder path
1712  * @return array an array of page types.
1713  */
1714 function page_import_types($path) {
1715     global $CFG;
1716     debugging('Call to deprecated function page_import_types.', DEBUG_DEVELOPER);
1717 }
1718
1719 /**
1720  * @deprecated since Moodle 2.0
1721  * Do not use this any more. The global $PAGE is automatically created for you.
1722  * If you need custom behaviour, you should just set properties of that object.
1723  * @param integer $instance legacy page instance id.
1724  * @return the global $PAGE object.
1725  */
1726 function page_create_instance($instance) {
1727     global $PAGE;
1728     return page_create_object($PAGE->pagetype, $instance);
1729 }
1730
1731 /**
1732  * @deprecated since Moodle 2.0
1733  * Do not use this any more. The global $PAGE is automatically created for you.
1734  * If you need custom behaviour, you should just set properties of that object.
1735  */
1736 function page_create_object($type, $id = NULL) {
1737     global $CFG, $PAGE, $SITE, $ME;
1738     debugging('Call to deprecated function page_create_object.', DEBUG_DEVELOPER);
1739
1740     $data = new stdClass;
1741     $data->pagetype = $type;
1742     $data->pageid = $id;
1743
1744     $classname = page_map_class($type);
1745     if (!$classname) {
1746         return $PAGE;
1747     }
1748     $legacypage = new $classname;
1749     $legacypage->init_quick($data);
1750
1751     $course = $PAGE->course;
1752     if ($course->id != $SITE->id) {
1753         $legacypage->set_course($course);
1754     } else {
1755         try {
1756             $category = $PAGE->category;
1757         } catch (coding_exception $e) {
1758             // Was not set before, so no need to try to set it again.
1759             $category = false;
1760         }
1761         if ($category) {
1762             $legacypage->set_category_by_id($category->id);
1763         } else {
1764             $legacypage->set_course($SITE);
1765         }
1766     }
1767
1768     $legacypage->set_pagetype($type);
1769
1770     $legacypage->set_url($ME);
1771     $PAGE->set_url(str_replace($CFG->wwwroot . '/', '', $legacypage->url_get_full()));
1772
1773     $PAGE->set_pagetype($type);
1774     $PAGE->set_legacy_page_object($legacypage);
1775     return $PAGE;
1776 }
1777
1778 /**
1779  * @deprecated since Moodle 2.0
1780  * You should not be writing page subclasses any more. Just set properties on the
1781  * global $PAGE object to control its behaviour.
1782  */
1783 function page_map_class($type, $classname = NULL) {
1784     global $CFG;
1785
1786     static $mappings = array(
1787         PAGE_COURSE_VIEW => 'page_course',
1788     );
1789
1790     if (!empty($type) && !empty($classname)) {
1791         $mappings[$type] = $classname;
1792     }
1793
1794     if (!isset($mappings[$type])) {
1795         debugging('Page class mapping requested for unknown type: '.$type);
1796         return null;
1797     } else if (empty($classname) && !class_exists($mappings[$type])) {
1798         debugging('Page class mapping for id "'.$type.'" exists but class "'.$mappings[$type].'" is not defined');
1799         return null;
1800     }
1801
1802     return $mappings[$type];
1803 }
1804
1805 /**
1806  * @deprecated since Moodle 2.0
1807  * Parent class from which all Moodle page classes derive
1808  *
1809  * @package    core
1810  * @subpackage lib
1811  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
1812  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1813  */
1814 class page_base extends moodle_page {
1815     /**
1816      * The numeric identifier of the page being described.
1817      * @var int $id
1818      */
1819     var $id             = NULL;
1820
1821 /// Class Functions
1822
1823     // HTML OUTPUT SECTION
1824
1825     // SELF-REPORTING SECTION
1826
1827     // Simple stuff, do not override this.
1828     function get_id() {
1829         return $this->id;
1830     }
1831
1832     // Initialize the data members of the parent class
1833     function init_quick($data) {
1834         $this->id   = $data->pageid;
1835     }
1836
1837     function init_full() {
1838     }
1839 }
1840
1841 /**
1842  * @deprecated since Moodle 2.0
1843  * Class that models the behavior of a moodle course.
1844  * Although this does nothing, this class declaration should be left for now
1845  * since there may be legacy class doing class page_... extends page_course
1846  *
1847  * @package    core
1848  * @subpackage lib
1849  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
1850  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1851  */
1852 class page_course extends page_base {
1853 }
1854
1855 /**
1856  * @deprecated since Moodle 2.0
1857  * Class that models the common parts of all activity modules
1858  *
1859  * @package    core
1860  * @subpackage lib
1861  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
1862  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1863  */
1864 class page_generic_activity extends page_base {
1865     // Although this function is deprecated, it should be left here because
1866     // people upgrading legacy code need to copy it. See
1867     // http://docs.moodle.org/en/Development:Migrating_your_code_code_to_the_2.0_rendering_API
1868     function print_header($title, $morenavlinks = NULL, $bodytags = '', $meta = '') {
1869         global $USER, $CFG, $PAGE, $OUTPUT;
1870
1871         $this->init_full();
1872         $replacements = array(
1873             '%fullname%' => format_string($this->activityrecord->name)
1874         );
1875         foreach ($replacements as $search => $replace) {
1876             $title = str_replace($search, $replace, $title);
1877         }
1878
1879         $buttons = '<table><tr><td>'.$OUTPUT->update_module_button($this->modulerecord->id, $this->activityname).'</td>';
1880         if ($this->user_allowed_editing()) {
1881             $buttons .= '<td><form method="get" action="view.php"><div>'.
1882                 '<input type="hidden" name="id" value="'.$this->modulerecord->id.'" />'.
1883                 '<input type="hidden" name="edit" value="'.($this->user_is_editing()?'off':'on').'" />'.
1884                 '<input type="submit" value="'.get_string($this->user_is_editing()?'blockseditoff':'blocksediton').'" /></div></form></td>';
1885         }
1886         $buttons .= '</tr></table>';
1887
1888         if (!empty($morenavlinks) && is_array($morenavlinks)) {
1889             foreach ($morenavlinks as $navitem) {
1890                 if (is_array($navitem) && array_key_exists('name', $navitem)) {
1891                     $link = null;
1892                     if (array_key_exists('link', $navitem)) {
1893                         $link = $navitem['link'];
1894                     }
1895                     $PAGE->navbar->add($navitem['name'], $link);
1896                 }
1897             }
1898         }
1899
1900         $PAGE->set_title($title);
1901         $PAGE->set_heading($this->course->fullname);
1902         $PAGE->set_button($buttons);
1903         echo $OUTPUT->header();
1904     }
1905 }