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