PageRenderTime 60ms CodeModel.GetById 23ms app.highlight 26ms RepoModel.GetById 1ms app.codeStats 1ms

/moodle/lib/pagelib.php

#
PHP | 1924 lines | 965 code | 235 blank | 724 comment | 209 complexity | 3ad51e4b8031e72de1886561458f9141 MD5 | raw file

Large files files are truncated, but you can click here to view the full file

   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
  29defined('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 $devicetypeinuse The name of the device type in use
  68 * @property-read string $docspath The path to the Moodle docs for this page.
  69 * @property-read string $focuscontrol The id of the HTML element to be focused when the page has loaded.
  70 * @property-read bool $headerprinted
  71 * @property-read string $heading The main heading that should be displayed at the top of the <body>.
  72 * @property-read string $headingmenu The menu (or actions) to display in the heading
  73 * @property-read array $layout_options Returns arrays with options for layout file.
  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 */
  90class 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 the name of the device type in use.
 221     * This will we worked out when it is first used.
 222     *
 223     * @var string
 224     */
 225    protected $_devicetypeinuse = null;
 226
 227    protected $_https_login_required = false;
 228
 229    protected $_popup_notification_allowed = true;
 230
 231/// Magic getter methods =============================================================
 232/// Due to the __get magic below, you normally do not call these as $PAGE->magic_get_x
 233/// methods, but instead use the $PAGE->x syntax.
 234
 235    /**
 236     * Please do not call this method directly, use the ->state syntax. {@link __get()}.
 237     * @return integer one of the STATE_... constants. You should not normally need
 238     * to use this in your code. It is intended for internal use by this class
 239     * and its friends like print_header, to check that everything is working as
 240     * expected. Also accessible as $PAGE->state.
 241     */
 242    protected function magic_get_state() {
 243        return $this->_state;
 244    }
 245
 246    /**
 247     * Please do not call this method directly, use the ->headerprinted syntax. {@link __get()}.
 248     * @return boolean has the header already been printed?
 249     */
 250    protected function magic_get_headerprinted() {
 251        return $this->_state >= self::STATE_IN_BODY;
 252    }
 253
 254    /**
 255     * Please do not call this method directly, use the ->course syntax. {@link __get()}.
 256     *
 257     * @global object
 258     * @return object the current course that we are inside - a row from the
 259     * course table. (Also available as $COURSE global.) If we are not inside
 260     * an actual course, this will be the site course.
 261     */
 262    protected function magic_get_course() {
 263        global $SITE;
 264        if (is_null($this->_course)) {
 265            return $SITE;
 266        }
 267        return $this->_course;
 268    }
 269
 270    /**
 271     * Please do not call this method directly, use the ->cm syntax. {@link __get()}.
 272     * @return object the course_module that this page belongs to. Will be null
 273     * if this page is not within a module. This is a full cm object, as loaded
 274     * by get_coursemodule_from_id or get_coursemodule_from_instance,
 275     * so the extra modname and name fields are present.
 276     * @return cm_info
 277     */
 278    protected function magic_get_cm() {
 279        return $this->_cm;
 280    }
 281
 282    /**
 283     * Please do not call this method directly, use the ->activityrecord syntax. {@link __get()}.
 284     * @return object the row from the activities own database table (for example
 285     * the forum or quiz table) that this page belongs to. Will be null
 286     * if this page is not within a module.
 287     */
 288    protected function magic_get_activityrecord() {
 289        if (is_null($this->_module) && !is_null($this->_cm)) {
 290            $this->load_activity_record();
 291        }
 292        return $this->_module;
 293    }
 294
 295    /**
 296     * Please do not call this method directly, use the ->activityname syntax. {@link __get()}.
 297     * @return string|null the The type of activity we are in, for example 'forum' or 'quiz'.
 298     * Will be null if this page is not within a module.
 299     */
 300    protected function magic_get_activityname() {
 301        if (is_null($this->_cm)) {
 302            return null;
 303        }
 304        return $this->_cm->modname;
 305    }
 306
 307    /**
 308     * Please do not call this method directly, use the ->category syntax. {@link __get()}.
 309     * @return mixed the category that the page course belongs to. If there isn't one
 310     * (that is, if this is the front page course) returns null.
 311     */
 312    protected function magic_get_category() {
 313        $this->ensure_category_loaded();
 314        if (!empty($this->_categories)) {
 315            return reset($this->_categories);
 316        } else {
 317            return null;
 318        }
 319    }
 320
 321    /**
 322     * Please do not call this method directly, use the ->categories syntax. {@link __get()}.
 323     * @return array an array of all the categories the page course belongs to,
 324     * starting with the immediately containing category, and working out to
 325     * the top-level category. This may be the empty array if we are in the
 326     * front page course.
 327     */
 328    protected function magic_get_categories() {
 329        $this->ensure_categories_loaded();
 330        return $this->_categories;
 331    }
 332
 333    /**
 334     * Please do not call this method directly, use the ->context syntax. {@link __get()}.
 335     * @return object the main context to which this page belongs.
 336     */
 337    protected function magic_get_context() {
 338        if (is_null($this->_context)) {
 339            if (CLI_SCRIPT or NO_MOODLE_COOKIES) {
 340                // cli scripts work in system context, do not annoy devs with debug info
 341                // very few scripts do not use cookies, we can safely use system as default context there
 342            } else {
 343                debugging('Coding problem: $PAGE->context was not set. You may have forgotten '
 344                    .'to call require_login() or $PAGE->set_context(). The page may not display '
 345                    .'correctly as a result');
 346            }
 347            $this->_context = get_context_instance(CONTEXT_SYSTEM);
 348        }
 349        return $this->_context;
 350    }
 351
 352    /**
 353     * Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
 354     * @return string e.g. 'my-index' or 'mod-quiz-attempt'.
 355     */
 356    protected function magic_get_pagetype() {
 357        global $CFG;
 358        if (is_null($this->_pagetype) || isset($CFG->pagepath)) {
 359            $this->initialise_default_pagetype();
 360        }
 361        return $this->_pagetype;
 362    }
 363
 364    /**
 365     * Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
 366     * @return string The id to use on the body tag, uses {@link magic_get_pagetype()}.
 367     */
 368    protected function magic_get_bodyid() {
 369        return 'page-'.$this->pagetype;
 370    }
 371
 372    /**
 373     * Please do not call this method directly, use the ->pagelayout syntax. {@link __get()}.
 374     * @return string the general type of page this is. For example 'standard', 'popup', 'home'.
 375     *      Allows the theme to display things differently, if it wishes to.
 376     */
 377    protected function magic_get_pagelayout() {
 378        return $this->_pagelayout;
 379    }
 380
 381    /**
 382     * Please do not call this method directly, use the ->layout_tions syntax. {@link __get()}.
 383     * @return array returns arrys with options for layout file
 384     */
 385    protected function magic_get_layout_options() {
 386        return $this->_layout_options;
 387    }
 388
 389    /**
 390     * Please do not call this method directly, use the ->subpage syntax. {@link __get()}.
 391     * @return string|null The subpage identifier, if any.
 392     */
 393    protected function magic_get_subpage() {
 394        return $this->_subpage;
 395    }
 396
 397    /**
 398     * Please do not call this method directly, use the ->bodyclasses syntax. {@link __get()}.
 399     * @return string the class names to put on the body element in the HTML.
 400     */
 401    protected function magic_get_bodyclasses() {
 402        return implode(' ', array_keys($this->_bodyclasses));
 403    }
 404
 405    /**
 406     * Please do not call this method directly, use the ->title syntax. {@link __get()}.
 407     * @return string the title that should go in the <head> section of the HTML of this page.
 408     */
 409    protected function magic_get_title() {
 410        return $this->_title;
 411    }
 412
 413    /**
 414     * Please do not call this method directly, use the ->heading syntax. {@link __get()}.
 415     * @return string the main heading that should be displayed at the top of the <body>.
 416     */
 417    protected function magic_get_heading() {
 418        return $this->_heading;
 419    }
 420
 421    /**
 422     * Please do not call this method directly, use the ->heading syntax. {@link __get()}.
 423     * @return string The menu (or actions) to display in the heading
 424     */
 425    protected function magic_get_headingmenu() {
 426        return $this->_headingmenu;
 427    }
 428
 429    /**
 430     * Please do not call this method directly, use the ->docspath syntax. {@link __get()}.
 431     * @return string the path to the Moodle docs for this page.
 432     */
 433    protected function magic_get_docspath() {
 434        if (is_string($this->_docspath)) {
 435            return $this->_docspath;
 436        } else {
 437            return str_replace('-', '/', $this->pagetype);
 438        }
 439    }
 440
 441    /**
 442     * Please do not call this method directly, use the ->url syntax. {@link __get()}.
 443     * @return moodle_url the clean URL required to load the current page. (You
 444     * should normally use this in preference to $ME or $FULLME.)
 445     */
 446    protected function magic_get_url() {
 447        global $FULLME;
 448        if (is_null($this->_url)) {
 449            debugging('This page did not call $PAGE->set_url(...). Using '.s($FULLME), DEBUG_DEVELOPER);
 450            $this->_url = new moodle_url($FULLME);
 451            // Make sure the guessed URL cannot lead to dangerous redirects.
 452            $this->_url->remove_params('sesskey');
 453        }
 454        return new moodle_url($this->_url); // Return a clone for safety.
 455    }
 456
 457    /**
 458     * The list of alternate versions of this page.
 459     * @return array mime type => object with ->url and ->title.
 460     */
 461    protected function magic_get_alternateversions() {
 462        return $this->_alternateversions;
 463    }
 464
 465    /**
 466     * Please do not call this method directly, use the ->blocks syntax. {@link __get()}.
 467     * @return blocks_manager the blocks manager object for this page.
 468     */
 469    protected function magic_get_blocks() {
 470        global $CFG;
 471        if (is_null($this->_blocks)) {
 472            if (!empty($CFG->blockmanagerclass)) {
 473                $classname = $CFG->blockmanagerclass;
 474            } else {
 475                $classname = 'block_manager';
 476            }
 477            $this->_blocks = new $classname($this);
 478        }
 479        return $this->_blocks;
 480    }
 481
 482    /**
 483     * Please do not call this method directly, use the ->requires syntax. {@link __get()}.
 484     * @return page_requirements_manager tracks the JavaScript, CSS files, etc. required by this page.
 485     */
 486    protected function magic_get_requires() {
 487        global $CFG;
 488        if (is_null($this->_requires)) {
 489            $this->_requires = new page_requirements_manager();
 490        }
 491        return $this->_requires;
 492    }
 493
 494    /**
 495     * Please do not call this method directly, use the ->cacheable syntax. {@link __get()}.
 496     * @return boolean can this page be cached by the user's browser.
 497     */
 498    protected function magic_get_cacheable() {
 499        return $this->_cacheable;
 500    }
 501
 502    /**
 503     * Please do not call this method directly, use the ->focuscontrol syntax. {@link __get()}.
 504     * @return string the id of the HTML element to be focused when the page has loaded.
 505     */
 506    protected function magic_get_focuscontrol() {
 507        return $this->_focuscontrol;
 508    }
 509
 510    /**
 511     * Please do not call this method directly, use the ->button syntax. {@link __get()}.
 512     * @return string the HTML to go where the Turn editing on button normally goes.
 513     */
 514    protected function magic_get_button() {
 515        return $this->_button;
 516    }
 517
 518    /**
 519     * Please do not call this method directly, use the ->theme syntax. {@link __get()}.
 520     * @return theme_config the initialised theme for this page.
 521     */
 522    protected function magic_get_theme() {
 523        if (is_null($this->_theme)) {
 524            $this->initialise_theme_and_output();
 525        }
 526        return $this->_theme;
 527    }
 528
 529    /**
 530     * Please do not call this method directly, use the ->devicetypeinuse syntax. {@link __get()}.
 531     *
 532     * @return string The device type being used.
 533     */
 534    protected function magic_get_devicetypeinuse() {
 535        if (empty($this->_devicetypeinuse)) {
 536            $this->_devicetypeinuse = get_user_device_type();
 537        }
 538        return $this->_devicetypeinuse;
 539    }
 540
 541    /**
 542     * Please do not call this method directly, use the ->legacythemeinuse syntax. {@link __get()}.
 543     * @deprecated since 2.1
 544     * @return bool
 545     */
 546    protected function magic_get_legacythemeinuse() {
 547        debugging('$PAGE->legacythemeinuse is a deprecated property - please use $PAGE->devicetypeinuse and check if it is equal to legacy.', DEBUG_DEVELOPER);
 548        return ($this->devicetypeinuse == 'legacy');
 549    }
 550
 551    /**
 552     * Please do not call this method directly use the ->periodicrefreshdelay syntax
 553     * {@link __get()}
 554     * @return int The periodic refresh delay to use with meta refresh
 555     */
 556    protected function magic_get_periodicrefreshdelay() {
 557        return $this->_periodicrefreshdelay;
 558    }
 559
 560    /**
 561     * Please do not call this method directly use the ->opencontainers syntax. {@link __get()}
 562     * @return xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed.
 563     *      mainly for internal use by the rendering code.
 564     */
 565    protected function magic_get_opencontainers() {
 566        if (is_null($this->_opencontainers)) {
 567            $this->_opencontainers = new xhtml_container_stack();
 568        }
 569        return $this->_opencontainers;
 570    }
 571
 572    /**
 573     * Return the navigation object
 574     * @return global_navigation
 575     */
 576    protected function magic_get_navigation() {
 577        if ($this->_navigation === null) {
 578            $this->_navigation = new global_navigation($this);
 579        }
 580        return $this->_navigation;
 581    }
 582
 583    /**
 584     * Return a navbar object
 585     * @return navbar
 586     */
 587    protected function magic_get_navbar() {
 588        if ($this->_navbar === null) {
 589            $this->_navbar = new navbar($this);
 590        }
 591        return $this->_navbar;
 592    }
 593
 594    /**
 595     * Returns the settings navigation object
 596     * @return settings_navigation
 597     */
 598    protected function magic_get_settingsnav() {
 599        if ($this->_settingsnav === null) {
 600            $this->_settingsnav = new settings_navigation($this);
 601            $this->_settingsnav->initialise();
 602        }
 603        return $this->_settingsnav;
 604    }
 605
 606    /**
 607     * PHP overloading magic to make the $PAGE->course syntax work by redirecting
 608     * it to the corresponding $PAGE->magic_get_course() method if there is one, and
 609     * throwing an exception if not.
 610     *
 611     * @param $name string property name
 612     * @return mixed
 613     */
 614    public function __get($name) {
 615        $getmethod = 'magic_get_' . $name;
 616        if (method_exists($this, $getmethod)) {
 617            return $this->$getmethod();
 618        } else {
 619            throw new coding_exception('Unknown property ' . $name . ' of $PAGE.');
 620        }
 621    }
 622
 623    /**
 624     * PHP overloading magic which prevents the $PAGE->context = $context; syntax
 625     *
 626     * @param $name string property name
 627     * @param $name mixed value
 628     * @return void, throws exception if field not defined in page class
 629     */
 630    public function __set($name, $value) {
 631        if (method_exists($this, 'set_' . $name)) {
 632            throw new coding_exception('Invalid attempt to modify page object', "Use \$PAGE->set_$name() instead.");
 633        } else {
 634            throw new coding_exception('Invalid attempt to modify page object', "Unknown property $name");
 635        }
 636    }
 637
 638/// Other information getting methods ==========================================
 639
 640    /**
 641     * Returns instance of page renderer
 642     * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
 643     * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
 644     * @param string $target one of rendering target constants
 645     * @return renderer_base
 646     */
 647    public function get_renderer($component, $subtype = null, $target = null) {
 648        return $this->magic_get_theme()->get_renderer($this, $component, $subtype, $target);
 649    }
 650
 651    /**
 652     * Checks to see if there are any items on the navbar object
 653     * @return bool true if there are, false if not
 654     */
 655    public function has_navbar() {
 656        if ($this->_navbar === null) {
 657            $this->_navbar = new navbar($this);
 658        }
 659        return $this->_navbar->has_items();
 660    }
 661
 662    /**
 663     * @return boolean should the current user see this page in editing mode.
 664     * That is, are they allowed to edit this page, and are they currently in
 665     * editing mode.
 666     */
 667    public function user_is_editing() {
 668        global $USER;
 669        return !empty($USER->editing) && $this->user_allowed_editing();
 670    }
 671
 672    /**
 673     * @return boolean does the user have permission to edit blocks on this page.
 674     */
 675    public function user_can_edit_blocks() {
 676        return has_capability($this->_blockseditingcap, $this->_context);
 677    }
 678
 679    /**
 680     * @return boolean does the user have permission to see this page in editing mode.
 681     */
 682    public function user_allowed_editing() {
 683        if ($this->_legacypageobject) {
 684            return $this->_legacypageobject->user_allowed_editing();
 685        }
 686        return has_any_capability($this->all_editing_caps(), $this->_context);
 687    }
 688
 689    /**
 690     * @return string a description of this page. Normally displayed in the footer in
 691     * developer debug mode.
 692     */
 693    public function debug_summary() {
 694        $summary = '';
 695        $summary .= 'General type: ' . $this->pagelayout . '. ';
 696        if (!during_initial_install()) {
 697            $summary .= 'Context ' . print_context_name($this->_context) . ' (context id ' . $this->_context->id . '). ';
 698        }
 699        $summary .= 'Page type ' . $this->pagetype .  '. ';
 700        if ($this->subpage) {
 701            'Sub-page ' . $this->subpage .  '. ';
 702        }
 703        return $summary;
 704    }
 705
 706/// Setter methods =============================================================
 707
 708    /**
 709     * Set the state. The state must be one of that STATE_... constants, and
 710     * the state is only allowed to advance one step at a time.
 711     * @param integer $state the new state.
 712     */
 713    public function set_state($state) {
 714        if ($state != $this->_state + 1 || $state > self::STATE_DONE) {
 715            throw new coding_exception('Invalid state passed to moodle_page::set_state. We are in state ' .
 716                    $this->_state . ' and state ' . $state . ' was requested.');
 717        }
 718
 719        if ($state == self::STATE_PRINTING_HEADER) {
 720            $this->starting_output();
 721        }
 722
 723        $this->_state = $state;
 724    }
 725
 726    /**
 727     * Set the current course. This sets both $PAGE->course and $COURSE. It also
 728     * sets the right theme and locale.
 729     *
 730     * Normally you don't need to call this function yourself, require_login will
 731     * call it for you if you pass a $course to it. You can use this function
 732     * on pages that do need to call require_login().
 733     *
 734     * Sets $PAGE->context to the course context, if it is not already set.
 735     *
 736     * @param object the course to set as the global course.
 737     */
 738    public function set_course($course) {
 739        global $COURSE, $PAGE;
 740
 741        if (empty($course->id)) {
 742            throw new coding_exception('$course passed to moodle_page::set_course does not look like a proper course object.');
 743        }
 744
 745        $this->ensure_theme_not_set();
 746
 747        if (!empty($this->_course->id) && $this->_course->id != $course->id) {
 748            $this->_categories = null;
 749        }
 750
 751        $this->_course = clone($course);
 752
 753        if ($this === $PAGE) {
 754            $COURSE = $this->_course;
 755            moodle_setlocale();
 756        }
 757
 758        if (!$this->_context) {
 759            $this->set_context(get_context_instance(CONTEXT_COURSE, $this->_course->id));
 760        }
 761    }
 762
 763    /**
 764     * Set the main context to which this page belongs.
 765     * @param object $context a context object, normally obtained with get_context_instance.
 766     */
 767    public function set_context($context) {
 768        if ($context === null) {
 769            // extremely ugly hack which sets context to some value in order to prevent warnings,
 770            // use only for core error handling!!!!
 771            if (!$this->_context) {
 772                $this->_context = get_context_instance(CONTEXT_SYSTEM);
 773            }
 774            return;
 775        }
 776
 777        // ideally we should set context only once
 778        if (isset($this->_context)) {
 779            if ($context->id == $this->_context->id) {
 780                // fine - no change needed
 781            } else if ($this->_context->contextlevel == CONTEXT_SYSTEM or $this->_context->contextlevel == CONTEXT_COURSE) {
 782                // hmm - not ideal, but it might produce too many warnings due to the design of require_login
 783            } else if ($this->_context->contextlevel == CONTEXT_MODULE and $this->_context->id == get_parent_contextid($context)) {
 784                // hmm - most probably somebody did require_login() and after that set the block context
 785            } else {
 786                // we do not want devs to do weird switching of context levels on the fly,
 787                // because we might have used the context already such as in text filter in page title
 788                debugging('Coding problem: unsupported modification of PAGE->context from '.$this->_context->contextlevel.' to '.$context->contextlevel);
 789            }
 790        }
 791
 792        $this->_context = $context;
 793    }
 794
 795    /**
 796     * The course module that this page belongs to (if it does belong to one).
 797     *
 798     * @param stdClass|cm_info $cm a record from course_modules table or cm_info from get_fast_modinfo().
 799     * @param stdClass $course
 800     * @param stdClass $module
 801     * @return void
 802     */
 803    public function set_cm($cm, $course = null, $module = null) {
 804        global $DB;
 805
 806        if (!isset($cm->id) || !isset($cm->course)) {
 807            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.');
 808        }
 809
 810        if (!$this->_course || $this->_course->id != $cm->course) {
 811            if (!$course) {
 812                $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
 813            }
 814            if ($course->id != $cm->course) {
 815                throw new coding_exception('The course you passed to $PAGE->set_cm does not correspond to the $cm.');
 816            }
 817            $this->set_course($course);
 818        }
 819
 820        // make sure we have a $cm from get_fast_modinfo as this contains activity access details
 821        if (!($cm instanceof cm_info)) {
 822            $modinfo = get_fast_modinfo($this->_course);
 823            $cm = $modinfo->get_cm($cm->id);
 824        }
 825        $this->_cm = $cm;
 826
 827        // unfortunately the context setting is a mess, let's try to work around some common block problems and show some debug messages
 828        if (empty($this->_context) or $this->_context->contextlevel != CONTEXT_BLOCK) {
 829            $context = get_context_instance(CONTEXT_MODULE, $cm->id);
 830            $this->set_context($context);
 831        }
 832
 833        if ($module) {
 834            $this->set_activity_record($module);
 835        }
 836    }
 837
 838    /**
 839     * @param $module a row from the main database table for the module that this
 840     * page belongs to. For example, if ->cm is a forum, then you can pass the
 841     * corresponding row from the forum table here if you have it (saves a database
 842     * query sometimes).
 843     */
 844    public function set_activity_record($module) {
 845        if (is_null($this->_cm)) {
 846            throw new coding_exception('You cannot call $PAGE->set_activity_record until after $PAGE->cm has been set.');
 847        }
 848        if ($module->id != $this->_cm->instance || $module->course != $this->_course->id) {
 849            throw new coding_exception('The activity record your are trying to set does not seem to correspond to the cm that has been set.');
 850        }
 851        $this->_module = $module;
 852    }
 853
 854    /**
 855     * @param string $pagetype e.g. 'my-index' or 'mod-quiz-attempt'. Normally
 856     * you do not need to set this manually, it is automatically created from the
 857     * script name. However, on some pages this is overridden. For example, the
 858     * page type for course/view.php includes the course format, for example
 859     * 'course-view-weeks'. This gets used as the id attribute on <body> and
 860     * also for determining which blocks are displayed.
 861     */
 862    public function set_pagetype($pagetype) {
 863        $this->_pagetype = $pagetype;
 864    }
 865
 866    /**
 867     * @param string $pagelayout the page layout this is. For example 'popup', 'home'.
 868     * This properly defaults to 'base', so you only need to call this function if
 869     * you want something different. The exact range of supported layouts is specified
 870     * in the standard theme.
 871     */
 872    public function set_pagelayout($pagelayout) {
 873        /**
 874         * Uncomment this to debug theme pagelayout issues like missing blocks.
 875         *
 876         * if (!empty($this->_wherethemewasinitialised) && $pagelayout != $this->_pagelayout) {
 877         *     debugging('Page layout has already been set and cannot be changed.', DEBUG_DEVELOPER);
 878         * }
 879         */
 880        $this->_pagelayout = $pagelayout;
 881    }
 882
 883    /**
 884     * If context->id and pagetype are not enough to uniquely identify this page,
 885     * then you can set a subpage id as well. For example, the tags page sets
 886     * @param string $subpage an arbitrary identifier that, along with context->id
 887     *      and pagetype, uniquely identifies this page.
 888     */
 889    public function set_subpage($subpage) {
 890        if (empty($subpage)) {
 891            $this->_subpage = '';
 892        } else {
 893            $this->_subpage = $subpage;
 894        }
 895    }
 896
 897    /**
 898     * @param string $class add this class name ot the class attribute on the body tag.
 899     */
 900    public function add_body_class($class) {
 901        if ($this->_state > self::STATE_BEFORE_HEADER) {
 902            throw new coding_exception('Cannot call moodle_page::add_body_class after output has been started.');
 903        }
 904        $this->_bodyclasses[$class] = 1;
 905    }
 906
 907    /**
 908     * @param array $classes this utility method calls add_body_class for each array element.
 909     */
 910    public function add_body_classes($classes) {
 911        foreach ($classes as $class) {
 912            $this->add_body_class($class);
 913        }
 914    }
 915
 916    /**
 917     * @param string $title the title that should go in the <head> section of the HTML of this page.
 918     */
 919    public function set_title($title) {
 920        $title = format_string($title);
 921        $title = str_replace('"', '&quot;', $title);
 922        $this->_title = $title;
 923    }
 924
 925    /**
 926     * @param string $heading the main heading that should be displayed at the top of the <body>.
 927     */
 928    public function set_heading($heading) {
 929        $this->_heading = format_string($heading);
 930    }
 931
 932    /**
 933     * @param string $menu The menu/content to show in the heading
 934     */
 935    public function set_headingmenu($menu) {
 936        $this->_headingmenu = $menu;
 937    }
 938
 939    /**
 940     * Set the course category this page belongs to manually. This automatically
 941     * sets $PAGE->course to be the site course. You cannot use this method if
 942     * you have already set $PAGE->course - in that case, the category must be
 943     * the one that the course belongs to. This also automatically sets the
 944     * page context to the category context.
 945     * @param integer $categoryid The id of the category to set.
 946     */
 947    public function set_category_by_id($categoryid) {
 948        global $SITE, $DB;
 949        if (!is_null($this->_course)) {
 950            throw new coding_exception('Attempt to manually set the course category when the course has been set. This is not allowed.');
 951        }
 952        if (is_array($this->_categories)) {
 953            throw new coding_exception('Course category has already been set. You are not allowed to change it.');
 954        }
 955        $this->ensure_theme_not_set();
 956        $this->set_course($SITE);
 957        $this->load_category($categoryid);
 958        $this->set_context(get_context_instance(CONTEXT_COURSECAT, $categoryid));
 959    }
 960
 961    /**
 962     * Set a different path to use for the 'Moodle docs for this page' link.
 963     * By default, it uses the pagetype, which is normally the same as the
 964     * script name. So, for example, for mod/quiz/attempt.php, pagetype is
 965     * mod-quiz-attempt, and so docspath is mod/quiz/attempt.
 966     * @param string $path the path to use at the end of the moodle docs URL.
 967     */
 968    public function set_docs_path($path) {
 969        $this->_docspath = $path;
 970    }
 971
 972    /**
 973     * You should call this method from every page to set the cleaned-up URL
 974     * that should be used to return to this page. Used, for example, by the
 975     * blocks editing UI to know where to return the user after an action.
 976     * For example, course/view.php does:
 977     *      $id = optional_param('id', 0, PARAM_INT);
 978     *      $PAGE->set_url('/course/view.php', array('id' => $id));
 979     * @param moodle_url|string $url URL relative to $CFG->wwwroot or {@link moodle_url} instance
 980     * @param array $params parameters to add to the URL
 981     */
 982    public function set_url($url, array $params = null) {
 983        global $CFG;
 984
 985        if (is_string($url)) {
 986            if (strpos($url, 'http') === 0) {
 987                // ok
 988            } else if (strpos($url, '/') === 0) {
 989                // we have to use httpswwwroot here, because of loginhttps pages
 990                $url = $CFG->httpswwwroot . $url;
 991            } else {
 992                throw new coding_exception('Invalid parameter $url, has to be full url or in shortened form starting with /.');
 993            }
 994        }
 995
 996        $this->_url = new moodle_url($url, $params);
 997
 998        $fullurl = $this->_url->out_omit_querystring();
 999        if (strpos($fullurl, "$CFG->httpswwwroot/") !== 0) {
1000            debugging('Most probably incorrect set_page() url argument, it does not match the httpswwwroot!');
1001        }
1002        $shorturl = str_replace("$CFG->httpswwwroot/", '', $fullurl);
1003
1004        if (is_null($this->_pagetype)) {
1005            $this->initialise_default_pagetype($shorturl);
1006        }
1007        if (!is_null($this->_legacypageobject)) {
1008            $this->_legacypageobject->set_url($url, $params);
1009        }
1010    }
1011
1012    /**
1013     * Make sure page URL does not contain the given URL parameter.
1014     *
1015     * This should not be necessary if the script has called set_url properly.
1016     * However, in some situations like the block editing actions; when the URL
1017     * has been guessed, it will contain dangerous block-related actions.
1018     * Therefore, the blocks code calls this function to clean up such parameters
1019     * before doing any redirect.
1020     *
1021     * @param string $param the name of the parameter to make sure is not in the
1022     * page URL.
1023     */
1024    public function ensure_param_not_in_url($param) {
1025        $discard = $this->url; // Make sure $this->url is lazy-loaded;
1026        $this->_url->remove_params($param);
1027    }
1028
1029    /**
1030     * There can be alternate versions of some pages (for example an RSS feed version).
1031     * If such other version exist, call this method, and a link to the alternate
1032     * version will be included in the <head> of the page.
1033     *
1034     * @param $title The title to give the alternate version.
1035     * @param $url The URL of the alternate version.
1036     * @param $mimetype The mime-type of the alternate version.
1037     */
1038    public function add_alternate_version($title, $url, $mimetype) {
1039        if ($this->_state > self::STATE_BEFORE_HEADER) {
1040            throw new coding_exception('Cannot call moodle_page::add_alternate_version after output has been started.');
1041        }
1042        $alt = new stdClass;
1043        $alt->title = $title;
1044        $alt->url = $url;
1045        $this->_alternateversions[$mimetype] = $alt;
1046    }
1047
1048    /**
1049     * Specify a form control should be focused when the page has loaded.
1050     *
1051     * @param string $controlid the id of the HTML element to be focused.
1052     */
1053    public function set_focuscontrol($controlid) {
1054        $this->_focuscontrol = $controlid;
1055    }
1056
1057    /**
1058     * Specify a fragment of HTML that goes where the 'Turn editing on' button normally goes.
1059     *
1060     * @param string $html the HTML to display there.
1061     */
1062    public function set_button($html) {
1063        $this->_button = $html;
1064    }
1065
1066    /**
1067     * Set the capability that allows users to edit blocks on this page. Normally
1068     * the default of 'moodle/site:manageblocks' is used, but a few pages like
1069     * the My Moodle page need to use a different capability like 'moodle/my:manageblocks'.
1070     * @param string $capability a capability.
1071     */
1072    public function set_blocks_editing_capability($capability) {
1073        $this->_blockseditingcap = $capability;
1074    }
1075
1076    /**
1077     * Some pages let you turn editing on for reasons other than editing blocks.
1078     * If that is the case, you can pass other capabilities that let the user
1079     * edit this page here.
1080     * @param string|array $capability either a capability, or an array of capabilities.
1081     */
1082    public function set_other_editing_capability($capability) {
1083        if (is_array($capability)) {
1084            $this->_othereditingcaps = array_unique($this->_othereditingcaps + $capability);
1085        } else {
1086            $this->_othereditingcaps[] = $capability;
1087        }
1088    }
1089
1090    /**
1091     * @return boolean $cacheable can this page be cached by the user's browser.
1092     */
1093    public function set_cacheable($cacheable) {
1094        $this->_cacheable = $cacheable;
1095    }
1096
1097    /**
1098     * Sets the page to periodically refresh
1099     *
1100     * This function must be called before $OUTPUT->header has been called or
1101     * a coding exception will be thrown.
1102     *
1103     * @param int $delay Sets the delay before refreshing the page, if set to null
1104     *                    refresh is cancelled
1105     */
1106    public function set_periodic_refresh_delay($delay=null) {
1107        if ($this->_state > self::STATE_BEFORE_HEADER) {
1108            throw new coding_exception('You cannot set a periodic refresh delay after the header has been printed');
1109        }
1110        if ($delay===null) {
1111            $this->_periodicrefreshdelay = null;
1112        } else if (is_int($delay)) {
1113            $this->_periodicrefreshdelay = $delay;
1114        }
1115    }
1116
1117    /**
1118     * Force this page to use a particular theme.
1119     *
1120     * Please use this cautiously. It is only intended to be used by the themes selector admin page.
1121     *
1122     * @param $themename the name of the theme to use.
1123     */
1124    public function force_theme($themename) {
1125        $this->ensure_theme_not_set();
1126        $this->_theme = theme_config::load($themename);
1127    }
1128
1129    /**
1130     * This function indicates that current page requires the https
1131     * when $CFG->loginhttps enabled.
1132     *
1133     * By using this function properly, we can ensure 100% https-ized pages
1134     * at our entire discretion (login, forgot_password, change_password)
1135     * @return void
1136     */
1137    public function https_required() {
1138        global $CFG;
1139
1140        if (!is_null($this->_url)) {
1141            throw new coding_exception('https_required() must be used before setting page url!');
1142        }
1143
1144        $this->ensure_theme_not_set();
1145
1146        $this->_https_login_required = true;
1147
1148        if (!empty($CFG->loginhttps)) {
1149            $CFG->httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
1150        } else {
1151            $CFG->httpswwwroot = $CFG->wwwroot;
1152        }
1153    }
1154
1155    /**
1156     * Makes sure that page previously marked with https_required()
1157     * is really using https://, if not it redirects to https://
1158     *
1159     * @return void (may redirect to https://self)
1160     */
1161    public function verify_https_required() {
1162        global $CFG, $FULLME;
1163
1164        if (is_null($this->_url)) {
1165            throw new coding_exception('verify_https_required() must be called after setting page url!');
1166        }
1167
1168        if (!$this->_https_login_required) {
1169            throw new coding_exception('verify_https_required() must be called only after https_required()!');
1170        }
1171
1172        if (empty($CFG->loginhttps)) {
1173            // https not required, so stop checking
1174            return;
1175        }
1176
1177        if (strpos($this->_url, 'https://')) {
1178            // detect if incorrect PAGE->set_url() used, it is recommended to use root-relative paths there
1179            throw new coding_exception('Invalid page url specified, it must start with https:// for pages that set https_required()!');
1180        }
1181
1182        if (!empty($CFG->sslproxy)) {
1183            // it does not make much sense to use sslproxy and loginhttps at the same time
1184            return;
1185        }
1186
1187        // now the real test and redirect!
1188        // NOTE: do NOT use this test for detection of https on current page because this code is not compatible with SSL proxies,
1189        //       instead use strpos($CFG->httpswwwroot, 'https:') === 0
1190        if (strpos($FULLME, 'https:') !== 0) {
1191            // this may lead to infinite redirect on misconfigured sites, in that case use $CFG->loginhttps=0; in /config.php
1192            redirect($this->_url);
1193        }
1194    }
1195
1196/// Initialisation methods =====================================================
1197/// These set various things up in a default way.
1198
1199    /**
1200     * This method is called when the page first moves out of the STATE_BEFORE_HEADER
1201     * state. This is our last change to initialise things.
1202     */
1203    protected function starting_output() {
1204        global $CFG;
1205
1206        if (!during_initial_install()) {
1207            $this->blocks->load_blocks();
1208            if (empty($this->_block_actions_done)) {
1209                $this->_block_actions_done = true;
1210                if ($this->blocks->process_url_actions($this)) {
1211                    redirect($this->url->out(false));
1212                }
1213            }
1214            $this->blocks->create_all_block_instances();
1215        }
1216
1217        // If maintenance mode is on, change the page header.
1218        if (!empty($CFG->maintenance_enabled)) {
1219            $this->set_button('<a href="' . $CFG->wwwroot . '/' . $CFG->admin .
1220                    '/settings.php?section=maintenancemode">' . get_string('maintenancemode', 'admin') .
1221                    '</a> ' . $this->button);
1222
1223            $title = $this->title;
1224            if ($title) {
1225                $title .= ' - ';
1226            }
1227            $this->set_title($title . get_string('maintenancemode', 'admin'));
1228        } else {
1229            // Show the messaging popup if there are messages
1230            message_popup_window();
1231        }
1232
1233        $this->initialise_standard_body_classes();
1234    }
1235
1236    /**
1237     * Method for use by Moodle core to set up the theme. Do not
1238     * use this in your own code.
1239     *
1240     * Make sure the right theme for this page is loaded. Tell our
1241     * blocks_manager about the theme block regions, and then, if
1242     * we are $PAGE, set up the global $OUTPUT.
1243     */
1244    public function initialise_theme_and_output() {
1245        global $OUTPUT, $PAGE, $SITE;
1246
1247        if (!empty($this->_wherethemewasinitialised)) {
1248            return;
1249        }
1250
1251        if (!during_initial_install()) {
1252            // detect PAGE->context mess
1253            $this->magic_get_context();
1254        }
1255
1256        if (!$this->_course && !during_initial_install()) {
1257            $this->set_course($SITE);
1258        }
1259
1260        if (is_null($this->_theme)) {
1261            $themename = $this->resolve_theme();
1262            $this->_theme = theme_config::load($themename);
1263            $this->_layout_options = $this->_theme->pagelayout_options($this->pagelayout);
1264        }
1265
1266        $this->_theme->setup_blocks($this->pagelayout, $this->blocks);
1267
1268        if ($this === $PAGE) {
1269            $OUTPUT = $this->get_renderer('core');
1270        }
1271
1272        $this->_wherethemewasinitialised = debug_backtrace();
1273    }
1274
1275    /**
1276     * Work out the theme this page should use.
1277     *
1278     * This depends on numerous $CFG settings, and the properties of this page.
1279     *
1280     * @return string the name of the theme that should be used on this page.
1281     */
1282    protected function resolve_theme() {
1283        global $CFG, $USER, $SESSION;
1284
1285        if (empty($CFG->themeorder)) {
1286            $themeorder = array('course', 'category', 'session', 'user', 'site');
1287        } else {
1288            $themeorder = $CFG->themeorder;
1289            // Just in case, make sure we always use the site theme if nothing else matched.
1290            $themeorder[] = 'site';
1291        }
1292
1293        $mnetpeertheme = '';
1294        if (isloggedin() and isset($CFG->mnet_localhost_id) and $USER->mnethostid != $CFG->mnet_localhost_id) {
1295            require_once($CFG->dirroot.'/mnet/peer.php');
1296            $mnetpeer = new mnet_peer();
1297            $mnetpeer->set_id($USER->mnethostid);
1298            if ($mnetpeer->force_theme == 1 && $mnetpeer->theme != '') {
1299                $mnetpeertheme = $mnetpeer->theme;
1300            }
1301        }
1302
1303        foreach ($themeorder as $themetype) {
1304            switch ($t…

Large files files are truncated, but you can click here to view the full file