MDL-55074 theme_boost: Navigation and blocks
[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 flat_navigation Contains a list of nav nodes, most closely related to the current page.
291      */
292     protected $_flatnav = null;
294     /**
295      * @var navbar Contains the navbar structure.
296      */
297     protected $_navbar = null;
299     /**
300      * @var string The menu (or actions) to display in the heading.
301      */
302     protected $_headingmenu = null;
304     /**
305      * @var array stack trace. Then the theme is initialised, we save the stack
306      * trace, for use in error messages.
307      */
308     protected $_wherethemewasinitialised = null;
310     /**
311      * @var xhtml_container_stack Tracks XHTML tags on this page that have been
312      * opened but not closed.
313      */
314     protected $_opencontainers;
316     /**
317      * @var int Sets the page to refresh after a given delay (in seconds) using
318      * meta refresh in {@link standard_head_html()} in outputlib.php
319      * If set to null(default) the page is not refreshed
320      */
321     protected $_periodicrefreshdelay = null;
323     /**
324      * @var array Associative array of browser shortnames (as used by check_browser_version)
325      * and their minimum required versions
326      */
327     protected $_legacybrowsers = array('MSIE' => 6.0);
329     /**
330      * @var string Is set to the name of the device type in use.
331      * This will we worked out when it is first used.
332      */
333     protected $_devicetypeinuse = null;
335     /**
336      * @var bool Used to determine if HTTPS should be required for login.
337      */
338     protected $_https_login_required = false;
340     /**
341      * @var bool Determines if popup notifications allowed on this page.
342      * Code such as the quiz module disables popup notifications in situations
343      * such as upgrading or completing a quiz.
344      */
345     protected $_popup_notification_allowed = true;
347     // Magic getter methods =============================================================
348     // Due to the __get magic below, you normally do not call these as $PAGE->magic_get_x
349     // methods, but instead use the $PAGE->x syntax.
351     /**
352      * Please do not call this method directly, use the ->state syntax. {@link moodle_page::__get()}.
353      * @return integer one of the STATE_XXX constants. You should not normally need
354      * to use this in your code. It is intended for internal use by this class
355      * and its friends like print_header, to check that everything is working as
356      * expected. Also accessible as $PAGE->state.
357      */
358     protected function magic_get_state() {
359         return $this->_state;
360     }
362     /**
363      * Please do not call this method directly, use the ->headerprinted syntax. {@link moodle_page::__get()}.
364      * @return bool has the header already been printed?
365      */
366     protected function magic_get_headerprinted() {
367         return $this->_state >= self::STATE_IN_BODY;
368     }
370     /**
371      * Please do not call this method directly, use the ->course syntax. {@link moodle_page::__get()}.
372      * @return stdClass the current course that we are inside - a row from the
373      * course table. (Also available as $COURSE global.) If we are not inside
374      * an actual course, this will be the site course.
375      */
376     protected function magic_get_course() {
377         global $SITE;
378         if (is_null($this->_course)) {
379             return $SITE;
380         }
381         return $this->_course;
382     }
384     /**
385      * Please do not call this method directly, use the ->cm syntax. {@link moodle_page::__get()}.
386      * @return cm_info the course_module that this page belongs to. Will be null
387      * if this page is not within a module. This is a full cm object, as loaded
388      * by get_coursemodule_from_id or get_coursemodule_from_instance,
389      * so the extra modname and name fields are present.
390      */
391     protected function magic_get_cm() {
392         return $this->_cm;
393     }
395     /**
396      * Please do not call this method directly, use the ->activityrecord syntax. {@link moodle_page::__get()}.
397      * @return stdClass the row from the activities own database table (for example
398      * the forum or quiz table) that this page belongs to. Will be null
399      * if this page is not within a module.
400      */
401     protected function magic_get_activityrecord() {
402         if (is_null($this->_module) && !is_null($this->_cm)) {
403             $this->load_activity_record();
404         }
405         return $this->_module;
406     }
408     /**
409      * Please do not call this method directly, use the ->activityname syntax. {@link moodle_page::__get()}.
410      * @return string the The type of activity we are in, for example 'forum' or 'quiz'.
411      * Will be null if this page is not within a module.
412      */
413     protected function magic_get_activityname() {
414         if (is_null($this->_cm)) {
415             return null;
416         }
417         return $this->_cm->modname;
418     }
420     /**
421      * Please do not call this method directly, use the ->category syntax. {@link moodle_page::__get()}.
422      * @return stdClass the category that the page course belongs to. If there isn't one
423      * (that is, if this is the front page course) returns null.
424      */
425     protected function magic_get_category() {
426         $this->ensure_category_loaded();
427         if (!empty($this->_categories)) {
428             return reset($this->_categories);
429         } else {
430             return null;
431         }
432     }
434     /**
435      * Please do not call this method directly, use the ->categories syntax. {@link moodle_page::__get()}.
436      * @return array an array of all the categories the page course belongs to,
437      * starting with the immediately containing category, and working out to
438      * the top-level category. This may be the empty array if we are in the
439      * front page course.
440      */
441     protected function magic_get_categories() {
442         $this->ensure_categories_loaded();
443         return $this->_categories;
444     }
446     /**
447      * Please do not call this method directly, use the ->context syntax. {@link moodle_page::__get()}.
448      * @return context the main context to which this page belongs.
449      */
450     protected function magic_get_context() {
451         global $CFG;
452         if (is_null($this->_context)) {
453             if (CLI_SCRIPT or NO_MOODLE_COOKIES) {
454                 // Cli scripts work in system context, do not annoy devs with debug info.
455                 // Very few scripts do not use cookies, we can safely use system as default context there.
456             } else if (AJAX_SCRIPT && $CFG->debugdeveloper) {
457                 // Throw exception inside AJAX script in developer mode, otherwise the debugging message may be missed.
458                 throw new coding_exception('$PAGE->context was not set. You may have forgotten '
459                     .'to call require_login() or $PAGE->set_context()');
460             } else {
461                 debugging('Coding problem: $PAGE->context was not set. You may have forgotten '
462                     .'to call require_login() or $PAGE->set_context(). The page may not display '
463                     .'correctly as a result');
464             }
465             $this->_context = context_system::instance();
466         }
467         return $this->_context;
468     }
470     /**
471      * Please do not call this method directly, use the ->pagetype syntax. {@link moodle_page::__get()}.
472      * @return string e.g. 'my-index' or 'mod-quiz-attempt'.
473      */
474     protected function magic_get_pagetype() {
475         global $CFG;
476         if (is_null($this->_pagetype) || isset($CFG->pagepath)) {
477             $this->initialise_default_pagetype();
478         }
479         return $this->_pagetype;
480     }
482     /**
483      * Please do not call this method directly, use the ->pagetype syntax. {@link moodle_page::__get()}.
484      * @return string The id to use on the body tag, uses {@link magic_get_pagetype()}.
485      */
486     protected function magic_get_bodyid() {
487         return 'page-'.$this->pagetype;
488     }
490     /**
491      * Please do not call this method directly, use the ->pagelayout syntax. {@link moodle_page::__get()}.
492      * @return string the general type of page this is. For example 'standard', 'popup', 'home'.
493      *      Allows the theme to display things differently, if it wishes to.
494      */
495     protected function magic_get_pagelayout() {
496         return $this->_pagelayout;
497     }
499     /**
500      * Please do not call this method directly, use the ->layout_options syntax. {@link moodle_page::__get()}.
501      * @return array returns arrays with options for layout file
502      */
503     protected function magic_get_layout_options() {
504         if (!is_array($this->_layout_options)) {
505             $this->_layout_options = $this->_theme->pagelayout_options($this->pagelayout);
506         }
507         return $this->_layout_options;
508     }
510     /**
511      * Please do not call this method directly, use the ->subpage syntax. {@link moodle_page::__get()}.
512      * @return string The subpage identifier, if any.
513      */
514     protected function magic_get_subpage() {
515         return $this->_subpage;
516     }
518     /**
519      * Please do not call this method directly, use the ->bodyclasses syntax. {@link moodle_page::__get()}.
520      * @return string the class names to put on the body element in the HTML.
521      */
522     protected function magic_get_bodyclasses() {
523         return implode(' ', array_keys($this->_bodyclasses));
524     }
526     /**
527      * Please do not call this method directly, use the ->title syntax. {@link moodle_page::__get()}.
528      * @return string the title that should go in the <head> section of the HTML of this page.
529      */
530     protected function magic_get_title() {
531         return $this->_title;
532     }
534     /**
535      * Please do not call this method directly, use the ->heading syntax. {@link moodle_page::__get()}.
536      * @return string the main heading that should be displayed at the top of the <body>.
537      */
538     protected function magic_get_heading() {
539         return $this->_heading;
540     }
542     /**
543      * Please do not call this method directly, use the ->heading syntax. {@link moodle_page::__get()}.
544      * @return string The menu (or actions) to display in the heading
545      */
546     protected function magic_get_headingmenu() {
547         return $this->_headingmenu;
548     }
550     /**
551      * Please do not call this method directly, use the ->docspath syntax. {@link moodle_page::__get()}.
552      * @return string the path to the Moodle docs for this page.
553      */
554     protected function magic_get_docspath() {
555         if (is_string($this->_docspath)) {
556             return $this->_docspath;
557         } else {
558             return str_replace('-', '/', $this->pagetype);
559         }
560     }
562     /**
563      * Please do not call this method directly, use the ->url syntax. {@link moodle_page::__get()}.
564      * @return moodle_url the clean URL required to load the current page. (You
565      * should normally use this in preference to $ME or $FULLME.)
566      */
567     protected function magic_get_url() {
568         global $FULLME;
569         if (is_null($this->_url)) {
570             debugging('This page did not call $PAGE->set_url(...). Using '.s($FULLME), DEBUG_DEVELOPER);
571             $this->_url = new moodle_url($FULLME);
572             // Make sure the guessed URL cannot lead to dangerous redirects.
573             $this->_url->remove_params('sesskey');
574         }
575         return new moodle_url($this->_url); // Return a clone for safety.
576     }
578     /**
579      * The list of alternate versions of this page.
580      * @return array mime type => object with ->url and ->title.
581      */
582     protected function magic_get_alternateversions() {
583         return $this->_alternateversions;
584     }
586     /**
587      * Please do not call this method directly, use the ->blocks syntax. {@link moodle_page::__get()}.
588      * @return block_manager the blocks manager object for this page.
589      */
590     protected function magic_get_blocks() {
591         global $CFG;
592         if (is_null($this->_blocks)) {
593             if (!empty($CFG->blockmanagerclass)) {
594                 if (!empty($CFG->blockmanagerclassfile)) {
595                     require_once($CFG->blockmanagerclassfile);
596                 }
597                 $classname = $CFG->blockmanagerclass;
598             } else {
599                 $classname = 'block_manager';
600             }
601             $this->_blocks = new $classname($this);
602         }
603         return $this->_blocks;
604     }
606     /**
607      * Please do not call this method directly, use the ->requires syntax. {@link moodle_page::__get()}.
608      * @return page_requirements_manager tracks the JavaScript, CSS files, etc. required by this page.
609      */
610     protected function magic_get_requires() {
611         if (is_null($this->_requires)) {
612             $this->_requires = new page_requirements_manager();
613         }
614         return $this->_requires;
615     }
617     /**
618      * Please do not call this method directly, use the ->cacheable syntax. {@link moodle_page::__get()}.
619      * @return bool can this page be cached by the user's browser.
620      */
621     protected function magic_get_cacheable() {
622         return $this->_cacheable;
623     }
625     /**
626      * Please do not call this method directly, use the ->focuscontrol syntax. {@link moodle_page::__get()}.
627      * @return string the id of the HTML element to be focused when the page has loaded.
628      */
629     protected function magic_get_focuscontrol() {
630         return $this->_focuscontrol;
631     }
633     /**
634      * Please do not call this method directly, use the ->button syntax. {@link moodle_page::__get()}.
635      * @return string the HTML to go where the Turn editing on button normally goes.
636      */
637     protected function magic_get_button() {
638         return $this->_button;
639     }
641     /**
642      * Please do not call this method directly, use the ->theme syntax. {@link moodle_page::__get()}.
643      * @return theme_config the initialised theme for this page.
644      */
645     protected function magic_get_theme() {
646         if (is_null($this->_theme)) {
647             $this->initialise_theme_and_output();
648         }
649         return $this->_theme;
650     }
652     /**
653      * Returns an array of minipulations or false if there are none to make.
654      *
655      * @since Moodle 2.5.1 2.6
656      * @return bool|array
657      */
658     protected function magic_get_blockmanipulations() {
659         if (!right_to_left()) {
660             return false;
661         }
662         if (is_null($this->_theme)) {
663             $this->initialise_theme_and_output();
664         }
665         return $this->_theme->blockrtlmanipulations;
666     }
668     /**
669      * Please do not call this method directly, use the ->devicetypeinuse syntax. {@link moodle_page::__get()}.
670      * @return string The device type being used.
671      */
672     protected function magic_get_devicetypeinuse() {
673         if (empty($this->_devicetypeinuse)) {
674             $this->_devicetypeinuse = core_useragent::get_user_device_type();
675         }
676         return $this->_devicetypeinuse;
677     }
679     /**
680      * Please do not call this method directly use the ->periodicrefreshdelay syntax
681      * {@link moodle_page::__get()}
682      * @return int The periodic refresh delay to use with meta refresh
683      */
684     protected function magic_get_periodicrefreshdelay() {
685         return $this->_periodicrefreshdelay;
686     }
688     /**
689      * Please do not call this method directly use the ->opencontainers syntax. {@link moodle_page::__get()}
690      * @return xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed.
691      *      mainly for internal use by the rendering code.
692      */
693     protected function magic_get_opencontainers() {
694         if (is_null($this->_opencontainers)) {
695             $this->_opencontainers = new xhtml_container_stack();
696         }
697         return $this->_opencontainers;
698     }
700     /**
701      * Return the navigation object
702      * @return global_navigation
703      */
704     protected function magic_get_navigation() {
705         if ($this->_navigation === null) {
706             $this->_navigation = new global_navigation($this);
707         }
708         return $this->_navigation;
709     }
711     /**
712      * Return a navbar object
713      * @return navbar
714      */
715     protected function magic_get_navbar() {
716         if ($this->_navbar === null) {
717             $this->_navbar = new navbar($this);
718         }
719         return $this->_navbar;
720     }
722     /**
723      * Returns the settings navigation object
724      * @return settings_navigation
725      */
726     protected function magic_get_settingsnav() {
727         if ($this->_settingsnav === null) {
728             $this->_settingsnav = new settings_navigation($this);
729             $this->_settingsnav->initialise();
730         }
731         return $this->_settingsnav;
732     }
734     /**
735      * Returns the flat navigation object
736      * @return flat_navigation
737      */
738     protected function magic_get_flatnav() {
739         if ($this->_flatnav === null) {
740             $this->_flatnav = new flat_navigation($this);
741             $this->_flatnav->initialise();
742         }
743         return $this->_flatnav;
744     }
746     /**
747      * Returns request IP address.
748      *
749      * @return string IP address or null if unknown
750      */
751     protected function magic_get_requestip() {
752         return getremoteaddr(null);
753     }
755     /**
756      * Returns the origin of current request.
757      *
758      * Note: constants are not required because we need to use these values in logging and reports.
759      *
760      * @return string 'web', 'ws', 'cli', 'restore', etc.
761      */
762     protected function magic_get_requestorigin() {
763         if (class_exists('restore_controller', false) && restore_controller::is_executing()) {
764             return 'restore';
765         }
767         if (WS_SERVER) {
768             return 'ws';
769         }
771         if (CLI_SCRIPT) {
772             return 'cli';
773         }
775         return 'web';
776     }
778     /**
779      * PHP overloading magic to make the $PAGE->course syntax work by redirecting
780      * it to the corresponding $PAGE->magic_get_course() method if there is one, and
781      * throwing an exception if not.
782      *
783      * @param string $name property name
784      * @return mixed
785      * @throws coding_exception
786      */
787     public function __get($name) {
788         $getmethod = 'magic_get_' . $name;
789         if (method_exists($this, $getmethod)) {
790             return $this->$getmethod();
791         } else {
792             throw new coding_exception('Unknown property ' . $name . ' of $PAGE.');
793         }
794     }
796     /**
797      * PHP overloading magic to catch obvious coding errors.
798      *
799      * This method has been created to catch obvious coding errors where the
800      * developer has tried to set a page property using $PAGE->key = $value.
801      * In the moodle_page class all properties must be set using the appropriate
802      * $PAGE->set_something($value) method.
803      *
804      * @param string $name property name
805      * @param mixed $value Value
806      * @return void Throws exception if field not defined in page class
807      * @throws coding_exception
808      */
809     public function __set($name, $value) {
810         if (method_exists($this, 'set_' . $name)) {
811             throw new coding_exception('Invalid attempt to modify page object', "Use \$PAGE->set_$name() instead.");
812         } else {
813             throw new coding_exception('Invalid attempt to modify page object', "Unknown property $name");
814         }
815     }
817     // Other information getting methods ==========================================.
819     /**
820      * Returns instance of page renderer
821      *
822      * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
823      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
824      * @param string $target one of rendering target constants
825      * @return renderer_base
826      */
827     public function get_renderer($component, $subtype = null, $target = null) {
828         if ($this->pagelayout === 'maintenance') {
829             // If the page is using the maintenance layout then we're going to force target to maintenance.
830             // This leads to a special core renderer that is designed to block access to API's that are likely unavailable for this
831             // page layout.
832             $target = RENDERER_TARGET_MAINTENANCE;
833         }
834         return $this->magic_get_theme()->get_renderer($this, $component, $subtype, $target);
835     }
837     /**
838      * Checks to see if there are any items on the navbar object
839      *
840      * @return bool true if there are, false if not
841      */
842     public function has_navbar() {
843         if ($this->_navbar === null) {
844             $this->_navbar = new navbar($this);
845         }
846         return $this->_navbar->has_items();
847     }
849     /**
850      * Switches from the regular requirements manager to the fragment requirements manager to
851      * capture all necessary JavaScript to display a chunk of HTML such as an mform. This is for use
852      * by the get_fragment() web service and not for use elsewhere.
853      */
854     public function start_collecting_javascript_requirements() {
855         global $CFG;
856         require_once($CFG->libdir.'/outputfragmentrequirementslib.php');
858         // Check that the requirements manager has not already been switched.
859         if (get_class($this->_requires) == 'fragment_requirements_manager') {
860             throw new coding_exception('JavaScript collection has already been started.');
861         }
862         // The header needs to have been called to flush out the generic JavaScript for the page. This allows only
863         // JavaScript for the fragment to be collected. _wherethemewasinitialised is set when header() is called.
864         if (!empty($this->_wherethemewasinitialised)) {
865             // Change the current requirements manager over to the fragment manager to capture JS.
866             $this->_requires = new fragment_requirements_manager();
867         } else {
868             throw new coding_exception('$OUTPUT->header() needs to be called before collecting JavaScript requirements.');
869         }
870     }
872     /**
873      * Should the current user see this page in editing mode.
874      * That is, are they allowed to edit this page, and are they currently in
875      * editing mode.
876      * @return bool
877      */
878     public function user_is_editing() {
879         global $USER;
880         return !empty($USER->editing) && $this->user_allowed_editing();
881     }
883     /**
884      * Does the user have permission to edit blocks on this page.
885      * @return bool
886      */
887     public function user_can_edit_blocks() {
888         return has_capability($this->_blockseditingcap, $this->_context);
889     }
891     /**
892      * Does the user have permission to see this page in editing mode.
893      * @return bool
894      */
895     public function user_allowed_editing() {
896         return has_any_capability($this->all_editing_caps(), $this->_context);
897     }
899     /**
900      * Get a description of this page. Normally displayed in the footer in developer debug mode.
901      * @return string
902      */
903     public function debug_summary() {
904         $summary = '';
905         $summary .= 'General type: ' . $this->pagelayout . '. ';
906         if (!during_initial_install()) {
907             $summary .= 'Context ' . $this->context->get_context_name() . ' (context id ' . $this->_context->id . '). ';
908         }
909         $summary .= 'Page type ' . $this->pagetype .  '. ';
910         if ($this->subpage) {
911             $summary .= 'Sub-page ' . $this->subpage .  '. ';
912         }
913         return $summary;
914     }
916     // Setter methods =============================================================.
918     /**
919      * Set the state.
920      *
921      * The state must be one of that STATE_... constants, and the state is only allowed to advance one step at a time.
922      *
923      * @param int $state The new state.
924      * @throws coding_exception
925      */
926     public function set_state($state) {
927         if ($state != $this->_state + 1 || $state > self::STATE_DONE) {
928             throw new coding_exception('Invalid state passed to moodle_page::set_state. We are in state ' .
929                     $this->_state . ' and state ' . $state . ' was requested.');
930         }
932         if ($state == self::STATE_PRINTING_HEADER) {
933             $this->starting_output();
934         }
936         $this->_state = $state;
937     }
939     /**
940      * Set the current course. This sets both $PAGE->course and $COURSE. It also
941      * sets the right theme and locale.
942      *
943      * Normally you don't need to call this function yourself, require_login will
944      * call it for you if you pass a $course to it. You can use this function
945      * on pages that do need to call require_login().
946      *
947      * Sets $PAGE->context to the course context, if it is not already set.
948      *
949      * @param stdClass $course the course to set as the global course.
950      * @throws coding_exception
951      */
952     public function set_course($course) {
953         global $COURSE, $PAGE, $CFG, $SITE;
955         if (empty($course->id)) {
956             throw new coding_exception('$course passed to moodle_page::set_course does not look like a proper course object.');
957         }
959         $this->ensure_theme_not_set();
961         if (!empty($this->_course->id) && $this->_course->id != $course->id) {
962             $this->_categories = null;
963         }
965         $this->_course = clone($course);
967         if ($this === $PAGE) {
968             $COURSE = $this->_course;
969             moodle_setlocale();
970         }
972         if (!$this->_context) {
973             $this->set_context(context_course::instance($this->_course->id));
974         }
976         // Notify course format that this page is set for the course.
977         if ($this->_course->id != $SITE->id) {
978             require_once($CFG->dirroot.'/course/lib.php');
979             $courseformat = course_get_format($this->_course);
980             $this->add_body_class('format-'. $courseformat->get_format());
981             $courseformat->page_set_course($this);
982         } else {
983             $this->add_body_class('format-site');
984         }
985     }
987     /**
988      * Set the main context to which this page belongs.
989      *
990      * @param context $context a context object. You normally get this with context_xxxx::instance().
991      */
992     public function set_context($context) {
993         if ($context === null) {
994             // Extremely ugly hack which sets context to some value in order to prevent warnings,
995             // use only for core error handling!!!!
996             if (!$this->_context) {
997                 $this->_context = context_system::instance();
998             }
999             return;
1000         }
1001         // Ideally we should set context only once.
1002         if (isset($this->_context) && $context->id !== $this->_context->id) {
1003             $current = $this->_context->contextlevel;
1004             if ($current == CONTEXT_SYSTEM or $current == CONTEXT_COURSE) {
1005                 // Hmm - not ideal, but it might produce too many warnings due to the design of require_login.
1006             } else if ($current == CONTEXT_MODULE and ($parentcontext = $context->get_parent_context()) and
1007                 $this->_context->id == $parentcontext->id) {
1008                 // Hmm - most probably somebody did require_login() and after that set the block context.
1009             } else {
1010                 // We do not want devs to do weird switching of context levels on the fly because we might have used
1011                 // the context already such as in text filter in page title.
1012                 debugging("Coding problem: unsupported modification of PAGE->context from {$current} to {$context->contextlevel}");
1013             }
1014         }
1016         $this->_context = $context;
1017     }
1019     /**
1020      * The course module that this page belongs to (if it does belong to one).
1021      *
1022      * @param stdClass|cm_info $cm a record from course_modules table or cm_info from get_fast_modinfo().
1023      * @param stdClass $course
1024      * @param stdClass $module
1025      * @return void
1026      * @throws coding_exception
1027      */
1028     public function set_cm($cm, $course = null, $module = null) {
1029         global $DB, $CFG, $SITE;
1031         if (!isset($cm->id) || !isset($cm->course)) {
1032             throw new coding_exception('Invalid $cm. It has to be instance of cm_info or record from the course_modules table.');
1033         }
1035         if (!$this->_course || $this->_course->id != $cm->course) {
1036             if (!$course) {
1037                 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
1038             }
1039             if ($course->id != $cm->course) {
1040                 throw new coding_exception('The course you passed to $PAGE->set_cm does not correspond to the $cm.');
1041             }
1042             $this->set_course($course);
1043         }
1045         // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
1046         if (!($cm instanceof cm_info)) {
1047             $modinfo = get_fast_modinfo($this->_course);
1048             $cm = $modinfo->get_cm($cm->id);
1049         }
1050         $this->_cm = $cm;
1052         // Unfortunately the context setting is a mess.
1053         // Let's try to work around some common block problems and show some debug messages.
1054         if (empty($this->_context) or $this->_context->contextlevel != CONTEXT_BLOCK) {
1055             $context = context_module::instance($cm->id);
1056             $this->set_context($context);
1057         }
1059         if ($module) {
1060             $this->set_activity_record($module);
1061         }
1063         // Notify course format that this page is set for the course module.
1064         if ($this->_course->id != $SITE->id) {
1065             require_once($CFG->dirroot.'/course/lib.php');
1066             course_get_format($this->_course)->page_set_cm($this);
1067         }
1068     }
1070     /**
1071      * Sets the activity record. This could be a row from the main table for a
1072      * module. For instance if the current module (cm) is a forum this should be a row
1073      * from the forum table.
1074      *
1075      * @param stdClass $module A row from the main database table for the module that this page belongs to.
1076      * @throws coding_exception
1077      */
1078     public function set_activity_record($module) {
1079         if (is_null($this->_cm)) {
1080             throw new coding_exception('You cannot call $PAGE->set_activity_record until after $PAGE->cm has been set.');
1081         }
1082         if ($module->id != $this->_cm->instance || $module->course != $this->_course->id) {
1083             throw new coding_exception('The activity record does not seem to correspond to the cm that has been set.');
1084         }
1085         $this->_module = $module;
1086     }
1088     /**
1089      * Sets the pagetype to use for this page.
1090      *
1091      * Normally you do not need to set this manually, it is automatically created
1092      * from the script name. However, on some pages this is overridden.
1093      * For example the page type for course/view.php includes the course format,
1094      * for example 'course-view-weeks'. This gets used as the id attribute on
1095      * <body> and also for determining which blocks are displayed.
1096      *
1097      * @param string $pagetype e.g. 'my-index' or 'mod-quiz-attempt'.
1098      */
1099     public function set_pagetype($pagetype) {
1100         $this->_pagetype = $pagetype;
1101     }
1103     /**
1104      * Sets the layout to use for this page.
1105      *
1106      * The page layout determines how the page will be displayed, things such as
1107      * block regions, content areas, etc are controlled by the layout.
1108      * The theme in use for the page will determine that the layout contains.
1109      *
1110      * This properly defaults to 'base', so you only need to call this function if
1111      * you want something different. The exact range of supported layouts is specified
1112      * in the standard theme.
1113      *
1114      * For an idea of the common page layouts see
1115      * {@link http://docs.moodle.org/dev/Themes_2.0#The_different_layouts_as_of_August_17th.2C_2010}
1116      * But please keep in mind that it may be (and normally is) out of date.
1117      * The only place to find an accurate up-to-date list of the page layouts
1118      * available for your version of Moodle is {@link theme/base/config.php}
1119      *
1120      * @param string $pagelayout the page layout this is. For example 'popup', 'home'.
1121      */
1122     public function set_pagelayout($pagelayout) {
1123         global $SESSION;
1125         if (!empty($SESSION->forcepagelayout)) {
1126             $this->_pagelayout = $SESSION->forcepagelayout;
1127         } else {
1128             // Uncomment this to debug theme pagelayout issues like missing blocks.
1129             // if (!empty($this->_wherethemewasinitialised) && $pagelayout != $this->_pagelayout)
1130             //     debugging('Page layout has already been set and cannot be changed.', DEBUG_DEVELOPER);
1131             $this->_pagelayout = $pagelayout;
1132         }
1133     }
1135     /**
1136      * If context->id and pagetype are not enough to uniquely identify this page,
1137      * then you can set a subpage id as well. For example, the tags page sets
1138      *
1139      * @param string $subpage an arbitrary identifier that, along with context->id
1140      *      and pagetype, uniquely identifies this page.
1141      */
1142     public function set_subpage($subpage) {
1143         if (empty($subpage)) {
1144             $this->_subpage = '';
1145         } else {
1146             $this->_subpage = $subpage;
1147         }
1148     }
1150     /**
1151      * Adds a CSS class to the body tag of the page.
1152      *
1153      * @param string $class add this class name ot the class attribute on the body tag.
1154      * @throws coding_exception
1155      */
1156     public function add_body_class($class) {
1157         if ($this->_state > self::STATE_BEFORE_HEADER) {
1158             throw new coding_exception('Cannot call moodle_page::add_body_class after output has been started.');
1159         }
1160         $this->_bodyclasses[$class] = 1;
1161     }
1163     /**
1164      * Adds an array of body classes to the body tag of this page.
1165      *
1166      * @param array $classes this utility method calls add_body_class for each array element.
1167      */
1168     public function add_body_classes($classes) {
1169         foreach ($classes as $class) {
1170             $this->add_body_class($class);
1171         }
1172     }
1174     /**
1175      * Sets the title for the page.
1176      * This is normally used within the title tag in the head of the page.
1177      *
1178      * @param string $title the title that should go in the <head> section of the HTML of this page.
1179      */
1180     public function set_title($title) {
1181         $title = format_string($title);
1182         $title = strip_tags($title);
1183         $title = str_replace('"', '&quot;', $title);
1184         $this->_title = $title;
1185     }
1187     /**
1188      * Sets the heading to use for the page.
1189      * This is normally used as the main heading at the top of the content.
1190      *
1191      * @param string $heading the main heading that should be displayed at the top of the <body>.
1192      */
1193     public function set_heading($heading) {
1194         $this->_heading = format_string($heading);
1195     }
1197     /**
1198      * Sets some HTML to use next to the heading {@link moodle_page::set_heading()}
1199      *
1200      * @param string $menu The menu/content to show in the heading
1201      */
1202     public function set_headingmenu($menu) {
1203         $this->_headingmenu = $menu;
1204     }
1206     /**
1207      * Set the course category this page belongs to manually.
1208      *
1209      * This automatically sets $PAGE->course to be the site course. You cannot
1210      * use this method if you have already set $PAGE->course - in that case,
1211      * the category must be the one that the course belongs to. This also
1212      * automatically sets the page context to the category context.
1213      *
1214      * @param int $categoryid The id of the category to set.
1215      * @throws coding_exception
1216      */
1217     public function set_category_by_id($categoryid) {
1218         global $SITE;
1219         if (!is_null($this->_course)) {
1220             throw new coding_exception('Course has already been set. You cannot change the category now.');
1221         }
1222         if (is_array($this->_categories)) {
1223             throw new coding_exception('Course category has already been set. You cannot to change it now.');
1224         }
1225         $this->ensure_theme_not_set();
1226         $this->set_course($SITE);
1227         $this->load_category($categoryid);
1228         $this->set_context(context_coursecat::instance($categoryid));
1229     }
1231     /**
1232      * Set a different path to use for the 'Moodle docs for this page' link.
1233      *
1234      * By default, it uses the pagetype, which is normally the same as the
1235      * script name. So, for example, for mod/quiz/attempt.php, pagetype is
1236      * mod-quiz-attempt, and so docspath is mod/quiz/attempt.
1237      *
1238      * @param string $path the path to use at the end of the moodle docs URL.
1239      */
1240     public function set_docs_path($path) {
1241         $this->_docspath = $path;
1242     }
1244     /**
1245      * You should call this method from every page to set the URL that should be used to return to this page.
1246      *
1247      * Used, for example, by the blocks editing UI to know where to return the
1248      * user after an action.
1249      * For example, course/view.php does:
1250      *      $id = optional_param('id', 0, PARAM_INT);
1251      *      $PAGE->set_url('/course/view.php', array('id' => $id));
1252      *
1253      * @param moodle_url|string $url URL relative to $CFG->wwwroot or {@link moodle_url} instance
1254      * @param array $params parameters to add to the URL
1255      * @throws coding_exception
1256      */
1257     public function set_url($url, array $params = null) {
1258         global $CFG;
1260         if (is_string($url) && strpos($url, 'http') !== 0) {
1261             if (strpos($url, '/') === 0) {
1262                 // We have to use httpswwwroot here, because of loginhttps pages.
1263                 $url = $CFG->httpswwwroot . $url;
1264             } else {
1265                 throw new coding_exception('Invalid parameter $url, has to be full url or in shortened form starting with /.');
1266             }
1267         }
1269         $this->_url = new moodle_url($url, $params);
1271         $fullurl = $this->_url->out_omit_querystring();
1272         if (strpos($fullurl, "$CFG->httpswwwroot/") !== 0) {
1273             debugging('Most probably incorrect set_page() url argument, it does not match the httpswwwroot!');
1274         }
1275         $shorturl = str_replace("$CFG->httpswwwroot/", '', $fullurl);
1277         if (is_null($this->_pagetype)) {
1278             $this->initialise_default_pagetype($shorturl);
1279         }
1280     }
1282     /**
1283      * Make sure page URL does not contain the given URL parameter.
1284      *
1285      * This should not be necessary if the script has called set_url properly.
1286      * However, in some situations like the block editing actions; when the URL
1287      * has been guessed, it will contain dangerous block-related actions.
1288      * Therefore, the blocks code calls this function to clean up such parameters
1289      * before doing any redirect.
1290      *
1291      * @param string $param the name of the parameter to make sure is not in the
1292      * page URL.
1293      */
1294     public function ensure_param_not_in_url($param) {
1295         $this->_url->remove_params($param);
1296     }
1298     /**
1299      * Sets an alternative version of this page.
1300      *
1301      * There can be alternate versions of some pages (for example an RSS feed version).
1302      * Call this method for each alternative version available.
1303      * For each alternative version a link will be included in the <head> tag.
1304      *
1305      * @param string $title The title to give the alternate version.
1306      * @param string|moodle_url $url The URL of the alternate version.
1307      * @param string $mimetype The mime-type of the alternate version.
1308      * @throws coding_exception
1309      */
1310     public function add_alternate_version($title, $url, $mimetype) {
1311         if ($this->_state > self::STATE_BEFORE_HEADER) {
1312             throw new coding_exception('Cannot call moodle_page::add_alternate_version after output has been started.');
1313         }
1314         $alt = new stdClass;
1315         $alt->title = $title;
1316         $alt->url = $url;
1317         $this->_alternateversions[$mimetype] = $alt;
1318     }
1320     /**
1321      * Specify a form control should be focused when the page has loaded.
1322      *
1323      * @param string $controlid the id of the HTML element to be focused.
1324      */
1325     public function set_focuscontrol($controlid) {
1326         $this->_focuscontrol = $controlid;
1327     }
1329     /**
1330      * Specify a fragment of HTML that goes where the 'Turn editing on' button normally goes.
1331      *
1332      * @param string $html the HTML to display there.
1333      */
1334     public function set_button($html) {
1335         $this->_button = $html;
1336     }
1338     /**
1339      * Set the capability that allows users to edit blocks on this page.
1340      *
1341      * Normally the default of 'moodle/site:manageblocks' is used, but a few
1342      * pages like the My Moodle page need to use a different capability
1343      * like 'moodle/my:manageblocks'.
1344      *
1345      * @param string $capability a capability.
1346      */
1347     public function set_blocks_editing_capability($capability) {
1348         $this->_blockseditingcap = $capability;
1349     }
1351     /**
1352      * Some pages let you turn editing on for reasons other than editing blocks.
1353      * If that is the case, you can pass other capabilities that let the user
1354      * edit this page here.
1355      *
1356      * @param string|array $capability either a capability, or an array of capabilities.
1357      */
1358     public function set_other_editing_capability($capability) {
1359         if (is_array($capability)) {
1360             $this->_othereditingcaps = array_unique($this->_othereditingcaps + $capability);
1361         } else {
1362             $this->_othereditingcaps[] = $capability;
1363         }
1364     }
1366     /**
1367      * Sets whether the browser should cache this page or not.
1368      *
1369      * @param bool $cacheable can this page be cached by the user's browser.
1370      */
1371     public function set_cacheable($cacheable) {
1372         $this->_cacheable = $cacheable;
1373     }
1375     /**
1376      * Sets the page to periodically refresh
1377      *
1378      * This function must be called before $OUTPUT->header has been called or
1379      * a coding exception will be thrown.
1380      *
1381      * @param int $delay Sets the delay before refreshing the page, if set to null refresh is cancelled.
1382      * @throws coding_exception
1383      */
1384     public function set_periodic_refresh_delay($delay = null) {
1385         if ($this->_state > self::STATE_BEFORE_HEADER) {
1386             throw new coding_exception('You cannot set a periodic refresh delay after the header has been printed');
1387         }
1388         if ($delay === null) {
1389             $this->_periodicrefreshdelay = null;
1390         } else if (is_int($delay)) {
1391             $this->_periodicrefreshdelay = $delay;
1392         }
1393     }
1395     /**
1396      * Force this page to use a particular theme.
1397      *
1398      * Please use this cautiously.
1399      * It is only intended to be used by the themes selector admin page.
1400      *
1401      * @param string $themename the name of the theme to use.
1402      */
1403     public function force_theme($themename) {
1404         $this->ensure_theme_not_set();
1405         $this->_theme = theme_config::load($themename);
1406     }
1408     /**
1409      * Reload theme settings.
1410      *
1411      * This is used when we need to reset settings
1412      * because they are now double cached in theme.
1413      */
1414     public function reload_theme() {
1415         if (!is_null($this->_theme)) {
1416             $this->_theme = theme_config::load($this->_theme->name);
1417         }
1418     }
1420     /**
1421      * This function indicates that current page requires the https when $CFG->loginhttps enabled.
1422      *
1423      * By using this function properly, we can ensure 100% https-ized pages
1424      * at our entire discretion (login, forgot_password, change_password)
1425      *
1426      * @return void
1427      * @throws coding_exception
1428      */
1429     public function https_required() {
1430         global $CFG;
1432         if (!is_null($this->_url)) {
1433             throw new coding_exception('https_required() must be used before setting page url!');
1434         }
1436         $this->ensure_theme_not_set();
1438         $this->_https_login_required = true;
1440         if (!empty($CFG->loginhttps)) {
1441             $CFG->httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
1442         } else {
1443             $CFG->httpswwwroot = $CFG->wwwroot;
1444         }
1445     }
1447     /**
1448      * Makes sure that page previously marked with https_required() is really using https://, if not it redirects to https://
1449      *
1450      * @return void (may redirect to https://self)
1451      * @throws coding_exception
1452      */
1453     public function verify_https_required() {
1454         global $CFG, $FULLME;
1456         if (is_null($this->_url)) {
1457             throw new coding_exception('verify_https_required() must be called after setting page url!');
1458         }
1460         if (!$this->_https_login_required) {
1461             throw new coding_exception('verify_https_required() must be called only after https_required()!');
1462         }
1464         if (empty($CFG->loginhttps)) {
1465             // Https not required, so stop checking.
1466             return;
1467         }
1469         if (strpos($this->_url, 'https://')) {
1470             // Detect if incorrect PAGE->set_url() used, it is recommended to use root-relative paths there.
1471             throw new coding_exception('Invalid page url. It must start with https:// for pages that set https_required()!');
1472         }
1474         if (!empty($CFG->sslproxy)) {
1475             // It does not make much sense to use sslproxy and loginhttps at the same time.
1476             return;
1477         }
1479         // Now the real test and redirect!
1480         // NOTE: do NOT use this test for detection of https on current page because this code is not compatible with SSL proxies,
1481         //       instead use is_https().
1482         if (strpos($FULLME, 'https:') !== 0) {
1483             // This may lead to infinite redirect on an incorrectly configured site.
1484             // In that case set $CFG->loginhttps=0; within /config.php.
1485             redirect($this->_url);
1486         }
1487     }
1489     // Initialisation methods =====================================================
1490     // These set various things up in a default way.
1492     /**
1493      * This method is called when the page first moves out of the STATE_BEFORE_HEADER
1494      * state. This is our last change to initialise things.
1495      */
1496     protected function starting_output() {
1497         global $CFG;
1499         if (!during_initial_install()) {
1500             $this->blocks->load_blocks();
1501             if (empty($this->_block_actions_done)) {
1502                 $this->_block_actions_done = true;
1503                 if ($this->blocks->process_url_actions($this)) {
1504                     redirect($this->url->out(false));
1505                 }
1506             }
1507             $this->blocks->create_all_block_instances();
1508         }
1510         // If maintenance mode is on, change the page header.
1511         if (!empty($CFG->maintenance_enabled)) {
1512             $this->set_button('<a href="' . $CFG->wwwroot . '/' . $CFG->admin .
1513                     '/settings.php?section=maintenancemode">' . get_string('maintenancemode', 'admin') .
1514                     '</a> ' . $this->button);
1516             $title = $this->title;
1517             if ($title) {
1518                 $title .= ' - ';
1519             }
1520             $this->set_title($title . get_string('maintenancemode', 'admin'));
1521         }
1523         $this->initialise_standard_body_classes();
1524     }
1526     /**
1527      * Method for use by Moodle core to set up the theme. Do not
1528      * use this in your own code.
1529      *
1530      * Make sure the right theme for this page is loaded. Tell our
1531      * blocks_manager about the theme block regions, and then, if
1532      * we are $PAGE, set up the global $OUTPUT.
1533      *
1534      * @return void
1535      */
1536     public function initialise_theme_and_output() {
1537         global $OUTPUT, $PAGE, $SITE, $CFG;
1539         if (!empty($this->_wherethemewasinitialised)) {
1540             return;
1541         }
1543         if (!during_initial_install()) {
1544             // Detect PAGE->context mess.
1545             $this->magic_get_context();
1546         }
1548         if (!$this->_course && !during_initial_install()) {
1549             $this->set_course($SITE);
1550         }
1552         if (is_null($this->_theme)) {
1553             $themename = $this->resolve_theme();
1554             $this->_theme = theme_config::load($themename);
1555         }
1557         $this->_theme->setup_blocks($this->pagelayout, $this->blocks);
1558         if ($this->_theme->enable_dock && !empty($CFG->allowblockstodock)) {
1559             $this->requires->strings_for_js(array('addtodock', 'undockitem', 'dockblock', 'undockblock', 'undockall', 'hidedockpanel', 'hidepanel'), 'block');
1560             $this->requires->string_for_js('thisdirectionvertical', 'langconfig');
1561             $this->requires->yui_module('moodle-core-dock-loader', 'M.core.dock.loader.initLoader');
1562         }
1564         if ($this === $PAGE) {
1565             $target = null;
1566             if ($this->pagelayout === 'maintenance') {
1567                 // If the page is using the maintenance layout then we're going to force target to maintenance.
1568                 // This leads to a special core renderer that is designed to block access to API's that are likely unavailable for this
1569                 // page layout.
1570                 $target = RENDERER_TARGET_MAINTENANCE;
1571             }
1572             $OUTPUT = $this->get_renderer('core', null, $target);
1573         }
1575         $this->_wherethemewasinitialised = debug_backtrace();
1576     }
1578     /**
1579      * Reset the theme and output for a new context. This only makes sense from
1580      * external::validate_context(). Do not cheat.
1581      *
1582      * @return string the name of the theme that should be used on this page.
1583      */
1584     public function reset_theme_and_output() {
1585         global $COURSE, $SITE;
1587         $COURSE = clone($SITE);
1588         $this->_theme = null;
1589         $this->_wherethemewasinitialised = null;
1590         $this->_course = null;
1591         $this->_cm = null;
1592         $this->_module = null;
1593         $this->_context = null;
1594     }
1596     /**
1597      * Work out the theme this page should use.
1598      *
1599      * This depends on numerous $CFG settings, and the properties of this page.
1600      *
1601      * @return string the name of the theme that should be used on this page.
1602      */
1603     protected function resolve_theme() {
1604         global $CFG, $USER, $SESSION;
1606         if (empty($CFG->themeorder)) {
1607             $themeorder = array('course', 'category', 'session', 'user', 'site');
1608         } else {
1609             $themeorder = $CFG->themeorder;
1610             // Just in case, make sure we always use the site theme if nothing else matched.
1611             $themeorder[] = 'site';
1612         }
1614         $mnetpeertheme = '';
1615         if (isloggedin() and isset($CFG->mnet_localhost_id) and $USER->mnethostid != $CFG->mnet_localhost_id) {
1616             require_once($CFG->dirroot.'/mnet/peer.php');
1617             $mnetpeer = new mnet_peer();
1618             $mnetpeer->set_id($USER->mnethostid);
1619             if ($mnetpeer->force_theme == 1 && $mnetpeer->theme != '') {
1620                 $mnetpeertheme = $mnetpeer->theme;
1621             }
1622         }
1624         $devicetheme = core_useragent::get_device_type_theme($this->devicetypeinuse);
1626         // The user is using another device than default, and we have a theme for that, we should use it.
1627         $hascustomdevicetheme = core_useragent::DEVICETYPE_DEFAULT != $this->devicetypeinuse && !empty($devicetheme);
1629         foreach ($themeorder as $themetype) {
1631             switch ($themetype) {
1632                 case 'course':
1633                     if (!empty($CFG->allowcoursethemes) && !empty($this->_course->theme) && !$hascustomdevicetheme) {
1634                         return $this->_course->theme;
1635                     }
1636                 break;
1638                 case 'category':
1639                     if (!empty($CFG->allowcategorythemes) && !$hascustomdevicetheme) {
1640                         $categories = $this->categories;
1641                         foreach ($categories as $category) {
1642                             if (!empty($category->theme)) {
1643                                 return $category->theme;
1644                             }
1645                         }
1646                     }
1647                 break;
1649                 case 'session':
1650                     if (!empty($SESSION->theme)) {
1651                         return $SESSION->theme;
1652                     }
1653                 break;
1655                 case 'user':
1656                     if (!empty($CFG->allowuserthemes) && !empty($USER->theme) && !$hascustomdevicetheme) {
1657                         if ($mnetpeertheme) {
1658                             return $mnetpeertheme;
1659                         } else {
1660                             return $USER->theme;
1661                         }
1662                     }
1663                 break;
1665                 case 'site':
1666                     if ($mnetpeertheme) {
1667                         return $mnetpeertheme;
1668                     }
1669                     // First try for the device the user is using.
1670                     if (!empty($devicetheme)) {
1671                         return $devicetheme;
1672                     }
1673                     // Next try for the default device (as a fallback).
1674                     $devicetheme = core_useragent::get_device_type_theme(core_useragent::DEVICETYPE_DEFAULT);
1675                     if (!empty($devicetheme)) {
1676                         return $devicetheme;
1677                     }
1678                     // The default device theme isn't set up - use the overall default theme.
1679                     return theme_config::DEFAULT_THEME;
1680             }
1681         }
1683         // We should most certainly have resolved a theme by now. Something has gone wrong.
1684         debugging('Error resolving the theme to use for this page.', DEBUG_DEVELOPER);
1685         return theme_config::DEFAULT_THEME;
1686     }
1689     /**
1690      * Sets ->pagetype from the script name. For example, if the script that was
1691      * run is mod/quiz/view.php, ->pagetype will be set to 'mod-quiz-view'.
1692      *
1693      * @param string $script the path to the script that should be used to
1694      * initialise ->pagetype. If not passed the $SCRIPT global will be used.
1695      * If legacy code has set $CFG->pagepath that will be used instead, and a
1696      * developer warning issued.
1697      */
1698     protected function initialise_default_pagetype($script = null) {
1699         global $CFG, $SCRIPT;
1701         if (isset($CFG->pagepath)) {
1702             debugging('Some code appears to have set $CFG->pagepath. That was a horrible deprecated thing. ' .
1703                     'Don\'t do it! Try calling $PAGE->set_pagetype() instead.');
1704             $script = $CFG->pagepath;
1705             unset($CFG->pagepath);
1706         }
1708         if (is_null($script)) {
1709             $script = ltrim($SCRIPT, '/');
1710             $len = strlen($CFG->admin);
1711             if (substr($script, 0, $len) == $CFG->admin) {
1712                 $script = 'admin' . substr($script, $len);
1713             }
1714         }
1716         $path = str_replace('.php', '', $script);
1717         if (substr($path, -1) == '/') {
1718             $path .= 'index';
1719         }
1721         if (empty($path) || $path == 'index') {
1722             $this->_pagetype = 'site-index';
1723         } else {
1724             $this->_pagetype = str_replace('/', '-', $path);
1725         }
1726     }
1728     /**
1729      * Initialises the CSS classes that will be added to body tag of the page.
1730      *
1731      * The function is responsible for adding all of the critical CSS classes
1732      * that describe the current page, and its state.
1733      * This includes classes that describe the following for example:
1734      *    - Current language
1735      *    - Language direction
1736      *    - YUI CSS initialisation
1737      *    - Pagelayout
1738      * These are commonly used in CSS to target specific types of pages.
1739      */
1740     protected function initialise_standard_body_classes() {
1741         global $CFG, $USER;
1743         $pagetype = $this->pagetype;
1744         if ($pagetype == 'site-index') {
1745             $this->_legacyclass = 'course';
1746         } else if (substr($pagetype, 0, 6) == 'admin-') {
1747             $this->_legacyclass = 'admin';
1748         }
1749         $this->add_body_class($this->_legacyclass);
1751         $pathbits = explode('-', trim($pagetype));
1752         for ($i = 1; $i < count($pathbits); $i++) {
1753             $this->add_body_class('path-' . join('-', array_slice($pathbits, 0, $i)));
1754         }
1756         $this->add_body_classes(core_useragent::get_browser_version_classes());
1757         $this->add_body_class('dir-' . get_string('thisdirection', 'langconfig'));
1758         $this->add_body_class('lang-' . current_language());
1759         $this->add_body_class('yui-skin-sam'); // Make YUI happy, if it is used.
1760         $this->add_body_class('yui3-skin-sam'); // Make YUI3 happy, if it is used.
1761         $this->add_body_class($this->url_to_class_name($CFG->wwwroot));
1763         // Extra class describing current page layout.
1764         $this->add_body_class('pagelayout-' . $this->_pagelayout);
1766         if (!during_initial_install()) {
1767             $this->add_body_class('course-' . $this->_course->id);
1768             $this->add_body_class('context-' . $this->_context->id);
1769         }
1771         if (!empty($this->_cm)) {
1772             $this->add_body_class('cmid-' . $this->_cm->id);
1773         }
1775         if (!empty($CFG->allowcategorythemes)) {
1776             $this->ensure_category_loaded();
1777             foreach ($this->_categories as $catid => $notused) {
1778                 $this->add_body_class('category-' . $catid);
1779             }
1780         } else {
1781             $catid = 0;
1782             if (is_array($this->_categories)) {
1783                 $catids = array_keys($this->_categories);
1784                 $catid = reset($catids);
1785             } else if (!empty($this->_course->category)) {
1786                 $catid = $this->_course->category;
1787             }
1788             if ($catid) {
1789                 $this->add_body_class('category-' . $catid);
1790             }
1791         }
1793         if (!isloggedin()) {
1794             $this->add_body_class('notloggedin');
1795         }
1797         if ($this->user_is_editing()) {
1798             $this->add_body_class('editing');
1799             if (optional_param('bui_moveid', false, PARAM_INT)) {
1800                 $this->add_body_class('blocks-moving');
1801             }
1802         }
1804         if (!empty($CFG->blocksdrag)) {
1805             $this->add_body_class('drag');
1806         }
1808         if ($this->_devicetypeinuse != 'default') {
1809             $this->add_body_class($this->_devicetypeinuse . 'theme');
1810         }
1812         // Add class for behat site to apply behat related fixes.
1813         if (defined('BEHAT_SITE_RUNNING')) {
1814             $this->add_body_class('behat-site');
1815         }
1816     }
1818     /**
1819      * Loads the activity record for the current CM object associated with this
1820      * page.
1821      *
1822      * This will load {@link moodle_page::$_module} with a row from the related
1823      * module table in the database.
1824      * For instance if {@link moodle_page::$_cm} is a forum then a row from the
1825      * forum table will be loaded.
1826      */
1827     protected function load_activity_record() {
1828         global $DB;
1829         if (is_null($this->_cm)) {
1830             return;
1831         }
1832         $this->_module = $DB->get_record($this->_cm->modname, array('id' => $this->_cm->instance));
1833     }
1835     /**
1836      * This function ensures that the category of the current course has been
1837      * loaded, and if not, the function loads it now.
1838      *
1839      * @return void
1840      * @throws coding_exception
1841      */
1842     protected function ensure_category_loaded() {
1843         if (is_array($this->_categories)) {
1844             return; // Already done.
1845         }
1846         if (is_null($this->_course)) {
1847             throw new coding_exception('Attempt to get the course category for this page before the course was set.');
1848         }
1849         if ($this->_course->category == 0) {
1850             $this->_categories = array();
1851         } else {
1852             $this->load_category($this->_course->category);
1853         }
1854     }
1856     /**
1857      * Loads the requested category into the pages categories array.
1858      *
1859      * @param int $categoryid
1860      * @throws moodle_exception
1861      */
1862     protected function load_category($categoryid) {
1863         global $DB;
1864         $category = $DB->get_record('course_categories', array('id' => $categoryid));
1865         if (!$category) {
1866             throw new moodle_exception('unknowncategory');
1867         }
1868         $this->_categories[$category->id] = $category;
1869         $parentcategoryids = explode('/', trim($category->path, '/'));
1870         array_pop($parentcategoryids);
1871         foreach (array_reverse($parentcategoryids) as $catid) {
1872             $this->_categories[$catid] = null;
1873         }
1874     }
1876     /**
1877      * Ensures that the category the current course is within, as well as all of
1878      * its parent categories, have been loaded.
1879      *
1880      * @return void
1881      */
1882     protected function ensure_categories_loaded() {
1883         global $DB;
1884         $this->ensure_category_loaded();
1885         if (!is_null(end($this->_categories))) {
1886             return; // Already done.
1887         }
1888         $idstoload = array_keys($this->_categories);
1889         array_shift($idstoload);
1890         $categories = $DB->get_records_list('course_categories', 'id', $idstoload);
1891         foreach ($idstoload as $catid) {
1892             $this->_categories[$catid] = $categories[$catid];
1893         }
1894     }
1896     /**
1897      * Ensure the theme has not been loaded yet. If it has an exception is thrown.
1898      *
1899      * @throws coding_exception
1900      */
1901     protected function ensure_theme_not_set() {
1902         // This is explicitly allowed for webservices though which may process many course contexts in a single request.
1903         if (WS_SERVER) {
1904             return;
1905         }
1907         if (!is_null($this->_theme)) {
1908             throw new coding_exception('The theme has already been set up for this page ready for output. ' .
1909                     'Therefore, you can no longer change the theme, or anything that might affect what ' .
1910                     'the current theme is, for example, the course.',
1911                     'Stack trace when the theme was set up: ' . format_backtrace($this->_wherethemewasinitialised));
1912         }
1913     }
1915     /**
1916      * Converts the provided URL into a CSS class that be used within the page.
1917      * This is primarily used to add the wwwroot to the body tag as a CSS class.
1918      *
1919      * @param string $url
1920      * @return string
1921      */
1922     protected function url_to_class_name($url) {
1923         $bits = parse_url($url);
1924         $class = str_replace('.', '-', $bits['host']);
1925         if (!empty($bits['port'])) {
1926             $class .= '--' . $bits['port'];
1927         }
1928         if (!empty($bits['path'])) {
1929             $path = trim($bits['path'], '/');
1930             if ($path) {
1931                 $class .= '--' . str_replace('/', '-', $path);
1932             }
1933         }
1934         return $class;
1935     }
1937     /**
1938      * Combines all of the required editing caps for the page and returns them
1939      * as an array.
1940      *
1941      * @return array
1942      */
1943     protected function all_editing_caps() {
1944         $caps = $this->_othereditingcaps;
1945         $caps[] = $this->_blockseditingcap;
1946         return $caps;
1947     }
1949     /**
1950      * Returns true if the page URL has beem set.
1951      *
1952      * @return bool
1953      */
1954     public function has_set_url() {
1955         return ($this->_url!==null);
1956     }
1958     /**
1959      * Gets set when the block actions for the page have been processed.
1960      *
1961      * @param bool $setting
1962      */
1963     public function set_block_actions_done($setting = true) {
1964         $this->_block_actions_done = $setting;
1965     }
1967     /**
1968      * Are popup notifications allowed on this page?
1969      * Popup notifications may be disallowed in situations such as while upgrading or completing a quiz
1970      *
1971      * @return bool true if popup notifications may be displayed
1972      */
1973     public function get_popup_notification_allowed() {
1974         return $this->_popup_notification_allowed;
1975     }
1977     /**
1978      * Allow or disallow popup notifications on this page. Popups are allowed by default.
1979      *
1980      * @param bool $allowed true if notifications are allowed. False if not allowed. They are allowed by default.
1981      */
1982     public function set_popup_notification_allowed($allowed) {
1983         $this->_popup_notification_allowed = $allowed;
1984     }
1986     /**
1987      * Returns the block region having made any required theme manipulations.
1988      *
1989      * @since Moodle 2.5.1 2.6
1990      * @param string $region
1991      * @return string
1992      */
1993     public function apply_theme_region_manipulations($region) {
1994         if ($this->blockmanipulations && isset($this->blockmanipulations[$region])) {
1995             $regionwas = $region;
1996             $regionnow = $this->blockmanipulations[$region];
1997             if ($this->blocks->is_known_region($regionwas) && $this->blocks->is_known_region($regionnow)) {
1998                 // Both the before and after regions are known so we can swap them over.
1999                 return $regionnow;
2000             }
2001             // We didn't know about both, we won't swap them over.
2002             return $regionwas;
2003         }
2004         return $region;
2005     }
2007     /**
2008      * Add a report node and a specific report to the navigation.
2009      *
2010      * @param int $userid The user ID that we are looking to add this report node to.
2011      * @param array $nodeinfo Name and url of the final node that we are creating.
2012      */
2013     public function add_report_nodes($userid, $nodeinfo) {
2014         global $USER;
2015         // Try to find the specific user node.
2016         $newusernode = $this->navigation->find('user' . $userid, null);
2017         $reportnode = null;
2018         $navigationnodeerror =
2019                 'Could not find the navigation node requested. Please check that the node you are looking for exists.';
2020         if ($userid != $USER->id) {
2021             // Check that we have a valid node.
2022             if (empty($newusernode)) {
2023                 // Throw an error if we ever reach here.
2024                 throw new coding_exception($navigationnodeerror);
2025             }
2026             // Add 'Reports' to the user node.
2027             $reportnode = $newusernode->add(get_string('reports'));
2028         } else {
2029             // We are looking at our own profile.
2030             $myprofilenode = $this->settingsnav->find('myprofile', null);
2031             // Check that we do end up with a valid node.
2032             if (empty($myprofilenode)) {
2033                 // Throw an error if we ever reach here.
2034                 throw new coding_exception($navigationnodeerror);
2035             }
2036             // Add 'Reports' to our node.
2037             $reportnode = $myprofilenode->add(get_string('reports'));
2038         }
2039         // Finally add the report to the navigation tree.
2040         $reportnode->add($nodeinfo['name'], $nodeinfo['url'], navigation_node::TYPE_COURSE);
2041     }