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