weekly release 2.4dev
[moodle.git] / lib / outputlib.php
CommitLineData
571fa828 1<?php
571fa828 2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
78946b9b
PS
17/**
18 * Functions for generating the HTML that Moodle should output.
19 *
20 * Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
21 * for an overview.
22 *
473dd811
SH
23 * @copyright 2009 Tim Hunt
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
f8129210 25 * @package core
76be40cc 26 * @category output
78946b9b
PS
27 */
28
78bfb562
PS
29defined('MOODLE_INTERNAL') || die();
30
d9c8f425 31require_once($CFG->libdir.'/outputcomponents.php');
32require_once($CFG->libdir.'/outputactions.php');
33require_once($CFG->libdir.'/outputfactories.php');
d9c8f425 34require_once($CFG->libdir.'/outputrenderers.php');
0bb38e8c 35require_once($CFG->libdir.'/outputrequirementslib.php');
d9c8f425 36
571fa828 37/**
78946b9b 38 * Invalidate all server and client side caches.
473dd811 39 *
f11db1a6 40 * This method deletes the physical directory that is used to cache the theme
473dd811 41 * files used for serving.
f11db1a6 42 * Because it deletes the main theme cache directory all themes are reset by
473dd811 43 * this function.
78946b9b
PS
44 */
45function theme_reset_all_caches() {
46 global $CFG;
47 require_once("$CFG->libdir/filelib.php");
48
f11db1a6
PS
49 $next = time();
50 if (isset($CFG->themerev) and $next <= $CFG->themerev and $CFG->themerev - $next < 60*60) {
51 // This resolves problems when reset is requested repeatedly within 1s,
52 // the < 1h condition prevents accidental switching to future dates
53 // because we might not recover from it.
54 $next = $CFG->themerev+1;
55 }
56
57 set_config('themerev', $next); // time is unique even when you reset/switch database
365bec4c 58 fulldelete("$CFG->cachedir/theme");
78946b9b
PS
59}
60
61/**
62 * Enable or disable theme designer mode.
473dd811 63 *
78946b9b 64 * @param bool $state
78946b9b
PS
65 */
66function theme_set_designer_mod($state) {
67 theme_reset_all_caches();
68 set_config('themedesignermode', (int)!empty($state));
69}
70
71/**
72 * Returns current theme revision number.
473dd811 73 *
78946b9b 74 * @return int
571fa828 75 */
78946b9b
PS
76function theme_get_revision() {
77 global $CFG;
78
79 if (empty($CFG->themedesignermode)) {
80 if (empty($CFG->themerev)) {
81 return -1;
82 } else {
83 return $CFG->themerev;
84 }
85
86 } else {
87 return -1;
88 }
89}
90
571fa828 91
571fa828 92/**
fdeb7fa1 93 * This class represents the configuration variables of a Moodle theme.
94 *
95 * All the variables with access: public below (with a few exceptions that are marked)
3d3fae72 96 * are the properties you can set in your themes config.php file.
fdeb7fa1 97 *
98 * There are also some methods and protected variables that are part of the inner
3d3fae72 99 * workings of Moodle's themes system. If you are just editing a themes config.php
fa1afe32 100 * file, you can just ignore those, and the following information for developers.
ebebf55c 101 *
102 * Normally, to create an instance of this class, you should use the
103 * {@link theme_config::load()} factory method to load a themes config.php file.
fa1afe32 104 * However, normally you don't need to bother, because moodle_page (that is, $PAGE)
fdeb7fa1 105 * will create one for you, accessible as $PAGE->theme.
571fa828 106 *
107 * @copyright 2009 Tim Hunt
473dd811
SH
108 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
109 * @since Moodle 2.0
f8129210 110 * @package core
76be40cc 111 * @category output
571fa828 112 */
ebebf55c 113class theme_config {
473dd811 114
5f0baa43 115 /**
76be40cc 116 * @var string Default theme, used when requested theme not found.
5f0baa43 117 */
90723839 118 const DEFAULT_THEME = 'standard';
5f0baa43 119
ebebf55c 120 /**
76be40cc 121 * @var array You can base your theme on other themes by linking to the other theme as
78946b9b 122 * parents. This lets you use the CSS and layouts from the other themes
f8129210 123 * (see {@link theme_config::$layouts}).
fdeb7fa1 124 * That makes it easy to create a new theme that is similar to another one
3d3fae72 125 * but with a few changes. In this themes CSS you only need to override
fdeb7fa1 126 * those rules you want to change.
fdeb7fa1 127 */
78946b9b 128 public $parents;
571fa828 129
fdeb7fa1 130 /**
76be40cc 131 * @var array The names of all the stylesheets from this theme that you would
78946b9b 132 * like included, in order. Give the names of the files without .css.
fdeb7fa1 133 */
78946b9b 134 public $sheets = array();
571fa828 135
fdeb7fa1 136 /**
76be40cc 137 * @var array The names of all the stylesheets from parents that should be excluded.
78946b9b
PS
138 * true value may be used to specify all parents or all themes from one parent.
139 * If no value specified value from parent theme used.
fdeb7fa1 140 */
78946b9b 141 public $parents_exclude_sheets = null;
571fa828 142
fdeb7fa1 143 /**
76be40cc 144 * @var array List of plugin sheets to be excluded.
78946b9b 145 * If no value specified value from parent theme used.
fdeb7fa1 146 */
78946b9b 147 public $plugins_exclude_sheets = null;
571fa828 148
fdeb7fa1 149 /**
76be40cc 150 * @var array List of style sheets that are included in the text editor bodies.
78946b9b 151 * Sheets from parent themes are used automatically and can not be excluded.
fdeb7fa1 152 */
78946b9b 153 public $editor_sheets = array();
571fa828 154
38aafea2 155 /**
76be40cc 156 * @var array The names of all the javascript files this theme that you would
04c01408 157 * like included from head, in order. Give the names of the files without .js.
38aafea2
PS
158 */
159 public $javascripts = array();
160
04c01408 161 /**
76be40cc 162 * @var array The names of all the javascript files this theme that you would
04c01408 163 * like included from footer, in order. Give the names of the files without .js.
04c01408
PS
164 */
165 public $javascripts_footer = array();
4399b9d5 166
38aafea2 167 /**
76be40cc
SH
168 * @var array The names of all the javascript files from parents that should
169 * be excluded. true value may be used to specify all parents or all themes
170 * from one parent.
38aafea2 171 * If no value specified value from parent theme used.
38aafea2
PS
172 */
173 public $parents_exclude_javascripts = null;
174
fdeb7fa1 175 /**
76be40cc 176 * @var array Which file to use for each page layout.
fdeb7fa1 177 *
78946b9b
PS
178 * This is an array of arrays. The keys of the outer array are the different layouts.
179 * Pages in Moodle are using several different layouts like 'normal', 'course', 'home',
180 * 'popup', 'form', .... The most reliable way to get a complete list is to look at
181 * {@link http://cvs.moodle.org/moodle/theme/base/config.php?view=markup the base theme config.php file}.
d4a03c00 182 * That file also has a good example of how to set this setting.
fdeb7fa1 183 *
78946b9b 184 * For each layout, the value in the outer array is an array that describes
d4a03c00 185 * how you want that type of page to look. For example
186 * <pre>
187 * $THEME->layouts = array(
39df78bf 188 * // Most pages - if we encounter an unknown or a missing page type, this one is used.
191b267b 189 * 'standard' => array(
78946b9b
PS
190 * 'theme' = 'mytheme',
191 * 'file' => 'normal.php',
d4a03c00 192 * 'regions' => array('side-pre', 'side-post'),
193 * 'defaultregion' => 'side-post'
194 * ),
195 * // The site home page.
196 * 'home' => array(
78946b9b
PS
197 * 'theme' = 'mytheme',
198 * 'file' => 'home.php',
d4a03c00 199 * 'regions' => array('side-pre', 'side-post'),
200 * 'defaultregion' => 'side-post'
201 * ),
202 * // ...
203 * );
204 * </pre>
fdeb7fa1 205 *
78946b9b
PS
206 * 'theme' name of the theme where is the layout located
207 * 'file' is the layout file to use for this type of page.
208 * layout files are stored in layout subfolder
d4a03c00 209 * 'regions' This lists the regions on the page where blocks may appear. For
210 * each region you list here, your layout file must include a call to
211 * <pre>
212 * echo $OUTPUT->blocks_for_region($regionname);
213 * </pre>
214 * or equivalent so that the blocks are actually visible.
fdeb7fa1 215 *
d4a03c00 216 * 'defaultregion' If the list of regions is non-empty, then you must pick
217 * one of the one of them as 'default'. This has two meanings. First, this is
218 * where new blocks are added. Second, if there are any blocks associated with
fa1afe32 219 * the page, but in non-existent regions, they appear here. (Imaging, for example,
d4a03c00 220 * that someone added blocks using a different theme that used different region
221 * names, and then switched to this theme.)
fdeb7fa1 222 */
d4a03c00 223 public $layouts = array();
571fa828 224
fdeb7fa1 225 /**
76be40cc
SH
226 * @var string Name of the renderer factory class to use. Must implement the
227 * {@link renderer_factory} interface.
fdeb7fa1 228 *
229 * This is an advanced feature. Moodle output is generated by 'renderers',
230 * you can customise the HTML that is output by writing custom renderers,
231 * and then you need to specify 'renderer factory' so that Moodle can find
232 * your renderers.
233 *
234 * There are some renderer factories supplied with Moodle. Please follow these
235 * links to see what they do.
236 * <ul>
237 * <li>{@link standard_renderer_factory} - the default.</li>
238 * <li>{@link theme_overridden_renderer_factory} - use this if you want to write
78946b9b 239 * your own custom renderers in a lib.php file in this theme (or the parent theme).</li>
fdeb7fa1 240 * </ul>
fdeb7fa1 241 */
ebebf55c 242 public $rendererfactory = 'standard_renderer_factory';
ebebf55c 243
fdeb7fa1 244 /**
76be40cc 245 * @var string Function to do custom CSS post-processing.
fdeb7fa1 246 *
78946b9b
PS
247 * This is an advanced feature. If you want to do custom post-processing on the
248 * CSS before it is output (for example, to replace certain variable names
249 * with particular values) you can give the name of a function here.
fdeb7fa1 250 */
78946b9b 251 public $csspostprocess = null;
571fa828 252
253 /**
76be40cc 254 * @var string Accessibility: Right arrow-like character is
78946b9b
PS
255 * used in the breadcrumb trail, course navigation menu
256 * (previous/next activity), calendar, and search forum block.
257 * If the theme does not set characters, appropriate defaults
258 * are set automatically. Please DO NOT
259 * use &lt; &gt; &raquo; - these are confusing for blind users.
78946b9b
PS
260 */
261 public $rarrow = null;
262
263 /**
76be40cc 264 * @var string Accessibility: Right arrow-like character is
78946b9b
PS
265 * used in the breadcrumb trail, course navigation menu
266 * (previous/next activity), calendar, and search forum block.
267 * If the theme does not set characters, appropriate defaults
268 * are set automatically. Please DO NOT
269 * use &lt; &gt; &raquo; - these are confusing for blind users.
571fa828 270 */
78946b9b
PS
271 public $larrow = null;
272
03276af6 273 /**
76be40cc 274 * @var bool Some themes may want to disable ajax course editing.
03276af6
DM
275 */
276 public $enablecourseajax = true;
78946b9b 277
13725b37
PS
278 /**
279 * @var string Determines served document types
280 * - 'html5' the only officially supported doctype in Moodle
281 * - 'xhtml5' may be used in development for validation (not intended for production servers!)
282 * - 'xhtml' XHTML 1.0 Strict for legacy themes only
283 */
284 public $doctype = 'html5';
285
78946b9b 286 //==Following properties are not configurable from theme config.php==
571fa828 287
fdeb7fa1 288 /**
76be40cc 289 * @var string The name of this theme. Set automatically when this theme is
78946b9b 290 * loaded. This can not be set in theme config.php
fdeb7fa1 291 */
78946b9b 292 public $name;
fdeb7fa1 293
294 /**
76be40cc 295 * @var string The folder where this themes files are stored. This is set
78946b9b 296 * automatically. This can not be set in theme config.php
fdeb7fa1 297 */
78946b9b 298 public $dir;
fdeb7fa1 299
300 /**
76be40cc 301 * @var stdClass Theme settings stored in config_plugins table.
78946b9b 302 * This can not be set in theme config.php
78946b9b
PS
303 */
304 public $setting = null;
305
d2c394f3 306 /**
76be40cc 307 * @var bool If set to true and the theme enables the dock then blocks will be able
d2c394f3 308 * to be moved to the special dock
d2c394f3
SH
309 */
310 public $enable_dock = false;
311
4d56ee95 312 /**
76be40cc 313 * @var bool If set to true then this theme will not be shown in the theme selector unless
4d56ee95 314 * theme designer mode is turned on.
4d56ee95
SH
315 */
316 public $hidefromselector = false;
317
78946b9b 318 /**
76be40cc 319 * @var renderer_factory Instance of the renderer_factory implementation
fdeb7fa1 320 * we are using. Implementation detail.
321 */
322 protected $rf = null;
323
324 /**
76be40cc 325 * @var array List of parent config objects.
78946b9b
PS
326 **/
327 protected $parent_configs = array();
fdeb7fa1 328
b305d623
SH
329 /**
330 * @var bool If set to true then the theme is safe to run through the optimiser (if it is enabled)
331 * If set to false then we know either the theme has already been optimised and the CSS optimiser is not needed
332 * or the theme is not compatible with the CSS optimiser. In both cases even if enabled the CSS optimiser will not
333 * be used with this theme if set to false.
334 */
335 public $supportscssoptimisation = true;
336
571fa828 337 /**
ebebf55c 338 * Load the config.php file for a particular theme, and return an instance
339 * of this class. (That is, this is a factory method.)
340 *
341 * @param string $themename the name of the theme.
342 * @return theme_config an instance of this class.
571fa828 343 */
ebebf55c 344 public static function load($themename) {
345 global $CFG;
571fa828 346
78946b9b
PS
347 // load theme settings from db
348 try {
349 $settings = get_config('theme_'.$themename);
350 } catch (dml_exception $e) {
da0c0e25 351 // most probably moodle tables not created yet
365a5941 352 $settings = new stdClass();
78946b9b 353 }
ebebf55c 354
78946b9b
PS
355 if ($config = theme_config::find_theme_config($themename, $settings)) {
356 return new theme_config($config);
5f0baa43
PS
357
358 } else if ($themename == theme_config::DEFAULT_THEME) {
359 throw new coding_exception('Default theme '.theme_config::DEFAULT_THEME.' not available or broken!');
360
78946b9b
PS
361 } else {
362 // bad luck, the requested theme has some problems - admin see details in theme config
5f0baa43 363 return new theme_config(theme_config::find_theme_config(theme_config::DEFAULT_THEME, $settings));
78946b9b
PS
364 }
365 }
ebebf55c 366
78946b9b
PS
367 /**
368 * Theme diagnostic code. It is very problematic to send debug output
369 * to the actual CSS file, instead this functions is supposed to
ae5b6801 370 * diagnose given theme and highlights all potential problems.
78946b9b
PS
371 * This information should be available from the theme selection page
372 * or some other debug page for theme designers.
373 *
374 * @param string $themename
375 * @return array description of problems
376 */
377 public static function diagnose($themename) {
5ef719e7 378 //TODO: MDL-21108
78946b9b
PS
379 return array();
380 }
381
382 /**
383 * Private constructor, can be called only from the factory method.
384 * @param stdClass $config
385 */
386 private function __construct($config) {
387 global $CFG; //needed for included lib.php files
388
389 $this->settings = $config->settings;
390 $this->name = $config->name;
391 $this->dir = $config->dir;
392
393 if ($this->name != 'base') {
394 $baseconfig = theme_config::find_theme_config('base', $this->settings);
395 } else {
396 $baseconfig = $config;
571fa828 397 }
ebebf55c 398
fef27578 399 $configurable = array('parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets', 'javascripts', 'javascripts_footer',
b305d623 400 'parents_exclude_javascripts', 'layouts', 'enable_dock', 'enablecourseajax', 'supportscssoptimisation',
13725b37 401 'rendererfactory', 'csspostprocess', 'editor_sheets', 'rarrow', 'larrow', 'hidefromselector', 'doctype');
ebebf55c 402
78946b9b
PS
403 foreach ($config as $key=>$value) {
404 if (in_array($key, $configurable)) {
405 $this->$key = $value;
406 }
407 }
408
409 // verify all parents and load configs and renderers
410 foreach ($this->parents as $parent) {
411 if ($parent == 'base') {
412 $parent_config = $baseconfig;
413 } else if (!$parent_config = theme_config::find_theme_config($parent, $this->settings)) {
414 // this is not good - better exclude faulty parents
415 continue;
416 }
417 $libfile = $parent_config->dir.'/lib.php';
418 if (is_readable($libfile)) {
419 // theme may store various function here
420 include_once($libfile);
421 }
422 $renderersfile = $parent_config->dir.'/renderers.php';
423 if (is_readable($renderersfile)) {
424 // may contain core and plugin renderers and renderer factory
425 include_once($renderersfile);
426 }
427 $this->parent_configs[$parent] = $parent_config;
428 $rendererfile = $parent_config->dir.'/renderers.php';
429 if (is_readable($rendererfile)) {
430 // may contain core and plugin renderers and renderer factory
431 include_once($rendererfile);
432 }
433 }
434 $libfile = $this->dir.'/lib.php';
435 if (is_readable($libfile)) {
436 // theme may store various function here
437 include_once($libfile);
438 }
439 $rendererfile = $this->dir.'/renderers.php';
440 if (is_readable($rendererfile)) {
441 // may contain core and plugin renderers and renderer factory
442 include_once($rendererfile);
6fc267a0
BJ
443 } else {
444 // check if renderers.php file is missnamed renderer.php
445 if (is_readable($this->dir.'/renderer.php')) {
446 debugging('Developer hint: '.$this->dir.'/renderer.php should be renamed to ' . $this->dir."/renderers.php.
11c0ecce 447 See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER);
6fc267a0 448 }
78946b9b 449 }
4399b9d5 450
78946b9b
PS
451 // cascade all layouts properly
452 foreach ($baseconfig->layouts as $layout=>$value) {
453 if (!isset($this->layouts[$layout])) {
454 foreach ($this->parent_configs as $parent_config) {
455 if (isset($parent_config->layouts[$layout])) {
456 $this->layouts[$layout] = $parent_config->layouts[$layout];
457 continue 2;
458 }
459 }
460 $this->layouts[$layout] = $value;
461 }
462 }
463
464 //fix arrows if needed
465 $this->check_theme_arrows();
571fa828 466 }
467
f8129210 468 /**
78946b9b
PS
469 * Checks if arrows $THEME->rarrow, $THEME->larrow have been set (theme/-/config.php).
470 * If not it applies sensible defaults.
471 *
472 * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
473 * search forum block, etc. Important: these are 'silent' in a screen-reader
474 * (unlike &gt; &raquo;), and must be accompanied by text.
34a2777c 475 */
78946b9b
PS
476 private function check_theme_arrows() {
477 if (!isset($this->rarrow) and !isset($this->larrow)) {
478 // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
479 // Also OK in Win 9x/2K/IE 5.x
480 $this->rarrow = '&#x25BA;';
481 $this->larrow = '&#x25C4;';
482 if (empty($_SERVER['HTTP_USER_AGENT'])) {
483 $uagent = '';
ebebf55c 484 } else {
78946b9b
PS
485 $uagent = $_SERVER['HTTP_USER_AGENT'];
486 }
487 if (false !== strpos($uagent, 'Opera')
488 || false !== strpos($uagent, 'Mac')) {
489 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
490 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
491 $this->rarrow = '&#x25B6;';
492 $this->larrow = '&#x25C0;';
493 }
494 elseif (false !== strpos($uagent, 'Konqueror')) {
495 $this->rarrow = '&rarr;';
496 $this->larrow = '&larr;';
497 }
498 elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
499 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
500 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
501 // To be safe, non-Unicode browsers!
502 $this->rarrow = '&gt;';
503 $this->larrow = '&lt;';
504 }
505
f8129210 506 // RTL support - in RTL languages, swap r and l arrows
78946b9b
PS
507 if (right_to_left()) {
508 $t = $this->rarrow;
509 $this->rarrow = $this->larrow;
510 $this->larrow = $t;
ebebf55c 511 }
ebebf55c 512 }
78946b9b 513 }
ebebf55c 514
78946b9b
PS
515 /**
516 * Returns output renderer prefixes, these are used when looking
71c03ac1 517 * for the overridden renderers in themes.
473dd811 518 *
78946b9b
PS
519 * @return array
520 */
521 public function renderer_prefixes() {
522 global $CFG; // just in case the included files need it
523
596af93a 524 $prefixes = array('theme_'.$this->name);
78946b9b
PS
525
526 foreach ($this->parent_configs as $parent) {
527 $prefixes[] = 'theme_'.$parent->name;
528 }
529
530 return $prefixes;
34a2777c 531 }
532
571fa828 533 /**
78946b9b 534 * Returns the stylesheet URL of this editor content
473dd811 535 *
78946b9b
PS
536 * @param bool $encoded false means use & and true use &amp; in URLs
537 * @return string
571fa828 538 */
78946b9b
PS
539 public function editor_css_url($encoded=true) {
540 global $CFG;
541
542 $rev = theme_get_revision();
543
544 if ($rev > -1) {
7070b7f2
PS
545 if (!empty($CFG->slasharguments)) {
546 $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
547 $url->set_slashargument('/'.$this->name.'/'.$rev.'/editor', 'noparam', true);
548 return $url;
549 } else {
550 $params = array('theme'=>$this->name,'rev'=>$rev, 'type'=>'editor');
551 return new moodle_url($CFG->httpswwwroot.'/theme/styles.php', $params);
552 }
78946b9b
PS
553 } else {
554 $params = array('theme'=>$this->name, 'type'=>'editor');
555 return new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php', $params);
571fa828 556 }
571fa828 557 }
558
559 /**
78946b9b 560 * Returns the content of the CSS to be used in editor content
473dd811 561 *
78946b9b 562 * @return string
571fa828 563 */
71be124d 564 public function editor_css_files() {
78946b9b
PS
565 global $CFG;
566
71be124d 567 $files = array();
78946b9b
PS
568
569 // first editor plugins
570 $plugins = get_plugin_list('editor');
571 foreach ($plugins as $plugin=>$fulldir) {
572 $sheetfile = "$fulldir/editor_styles.css";
573 if (is_readable($sheetfile)) {
71be124d 574 $files['plugin_'.$plugin] = $sheetfile;
78946b9b
PS
575 }
576 }
577 // then parent themes
578 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
579 if (empty($parent_config->editor_sheets)) {
580 continue;
581 }
582 foreach ($parent_config->editor_sheets as $sheet) {
ca194849 583 $sheetfile = "$parent_config->dir/style/$sheet.css";
78946b9b 584 if (is_readable($sheetfile)) {
71be124d 585 $files['parent_'.$parent_config->name.'_'.$sheet] = $sheetfile;
78946b9b
PS
586 }
587 }
588 }
589 // finally this theme
590 if (!empty($this->editor_sheets)) {
591 foreach ($this->editor_sheets as $sheet) {
71be124d 592 $sheetfile = "$this->dir/style/$sheet.css";
78946b9b 593 if (is_readable($sheetfile)) {
71be124d 594 $files['theme_'.$sheet] = $sheetfile;
78946b9b
PS
595 }
596 }
597 }
598
71be124d 599 return $files;
571fa828 600 }
601
602 /**
78946b9b 603 * Get the stylesheet URL of this theme
473dd811
SH
604 *
605 * @param moodle_page $page Not used... deprecated?
38aafea2 606 * @return array of moodle_url
571fa828 607 */
efaa4c08 608 public function css_urls(moodle_page $page) {
78946b9b
PS
609 global $CFG;
610
611 $rev = theme_get_revision();
612
efaa4c08 613 $urls = array();
efaa4c08 614
78946b9b 615 if ($rev > -1) {
a6338a13 616 if (check_browser_version('MSIE', 5)) {
537740cb
SH
617 // We need to split the CSS files for IE
618 $urls[] = new moodle_url($CFG->httpswwwroot.'/theme/styles.php', array('theme'=>$this->name,'rev'=>$rev, 'type'=>'plugins'));
619 $urls[] = new moodle_url($CFG->httpswwwroot.'/theme/styles.php', array('theme'=>$this->name,'rev'=>$rev, 'type'=>'parents'));
620 $urls[] = new moodle_url($CFG->httpswwwroot.'/theme/styles.php', array('theme'=>$this->name,'rev'=>$rev, 'type'=>'theme'));
621 } else {
7070b7f2
PS
622 if (!empty($CFG->slasharguments)) {
623 $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
624 $url->set_slashargument('/'.$this->name.'/'.$rev.'/all', 'noparam', true);
625 $urls[] = $url;
626 } else {
627 $urls[] = new moodle_url($CFG->httpswwwroot.'/theme/styles.php', array('theme'=>$this->name,'rev'=>$rev, 'type'=>'all'));
628 }
78946b9b 629 }
78946b9b 630 } else {
7829cf79
PS
631 // find out the current CSS and cache it now for 5 seconds
632 // the point is to construct the CSS only once and pass it through the
633 // dataroot to the script that actually serves the sheets
d6b64d15
PS
634 if (!defined('THEME_DESIGNER_CACHE_LIFETIME')) {
635 define('THEME_DESIGNER_CACHE_LIFETIME', 4); // this can be also set in config.php
636 }
bcf7f9f3
637 $candidatedir = "$CFG->cachedir/theme/$this->name";
638 $candidatesheet = "$candidatedir/designer.ser";
639 $rebuild = true;
640 if (file_exists($candidatesheet) and filemtime($candidatesheet) > time() - THEME_DESIGNER_CACHE_LIFETIME) {
7829cf79
PS
641 if ($css = file_get_contents($candidatesheet)) {
642 $css = unserialize($css);
bcf7f9f3
643 if (is_array($css)) {
644 $rebuild = false;
645 }
646 }
647 }
648 if ($rebuild) {
649 // Prepare the CSS optimiser if it is to be used,
650 // please note that it may be very slow and is therefore strongly discouraged in theme designer mode.
651 $optimiser = null;
652 if (!empty($CFG->enablecssoptimiser) && $this->supportscssoptimisation) {
653 require_once($CFG->dirroot.'/lib/csslib.php');
654 $optimiser = new css_optimiser;
7829cf79 655 }
b305d623 656 $css = $this->css_content($optimiser);
bcf7f9f3
657
658 // We do not want any errors here because this may fail easily because of the concurrent access.
659 $prevabort = ignore_user_abort(true);
660 check_dir_exists($candidatedir);
661 $tempfile = tempnam($candidatedir, 'tmpdesigner');
662 file_put_contents($tempfile, serialize($css));
663 $reporting = error_reporting(0);
664 chmod($tempfile, $CFG->filepermissions);
665 unlink($candidatesheet); // Do not rely on rename() deleting original, they may decide to change it at any time as usually.
666 rename($tempfile, $candidatesheet);
667 error_reporting($reporting);
668 ignore_user_abort($prevabort);
7829cf79
PS
669 }
670
c724f835 671 $baseurl = $CFG->httpswwwroot.'/theme/styles_debug.php';
c09e1a2c
PS
672
673 if (check_browser_version('MSIE', 5)) {
674 // lalala, IE does not allow more than 31 linked CSS files from main document
71be124d 675 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'plugins'));
a6338a13
SH
676 foreach ($css['parents'] as $parent=>$sheets) {
677 // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096)
71be124d 678 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
a6338a13 679 }
71be124d 680 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'theme'));
c09e1a2c
PS
681
682 } else {
683 foreach ($css['plugins'] as $plugin=>$unused) {
684 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'plugin', 'subtype'=>$plugin));
685 }
686 foreach ($css['parents'] as $parent=>$sheets) {
687 foreach ($sheets as $sheet=>$unused2) {
688 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
689 }
690 }
691 foreach ($css['theme'] as $sheet=>$unused) {
692 $urls[] = new moodle_url($baseurl, array('sheet'=>$sheet, 'theme'=>$this->name, 'type'=>'theme')); // sheet first in order to make long urls easier to read
78946b9b 693 }
78946b9b 694 }
78946b9b 695 }
efaa4c08
PS
696
697 return $urls;
571fa828 698 }
34a2777c 699
ebebf55c 700 /**
045f492c 701 * Returns an array of organised CSS files required for this output
473dd811 702 *
045f492c 703 * @return array
ebebf55c 704 */
045f492c
SH
705 public function css_files() {
706 $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
78946b9b 707
8c96c3cb 708 // get all plugin sheets
045f492c 709 $excludes = $this->resolve_excludes('plugins_exclude_sheets');
78946b9b
PS
710 if ($excludes !== true) {
711 foreach (get_plugin_types() as $type=>$unused) {
045f492c 712 if ($type === 'theme' || (!empty($excludes[$type]) and $excludes[$type] === true)) {
78946b9b
PS
713 continue;
714 }
715 $plugins = get_plugin_list($type);
716 foreach ($plugins as $plugin=>$fulldir) {
717 if (!empty($excludes[$type]) and is_array($excludes[$type])
718 and in_array($plugin, $excludes[$type])) {
719 continue;
720 }
f8bb9666
SH
721
722 $plugincontent = '';
78946b9b
PS
723 $sheetfile = "$fulldir/styles.css";
724 if (is_readable($sheetfile)) {
045f492c 725 $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
f8bb9666
SH
726 }
727 $sheetthemefile = "$fulldir/styles_{$this->name}.css";
728 if (is_readable($sheetthemefile)) {
045f492c 729 $cssfiles['plugins'][$type.'_'.$plugin.'_'.$this->name] = $sheetthemefile;
f8bb9666 730 }
78946b9b
PS
731 }
732 }
733 }
34a2777c 734
78946b9b 735 // find out wanted parent sheets
045f492c 736 $excludes = $this->resolve_excludes('parents_exclude_sheets');
78946b9b
PS
737 if ($excludes !== true) {
738 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
739 $parent = $parent_config->name;
045f492c 740 if (empty($parent_config->sheets) || (!empty($excludes[$parent]) and $excludes[$parent] === true)) {
78946b9b
PS
741 continue;
742 }
743 foreach ($parent_config->sheets as $sheet) {
744 if (!empty($excludes[$parent]) and is_array($excludes[$parent])
745 and in_array($sheet, $excludes[$parent])) {
746 continue;
747 }
748 $sheetfile = "$parent_config->dir/style/$sheet.css";
749 if (is_readable($sheetfile)) {
045f492c 750 $cssfiles['parents'][$parent][$sheet] = $sheetfile;
78946b9b
PS
751 }
752 }
753 }
754 }
34a2777c 755
78946b9b
PS
756 // current theme sheets
757 if (is_array($this->sheets)) {
758 foreach ($this->sheets as $sheet) {
759 $sheetfile = "$this->dir/style/$sheet.css";
760 if (is_readable($sheetfile)) {
045f492c 761 $cssfiles['theme'][$sheet] = $sheetfile;
78946b9b 762 }
ebebf55c 763 }
78946b9b
PS
764 }
765
045f492c
SH
766 return $cssfiles;
767 }
768
769 /**
770 * Returns the content of the one huge CSS merged from all style sheets.
473dd811 771 *
b305d623 772 * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
045f492c
SH
773 * @return string
774 */
b305d623 775 public function css_content(css_optimiser $optimiser = null) {
71be124d 776 $files = array_merge($this->css_files(), array('editor'=>$this->editor_css_files()));
b305d623 777 $css = $this->css_files_get_contents($files, array(), $optimiser);
78946b9b
PS
778 return $css;
779 }
34a2777c 780
045f492c
SH
781 /**
782 * Given an array of file paths or a single file path loads the contents of
783 * the CSS file, processes it then returns it in the same structure it was given.
784 *
f8129210 785 * Can be used recursively on the results of {@link css_files}
045f492c
SH
786 *
787 * @param array|string $file An array of file paths or a single file path
71c03ac1 788 * @param array $keys An array of previous array keys [recursive addition]
b305d623 789 * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
045f492c
SH
790 * @return The converted array or the contents of the single file ($file type)
791 */
b305d623
SH
792 protected function css_files_get_contents($file, array $keys, css_optimiser $optimiser = null) {
793 global $CFG;
045f492c
SH
794 if (is_array($file)) {
795 foreach ($file as $key=>$f) {
b305d623 796 $file[$key] = $this->css_files_get_contents($f, array_merge($keys, array($key)), $optimiser);
045f492c
SH
797 }
798 return $file;
799 } else {
b305d623
SH
800 $contents = file_get_contents($file);
801 $contents = $this->post_process($contents);
045f492c 802 $comment = '/** Path: '.implode(' ', $keys).' **/'."\n";
b305d623
SH
803 $stats = '';
804 if (!is_null($optimiser)) {
805 $contents = $optimiser->process($contents);
806 if (!empty($CFG->cssoptimiserstats)) {
807 $stats = $optimiser->output_stats_css();
808 }
809 }
810 return $comment.$stats.$contents;
045f492c
SH
811 }
812 }
813
e68c5f36
PS
814
815 /**
473dd811
SH
816 * Generate a URL to the file that serves theme JavaScript files.
817 *
71c03ac1 818 * @param bool $inhead true means head url, false means footer
e68c5f36
PS
819 * @return moodle_url
820 */
baeb20bb 821 public function javascript_url($inhead) {
e68c5f36
PS
822 global $CFG;
823
824 $rev = theme_get_revision();
e68c5f36 825 $params = array('theme'=>$this->name,'rev'=>$rev);
baeb20bb
PS
826 $params['type'] = $inhead ? 'head' : 'footer';
827
ecbad2ad
PS
828 if (!empty($CFG->slasharguments) and $rev > 0) {
829 $url = new moodle_url("$CFG->httpswwwroot/theme/javascript.php");
830 $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
831 return $url;
832 } else {
833 return new moodle_url($CFG->httpswwwroot.'/theme/javascript.php', $params);
834 }
e68c5f36
PS
835 }
836
473dd811
SH
837 /**
838 * Get the URL's for the JavaScript files used by this theme.
839 * They won't be served directly, instead they'll be mediated through
840 * theme/javascript.php.
841 *
842 * @param string $type Either javascripts_footer, or javascripts
843 * @return array
844 */
045f492c
SH
845 public function javascript_files($type) {
846 if ($type === 'footer') {
847 $type = 'javascripts_footer';
848 } else {
f856106b 849 $type = 'javascripts';
045f492c 850 }
04c01408 851
358c13cb
PS
852 $js = array();
853 // find out wanted parent javascripts
045f492c 854 $excludes = $this->resolve_excludes('parents_exclude_javascripts');
358c13cb
PS
855 if ($excludes !== true) {
856 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
857 $parent = $parent_config->name;
04c01408 858 if (empty($parent_config->$type)) {
358c13cb
PS
859 continue;
860 }
861 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
862 continue;
863 }
04c01408 864 foreach ($parent_config->$type as $javascript) {
358c13cb
PS
865 if (!empty($excludes[$parent]) and is_array($excludes[$parent])
866 and in_array($javascript, $excludes[$parent])) {
867 continue;
868 }
869 $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
870 if (is_readable($javascriptfile)) {
045f492c 871 $js[] = $javascriptfile;
358c13cb
PS
872 }
873 }
874 }
875 }
876
877 // current theme javascripts
04c01408
PS
878 if (is_array($this->$type)) {
879 foreach ($this->$type as $javascript) {
358c13cb
PS
880 $javascriptfile = "$this->dir/javascript/$javascript.js";
881 if (is_readable($javascriptfile)) {
045f492c
SH
882 $js[] = $javascriptfile;
883 }
884 }
885 }
886
887 return $js;
888 }
889
890 /**
3d3fae72 891 * Resolves an exclude setting to the themes setting is applicable or the
045f492c
SH
892 * setting of its closest parent.
893 *
894 * @param string $variable The name of the setting the exclude setting to resolve
f8129210 895 * @param string $default
045f492c
SH
896 * @return mixed
897 */
f8129210 898 protected function resolve_excludes($variable, $default = null) {
045f492c
SH
899 $setting = $default;
900 if (is_array($this->{$variable}) or $this->{$variable} === true) {
901 $setting = $this->{$variable};
902 } else {
903 foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
904 if (!isset($parent_config->{$variable})) {
905 continue;
906 }
907 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
908 $setting = $parent_config->{$variable};
909 break;
358c13cb
PS
910 }
911 }
912 }
045f492c
SH
913 return $setting;
914 }
358c13cb 915
045f492c
SH
916 /**
917 * Returns the content of the one huge javascript file merged from all theme javascript files.
473dd811 918 *
f8129210 919 * @param bool $type
045f492c
SH
920 * @return string
921 */
922 public function javascript_content($type) {
923 $jsfiles = $this->javascript_files($type);
924 $js = '';
925 foreach ($jsfiles as $jsfile) {
926 $js .= file_get_contents($jsfile)."\n";
927 }
928 return $js;
e68c5f36
PS
929 }
930
473dd811
SH
931 /**
932 * Post processes CSS.
933 *
934 * This method post processes all of the CSS before it is served for this theme.
935 * This is done so that things such as image URL's can be swapped in and to
936 * run any specific CSS post process method the theme has requested.
3d3fae72 937 * This allows themes to use CSS settings.
473dd811
SH
938 *
939 * @param string $css The CSS to process.
940 * @return string The processed CSS.
941 */
045f492c 942 public function post_process($css) {
78946b9b
PS
943 // now resolve all image locations
944 if (preg_match_all('/\[\[pix:([a-z_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
945 $replaced = array();
946 foreach ($matches as $match) {
947 if (isset($replaced[$match[0]])) {
948 continue;
949 }
950 $replaced[$match[0]] = true;
951 $imagename = $match[2];
952 $component = rtrim($match[1], '|');
b9bc2019 953 $imageurl = $this->pix_url($imagename, $component)->out(false);
df06c1c4 954 // we do not need full url because the image.php is always in the same dir
9d473266 955 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
df06c1c4 956 $css = str_replace($match[0], $imageurl, $css);
ebebf55c 957 }
34a2777c 958 }
17a6649b 959
78946b9b
PS
960 // now resolve all theme settings or do any other postprocessing
961 $csspostprocess = $this->csspostprocess;
962 if (function_exists($csspostprocess)) {
963 $css = $csspostprocess($css, $this);
fdeb7fa1 964 }
965
78946b9b 966 return $css;
ebebf55c 967 }
17a6649b 968
ebebf55c 969 /**
78946b9b
PS
970 * Return the URL for an image
971 *
972 * @param string $imagename the name of the icon.
f8129210 973 * @param string $component specification of one plugin like in get_string()
78946b9b 974 * @return moodle_url
fdeb7fa1 975 */
c39e5ba2 976 public function pix_url($imagename, $component) {
fdeb7fa1 977 global $CFG;
78946b9b 978
9d473266
PS
979 $params = array('theme'=>$this->name);
980
981 if (empty($component) or $component === 'moodle' or $component === 'core') {
982 $params['component'] = 'core';
983 } else {
984 $params['component'] = $component;
985 }
78946b9b
PS
986
987 $rev = theme_get_revision();
988 if ($rev != -1) {
989 $params['rev'] = $rev;
990 }
9d473266
PS
991
992 $params['image'] = $imagename;
993
994 if (!empty($CFG->slasharguments) and $rev > 0) {
995 $url = new moodle_url("$CFG->httpswwwroot/theme/image.php");
996 $url->set_slashargument('/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'], 'noparam', true);
997 } else {
998 $url = new moodle_url("$CFG->httpswwwroot/theme/image.php", $params);
fdeb7fa1 999 }
78946b9b 1000
9d473266 1001 return $url;
fdeb7fa1 1002 }
1003
1004 /**
78946b9b
PS
1005 * Resolves the real image location.
1006 * @param string $image name of image, may contain relative path
1007 * @param string $component
1008 * @return string full file path
fdeb7fa1 1009 */
78946b9b
PS
1010 public function resolve_image_location($image, $component) {
1011 global $CFG;
1012
1013 if ($component === 'moodle' or $component === 'core' or empty($component)) {
1014 if ($imagefile = $this->image_exists("$this->dir/pix_core/$image")) {
1015 return $imagefile;
1016 }
1017 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1018 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image")) {
1019 return $imagefile;
1020 }
1021 }
f930cf6b
EM
1022 if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image")) {
1023 return $imagefile;
1024 }
78946b9b
PS
1025 if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image")) {
1026 return $imagefile;
1027 }
1028 return null;
1029
1030 } else if ($component === 'theme') { //exception
1031 if ($image === 'favicon') {
1032 return "$this->dir/pix/favicon.ico";
1033 }
1034 if ($imagefile = $this->image_exists("$this->dir/pix/$image")) {
1035 return $imagefile;
1036 }
1037 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1038 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image")) {
1039 return $imagefile;
1040 }
1041 }
1042 return null;
1043
78946b9b
PS
1044 } else {
1045 if (strpos($component, '_') === false) {
1046 $component = 'mod_'.$component;
1047 }
1048 list($type, $plugin) = explode('_', $component, 2);
1049
1050 if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image")) {
1051 return $imagefile;
1052 }
1053 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1054 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image")) {
1055 return $imagefile;
1056 }
1057 }
f930cf6b
EM
1058 if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image")) {
1059 return $imagefile;
1060 }
78946b9b
PS
1061 $dir = get_plugin_directory($type, $plugin);
1062 if ($imagefile = $this->image_exists("$dir/pix/$image")) {
1063 return $imagefile;
1064 }
1065 return null;
fdeb7fa1 1066 }
fdeb7fa1 1067 }
1068
d4a03c00 1069 /**
78946b9b 1070 * Checks if file with any image extension exists.
473dd811 1071 *
78946b9b
PS
1072 * @param string $filepath
1073 * @return string image name with extension
d4a03c00 1074 */
78946b9b
PS
1075 private static function image_exists($filepath) {
1076 if (file_exists("$filepath.gif")) {
1077 return "$filepath.gif";
1078 } else if (file_exists("$filepath.png")) {
1079 return "$filepath.png";
1080 } else if (file_exists("$filepath.jpg")) {
1081 return "$filepath.jpg";
1082 } else if (file_exists("$filepath.jpeg")) {
1083 return "$filepath.jpeg";
d4a03c00 1084 } else {
78946b9b 1085 return false;
d4a03c00 1086 }
1087 }
1088
fdeb7fa1 1089 /**
78946b9b 1090 * Loads the theme config from config.php file.
473dd811 1091 *
78946b9b 1092 * @param string $themename
473dd811
SH
1093 * @param stdClass $settings from config_plugins table
1094 * @return stdClass The theme configuration
fdeb7fa1 1095 */
78946b9b
PS
1096 private static function find_theme_config($themename, $settings) {
1097 // We have to use the variable name $THEME (upper case) because that
1098 // is what is used in theme config.php files.
fdeb7fa1 1099
78946b9b
PS
1100 if (!$dir = theme_config::find_theme_location($themename)) {
1101 return null;
fdeb7fa1 1102 }
2f67a9b3 1103
365a5941 1104 $THEME = new stdClass();
78946b9b
PS
1105 $THEME->name = $themename;
1106 $THEME->dir = $dir;
1107 $THEME->settings = $settings;
1108
1109 global $CFG; // just in case somebody tries to use $CFG in theme config
1110 include("$THEME->dir/config.php");
1111
1112 // verify the theme configuration is OK
1113 if (!is_array($THEME->parents)) {
1114 // parents option is mandatory now
1115 return null;
fdeb7fa1 1116 }
1117
78946b9b 1118 return $THEME;
fdeb7fa1 1119 }
1120
d4a03c00 1121 /**
78946b9b
PS
1122 * Finds the theme location and verifies the theme has all needed files
1123 * and is not obsoleted.
473dd811 1124 *
78946b9b
PS
1125 * @param string $themename
1126 * @return string full dir path or null if not found
d4a03c00 1127 */
78946b9b
PS
1128 private static function find_theme_location($themename) {
1129 global $CFG;
1130
1131 if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
1132 $dir = "$CFG->dirroot/theme/$themename";
d4a03c00 1133
3dd1d7e7
DM
1134 } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
1135 $dir = "$CFG->themedir/$themename";
1136
7d875874 1137 } else {
78946b9b 1138 return null;
d4a03c00 1139 }
78946b9b
PS
1140
1141 if (file_exists("$dir/styles.php")) {
1142 //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
1143 return null;
1144 }
2f67a9b3 1145
78946b9b 1146 return $dir;
d4a03c00 1147 }
1148
1d13c75c 1149 /**
78946b9b 1150 * Get the renderer for a part of Moodle for this theme.
473dd811 1151 *
78946b9b 1152 * @param moodle_page $page the page we are rendering
f8129210 1153 * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
78946b9b 1154 * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
c927e35c 1155 * @param string $target one of rendering target constants
78946b9b 1156 * @return renderer_base the requested renderer.
1d13c75c 1157 */
c927e35c 1158 public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
78946b9b 1159 if (is_null($this->rf)) {
c927e35c 1160 $classname = $this->rendererfactory;
78946b9b 1161 $this->rf = new $classname($this);
1d13c75c 1162 }
78946b9b 1163
c927e35c 1164 return $this->rf->get_renderer($page, $component, $subtype, $target);
1d13c75c 1165 }
1166
fdeb7fa1 1167 /**
78946b9b 1168 * Get the information from {@link $layouts} for this type of page.
473dd811 1169 *
78946b9b
PS
1170 * @param string $pagelayout the the page layout name.
1171 * @return array the appropriate part of {@link $layouts}.
fdeb7fa1 1172 */
78946b9b
PS
1173 protected function layout_info_for_page($pagelayout) {
1174 if (array_key_exists($pagelayout, $this->layouts)) {
1175 return $this->layouts[$pagelayout];
1176 } else {
191b267b
PS
1177 debugging('Invalid page layout specified: ' . $pagelayout);
1178 return $this->layouts['standard'];
fdeb7fa1 1179 }
1180 }
1181
1182 /**
78946b9b
PS
1183 * Given the settings of this theme, and the page pagelayout, return the
1184 * full path of the page layout file to use.
1185 *
1186 * Used by {@link core_renderer::header()}.
1187 *
1188 * @param string $pagelayout the the page layout name.
1189 * @return string Full path to the lyout file to use
ebebf55c 1190 */
78946b9b 1191 public function layout_file($pagelayout) {
ebebf55c 1192 global $CFG;
fdeb7fa1 1193
78946b9b
PS
1194 $layoutinfo = $this->layout_info_for_page($pagelayout);
1195 $layoutfile = $layoutinfo['file'];
fdeb7fa1 1196
84db3ea2
SH
1197 if (array_key_exists('theme', $layoutinfo)) {
1198 $themes = array($layoutinfo['theme']);
1199 } else {
1200 $themes = array_merge(array($this->name),$this->parents);
1201 }
4399b9d5 1202
84db3ea2
SH
1203 foreach ($themes as $theme) {
1204 if ($dir = $this->find_theme_location($theme)) {
1205 $path = "$dir/layout/$layoutfile";
1206
1207 // Check the template exists, return general base theme template if not.
1208 if (is_readable($path)) {
1209 return $path;
1210 }
78946b9b 1211 }
34a2777c 1212 }
1213
191b267b 1214 debugging('Can not find layout file for: ' . $pagelayout);
78946b9b
PS
1215 // fallback to standard normal layout
1216 return "$CFG->dirroot/theme/base/layout/general.php";
1217 }
ebebf55c 1218
78946b9b
PS
1219 /**
1220 * Returns auxiliary page layout options specified in layout configuration array.
473dd811 1221 *
78946b9b
PS
1222 * @param string $pagelayout
1223 * @return array
1224 */
1225 public function pagelayout_options($pagelayout) {
1226 $info = $this->layout_info_for_page($pagelayout);
1227 if (!empty($info['options'])) {
1228 return $info['options'];
34a2777c 1229 }
78946b9b
PS
1230 return array();
1231 }
34a2777c 1232
78946b9b
PS
1233 /**
1234 * Inform a block_manager about the block regions this theme wants on this
1235 * page layout.
473dd811 1236 *
78946b9b
PS
1237 * @param string $pagelayout the general type of the page.
1238 * @param block_manager $blockmanager the block_manger to set up.
78946b9b
PS
1239 */
1240 public function setup_blocks($pagelayout, $blockmanager) {
1241 $layoutinfo = $this->layout_info_for_page($pagelayout);
1242 if (!empty($layoutinfo['regions'])) {
1243 $blockmanager->add_regions($layoutinfo['regions']);
1244 $blockmanager->set_default_region($layoutinfo['defaultregion']);
ebebf55c 1245 }
34a2777c 1246 }
1247
473dd811
SH
1248 /**
1249 * Gets the visible name for the requested block region.
1250 *
1251 * @param string $region The region name to get
1252 * @param string $theme The theme the region belongs to (may come from the parent theme)
1253 * @return string
1254 */
cadc0d28
TH
1255 protected function get_region_name($region, $theme) {
1256 $regionstring = get_string('region-' . $region, 'theme_' . $theme);
1257 // A name exists in this theme, so use it
1258 if (substr($regionstring, 0, 1) != '[') {
1259 return $regionstring;
1260 }
1261
1262 // Otherwise, try to find one elsewhere
1263 // Check parents, if any
1264 foreach ($this->parents as $parentthemename) {
1265 $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
1266 if (substr($regionstring, 0, 1) != '[') {
1267 return $regionstring;
1268 }
1269 }
1270
1271 // Last resort, try the base theme for names
1272 return get_string('region-' . $region, 'theme_base');
1273 }
1274
ebebf55c 1275 /**
78946b9b 1276 * Get the list of all block regions known to this theme in all templates.
473dd811 1277 *
78946b9b 1278 * @return array internal region name => human readable name.
ebebf55c 1279 */
78946b9b
PS
1280 public function get_all_block_regions() {
1281 $regions = array();
78946b9b
PS
1282 foreach ($this->layouts as $layoutinfo) {
1283 foreach ($layoutinfo['regions'] as $region) {
a9535f79 1284 $regions[$region] = $this->get_region_name($region, $this->name);
ebebf55c 1285 }
34a2777c 1286 }
78946b9b 1287 return $regions;
34a2777c 1288 }
d609d962
SH
1289
1290 /**
1291 * Returns the human readable name of the theme
1292 *
1293 * @return string
1294 */
1295 public function get_theme_name() {
1296 return get_string('pluginname', 'theme_'.$this->name);
1297 }
ebebf55c 1298}
34a2777c 1299
ebebf55c 1300/**
d9c8f425 1301 * This class keeps track of which HTML tags are currently open.
1302 *
1303 * This makes it much easier to always generate well formed XHTML output, even
1304 * if execution terminates abruptly. Any time you output some opening HTML
1305 * without the matching closing HTML, you should push the necessary close tags
1306 * onto the stack.
ebebf55c 1307 *
1308 * @copyright 2009 Tim Hunt
473dd811
SH
1309 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1310 * @since Moodle 2.0
f8129210 1311 * @package core
76be40cc 1312 * @category output
ebebf55c 1313 */
d9c8f425 1314class xhtml_container_stack {
473dd811
SH
1315
1316 /**
76be40cc 1317 * @var array Stores the list of open containers.
473dd811 1318 */
d9c8f425 1319 protected $opencontainers = array();
473dd811 1320
fa1afe32 1321 /**
76be40cc 1322 * @var array In developer debug mode, stores a stack trace of all opens and
d9c8f425 1323 * closes, so we can output helpful error messages when there is a mismatch.
fa1afe32 1324 */
d9c8f425 1325 protected $log = array();
473dd811 1326
fa1afe32 1327 /**
76be40cc
SH
1328 * @var boolean Store whether we are developer debug mode. We need this in
1329 * several places including in the destructor where we may not have access to $CFG.
fa1afe32 1330 */
d9c8f425 1331 protected $isdebugging;
34a2777c 1332
473dd811
SH
1333 /**
1334 * Constructor
1335 */
d9c8f425 1336 public function __construct() {
1337 $this->isdebugging = debugging('', DEBUG_DEVELOPER);
ebebf55c 1338 }
34a2777c 1339
fa1afe32 1340 /**
d9c8f425 1341 * Push the close HTML for a recently opened container onto the stack.
473dd811 1342 *
d9c8f425 1343 * @param string $type The type of container. This is checked when {@link pop()}
1344 * is called and must match, otherwise a developer debug warning is output.
1345 * @param string $closehtml The HTML required to close the container.
fa1afe32 1346 */
d9c8f425 1347 public function push($type, $closehtml) {
1348 $container = new stdClass;
1349 $container->type = $type;
1350 $container->closehtml = $closehtml;
1351 if ($this->isdebugging) {
1352 $this->log('Open', $type);
3aaa27f4 1353 }
d9c8f425 1354 array_push($this->opencontainers, $container);
ebebf55c 1355 }
34a2777c 1356
fa1afe32 1357 /**
d9c8f425 1358 * Pop the HTML for the next closing container from the stack. The $type
1359 * must match the type passed when the container was opened, otherwise a
1360 * warning will be output.
473dd811 1361 *
d9c8f425 1362 * @param string $type The type of container.
1363 * @return string the HTML required to close the container.
fa1afe32 1364 */
d9c8f425 1365 public function pop($type) {
1366 if (empty($this->opencontainers)) {
1367 debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
1368 $this->output_log(), DEBUG_DEVELOPER);
1369 return;
3aaa27f4 1370 }
ebebf55c 1371
d9c8f425 1372 $container = array_pop($this->opencontainers);
1373 if ($container->type != $type) {
1374 debugging('<p>The type of container to be closed (' . $container->type .
1375 ') does not match the type of the next open container (' . $type .
1376 '). This suggests there is a nesting problem.</p>' .
1377 $this->output_log(), DEBUG_DEVELOPER);
ebebf55c 1378 }
d9c8f425 1379 if ($this->isdebugging) {
1380 $this->log('Close', $type);
e8775320 1381 }
d9c8f425 1382 return $container->closehtml;
ebebf55c 1383 }
e8775320 1384
fa1afe32 1385 /**
d9c8f425 1386 * Close all but the last open container. This is useful in places like error
1387 * handling, where you want to close all the open containers (apart from <body>)
1388 * before outputting the error message.
473dd811 1389 *
d9c8f425 1390 * @param bool $shouldbenone assert that the stack should be empty now - causes a
1391 * developer debug warning if it isn't.
1392 * @return string the HTML required to close any open containers inside <body>.
fa1afe32 1393 */
d9c8f425 1394 public function pop_all_but_last($shouldbenone = false) {
1395 if ($shouldbenone && count($this->opencontainers) != 1) {
1396 debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
1397 $this->output_log(), DEBUG_DEVELOPER);
1398 }
1399 $output = '';
1400 while (count($this->opencontainers) > 1) {
1401 $container = array_pop($this->opencontainers);
1402 $output .= $container->closehtml;
e8775320 1403 }
d9c8f425 1404 return $output;
e8775320 1405 }
34a2777c 1406
ebebf55c 1407 /**
d9c8f425 1408 * You can call this function if you want to throw away an instance of this
1409 * class without properly emptying the stack (for example, in a unit test).
1410 * Calling this method stops the destruct method from outputting a developer
1411 * debug warning. After calling this method, the instance can no longer be used.
ebebf55c 1412 */
d9c8f425 1413 public function discard() {
1414 $this->opencontainers = null;
ebebf55c 1415 }
d9c8f425 1416
fa1afe32 1417 /**
d9c8f425 1418 * Adds an entry to the log.
473dd811 1419 *
d9c8f425 1420 * @param string $action The name of the action
1421 * @param string $type The type of action
fa1afe32 1422 */
d9c8f425 1423 protected function log($action, $type) {
1424 $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
1425 format_backtrace(debug_backtrace()) . '</li>';
ebebf55c 1426 }
34a2777c 1427
fa1afe32 1428 /**
d9c8f425 1429 * Outputs the log's contents as a HTML list.
473dd811 1430 *
d9c8f425 1431 * @return string HTML list of the log
fa1afe32 1432 */
d9c8f425 1433 protected function output_log() {
1434 return '<ul>' . implode("\n", $this->log) . '</ul>';
34a2777c 1435 }
6fc267a0 1436}