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