Merge branch 'wip-MDL-38000-m25' of git://github.com/samhemelryk/moodle
[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
436dbeec
SH
337 /**
338 * Used to determine whether we can serve SVG images or not.
339 * @var bool
340 */
341 private $usesvg = null;
342
571fa828 343 /**
ebebf55c 344 * Load the config.php file for a particular theme, and return an instance
345 * of this class. (That is, this is a factory method.)
346 *
347 * @param string $themename the name of the theme.
348 * @return theme_config an instance of this class.
571fa828 349 */
ebebf55c 350 public static function load($themename) {
351 global $CFG;
571fa828 352
78946b9b
PS
353 // load theme settings from db
354 try {
355 $settings = get_config('theme_'.$themename);
356 } catch (dml_exception $e) {
da0c0e25 357 // most probably moodle tables not created yet
365a5941 358 $settings = new stdClass();
78946b9b 359 }
ebebf55c 360
78946b9b
PS
361 if ($config = theme_config::find_theme_config($themename, $settings)) {
362 return new theme_config($config);
5f0baa43
PS
363
364 } else if ($themename == theme_config::DEFAULT_THEME) {
365 throw new coding_exception('Default theme '.theme_config::DEFAULT_THEME.' not available or broken!');
366
2211f504
MA
367 } else if ($config = theme_config::find_theme_config($CFG->theme, $settings)) {
368 return new theme_config($config);
369
78946b9b
PS
370 } else {
371 // bad luck, the requested theme has some problems - admin see details in theme config
5f0baa43 372 return new theme_config(theme_config::find_theme_config(theme_config::DEFAULT_THEME, $settings));
78946b9b
PS
373 }
374 }
ebebf55c 375
78946b9b
PS
376 /**
377 * Theme diagnostic code. It is very problematic to send debug output
378 * to the actual CSS file, instead this functions is supposed to
ae5b6801 379 * diagnose given theme and highlights all potential problems.
78946b9b
PS
380 * This information should be available from the theme selection page
381 * or some other debug page for theme designers.
382 *
383 * @param string $themename
384 * @return array description of problems
385 */
386 public static function diagnose($themename) {
5ef719e7 387 //TODO: MDL-21108
78946b9b
PS
388 return array();
389 }
390
391 /**
392 * Private constructor, can be called only from the factory method.
393 * @param stdClass $config
394 */
395 private function __construct($config) {
396 global $CFG; //needed for included lib.php files
397
398 $this->settings = $config->settings;
399 $this->name = $config->name;
400 $this->dir = $config->dir;
401
402 if ($this->name != 'base') {
403 $baseconfig = theme_config::find_theme_config('base', $this->settings);
404 } else {
405 $baseconfig = $config;
571fa828 406 }
ebebf55c 407
fef27578 408 $configurable = array('parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets', 'javascripts', 'javascripts_footer',
b305d623 409 'parents_exclude_javascripts', 'layouts', 'enable_dock', 'enablecourseajax', 'supportscssoptimisation',
13725b37 410 'rendererfactory', 'csspostprocess', 'editor_sheets', 'rarrow', 'larrow', 'hidefromselector', 'doctype');
ebebf55c 411
78946b9b
PS
412 foreach ($config as $key=>$value) {
413 if (in_array($key, $configurable)) {
414 $this->$key = $value;
415 }
416 }
417
418 // verify all parents and load configs and renderers
419 foreach ($this->parents as $parent) {
420 if ($parent == 'base') {
421 $parent_config = $baseconfig;
422 } else if (!$parent_config = theme_config::find_theme_config($parent, $this->settings)) {
423 // this is not good - better exclude faulty parents
424 continue;
425 }
426 $libfile = $parent_config->dir.'/lib.php';
427 if (is_readable($libfile)) {
428 // theme may store various function here
429 include_once($libfile);
430 }
431 $renderersfile = $parent_config->dir.'/renderers.php';
432 if (is_readable($renderersfile)) {
433 // may contain core and plugin renderers and renderer factory
434 include_once($renderersfile);
435 }
436 $this->parent_configs[$parent] = $parent_config;
437 $rendererfile = $parent_config->dir.'/renderers.php';
438 if (is_readable($rendererfile)) {
439 // may contain core and plugin renderers and renderer factory
440 include_once($rendererfile);
441 }
442 }
443 $libfile = $this->dir.'/lib.php';
444 if (is_readable($libfile)) {
445 // theme may store various function here
446 include_once($libfile);
447 }
448 $rendererfile = $this->dir.'/renderers.php';
449 if (is_readable($rendererfile)) {
450 // may contain core and plugin renderers and renderer factory
451 include_once($rendererfile);
6fc267a0
BJ
452 } else {
453 // check if renderers.php file is missnamed renderer.php
454 if (is_readable($this->dir.'/renderer.php')) {
455 debugging('Developer hint: '.$this->dir.'/renderer.php should be renamed to ' . $this->dir."/renderers.php.
11c0ecce 456 See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER);
6fc267a0 457 }
78946b9b 458 }
4399b9d5 459
78946b9b
PS
460 // cascade all layouts properly
461 foreach ($baseconfig->layouts as $layout=>$value) {
462 if (!isset($this->layouts[$layout])) {
463 foreach ($this->parent_configs as $parent_config) {
464 if (isset($parent_config->layouts[$layout])) {
465 $this->layouts[$layout] = $parent_config->layouts[$layout];
466 continue 2;
467 }
468 }
469 $this->layouts[$layout] = $value;
470 }
471 }
472
473 //fix arrows if needed
474 $this->check_theme_arrows();
571fa828 475 }
476
f8129210 477 /**
78946b9b
PS
478 * Checks if arrows $THEME->rarrow, $THEME->larrow have been set (theme/-/config.php).
479 * If not it applies sensible defaults.
480 *
481 * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
482 * search forum block, etc. Important: these are 'silent' in a screen-reader
483 * (unlike &gt; &raquo;), and must be accompanied by text.
34a2777c 484 */
78946b9b
PS
485 private function check_theme_arrows() {
486 if (!isset($this->rarrow) and !isset($this->larrow)) {
487 // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
488 // Also OK in Win 9x/2K/IE 5.x
489 $this->rarrow = '&#x25BA;';
490 $this->larrow = '&#x25C4;';
491 if (empty($_SERVER['HTTP_USER_AGENT'])) {
492 $uagent = '';
ebebf55c 493 } else {
78946b9b
PS
494 $uagent = $_SERVER['HTTP_USER_AGENT'];
495 }
496 if (false !== strpos($uagent, 'Opera')
497 || false !== strpos($uagent, 'Mac')) {
498 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
499 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
500 $this->rarrow = '&#x25B6;';
501 $this->larrow = '&#x25C0;';
502 }
503 elseif (false !== strpos($uagent, 'Konqueror')) {
504 $this->rarrow = '&rarr;';
505 $this->larrow = '&larr;';
506 }
507 elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
508 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
509 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
510 // To be safe, non-Unicode browsers!
511 $this->rarrow = '&gt;';
512 $this->larrow = '&lt;';
513 }
514
f8129210 515 // RTL support - in RTL languages, swap r and l arrows
78946b9b
PS
516 if (right_to_left()) {
517 $t = $this->rarrow;
518 $this->rarrow = $this->larrow;
519 $this->larrow = $t;
ebebf55c 520 }
ebebf55c 521 }
78946b9b 522 }
ebebf55c 523
78946b9b
PS
524 /**
525 * Returns output renderer prefixes, these are used when looking
71c03ac1 526 * for the overridden renderers in themes.
473dd811 527 *
78946b9b
PS
528 * @return array
529 */
530 public function renderer_prefixes() {
531 global $CFG; // just in case the included files need it
532
596af93a 533 $prefixes = array('theme_'.$this->name);
78946b9b
PS
534
535 foreach ($this->parent_configs as $parent) {
536 $prefixes[] = 'theme_'.$parent->name;
537 }
538
539 return $prefixes;
34a2777c 540 }
541
571fa828 542 /**
78946b9b 543 * Returns the stylesheet URL of this editor content
473dd811 544 *
78946b9b
PS
545 * @param bool $encoded false means use & and true use &amp; in URLs
546 * @return string
571fa828 547 */
78946b9b
PS
548 public function editor_css_url($encoded=true) {
549 global $CFG;
550
551 $rev = theme_get_revision();
552
553 if ($rev > -1) {
7070b7f2
PS
554 if (!empty($CFG->slasharguments)) {
555 $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
556 $url->set_slashargument('/'.$this->name.'/'.$rev.'/editor', 'noparam', true);
557 return $url;
558 } else {
559 $params = array('theme'=>$this->name,'rev'=>$rev, 'type'=>'editor');
560 return new moodle_url($CFG->httpswwwroot.'/theme/styles.php', $params);
561 }
78946b9b
PS
562 } else {
563 $params = array('theme'=>$this->name, 'type'=>'editor');
564 return new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php', $params);
571fa828 565 }
571fa828 566 }
567
568 /**
78946b9b 569 * Returns the content of the CSS to be used in editor content
473dd811 570 *
78946b9b 571 * @return string
571fa828 572 */
71be124d 573 public function editor_css_files() {
78946b9b
PS
574 global $CFG;
575
71be124d 576 $files = array();
78946b9b
PS
577
578 // first editor plugins
579 $plugins = get_plugin_list('editor');
580 foreach ($plugins as $plugin=>$fulldir) {
581 $sheetfile = "$fulldir/editor_styles.css";
582 if (is_readable($sheetfile)) {
71be124d 583 $files['plugin_'.$plugin] = $sheetfile;
78946b9b
PS
584 }
585 }
586 // then parent themes
587 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
588 if (empty($parent_config->editor_sheets)) {
589 continue;
590 }
591 foreach ($parent_config->editor_sheets as $sheet) {
ca194849 592 $sheetfile = "$parent_config->dir/style/$sheet.css";
78946b9b 593 if (is_readable($sheetfile)) {
71be124d 594 $files['parent_'.$parent_config->name.'_'.$sheet] = $sheetfile;
78946b9b
PS
595 }
596 }
597 }
598 // finally this theme
599 if (!empty($this->editor_sheets)) {
600 foreach ($this->editor_sheets as $sheet) {
71be124d 601 $sheetfile = "$this->dir/style/$sheet.css";
78946b9b 602 if (is_readable($sheetfile)) {
71be124d 603 $files['theme_'.$sheet] = $sheetfile;
78946b9b
PS
604 }
605 }
606 }
607
71be124d 608 return $files;
571fa828 609 }
610
611 /**
78946b9b 612 * Get the stylesheet URL of this theme
473dd811
SH
613 *
614 * @param moodle_page $page Not used... deprecated?
38aafea2 615 * @return array of moodle_url
571fa828 616 */
efaa4c08 617 public function css_urls(moodle_page $page) {
78946b9b
PS
618 global $CFG;
619
620 $rev = theme_get_revision();
621
efaa4c08 622 $urls = array();
efaa4c08 623
383b89a1
SH
624 $svg = $this->use_svg_icons();
625
78946b9b 626 if ($rev > -1) {
383b89a1 627 $url = new moodle_url("$CFG->httpswwwroot/theme/styles.php");
a6338a13 628 if (check_browser_version('MSIE', 5)) {
537740cb 629 // We need to split the CSS files for IE
383b89a1
SH
630 $urls[] = new moodle_url($url, array('theme' => $this->name,'rev' => $rev, 'type' => 'plugins', 'svg' => '0'));
631 $urls[] = new moodle_url($url, array('theme' => $this->name,'rev' => $rev, 'type' => 'parents', 'svg' => '0'));
632 $urls[] = new moodle_url($url, array('theme' => $this->name,'rev' => $rev, 'type' => 'theme', 'svg' => '0'));
537740cb 633 } else {
7070b7f2 634 if (!empty($CFG->slasharguments)) {
383b89a1
SH
635 $slashargs = '/'.$this->name.'/'.$rev.'/all';
636 if (!$svg) {
637 // We add a simple /_s to the start of the path.
638 // The underscore is used to ensure that it isn't a valid theme name.
639 $slashargs = '/_s'.$slashargs;
640 }
641 $url->set_slashargument($slashargs, 'noparam', true);
7070b7f2 642 } else {
383b89a1
SH
643 $params = array('theme' => $this->name,'rev' => $rev, 'type' => 'all');
644 if (!$svg) {
645 // We add an SVG param so that we know not to serve SVG images.
646 // We do this because all modern browsers support SVG and this param will one day be removed.
647 $params['svg'] = '0';
648 }
649 $url->params($params);
7070b7f2 650 }
383b89a1 651 $urls[] = $url;
78946b9b 652 }
78946b9b 653 } else {
7829cf79
PS
654 // find out the current CSS and cache it now for 5 seconds
655 // the point is to construct the CSS only once and pass it through the
656 // dataroot to the script that actually serves the sheets
d6b64d15
PS
657 if (!defined('THEME_DESIGNER_CACHE_LIFETIME')) {
658 define('THEME_DESIGNER_CACHE_LIFETIME', 4); // this can be also set in config.php
659 }
bcf7f9f3 660 $candidatedir = "$CFG->cachedir/theme/$this->name";
383b89a1
SH
661 if ($svg) {
662 $candidatesheet = "$candidatedir/designer.ser";
663 } else {
664 $candidatesheet = "$candidatedir/designer_nosvg.ser";
665 }
bcf7f9f3
666 $rebuild = true;
667 if (file_exists($candidatesheet) and filemtime($candidatesheet) > time() - THEME_DESIGNER_CACHE_LIFETIME) {
7829cf79
PS
668 if ($css = file_get_contents($candidatesheet)) {
669 $css = unserialize($css);
bcf7f9f3
670 if (is_array($css)) {
671 $rebuild = false;
672 }
673 }
674 }
675 if ($rebuild) {
676 // Prepare the CSS optimiser if it is to be used,
677 // please note that it may be very slow and is therefore strongly discouraged in theme designer mode.
678 $optimiser = null;
679 if (!empty($CFG->enablecssoptimiser) && $this->supportscssoptimisation) {
680 require_once($CFG->dirroot.'/lib/csslib.php');
681 $optimiser = new css_optimiser;
7829cf79 682 }
b305d623 683 $css = $this->css_content($optimiser);
bcf7f9f3
684
685 // We do not want any errors here because this may fail easily because of the concurrent access.
686 $prevabort = ignore_user_abort(true);
687 check_dir_exists($candidatedir);
688 $tempfile = tempnam($candidatedir, 'tmpdesigner');
689 file_put_contents($tempfile, serialize($css));
690 $reporting = error_reporting(0);
691 chmod($tempfile, $CFG->filepermissions);
692 unlink($candidatesheet); // Do not rely on rename() deleting original, they may decide to change it at any time as usually.
693 rename($tempfile, $candidatesheet);
694 error_reporting($reporting);
695 ignore_user_abort($prevabort);
7829cf79
PS
696 }
697
383b89a1
SH
698 $baseurl = new moodle_url($CFG->httpswwwroot.'/theme/styles_debug.php');
699 if (!$svg) {
700 // We add an SVG param so that we know not to serve SVG images.
701 // We do this because all modern browsers support SVG and this param will one day be removed.
702 $baseurl->param('svg', '0');
703 }
c09e1a2c
PS
704 if (check_browser_version('MSIE', 5)) {
705 // lalala, IE does not allow more than 31 linked CSS files from main document
71be124d 706 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'plugins'));
a6338a13
SH
707 foreach ($css['parents'] as $parent=>$sheets) {
708 // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096)
71be124d 709 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
a6338a13 710 }
71be124d 711 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'theme'));
c09e1a2c
PS
712
713 } else {
714 foreach ($css['plugins'] as $plugin=>$unused) {
715 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'plugin', 'subtype'=>$plugin));
716 }
717 foreach ($css['parents'] as $parent=>$sheets) {
718 foreach ($sheets as $sheet=>$unused2) {
719 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
720 }
721 }
722 foreach ($css['theme'] as $sheet=>$unused) {
723 $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 724 }
78946b9b 725 }
78946b9b 726 }
efaa4c08
PS
727
728 return $urls;
571fa828 729 }
34a2777c 730
ebebf55c 731 /**
045f492c 732 * Returns an array of organised CSS files required for this output
473dd811 733 *
045f492c 734 * @return array
ebebf55c 735 */
045f492c
SH
736 public function css_files() {
737 $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
78946b9b 738
8c96c3cb 739 // get all plugin sheets
045f492c 740 $excludes = $this->resolve_excludes('plugins_exclude_sheets');
78946b9b
PS
741 if ($excludes !== true) {
742 foreach (get_plugin_types() as $type=>$unused) {
045f492c 743 if ($type === 'theme' || (!empty($excludes[$type]) and $excludes[$type] === true)) {
78946b9b
PS
744 continue;
745 }
746 $plugins = get_plugin_list($type);
747 foreach ($plugins as $plugin=>$fulldir) {
748 if (!empty($excludes[$type]) and is_array($excludes[$type])
749 and in_array($plugin, $excludes[$type])) {
750 continue;
751 }
f8bb9666
SH
752
753 $plugincontent = '';
78946b9b
PS
754 $sheetfile = "$fulldir/styles.css";
755 if (is_readable($sheetfile)) {
045f492c 756 $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
f8bb9666
SH
757 }
758 $sheetthemefile = "$fulldir/styles_{$this->name}.css";
759 if (is_readable($sheetthemefile)) {
045f492c 760 $cssfiles['plugins'][$type.'_'.$plugin.'_'.$this->name] = $sheetthemefile;
f8bb9666 761 }
78946b9b
PS
762 }
763 }
764 }
34a2777c 765
78946b9b 766 // find out wanted parent sheets
045f492c 767 $excludes = $this->resolve_excludes('parents_exclude_sheets');
78946b9b
PS
768 if ($excludes !== true) {
769 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
770 $parent = $parent_config->name;
045f492c 771 if (empty($parent_config->sheets) || (!empty($excludes[$parent]) and $excludes[$parent] === true)) {
78946b9b
PS
772 continue;
773 }
774 foreach ($parent_config->sheets as $sheet) {
775 if (!empty($excludes[$parent]) and is_array($excludes[$parent])
776 and in_array($sheet, $excludes[$parent])) {
777 continue;
778 }
779 $sheetfile = "$parent_config->dir/style/$sheet.css";
780 if (is_readable($sheetfile)) {
045f492c 781 $cssfiles['parents'][$parent][$sheet] = $sheetfile;
78946b9b
PS
782 }
783 }
784 }
785 }
34a2777c 786
78946b9b
PS
787 // current theme sheets
788 if (is_array($this->sheets)) {
789 foreach ($this->sheets as $sheet) {
790 $sheetfile = "$this->dir/style/$sheet.css";
791 if (is_readable($sheetfile)) {
045f492c 792 $cssfiles['theme'][$sheet] = $sheetfile;
78946b9b 793 }
ebebf55c 794 }
78946b9b
PS
795 }
796
045f492c
SH
797 return $cssfiles;
798 }
799
800 /**
801 * Returns the content of the one huge CSS merged from all style sheets.
473dd811 802 *
b305d623 803 * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
045f492c
SH
804 * @return string
805 */
b305d623 806 public function css_content(css_optimiser $optimiser = null) {
71be124d 807 $files = array_merge($this->css_files(), array('editor'=>$this->editor_css_files()));
b305d623 808 $css = $this->css_files_get_contents($files, array(), $optimiser);
78946b9b
PS
809 return $css;
810 }
34a2777c 811
045f492c
SH
812 /**
813 * Given an array of file paths or a single file path loads the contents of
814 * the CSS file, processes it then returns it in the same structure it was given.
815 *
f8129210 816 * Can be used recursively on the results of {@link css_files}
045f492c
SH
817 *
818 * @param array|string $file An array of file paths or a single file path
71c03ac1 819 * @param array $keys An array of previous array keys [recursive addition]
b305d623 820 * @param css_optimiser|null $optimiser A CSS optimiser to use during on the content. Null = don't optimise
045f492c
SH
821 * @return The converted array or the contents of the single file ($file type)
822 */
b305d623
SH
823 protected function css_files_get_contents($file, array $keys, css_optimiser $optimiser = null) {
824 global $CFG;
045f492c 825 if (is_array($file)) {
04cfa387
SH
826 // We use a separate array to keep everything in the exact same order.
827 $return = array();
045f492c 828 foreach ($file as $key=>$f) {
04cfa387 829 $return[clean_param($key, PARAM_SAFEDIR)] = $this->css_files_get_contents($f, array_merge($keys, array($key)), $optimiser);
045f492c 830 }
04cfa387 831 return $return;
045f492c 832 } else {
b305d623
SH
833 $contents = file_get_contents($file);
834 $contents = $this->post_process($contents);
045f492c 835 $comment = '/** Path: '.implode(' ', $keys).' **/'."\n";
b305d623
SH
836 $stats = '';
837 if (!is_null($optimiser)) {
838 $contents = $optimiser->process($contents);
839 if (!empty($CFG->cssoptimiserstats)) {
840 $stats = $optimiser->output_stats_css();
841 }
842 }
843 return $comment.$stats.$contents;
045f492c
SH
844 }
845 }
846
e68c5f36
PS
847
848 /**
473dd811
SH
849 * Generate a URL to the file that serves theme JavaScript files.
850 *
d7656956
ARN
851 * If we determine that the theme has no relevant files, then we return
852 * early with a null value.
853 *
71c03ac1 854 * @param bool $inhead true means head url, false means footer
d7656956 855 * @return moodle_url|null
e68c5f36 856 */
baeb20bb 857 public function javascript_url($inhead) {
e68c5f36
PS
858 global $CFG;
859
860 $rev = theme_get_revision();
e68c5f36 861 $params = array('theme'=>$this->name,'rev'=>$rev);
baeb20bb
PS
862 $params['type'] = $inhead ? 'head' : 'footer';
863
d7656956
ARN
864 // Return early if there are no files to serve
865 if (count($this->javascript_files($params['type'])) === 0) {
866 return null;
867 }
868
ecbad2ad
PS
869 if (!empty($CFG->slasharguments) and $rev > 0) {
870 $url = new moodle_url("$CFG->httpswwwroot/theme/javascript.php");
871 $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
872 return $url;
873 } else {
874 return new moodle_url($CFG->httpswwwroot.'/theme/javascript.php', $params);
875 }
e68c5f36
PS
876 }
877
473dd811
SH
878 /**
879 * Get the URL's for the JavaScript files used by this theme.
880 * They won't be served directly, instead they'll be mediated through
881 * theme/javascript.php.
882 *
883 * @param string $type Either javascripts_footer, or javascripts
884 * @return array
885 */
045f492c
SH
886 public function javascript_files($type) {
887 if ($type === 'footer') {
888 $type = 'javascripts_footer';
889 } else {
f856106b 890 $type = 'javascripts';
045f492c 891 }
04c01408 892
358c13cb
PS
893 $js = array();
894 // find out wanted parent javascripts
045f492c 895 $excludes = $this->resolve_excludes('parents_exclude_javascripts');
358c13cb
PS
896 if ($excludes !== true) {
897 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
898 $parent = $parent_config->name;
04c01408 899 if (empty($parent_config->$type)) {
358c13cb
PS
900 continue;
901 }
902 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
903 continue;
904 }
04c01408 905 foreach ($parent_config->$type as $javascript) {
358c13cb
PS
906 if (!empty($excludes[$parent]) and is_array($excludes[$parent])
907 and in_array($javascript, $excludes[$parent])) {
908 continue;
909 }
910 $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
911 if (is_readable($javascriptfile)) {
045f492c 912 $js[] = $javascriptfile;
358c13cb
PS
913 }
914 }
915 }
916 }
917
918 // current theme javascripts
04c01408
PS
919 if (is_array($this->$type)) {
920 foreach ($this->$type as $javascript) {
358c13cb
PS
921 $javascriptfile = "$this->dir/javascript/$javascript.js";
922 if (is_readable($javascriptfile)) {
045f492c
SH
923 $js[] = $javascriptfile;
924 }
925 }
926 }
045f492c
SH
927 return $js;
928 }
929
930 /**
3d3fae72 931 * Resolves an exclude setting to the themes setting is applicable or the
045f492c
SH
932 * setting of its closest parent.
933 *
934 * @param string $variable The name of the setting the exclude setting to resolve
f8129210 935 * @param string $default
045f492c
SH
936 * @return mixed
937 */
f8129210 938 protected function resolve_excludes($variable, $default = null) {
045f492c
SH
939 $setting = $default;
940 if (is_array($this->{$variable}) or $this->{$variable} === true) {
941 $setting = $this->{$variable};
942 } else {
943 foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
944 if (!isset($parent_config->{$variable})) {
945 continue;
946 }
947 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
948 $setting = $parent_config->{$variable};
949 break;
358c13cb
PS
950 }
951 }
952 }
045f492c
SH
953 return $setting;
954 }
358c13cb 955
045f492c
SH
956 /**
957 * Returns the content of the one huge javascript file merged from all theme javascript files.
473dd811 958 *
f8129210 959 * @param bool $type
045f492c
SH
960 * @return string
961 */
962 public function javascript_content($type) {
963 $jsfiles = $this->javascript_files($type);
964 $js = '';
965 foreach ($jsfiles as $jsfile) {
966 $js .= file_get_contents($jsfile)."\n";
967 }
968 return $js;
e68c5f36
PS
969 }
970
473dd811
SH
971 /**
972 * Post processes CSS.
973 *
974 * This method post processes all of the CSS before it is served for this theme.
975 * This is done so that things such as image URL's can be swapped in and to
976 * run any specific CSS post process method the theme has requested.
3d3fae72 977 * This allows themes to use CSS settings.
473dd811
SH
978 *
979 * @param string $css The CSS to process.
980 * @return string The processed CSS.
981 */
045f492c 982 public function post_process($css) {
78946b9b
PS
983 // now resolve all image locations
984 if (preg_match_all('/\[\[pix:([a-z_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
985 $replaced = array();
986 foreach ($matches as $match) {
987 if (isset($replaced[$match[0]])) {
988 continue;
989 }
990 $replaced[$match[0]] = true;
991 $imagename = $match[2];
992 $component = rtrim($match[1], '|');
b9bc2019 993 $imageurl = $this->pix_url($imagename, $component)->out(false);
df06c1c4 994 // we do not need full url because the image.php is always in the same dir
9d473266 995 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
df06c1c4 996 $css = str_replace($match[0], $imageurl, $css);
ebebf55c 997 }
34a2777c 998 }
17a6649b 999
78946b9b
PS
1000 // now resolve all theme settings or do any other postprocessing
1001 $csspostprocess = $this->csspostprocess;
1002 if (function_exists($csspostprocess)) {
1003 $css = $csspostprocess($css, $this);
fdeb7fa1 1004 }
1005
78946b9b 1006 return $css;
ebebf55c 1007 }
17a6649b 1008
ebebf55c 1009 /**
78946b9b
PS
1010 * Return the URL for an image
1011 *
1012 * @param string $imagename the name of the icon.
f8129210 1013 * @param string $component specification of one plugin like in get_string()
78946b9b 1014 * @return moodle_url
fdeb7fa1 1015 */
c39e5ba2 1016 public function pix_url($imagename, $component) {
fdeb7fa1 1017 global $CFG;
78946b9b 1018
9d473266 1019 $params = array('theme'=>$this->name);
436dbeec 1020 $svg = $this->use_svg_icons();
9d473266
PS
1021
1022 if (empty($component) or $component === 'moodle' or $component === 'core') {
1023 $params['component'] = 'core';
1024 } else {
1025 $params['component'] = $component;
1026 }
78946b9b
PS
1027
1028 $rev = theme_get_revision();
1029 if ($rev != -1) {
1030 $params['rev'] = $rev;
1031 }
9d473266
PS
1032
1033 $params['image'] = $imagename;
1034
436dbeec 1035 $url = new moodle_url("$CFG->httpswwwroot/theme/image.php");
9d473266 1036 if (!empty($CFG->slasharguments) and $rev > 0) {
436dbeec
SH
1037 $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
1038 if (!$svg) {
1039 // We add a simple /_s to the start of the path.
1040 // The underscore is used to ensure that it isn't a valid theme name.
1041 $path = '/_s'.$path;
1042 }
1043 $url->set_slashargument($path, 'noparam', true);
9d473266 1044 } else {
436dbeec
SH
1045 if (!$svg) {
1046 // We add an SVG param so that we know not to serve SVG images.
1047 // We do this because all modern browsers support SVG and this param will one day be removed.
1048 $params['svg'] = '0';
1049 }
1050 $url->params($params);
fdeb7fa1 1051 }
78946b9b 1052
9d473266 1053 return $url;
fdeb7fa1 1054 }
1055
1056 /**
78946b9b 1057 * Resolves the real image location.
436dbeec
SH
1058 *
1059 * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
1060 * and we need a way in which to turn it off.
1061 * By default SVG won't be used unless asked for. This is done for two reasons:
1062 * 1. It ensures that we don't serve svg images unless we really want to. The admin has selected to force them, of the users
1063 * browser supports SVG.
1064 * 2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
1065 * by the user due to security concerns.
1066 *
78946b9b
PS
1067 * @param string $image name of image, may contain relative path
1068 * @param string $component
436dbeec 1069 * @param bool $svg If set to true SVG images will also be looked for.
78946b9b 1070 * @return string full file path
fdeb7fa1 1071 */
436dbeec 1072 public function resolve_image_location($image, $component, $svg = false) {
78946b9b
PS
1073 global $CFG;
1074
436dbeec
SH
1075 if (!is_bool($svg)) {
1076 // If $svg isn't a bool then we need to decide for ourselves.
1077 $svg = $this->use_svg_icons();
1078 }
1079
78946b9b 1080 if ($component === 'moodle' or $component === 'core' or empty($component)) {
436dbeec 1081 if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
78946b9b
PS
1082 return $imagefile;
1083 }
1084 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
436dbeec 1085 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
78946b9b
PS
1086 return $imagefile;
1087 }
1088 }
436dbeec 1089 if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
f930cf6b
EM
1090 return $imagefile;
1091 }
436dbeec 1092 if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
78946b9b
PS
1093 return $imagefile;
1094 }
1095 return null;
1096
1097 } else if ($component === 'theme') { //exception
1098 if ($image === 'favicon') {
1099 return "$this->dir/pix/favicon.ico";
1100 }
436dbeec 1101 if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
78946b9b
PS
1102 return $imagefile;
1103 }
1104 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
436dbeec 1105 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
78946b9b
PS
1106 return $imagefile;
1107 }
1108 }
1109 return null;
1110
78946b9b
PS
1111 } else {
1112 if (strpos($component, '_') === false) {
1113 $component = 'mod_'.$component;
1114 }
1115 list($type, $plugin) = explode('_', $component, 2);
1116
436dbeec 1117 if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
78946b9b
PS
1118 return $imagefile;
1119 }
1120 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
436dbeec 1121 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
78946b9b
PS
1122 return $imagefile;
1123 }
1124 }
436dbeec 1125 if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
f930cf6b
EM
1126 return $imagefile;
1127 }
78946b9b 1128 $dir = get_plugin_directory($type, $plugin);
436dbeec 1129 if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
78946b9b
PS
1130 return $imagefile;
1131 }
1132 return null;
fdeb7fa1 1133 }
fdeb7fa1 1134 }
1135
436dbeec
SH
1136 /**
1137 * Return true if we should look for SVG images as well.
1138 *
1139 * @staticvar bool $svg
1140 * @return bool
1141 */
1142 public function use_svg_icons() {
1143 global $CFG;
1144 if ($this->usesvg === null) {
1145 if (!isset($CFG->svgicons) || !is_bool($CFG->svgicons)) {
1146 // IE 5 - 8 don't support SVG at all.
1147 if (empty($_SERVER['HTTP_USER_AGENT'])) {
1148 // Can't be sure, just say no.
1149 $this->usesvg = false;
3c1405a1 1150 } else if (check_browser_version('MSIE', 0) and !check_browser_version('MSIE', 9)) {
436dbeec
SH
1151 // IE < 9 doesn't support SVG. Say no.
1152 $this->usesvg = false;
1153 } else if (preg_match('#Android +[0-2]\.#', $_SERVER['HTTP_USER_AGENT'])) {
1154 // Android < 3 doesn't support SVG. Say no.
1155 $this->usesvg = false;
fbbf043c
FM
1156 } else if (check_browser_version('Opera', 0)) {
1157 // Opera 12 still does not support SVG well enough. Say no.
1158 $this->usesvg = false;
436dbeec
SH
1159 } else {
1160 // Presumed fine.
1161 $this->usesvg = true;
1162 }
1163 } else {
1164 // Force them on/off depending upon the setting.
1165 $this->usesvg = $CFG->svgicons;
1166 }
1167 }
1168 return $this->usesvg;
1169 }
1170
f7d6a556
SH
1171 /**
1172 * Forces the usesvg setting to either true or false, avoiding any decision making.
1173 *
1174 * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
383b89a1 1175 * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
f7d6a556
SH
1176 *
1177 * @param bool $setting True to force the use of svg when available, null otherwise.
1178 */
383b89a1 1179 public function force_svg_use($setting) {
f7d6a556
SH
1180 $this->usesvg = (bool)$setting;
1181 }
1182
d4a03c00 1183 /**
78946b9b 1184 * Checks if file with any image extension exists.
473dd811 1185 *
436dbeec
SH
1186 * The order to these images was adjusted prior to the release of 2.4
1187 * At that point the were the following image counts in Moodle core:
1188 *
1189 * - png = 667 in pix dirs (1499 total)
1190 * - gif = 385 in pix dirs (606 total)
1191 * - jpg = 62 in pix dirs (74 total)
1192 * - jpeg = 0 in pix dirs (1 total)
1193 *
1194 * There is work in progress to move towards SVG presently hence that has been prioritiesed.
1195 *
78946b9b 1196 * @param string $filepath
436dbeec 1197 * @param bool $svg If set to true SVG images will also be looked for.
78946b9b 1198 * @return string image name with extension
d4a03c00 1199 */
436dbeec
SH
1200 private static function image_exists($filepath, $svg = false) {
1201 if ($svg && file_exists("$filepath.svg")) {
1202 return "$filepath.svg";
78946b9b
PS
1203 } else if (file_exists("$filepath.png")) {
1204 return "$filepath.png";
436dbeec
SH
1205 } else if (file_exists("$filepath.gif")) {
1206 return "$filepath.gif";
78946b9b
PS
1207 } else if (file_exists("$filepath.jpg")) {
1208 return "$filepath.jpg";
1209 } else if (file_exists("$filepath.jpeg")) {
1210 return "$filepath.jpeg";
d4a03c00 1211 } else {
78946b9b 1212 return false;
d4a03c00 1213 }
1214 }
1215
fdeb7fa1 1216 /**
78946b9b 1217 * Loads the theme config from config.php file.
473dd811 1218 *
78946b9b 1219 * @param string $themename
473dd811
SH
1220 * @param stdClass $settings from config_plugins table
1221 * @return stdClass The theme configuration
fdeb7fa1 1222 */
78946b9b
PS
1223 private static function find_theme_config($themename, $settings) {
1224 // We have to use the variable name $THEME (upper case) because that
1225 // is what is used in theme config.php files.
fdeb7fa1 1226
78946b9b
PS
1227 if (!$dir = theme_config::find_theme_location($themename)) {
1228 return null;
fdeb7fa1 1229 }
2f67a9b3 1230
365a5941 1231 $THEME = new stdClass();
78946b9b
PS
1232 $THEME->name = $themename;
1233 $THEME->dir = $dir;
1234 $THEME->settings = $settings;
1235
1236 global $CFG; // just in case somebody tries to use $CFG in theme config
1237 include("$THEME->dir/config.php");
1238
1239 // verify the theme configuration is OK
1240 if (!is_array($THEME->parents)) {
1241 // parents option is mandatory now
1242 return null;
fdeb7fa1 1243 }
1244
78946b9b 1245 return $THEME;
fdeb7fa1 1246 }
1247
d4a03c00 1248 /**
78946b9b
PS
1249 * Finds the theme location and verifies the theme has all needed files
1250 * and is not obsoleted.
473dd811 1251 *
78946b9b
PS
1252 * @param string $themename
1253 * @return string full dir path or null if not found
d4a03c00 1254 */
78946b9b
PS
1255 private static function find_theme_location($themename) {
1256 global $CFG;
1257
1258 if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
1259 $dir = "$CFG->dirroot/theme/$themename";
d4a03c00 1260
3dd1d7e7
DM
1261 } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
1262 $dir = "$CFG->themedir/$themename";
1263
7d875874 1264 } else {
78946b9b 1265 return null;
d4a03c00 1266 }
78946b9b
PS
1267
1268 if (file_exists("$dir/styles.php")) {
1269 //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
1270 return null;
1271 }
2f67a9b3 1272
78946b9b 1273 return $dir;
d4a03c00 1274 }
1275
1d13c75c 1276 /**
78946b9b 1277 * Get the renderer for a part of Moodle for this theme.
473dd811 1278 *
78946b9b 1279 * @param moodle_page $page the page we are rendering
f8129210 1280 * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
78946b9b 1281 * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
c927e35c 1282 * @param string $target one of rendering target constants
78946b9b 1283 * @return renderer_base the requested renderer.
1d13c75c 1284 */
c927e35c 1285 public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
78946b9b 1286 if (is_null($this->rf)) {
c927e35c 1287 $classname = $this->rendererfactory;
78946b9b 1288 $this->rf = new $classname($this);
1d13c75c 1289 }
78946b9b 1290
c927e35c 1291 return $this->rf->get_renderer($page, $component, $subtype, $target);
1d13c75c 1292 }
1293
fdeb7fa1 1294 /**
78946b9b 1295 * Get the information from {@link $layouts} for this type of page.
473dd811 1296 *
78946b9b
PS
1297 * @param string $pagelayout the the page layout name.
1298 * @return array the appropriate part of {@link $layouts}.
fdeb7fa1 1299 */
78946b9b
PS
1300 protected function layout_info_for_page($pagelayout) {
1301 if (array_key_exists($pagelayout, $this->layouts)) {
1302 return $this->layouts[$pagelayout];
1303 } else {
191b267b
PS
1304 debugging('Invalid page layout specified: ' . $pagelayout);
1305 return $this->layouts['standard'];
fdeb7fa1 1306 }
1307 }
1308
1309 /**
78946b9b
PS
1310 * Given the settings of this theme, and the page pagelayout, return the
1311 * full path of the page layout file to use.
1312 *
1313 * Used by {@link core_renderer::header()}.
1314 *
1315 * @param string $pagelayout the the page layout name.
1316 * @return string Full path to the lyout file to use
ebebf55c 1317 */
78946b9b 1318 public function layout_file($pagelayout) {
ebebf55c 1319 global $CFG;
fdeb7fa1 1320
78946b9b
PS
1321 $layoutinfo = $this->layout_info_for_page($pagelayout);
1322 $layoutfile = $layoutinfo['file'];
fdeb7fa1 1323
84db3ea2
SH
1324 if (array_key_exists('theme', $layoutinfo)) {
1325 $themes = array($layoutinfo['theme']);
1326 } else {
1327 $themes = array_merge(array($this->name),$this->parents);
1328 }
4399b9d5 1329
84db3ea2
SH
1330 foreach ($themes as $theme) {
1331 if ($dir = $this->find_theme_location($theme)) {
1332 $path = "$dir/layout/$layoutfile";
1333
1334 // Check the template exists, return general base theme template if not.
1335 if (is_readable($path)) {
1336 return $path;
1337 }
78946b9b 1338 }
34a2777c 1339 }
1340
191b267b 1341 debugging('Can not find layout file for: ' . $pagelayout);
78946b9b
PS
1342 // fallback to standard normal layout
1343 return "$CFG->dirroot/theme/base/layout/general.php";
1344 }
ebebf55c 1345
78946b9b
PS
1346 /**
1347 * Returns auxiliary page layout options specified in layout configuration array.
473dd811 1348 *
78946b9b
PS
1349 * @param string $pagelayout
1350 * @return array
1351 */
1352 public function pagelayout_options($pagelayout) {
1353 $info = $this->layout_info_for_page($pagelayout);
1354 if (!empty($info['options'])) {
1355 return $info['options'];
34a2777c 1356 }
78946b9b
PS
1357 return array();
1358 }
34a2777c 1359
78946b9b
PS
1360 /**
1361 * Inform a block_manager about the block regions this theme wants on this
1362 * page layout.
473dd811 1363 *
78946b9b
PS
1364 * @param string $pagelayout the general type of the page.
1365 * @param block_manager $blockmanager the block_manger to set up.
78946b9b
PS
1366 */
1367 public function setup_blocks($pagelayout, $blockmanager) {
1368 $layoutinfo = $this->layout_info_for_page($pagelayout);
1369 if (!empty($layoutinfo['regions'])) {
1370 $blockmanager->add_regions($layoutinfo['regions']);
1371 $blockmanager->set_default_region($layoutinfo['defaultregion']);
ebebf55c 1372 }
34a2777c 1373 }
1374
473dd811
SH
1375 /**
1376 * Gets the visible name for the requested block region.
1377 *
1378 * @param string $region The region name to get
1379 * @param string $theme The theme the region belongs to (may come from the parent theme)
1380 * @return string
1381 */
cadc0d28
TH
1382 protected function get_region_name($region, $theme) {
1383 $regionstring = get_string('region-' . $region, 'theme_' . $theme);
1384 // A name exists in this theme, so use it
1385 if (substr($regionstring, 0, 1) != '[') {
1386 return $regionstring;
1387 }
1388
1389 // Otherwise, try to find one elsewhere
1390 // Check parents, if any
1391 foreach ($this->parents as $parentthemename) {
1392 $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
1393 if (substr($regionstring, 0, 1) != '[') {
1394 return $regionstring;
1395 }
1396 }
1397
1398 // Last resort, try the base theme for names
1399 return get_string('region-' . $region, 'theme_base');
1400 }
1401
ebebf55c 1402 /**
78946b9b 1403 * Get the list of all block regions known to this theme in all templates.
473dd811 1404 *
78946b9b 1405 * @return array internal region name => human readable name.
ebebf55c 1406 */
78946b9b
PS
1407 public function get_all_block_regions() {
1408 $regions = array();
78946b9b
PS
1409 foreach ($this->layouts as $layoutinfo) {
1410 foreach ($layoutinfo['regions'] as $region) {
a9535f79 1411 $regions[$region] = $this->get_region_name($region, $this->name);
ebebf55c 1412 }
34a2777c 1413 }
78946b9b 1414 return $regions;
34a2777c 1415 }
d609d962
SH
1416
1417 /**
1418 * Returns the human readable name of the theme
1419 *
1420 * @return string
1421 */
1422 public function get_theme_name() {
1423 return get_string('pluginname', 'theme_'.$this->name);
1424 }
ebebf55c 1425}
34a2777c 1426
ebebf55c 1427/**
d9c8f425 1428 * This class keeps track of which HTML tags are currently open.
1429 *
1430 * This makes it much easier to always generate well formed XHTML output, even
1431 * if execution terminates abruptly. Any time you output some opening HTML
1432 * without the matching closing HTML, you should push the necessary close tags
1433 * onto the stack.
ebebf55c 1434 *
1435 * @copyright 2009 Tim Hunt
473dd811
SH
1436 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1437 * @since Moodle 2.0
f8129210 1438 * @package core
76be40cc 1439 * @category output
ebebf55c 1440 */
d9c8f425 1441class xhtml_container_stack {
473dd811
SH
1442
1443 /**
76be40cc 1444 * @var array Stores the list of open containers.
473dd811 1445 */
d9c8f425 1446 protected $opencontainers = array();
473dd811 1447
fa1afe32 1448 /**
76be40cc 1449 * @var array In developer debug mode, stores a stack trace of all opens and
d9c8f425 1450 * closes, so we can output helpful error messages when there is a mismatch.
fa1afe32 1451 */
d9c8f425 1452 protected $log = array();
473dd811 1453
fa1afe32 1454 /**
76be40cc
SH
1455 * @var boolean Store whether we are developer debug mode. We need this in
1456 * several places including in the destructor where we may not have access to $CFG.
fa1afe32 1457 */
d9c8f425 1458 protected $isdebugging;
34a2777c 1459
473dd811
SH
1460 /**
1461 * Constructor
1462 */
d9c8f425 1463 public function __construct() {
1464 $this->isdebugging = debugging('', DEBUG_DEVELOPER);
ebebf55c 1465 }
34a2777c 1466
fa1afe32 1467 /**
d9c8f425 1468 * Push the close HTML for a recently opened container onto the stack.
473dd811 1469 *
d9c8f425 1470 * @param string $type The type of container. This is checked when {@link pop()}
1471 * is called and must match, otherwise a developer debug warning is output.
1472 * @param string $closehtml The HTML required to close the container.
fa1afe32 1473 */
d9c8f425 1474 public function push($type, $closehtml) {
1475 $container = new stdClass;
1476 $container->type = $type;
1477 $container->closehtml = $closehtml;
1478 if ($this->isdebugging) {
1479 $this->log('Open', $type);
3aaa27f4 1480 }
d9c8f425 1481 array_push($this->opencontainers, $container);
ebebf55c 1482 }
34a2777c 1483
fa1afe32 1484 /**
d9c8f425 1485 * Pop the HTML for the next closing container from the stack. The $type
1486 * must match the type passed when the container was opened, otherwise a
1487 * warning will be output.
473dd811 1488 *
d9c8f425 1489 * @param string $type The type of container.
1490 * @return string the HTML required to close the container.
fa1afe32 1491 */
d9c8f425 1492 public function pop($type) {
1493 if (empty($this->opencontainers)) {
1494 debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
1495 $this->output_log(), DEBUG_DEVELOPER);
1496 return;
3aaa27f4 1497 }
ebebf55c 1498
d9c8f425 1499 $container = array_pop($this->opencontainers);
1500 if ($container->type != $type) {
1501 debugging('<p>The type of container to be closed (' . $container->type .
1502 ') does not match the type of the next open container (' . $type .
1503 '). This suggests there is a nesting problem.</p>' .
1504 $this->output_log(), DEBUG_DEVELOPER);
ebebf55c 1505 }
d9c8f425 1506 if ($this->isdebugging) {
1507 $this->log('Close', $type);
e8775320 1508 }
d9c8f425 1509 return $container->closehtml;
ebebf55c 1510 }
e8775320 1511
fa1afe32 1512 /**
d9c8f425 1513 * Close all but the last open container. This is useful in places like error
1514 * handling, where you want to close all the open containers (apart from <body>)
1515 * before outputting the error message.
473dd811 1516 *
d9c8f425 1517 * @param bool $shouldbenone assert that the stack should be empty now - causes a
1518 * developer debug warning if it isn't.
1519 * @return string the HTML required to close any open containers inside <body>.
fa1afe32 1520 */
d9c8f425 1521 public function pop_all_but_last($shouldbenone = false) {
1522 if ($shouldbenone && count($this->opencontainers) != 1) {
1523 debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
1524 $this->output_log(), DEBUG_DEVELOPER);
1525 }
1526 $output = '';
1527 while (count($this->opencontainers) > 1) {
1528 $container = array_pop($this->opencontainers);
1529 $output .= $container->closehtml;
e8775320 1530 }
d9c8f425 1531 return $output;
e8775320 1532 }
34a2777c 1533
ebebf55c 1534 /**
d9c8f425 1535 * You can call this function if you want to throw away an instance of this
1536 * class without properly emptying the stack (for example, in a unit test).
1537 * Calling this method stops the destruct method from outputting a developer
1538 * debug warning. After calling this method, the instance can no longer be used.
ebebf55c 1539 */
d9c8f425 1540 public function discard() {
1541 $this->opencontainers = null;
ebebf55c 1542 }
d9c8f425 1543
fa1afe32 1544 /**
d9c8f425 1545 * Adds an entry to the log.
473dd811 1546 *
d9c8f425 1547 * @param string $action The name of the action
1548 * @param string $type The type of action
fa1afe32 1549 */
d9c8f425 1550 protected function log($action, $type) {
1551 $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
1552 format_backtrace(debug_backtrace()) . '</li>';
ebebf55c 1553 }
34a2777c 1554
fa1afe32 1555 /**
d9c8f425 1556 * Outputs the log's contents as a HTML list.
473dd811 1557 *
d9c8f425 1558 * @return string HTML list of the log
fa1afe32 1559 */
d9c8f425 1560 protected function output_log() {
1561 return '<ul>' . implode("\n", $this->log) . '</ul>';
34a2777c 1562 }
6fc267a0 1563}