weekly release 3.7dev
[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/**
5dd40ec4 38 * Returns current theme revision number.
473dd811 39 *
5dd40ec4 40 * @return int
78946b9b 41 */
5dd40ec4
RW
42function theme_get_revision() {
43 global $CFG;
44
45 if (empty($CFG->themedesignermode)) {
46 if (empty($CFG->themerev)) {
47 // This only happens during install. It doesn't matter what themerev we use as long as it's positive.
48 return 1;
49 } else {
50 return $CFG->themerev;
51 }
52
53 } else {
54 return -1;
55 }
56}
57
58/**
59 * Returns current theme sub revision number. This is the revision for
60 * this theme exclusively, not the global theme revision.
61 *
62 * @param string $themename The non-frankenstyle name of the theme
63 * @return int
64 */
65function theme_get_sub_revision_for_theme($themename) {
66 global $CFG;
67
68 if (empty($CFG->themedesignermode)) {
69 $pluginname = "theme_{$themename}";
63470cf3 70 $revision = during_initial_install() ? null : get_config($pluginname, 'themerev');
5dd40ec4
RW
71
72 if (empty($revision)) {
73 // This only happens during install. It doesn't matter what themerev we use as long as it's positive.
74 return 1;
75 } else {
76 return $revision;
77 }
78 } else {
79 return -1;
80 }
81}
82
83/**
84 * Calculates and returns the next theme revision number.
85 *
86 * @return int
87 */
88function theme_get_next_revision() {
89 global $CFG;
78946b9b 90
f11db1a6
PS
91 $next = time();
92 if (isset($CFG->themerev) and $next <= $CFG->themerev and $CFG->themerev - $next < 60*60) {
93 // This resolves problems when reset is requested repeatedly within 1s,
94 // the < 1h condition prevents accidental switching to future dates
95 // because we might not recover from it.
96 $next = $CFG->themerev+1;
97 }
98
5dd40ec4
RW
99 return $next;
100}
101
102/**
103 * Calculates and returns the next theme revision number.
104 *
105 * @param string $themename The non-frankenstyle name of the theme
106 * @return int
107 */
108function theme_get_next_sub_revision_for_theme($themename) {
109 global $CFG;
110
111 $next = time();
112 $current = theme_get_sub_revision_for_theme($themename);
113 if ($next <= $current and $current - $next < 60 * 60) {
114 // This resolves problems when reset is requested repeatedly within 1s,
115 // the < 1h condition prevents accidental switching to future dates
116 // because we might not recover from it.
117 $next = $current + 1;
118 }
119
120 return $next;
121}
122
123/**
124 * Sets the current theme revision number.
125 *
126 * @param int $revision The new theme revision number
127 */
128function theme_set_revision($revision) {
129 set_config('themerev', $revision);
130}
131
132/**
133 * Sets the current theme revision number for a specific theme.
134 * This does not affect the global themerev value.
135 *
136 * @param string $themename The non-frankenstyle name of the theme
137 * @param int $revision The new theme revision number
138 */
139function theme_set_sub_revision_for_theme($themename, $revision) {
140 set_config('themerev', $revision, "theme_{$themename}");
141}
142
143/**
144 * Get the path to a theme config.php file.
145 *
146 * @param string $themename The non-frankenstyle name of the theme to check
147 */
148function theme_get_config_file_path($themename) {
149 global $CFG;
150
151 if (file_exists("{$CFG->dirroot}/theme/{$themename}/config.php")) {
152 return "{$CFG->dirroot}/theme/{$themename}/config.php";
153 } else if (!empty($CFG->themedir) and file_exists("{$CFG->themedir}/{$themename}/config.php")) {
154 return "{$CFG->themedir}/{$themename}/config.php";
155 } else {
156 return null;
157 }
158}
159
160/**
161 * Get the path to the local cached CSS file.
162 *
163 * @param string $themename The non-frankenstyle theme name.
164 * @param int $globalrevision The global theme revision.
165 * @param int $themerevision The theme specific revision.
166 * @param string $direction Either 'ltr' or 'rtl' (case sensitive).
167 */
168function theme_get_css_filename($themename, $globalrevision, $themerevision, $direction) {
169 global $CFG;
170
171 $path = "{$CFG->localcachedir}/theme/{$globalrevision}/{$themename}/css";
172 $filename = $direction == 'rtl' ? "all-rtl_{$themerevision}" : "all_{$themerevision}";
173 return "{$path}/{$filename}.css";
174}
175
176/**
177 * Generates and saves the CSS files for the given theme configs.
178 *
179 * @param theme_config[] $themeconfigs An array of theme_config instances.
180 * @param array $directions Must be a subset of ['rtl', 'ltr'].
181 * @param bool $cache Should the generated files be stored in local cache.
182 */
183function theme_build_css_for_themes($themeconfigs = [], $directions = ['rtl', 'ltr'], $cache = true) {
184 global $CFG;
185
186 if (empty($themeconfigs)) {
187 return;
188 }
189
190 require_once("{$CFG->libdir}/csslib.php");
191
192 $themescss = [];
193 $themerev = theme_get_revision();
194 // Make sure the local cache directory exists.
195 make_localcache_directory('theme');
196
197 foreach ($themeconfigs as $themeconfig) {
198 $themecss = [];
199 $oldrevision = theme_get_sub_revision_for_theme($themeconfig->name);
200 $newrevision = theme_get_next_sub_revision_for_theme($themeconfig->name);
201
202 // First generate all the new css.
203 foreach ($directions as $direction) {
b3480499
DW
204 // Lock it on. Technically we should build all themes for SVG and no SVG - but ie9 is out of support.
205 $themeconfig->force_svg_use(true);
5dd40ec4
RW
206 $themeconfig->set_rtl_mode(($direction === 'rtl'));
207
208 $themecss[$direction] = $themeconfig->get_css_content();
209 if ($cache) {
b3480499 210 $themeconfig->set_css_content_cache($themecss[$direction]);
5dd40ec4
RW
211 $filename = theme_get_css_filename($themeconfig->name, $themerev, $newrevision, $direction);
212 css_store_css($themeconfig, $filename, $themecss[$direction]);
213 }
214 }
215 $themescss[] = $themecss;
216
217 if ($cache) {
218 // Only update the theme revision after we've successfully created the
219 // new CSS cache.
220 theme_set_sub_revision_for_theme($themeconfig->name, $newrevision);
221
222 // Now purge old files. We must purge all old files in the local cache
223 // because we've incremented the theme sub revision. This will leave any
224 // files with the old revision inaccessbile so we might as well removed
225 // them from disk.
226 foreach (['ltr', 'rtl'] as $direction) {
227 $oldcss = theme_get_css_filename($themeconfig->name, $themerev, $oldrevision, $direction);
228 if (file_exists($oldcss)) {
229 unlink($oldcss);
230 }
231 }
232 }
233 }
234
235 return $themescss;
236}
237
238/**
239 * Invalidate all server and client side caches.
240 *
241 * This method deletes the physical directory that is used to cache the theme
242 * files used for serving.
243 * Because it deletes the main theme cache directory all themes are reset by
244 * this function.
245 */
246function theme_reset_all_caches() {
247 global $CFG, $PAGE;
a990e4fa 248 require_once("{$CFG->libdir}/filelib.php");
5dd40ec4
RW
249
250 $next = theme_get_next_revision();
251 theme_set_revision($next);
fe7b75f8 252
98245a84
PS
253 if (!empty($CFG->themedesignermode)) {
254 $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'core', 'themedesigner');
255 $cache->purge();
256 }
257
4cc2f33b
SL
258 // Purge compiled post processed css.
259 cache::make('core', 'postprocessedcss')->purge();
260
a990e4fa
MH
261 // Delete all old theme localcaches.
262 $themecachedirs = glob("{$CFG->localcachedir}/theme/*", GLOB_ONLYDIR);
263 foreach ($themecachedirs as $localcachedir) {
264 fulldelete($localcachedir);
265 }
266
fe7b75f8
PS
267 if ($PAGE) {
268 $PAGE->reload_theme();
269 }
78946b9b
PS
270}
271
272/**
273 * Enable or disable theme designer mode.
473dd811 274 *
78946b9b 275 * @param bool $state
78946b9b
PS
276 */
277function theme_set_designer_mod($state) {
78946b9b 278 set_config('themedesignermode', (int)!empty($state));
98245a84
PS
279 // Reset caches after switching mode so that any designer mode caches get purged too.
280 theme_reset_all_caches();
78946b9b
PS
281}
282
f1ecad60
RW
283/**
284 * Checks if the given device has a theme defined in config.php.
285 *
286 * @return bool
287 */
288function theme_is_device_locked($device) {
289 global $CFG;
290 $themeconfigname = core_useragent::get_device_type_cfg_var_name($device);
291 return isset($CFG->config_php_settings[$themeconfigname]);
292}
293
294/**
295 * Returns the theme named defined in config.php for the given device.
296 *
297 * @return string or null
298 */
299function theme_get_locked_theme_for_device($device) {
300 global $CFG;
301
302 if (!theme_is_device_locked($device)) {
303 return null;
304 }
305
306 $themeconfigname = core_useragent::get_device_type_cfg_var_name($device);
307 return $CFG->config_php_settings[$themeconfigname];
308}
571fa828 309
571fa828 310/**
fdeb7fa1 311 * This class represents the configuration variables of a Moodle theme.
312 *
313 * All the variables with access: public below (with a few exceptions that are marked)
3d3fae72 314 * are the properties you can set in your themes config.php file.
fdeb7fa1 315 *
316 * There are also some methods and protected variables that are part of the inner
3d3fae72 317 * workings of Moodle's themes system. If you are just editing a themes config.php
fa1afe32 318 * file, you can just ignore those, and the following information for developers.
ebebf55c 319 *
320 * Normally, to create an instance of this class, you should use the
321 * {@link theme_config::load()} factory method to load a themes config.php file.
fa1afe32 322 * However, normally you don't need to bother, because moodle_page (that is, $PAGE)
fdeb7fa1 323 * will create one for you, accessible as $PAGE->theme.
571fa828 324 *
325 * @copyright 2009 Tim Hunt
473dd811
SH
326 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
327 * @since Moodle 2.0
f8129210 328 * @package core
76be40cc 329 * @category output
571fa828 330 */
ebebf55c 331class theme_config {
473dd811 332
5f0baa43 333 /**
76be40cc 334 * @var string Default theme, used when requested theme not found.
5f0baa43 335 */
e56b58e3 336 const DEFAULT_THEME = 'boost';
5f0baa43 337
41b973bc
FM
338 /** The key under which the SCSS file is stored amongst the CSS files. */
339 const SCSS_KEY = '__SCSS__';
340
ebebf55c 341 /**
76be40cc 342 * @var array You can base your theme on other themes by linking to the other theme as
78946b9b 343 * parents. This lets you use the CSS and layouts from the other themes
f8129210 344 * (see {@link theme_config::$layouts}).
fdeb7fa1 345 * That makes it easy to create a new theme that is similar to another one
3d3fae72 346 * but with a few changes. In this themes CSS you only need to override
fdeb7fa1 347 * those rules you want to change.
fdeb7fa1 348 */
78946b9b 349 public $parents;
571fa828 350
fdeb7fa1 351 /**
76be40cc 352 * @var array The names of all the stylesheets from this theme that you would
78946b9b 353 * like included, in order. Give the names of the files without .css.
fdeb7fa1 354 */
78946b9b 355 public $sheets = array();
571fa828 356
fdeb7fa1 357 /**
76be40cc 358 * @var array The names of all the stylesheets from parents that should be excluded.
78946b9b
PS
359 * true value may be used to specify all parents or all themes from one parent.
360 * If no value specified value from parent theme used.
fdeb7fa1 361 */
78946b9b 362 public $parents_exclude_sheets = null;
571fa828 363
fdeb7fa1 364 /**
76be40cc 365 * @var array List of plugin sheets to be excluded.
78946b9b 366 * If no value specified value from parent theme used.
fdeb7fa1 367 */
78946b9b 368 public $plugins_exclude_sheets = null;
571fa828 369
fdeb7fa1 370 /**
76be40cc 371 * @var array List of style sheets that are included in the text editor bodies.
78946b9b 372 * Sheets from parent themes are used automatically and can not be excluded.
fdeb7fa1 373 */
78946b9b 374 public $editor_sheets = array();
571fa828 375
0e9911e1
AN
376 /**
377 * @var bool Whether a fallback version of the stylesheet will be used
378 * whilst the final version is generated.
379 */
380 public $usefallback = false;
381
38aafea2 382 /**
76be40cc 383 * @var array The names of all the javascript files this theme that you would
04c01408 384 * like included from head, in order. Give the names of the files without .js.
38aafea2
PS
385 */
386 public $javascripts = array();
387
04c01408 388 /**
76be40cc 389 * @var array The names of all the javascript files this theme that you would
04c01408 390 * like included from footer, in order. Give the names of the files without .js.
04c01408
PS
391 */
392 public $javascripts_footer = array();
4399b9d5 393
38aafea2 394 /**
76be40cc
SH
395 * @var array The names of all the javascript files from parents that should
396 * be excluded. true value may be used to specify all parents or all themes
397 * from one parent.
38aafea2 398 * If no value specified value from parent theme used.
38aafea2
PS
399 */
400 public $parents_exclude_javascripts = null;
401
fdeb7fa1 402 /**
76be40cc 403 * @var array Which file to use for each page layout.
fdeb7fa1 404 *
78946b9b
PS
405 * This is an array of arrays. The keys of the outer array are the different layouts.
406 * Pages in Moodle are using several different layouts like 'normal', 'course', 'home',
407 * 'popup', 'form', .... The most reliable way to get a complete list is to look at
408 * {@link http://cvs.moodle.org/moodle/theme/base/config.php?view=markup the base theme config.php file}.
d4a03c00 409 * That file also has a good example of how to set this setting.
fdeb7fa1 410 *
78946b9b 411 * For each layout, the value in the outer array is an array that describes
d4a03c00 412 * how you want that type of page to look. For example
413 * <pre>
414 * $THEME->layouts = array(
39df78bf 415 * // Most pages - if we encounter an unknown or a missing page type, this one is used.
191b267b 416 * 'standard' => array(
78946b9b
PS
417 * 'theme' = 'mytheme',
418 * 'file' => 'normal.php',
d4a03c00 419 * 'regions' => array('side-pre', 'side-post'),
420 * 'defaultregion' => 'side-post'
421 * ),
422 * // The site home page.
423 * 'home' => array(
78946b9b
PS
424 * 'theme' = 'mytheme',
425 * 'file' => 'home.php',
d4a03c00 426 * 'regions' => array('side-pre', 'side-post'),
427 * 'defaultregion' => 'side-post'
428 * ),
429 * // ...
430 * );
431 * </pre>
fdeb7fa1 432 *
78946b9b
PS
433 * 'theme' name of the theme where is the layout located
434 * 'file' is the layout file to use for this type of page.
435 * layout files are stored in layout subfolder
d4a03c00 436 * 'regions' This lists the regions on the page where blocks may appear. For
437 * each region you list here, your layout file must include a call to
438 * <pre>
439 * echo $OUTPUT->blocks_for_region($regionname);
440 * </pre>
441 * or equivalent so that the blocks are actually visible.
fdeb7fa1 442 *
d4a03c00 443 * 'defaultregion' If the list of regions is non-empty, then you must pick
444 * one of the one of them as 'default'. This has two meanings. First, this is
445 * where new blocks are added. Second, if there are any blocks associated with
fa1afe32 446 * the page, but in non-existent regions, they appear here. (Imaging, for example,
d4a03c00 447 * that someone added blocks using a different theme that used different region
448 * names, and then switched to this theme.)
fdeb7fa1 449 */
d4a03c00 450 public $layouts = array();
571fa828 451
fdeb7fa1 452 /**
76be40cc
SH
453 * @var string Name of the renderer factory class to use. Must implement the
454 * {@link renderer_factory} interface.
fdeb7fa1 455 *
456 * This is an advanced feature. Moodle output is generated by 'renderers',
457 * you can customise the HTML that is output by writing custom renderers,
458 * and then you need to specify 'renderer factory' so that Moodle can find
459 * your renderers.
460 *
461 * There are some renderer factories supplied with Moodle. Please follow these
462 * links to see what they do.
463 * <ul>
464 * <li>{@link standard_renderer_factory} - the default.</li>
465 * <li>{@link theme_overridden_renderer_factory} - use this if you want to write
78946b9b 466 * your own custom renderers in a lib.php file in this theme (or the parent theme).</li>
fdeb7fa1 467 * </ul>
fdeb7fa1 468 */
ebebf55c 469 public $rendererfactory = 'standard_renderer_factory';
ebebf55c 470
fdeb7fa1 471 /**
76be40cc 472 * @var string Function to do custom CSS post-processing.
fdeb7fa1 473 *
78946b9b
PS
474 * This is an advanced feature. If you want to do custom post-processing on the
475 * CSS before it is output (for example, to replace certain variable names
476 * with particular values) you can give the name of a function here.
fdeb7fa1 477 */
78946b9b 478 public $csspostprocess = null;
571fa828 479
99a6118f
FM
480 /**
481 * @var string Function to do custom CSS post-processing on a parsed CSS tree.
482 *
483 * This is an advanced feature. If you want to do custom post-processing on the
484 * CSS before it is output, you can provide the name of the function here. The
485 * function will receive a CSS tree document as first parameter, and the theme_config
486 * object as second parameter. A return value is not required, the tree can
487 * be edited in place.
488 */
493ef66e 489 public $csstreepostprocessor = null;
99a6118f 490
571fa828 491 /**
76be40cc 492 * @var string Accessibility: Right arrow-like character is
78946b9b
PS
493 * used in the breadcrumb trail, course navigation menu
494 * (previous/next activity), calendar, and search forum block.
495 * If the theme does not set characters, appropriate defaults
496 * are set automatically. Please DO NOT
497 * use &lt; &gt; &raquo; - these are confusing for blind users.
78946b9b
PS
498 */
499 public $rarrow = null;
500
501 /**
06844353 502 * @var string Accessibility: Left arrow-like character is
78946b9b
PS
503 * used in the breadcrumb trail, course navigation menu
504 * (previous/next activity), calendar, and search forum block.
505 * If the theme does not set characters, appropriate defaults
506 * are set automatically. Please DO NOT
507 * use &lt; &gt; &raquo; - these are confusing for blind users.
571fa828 508 */
78946b9b
PS
509 public $larrow = null;
510
7b2eff28
DB
511 /**
512 * @var string Accessibility: Up arrow-like character is used in
513 * the book heirarchical navigation.
514 * If the theme does not set characters, appropriate defaults
515 * are set automatically. Please DO NOT
516 * use ^ - this is confusing for blind users.
517 */
518 public $uarrow = null;
519
7a05bc92
JP
520 /**
521 * @var string Accessibility: Down arrow-like character.
522 * If the theme does not set characters, appropriate defaults
523 * are set automatically.
524 */
525 public $darrow = null;
526
03276af6 527 /**
76be40cc 528 * @var bool Some themes may want to disable ajax course editing.
03276af6
DM
529 */
530 public $enablecourseajax = true;
78946b9b 531
13725b37
PS
532 /**
533 * @var string Determines served document types
534 * - 'html5' the only officially supported doctype in Moodle
535 * - 'xhtml5' may be used in development for validation (not intended for production servers!)
536 * - 'xhtml' XHTML 1.0 Strict for legacy themes only
537 */
538 public $doctype = 'html5';
539
0f73f3ab 540 /**
9d1402ab 541 * @var string requiredblocks If set to a string, will list the block types that cannot be deleted. Defaults to
0f73f3ab
DW
542 * navigation and settings.
543 */
9d1402ab 544 public $requiredblocks = false;
0f73f3ab 545
78946b9b 546 //==Following properties are not configurable from theme config.php==
571fa828 547
fdeb7fa1 548 /**
76be40cc 549 * @var string The name of this theme. Set automatically when this theme is
78946b9b 550 * loaded. This can not be set in theme config.php
fdeb7fa1 551 */
78946b9b 552 public $name;
fdeb7fa1 553
554 /**
76be40cc 555 * @var string The folder where this themes files are stored. This is set
78946b9b 556 * automatically. This can not be set in theme config.php
fdeb7fa1 557 */
78946b9b 558 public $dir;
fdeb7fa1 559
560 /**
76be40cc 561 * @var stdClass Theme settings stored in config_plugins table.
78946b9b 562 * This can not be set in theme config.php
78946b9b 563 */
5dd40ec4 564 public $settings = null;
78946b9b 565
d2c394f3 566 /**
76be40cc 567 * @var bool If set to true and the theme enables the dock then blocks will be able
d2c394f3 568 * to be moved to the special dock
d2c394f3
SH
569 */
570 public $enable_dock = false;
571
4d56ee95 572 /**
76be40cc 573 * @var bool If set to true then this theme will not be shown in the theme selector unless
4d56ee95 574 * theme designer mode is turned on.
4d56ee95
SH
575 */
576 public $hidefromselector = false;
577
97dbc8f2
PS
578 /**
579 * @var array list of YUI CSS modules to be included on each page. This may be used
580 * to remove cssreset and use cssnormalise module instead.
581 */
582 public $yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase');
583
36b77e3a
SH
584 /**
585 * An associative array of block manipulations that should be made if the user is using an rtl language.
586 * The key is the original block region, and the value is the block region to change to.
587 * This is used when displaying blocks for regions only.
588 * @var array
589 */
e2ad11d8 590 public $blockrtlmanipulations = array();
36b77e3a 591
78946b9b 592 /**
76be40cc 593 * @var renderer_factory Instance of the renderer_factory implementation
fdeb7fa1 594 * we are using. Implementation detail.
595 */
596 protected $rf = null;
597
598 /**
76be40cc 599 * @var array List of parent config objects.
78946b9b
PS
600 **/
601 protected $parent_configs = array();
fdeb7fa1 602
436dbeec
SH
603 /**
604 * Used to determine whether we can serve SVG images or not.
605 * @var bool
606 */
607 private $usesvg = null;
608
1d987cae
FM
609 /**
610 * Whether in RTL mode or not.
611 * @var bool
612 */
613 protected $rtlmode = false;
614
d433cf37
FM
615 /**
616 * The LESS file to compile. When set, the theme will attempt to compile the file itself.
617 * @var bool
618 */
619 public $lessfile = false;
620
65b8336e 621 /**
41b973bc
FM
622 * The SCSS file to compile (without .scss), located in the scss/ folder of the theme.
623 * Or a Closure, which receives the theme_config as argument and must
624 * return the SCSS content. This setting takes precedence over self::$lessfile.
625 * @var string|Closure
626 */
627 public $scss = false;
628
629 /**
630 * Local cache of the SCSS property.
631 * @var false|array
65b8336e 632 */
41b973bc 633 protected $scsscache = null;
65b8336e 634
d433cf37
FM
635 /**
636 * The name of the function to call to get the LESS code to inject.
637 * @var string
638 */
639 public $extralesscallback = null;
640
65b8336e
FM
641 /**
642 * The name of the function to call to get the SCSS code to inject.
643 * @var string
644 */
645 public $extrascsscallback = null;
646
d433cf37
FM
647 /**
648 * The name of the function to call to get extra LESS variables.
649 * @var string
650 */
651 public $lessvariablescallback = null;
652
65b8336e 653 /**
258143e3 654 * The name of the function to call to get SCSS to prepend.
65b8336e
FM
655 * @var string
656 */
258143e3 657 public $prescsscallback = null;
65b8336e 658
225c418f
SH
659 /**
660 * Sets the render method that should be used for rendering custom block regions by scripts such as my/index.php
661 * Defaults to {@link core_renderer::blocks_for_region()}
662 * @var string
663 */
664 public $blockrendermethod = null;
665
a26ce248
DW
666 /**
667 * Remember the results of icon remapping for the current page.
668 * @var array
669 */
670 public $remapiconcache = [];
671
af9edb2e
BB
672 /**
673 * The name of the function to call to get precompiled CSS.
674 * @var string
675 */
676 public $precompiledcsscallback = null;
677
571fa828 678 /**
ebebf55c 679 * Load the config.php file for a particular theme, and return an instance
680 * of this class. (That is, this is a factory method.)
681 *
682 * @param string $themename the name of the theme.
683 * @return theme_config an instance of this class.
571fa828 684 */
ebebf55c 685 public static function load($themename) {
686 global $CFG;
571fa828 687
78946b9b
PS
688 // load theme settings from db
689 try {
690 $settings = get_config('theme_'.$themename);
691 } catch (dml_exception $e) {
da0c0e25 692 // most probably moodle tables not created yet
365a5941 693 $settings = new stdClass();
78946b9b 694 }
ebebf55c 695
78946b9b
PS
696 if ($config = theme_config::find_theme_config($themename, $settings)) {
697 return new theme_config($config);
5f0baa43
PS
698
699 } else if ($themename == theme_config::DEFAULT_THEME) {
700 throw new coding_exception('Default theme '.theme_config::DEFAULT_THEME.' not available or broken!');
701
2211f504 702 } else if ($config = theme_config::find_theme_config($CFG->theme, $settings)) {
ea049ee6
TH
703 debugging('This page should be using theme ' . $themename .
704 ' which cannot be initialised. Falling back to the site theme ' . $CFG->theme, DEBUG_NORMAL);
2211f504
MA
705 return new theme_config($config);
706
78946b9b
PS
707 } else {
708 // bad luck, the requested theme has some problems - admin see details in theme config
ea049ee6
TH
709 debugging('This page should be using theme ' . $themename .
710 ' which cannot be initialised. Nor can the site theme ' . $CFG->theme .
711 '. Falling back to ' . theme_config::DEFAULT_THEME, DEBUG_NORMAL);
5f0baa43 712 return new theme_config(theme_config::find_theme_config(theme_config::DEFAULT_THEME, $settings));
78946b9b
PS
713 }
714 }
ebebf55c 715
78946b9b
PS
716 /**
717 * Theme diagnostic code. It is very problematic to send debug output
718 * to the actual CSS file, instead this functions is supposed to
ae5b6801 719 * diagnose given theme and highlights all potential problems.
78946b9b
PS
720 * This information should be available from the theme selection page
721 * or some other debug page for theme designers.
722 *
723 * @param string $themename
724 * @return array description of problems
725 */
726 public static function diagnose($themename) {
5ef719e7 727 //TODO: MDL-21108
78946b9b
PS
728 return array();
729 }
730
731 /**
732 * Private constructor, can be called only from the factory method.
733 * @param stdClass $config
734 */
735 private function __construct($config) {
736 global $CFG; //needed for included lib.php files
737
738 $this->settings = $config->settings;
739 $this->name = $config->name;
740 $this->dir = $config->dir;
741
644fcbb6
DW
742 if ($this->name != 'bootstrapbase') {
743 $baseconfig = theme_config::find_theme_config('bootstrapbase', $this->settings);
78946b9b
PS
744 } else {
745 $baseconfig = $config;
571fa828 746 }
ebebf55c 747
7b2eff28 748 $configurable = array(
0e9911e1 749 'parents', 'sheets', 'parents_exclude_sheets', 'plugins_exclude_sheets', 'usefallback',
7b2eff28 750 'javascripts', 'javascripts_footer', 'parents_exclude_javascripts',
9d1402ab 751 'layouts', 'enable_dock', 'enablecourseajax', 'requiredblocks',
7a05bc92 752 'rendererfactory', 'csspostprocess', 'editor_sheets', 'rarrow', 'larrow', 'uarrow', 'darrow',
7b2eff28 753 'hidefromselector', 'doctype', 'yuicssmodules', 'blockrtlmanipulations',
65b8336e 754 'lessfile', 'extralesscallback', 'lessvariablescallback', 'blockrendermethod',
af9edb2e
BB
755 'scss', 'extrascsscallback', 'prescsscallback', 'csstreepostprocessor', 'addblockposition',
756 'iconsystem', 'precompiledcsscallback');
ebebf55c 757
78946b9b
PS
758 foreach ($config as $key=>$value) {
759 if (in_array($key, $configurable)) {
760 $this->$key = $value;
761 }
762 }
763
764 // verify all parents and load configs and renderers
765 foreach ($this->parents as $parent) {
644fcbb6 766 if (!$parent_config = theme_config::find_theme_config($parent, $this->settings)) {
78946b9b
PS
767 // this is not good - better exclude faulty parents
768 continue;
769 }
770 $libfile = $parent_config->dir.'/lib.php';
771 if (is_readable($libfile)) {
772 // theme may store various function here
773 include_once($libfile);
774 }
775 $renderersfile = $parent_config->dir.'/renderers.php';
776 if (is_readable($renderersfile)) {
777 // may contain core and plugin renderers and renderer factory
778 include_once($renderersfile);
779 }
780 $this->parent_configs[$parent] = $parent_config;
78946b9b
PS
781 }
782 $libfile = $this->dir.'/lib.php';
783 if (is_readable($libfile)) {
784 // theme may store various function here
785 include_once($libfile);
786 }
787 $rendererfile = $this->dir.'/renderers.php';
788 if (is_readable($rendererfile)) {
789 // may contain core and plugin renderers and renderer factory
790 include_once($rendererfile);
6fc267a0
BJ
791 } else {
792 // check if renderers.php file is missnamed renderer.php
793 if (is_readable($this->dir.'/renderer.php')) {
794 debugging('Developer hint: '.$this->dir.'/renderer.php should be renamed to ' . $this->dir."/renderers.php.
11c0ecce 795 See: http://docs.moodle.org/dev/Output_renderers#Theme_renderers.", DEBUG_DEVELOPER);
6fc267a0 796 }
78946b9b 797 }
4399b9d5 798
78946b9b
PS
799 // cascade all layouts properly
800 foreach ($baseconfig->layouts as $layout=>$value) {
801 if (!isset($this->layouts[$layout])) {
802 foreach ($this->parent_configs as $parent_config) {
803 if (isset($parent_config->layouts[$layout])) {
804 $this->layouts[$layout] = $parent_config->layouts[$layout];
805 continue 2;
806 }
807 }
808 $this->layouts[$layout] = $value;
809 }
810 }
811
812 //fix arrows if needed
813 $this->check_theme_arrows();
571fa828 814 }
815
63c88397
PS
816 /**
817 * Let the theme initialise the page object (usually $PAGE).
818 *
819 * This may be used for example to request jQuery in add-ons.
820 *
821 * @param moodle_page $page
822 */
823 public function init_page(moodle_page $page) {
824 $themeinitfunction = 'theme_'.$this->name.'_page_init';
825 if (function_exists($themeinitfunction)) {
826 $themeinitfunction($page);
827 }
828 }
829
f8129210 830 /**
7a05bc92 831 * Checks if arrows $THEME->rarrow, $THEME->larrow, $THEME->uarrow, $THEME->darrow have been set (theme/-/config.php).
78946b9b
PS
832 * If not it applies sensible defaults.
833 *
834 * Accessibility: right and left arrow Unicode characters for breadcrumb, calendar,
835 * search forum block, etc. Important: these are 'silent' in a screen-reader
836 * (unlike &gt; &raquo;), and must be accompanied by text.
34a2777c 837 */
78946b9b
PS
838 private function check_theme_arrows() {
839 if (!isset($this->rarrow) and !isset($this->larrow)) {
840 // Default, looks good in Win XP/IE 6, Win/Firefox 1.5, Win/Netscape 8...
841 // Also OK in Win 9x/2K/IE 5.x
842 $this->rarrow = '&#x25BA;';
843 $this->larrow = '&#x25C4;';
7b2eff28 844 $this->uarrow = '&#x25B2;';
7a05bc92 845 $this->darrow = '&#x25BC;';
78946b9b
PS
846 if (empty($_SERVER['HTTP_USER_AGENT'])) {
847 $uagent = '';
ebebf55c 848 } else {
78946b9b
PS
849 $uagent = $_SERVER['HTTP_USER_AGENT'];
850 }
851 if (false !== strpos($uagent, 'Opera')
852 || false !== strpos($uagent, 'Mac')) {
853 // Looks good in Win XP/Mac/Opera 8/9, Mac/Firefox 2, Camino, Safari.
854 // Not broken in Mac/IE 5, Mac/Netscape 7 (?).
64489778
DP
855 $this->rarrow = '&#x25B6;&#xFE0E;';
856 $this->larrow = '&#x25C0;&#xFE0E;';
78946b9b 857 }
f04721e2 858 elseif ((false !== strpos($uagent, 'Konqueror'))
0179d6be
JF
859 || (false !== strpos($uagent, 'Android'))) {
860 // The fonts on Android don't include the characters required for this to work as expected.
861 // So we use the same ones Konqueror uses.
78946b9b
PS
862 $this->rarrow = '&rarr;';
863 $this->larrow = '&larr;';
7b2eff28 864 $this->uarrow = '&uarr;';
7a05bc92 865 $this->darrow = '&darr;';
78946b9b
PS
866 }
867 elseif (isset($_SERVER['HTTP_ACCEPT_CHARSET'])
868 && false === stripos($_SERVER['HTTP_ACCEPT_CHARSET'], 'utf-8')) {
869 // (Win/IE 5 doesn't set ACCEPT_CHARSET, but handles Unicode.)
870 // To be safe, non-Unicode browsers!
871 $this->rarrow = '&gt;';
872 $this->larrow = '&lt;';
7b2eff28 873 $this->uarrow = '^';
7a05bc92 874 $this->darrow = 'v';
78946b9b
PS
875 }
876
f8129210 877 // RTL support - in RTL languages, swap r and l arrows
78946b9b
PS
878 if (right_to_left()) {
879 $t = $this->rarrow;
880 $this->rarrow = $this->larrow;
881 $this->larrow = $t;
ebebf55c 882 }
ebebf55c 883 }
78946b9b 884 }
ebebf55c 885
78946b9b
PS
886 /**
887 * Returns output renderer prefixes, these are used when looking
71c03ac1 888 * for the overridden renderers in themes.
473dd811 889 *
78946b9b
PS
890 * @return array
891 */
892 public function renderer_prefixes() {
893 global $CFG; // just in case the included files need it
894
596af93a 895 $prefixes = array('theme_'.$this->name);
78946b9b
PS
896
897 foreach ($this->parent_configs as $parent) {
898 $prefixes[] = 'theme_'.$parent->name;
899 }
900
901 return $prefixes;
34a2777c 902 }
903
571fa828 904 /**
78946b9b 905 * Returns the stylesheet URL of this editor content
473dd811 906 *
78946b9b 907 * @param bool $encoded false means use & and true use &amp; in URLs
1eb2b517 908 * @return moodle_url
571fa828 909 */
78946b9b
PS
910 public function editor_css_url($encoded=true) {
911 global $CFG;
78946b9b 912 $rev = theme_get_revision();
78946b9b 913 if ($rev > -1) {
bb8bb8e4
RW
914 $themesubrevision = theme_get_sub_revision_for_theme($this->name);
915
916 // Provide the sub revision to allow us to invalidate cached theme CSS
917 // on a per theme basis, rather than globally.
918 if ($themesubrevision && $themesubrevision > 0) {
919 $rev .= "_{$themesubrevision}";
920 }
921
7eb50b32 922 $url = new moodle_url("/theme/styles.php");
7070b7f2 923 if (!empty($CFG->slasharguments)) {
7070b7f2 924 $url->set_slashargument('/'.$this->name.'/'.$rev.'/editor', 'noparam', true);
7070b7f2 925 } else {
1eb2b517 926 $url->params(array('theme'=>$this->name,'rev'=>$rev, 'type'=>'editor'));
7070b7f2 927 }
78946b9b
PS
928 } else {
929 $params = array('theme'=>$this->name, 'type'=>'editor');
7eb50b32 930 $url = new moodle_url('/theme/styles_debug.php', $params);
571fa828 931 }
1eb2b517 932 return $url;
571fa828 933 }
934
935 /**
78946b9b 936 * Returns the content of the CSS to be used in editor content
473dd811 937 *
98245a84 938 * @return array
571fa828 939 */
71be124d 940 public function editor_css_files() {
71be124d 941 $files = array();
78946b9b 942
98245a84 943 // First editor plugins.
bd3b3bba 944 $plugins = core_component::get_plugin_list('editor');
78946b9b
PS
945 foreach ($plugins as $plugin=>$fulldir) {
946 $sheetfile = "$fulldir/editor_styles.css";
947 if (is_readable($sheetfile)) {
71be124d 948 $files['plugin_'.$plugin] = $sheetfile;
78946b9b
PS
949 }
950 }
98245a84
PS
951 // Then parent themes - base first, the immediate parent last.
952 foreach (array_reverse($this->parent_configs) as $parent_config) {
78946b9b
PS
953 if (empty($parent_config->editor_sheets)) {
954 continue;
955 }
956 foreach ($parent_config->editor_sheets as $sheet) {
ca194849 957 $sheetfile = "$parent_config->dir/style/$sheet.css";
78946b9b 958 if (is_readable($sheetfile)) {
71be124d 959 $files['parent_'.$parent_config->name.'_'.$sheet] = $sheetfile;
78946b9b
PS
960 }
961 }
962 }
98245a84 963 // Finally this theme.
78946b9b
PS
964 if (!empty($this->editor_sheets)) {
965 foreach ($this->editor_sheets as $sheet) {
71be124d 966 $sheetfile = "$this->dir/style/$sheet.css";
78946b9b 967 if (is_readable($sheetfile)) {
71be124d 968 $files['theme_'.$sheet] = $sheetfile;
78946b9b
PS
969 }
970 }
971 }
972
71be124d 973 return $files;
571fa828 974 }
975
976 /**
98245a84 977 * Get the stylesheet URL of this theme.
473dd811
SH
978 *
979 * @param moodle_page $page Not used... deprecated?
98245a84 980 * @return moodle_url[]
571fa828 981 */
efaa4c08 982 public function css_urls(moodle_page $page) {
78946b9b
PS
983 global $CFG;
984
985 $rev = theme_get_revision();
986
efaa4c08 987 $urls = array();
efaa4c08 988
383b89a1 989 $svg = $this->use_svg_icons();
06a9e103 990 $separate = (core_useragent::is_ie() && !core_useragent::check_ie_version('10'));
383b89a1 991
78946b9b 992 if ($rev > -1) {
1d987cae 993 $filename = right_to_left() ? 'all-rtl' : 'all';
7eb50b32 994 $url = new moodle_url("/theme/styles.php");
5dd40ec4
RW
995 $themesubrevision = theme_get_sub_revision_for_theme($this->name);
996
997 // Provide the sub revision to allow us to invalidate cached theme CSS
998 // on a per theme basis, rather than globally.
999 if ($themesubrevision && $themesubrevision > 0) {
1000 $rev .= "_{$themesubrevision}";
1001 }
1002
1eb2b517
SH
1003 if (!empty($CFG->slasharguments)) {
1004 $slashargs = '';
1005 if (!$svg) {
1006 // We add a simple /_s to the start of the path.
1007 // The underscore is used to ensure that it isn't a valid theme name.
1008 $slashargs .= '/_s'.$slashargs;
1009 }
1d987cae 1010 $slashargs .= '/'.$this->name.'/'.$rev.'/'.$filename;
1eb2b517
SH
1011 if ($separate) {
1012 $slashargs .= '/chunk0';
1013 }
1014 $url->set_slashargument($slashargs, 'noparam', true);
537740cb 1015 } else {
e584e6ae 1016 $params = array('theme' => $this->name, 'rev' => $rev, 'type' => $filename);
1eb2b517
SH
1017 if (!$svg) {
1018 // We add an SVG param so that we know not to serve SVG images.
1019 // We do this because all modern browsers support SVG and this param will one day be removed.
1020 $params['svg'] = '0';
7070b7f2 1021 }
1eb2b517
SH
1022 if ($separate) {
1023 $params['chunk'] = '0';
1024 }
1025 $url->params($params);
78946b9b 1026 }
1eb2b517
SH
1027 $urls[] = $url;
1028
78946b9b 1029 } else {
7eb50b32 1030 $baseurl = new moodle_url('/theme/styles_debug.php');
c09e1a2c 1031
08823e5f 1032 $css = $this->get_css_files(true);
383b89a1
SH
1033 if (!$svg) {
1034 // We add an SVG param so that we know not to serve SVG images.
1035 // We do this because all modern browsers support SVG and this param will one day be removed.
1036 $baseurl->param('svg', '0');
1037 }
1d987cae
FM
1038 if (right_to_left()) {
1039 $baseurl->param('rtl', 1);
1040 }
06a9e103
FM
1041 if ($separate) {
1042 // We might need to chunk long files.
1043 $baseurl->param('chunk', '0');
1044 }
378b3eac 1045 if (core_useragent::is_ie()) {
98245a84 1046 // Lalala, IE does not allow more than 31 linked CSS files from main document.
71be124d 1047 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'plugins'));
a6338a13 1048 foreach ($css['parents'] as $parent=>$sheets) {
98245a84 1049 // We need to serve parents individually otherwise we may easily exceed the style limit IE imposes (4096).
71be124d 1050 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'ie', 'subtype'=>'parents', 'sheet'=>$parent));
a6338a13 1051 }
41b973bc 1052 if ($this->get_scss_property()) {
65b8336e
FM
1053 // No need to define the type as IE here.
1054 $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'scss'));
1055 } else if (!empty($this->lessfile)) {
08823e5f 1056 // No need to define the type as IE here.
06a9e103 1057 $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'less'));
29d73d27 1058 }
71be124d 1059 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name, 'type'=>'ie', 'subtype'=>'theme'));
c09e1a2c
PS
1060
1061 } else {
1062 foreach ($css['plugins'] as $plugin=>$unused) {
1063 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'plugin', 'subtype'=>$plugin));
1064 }
1065 foreach ($css['parents'] as $parent=>$sheets) {
1066 foreach ($sheets as $sheet=>$unused2) {
1067 $urls[] = new moodle_url($baseurl, array('theme'=>$this->name,'type'=>'parent', 'subtype'=>$parent, 'sheet'=>$sheet));
1068 }
1069 }
08823e5f 1070 foreach ($css['theme'] as $sheet => $filename) {
41b973bc 1071 if ($sheet === self::SCSS_KEY) {
65b8336e
FM
1072 // This is the theme SCSS file.
1073 $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'scss'));
1074 } else if ($sheet === $this->lessfile) {
08823e5f
FM
1075 // This is the theme LESS file.
1076 $urls[] = new moodle_url($baseurl, array('theme' => $this->name, 'type' => 'less'));
1077 } else {
d433cf37
FM
1078 // Sheet first in order to make long urls easier to read.
1079 $urls[] = new moodle_url($baseurl, array('sheet'=>$sheet, 'theme'=>$this->name, 'type'=>'theme'));
c09e1a2c 1080 }
78946b9b 1081 }
78946b9b 1082 }
78946b9b 1083 }
efaa4c08
PS
1084
1085 return $urls;
571fa828 1086 }
34a2777c 1087
ebebf55c 1088 /**
98245a84 1089 * Get the whole css stylesheet for production mode.
473dd811 1090 *
31f28b6a
1091 * NOTE: this method is not expected to be used from any addons.
1092 *
d52ebf11 1093 * @return string CSS markup compressed
98245a84
PS
1094 */
1095 public function get_css_content() {
98245a84
PS
1096
1097 $csscontent = '';
08823e5f
FM
1098 foreach ($this->get_css_files(false) as $type => $value) {
1099 foreach ($value as $identifier => $val) {
98245a84
PS
1100 if (is_array($val)) {
1101 foreach ($val as $v) {
1102 $csscontent .= file_get_contents($v) . "\n";
1103 }
1104 } else {
41b973bc 1105 if ($type === 'theme' && $identifier === self::SCSS_KEY) {
65b8336e 1106 // We need the content from SCSS because this is the SCSS file from the theme.
af9edb2e
BB
1107 if ($compiled = $this->get_css_content_from_scss(false)) {
1108 $csscontent .= $compiled;
1109 } else {
1110 // The compiler failed so default back to any precompiled css that might
1111 // exist.
1112 $csscontent .= $this->get_precompiled_css_content();
1113 }
65b8336e 1114 } else if ($type === 'theme' && $identifier === $this->lessfile) {
08823e5f
FM
1115 // We need the content from LESS because this is the LESS file from the theme.
1116 $csscontent .= $this->get_css_content_from_less(false);
d433cf37
FM
1117 } else {
1118 $csscontent .= file_get_contents($val) . "\n";
98245a84 1119 }
98245a84
PS
1120 }
1121 }
1122 }
1123 $csscontent = $this->post_process($csscontent);
d52ebf11 1124 $csscontent = core_minify::css($csscontent);
98245a84
PS
1125
1126 return $csscontent;
1127 }
4cc2f33b
SL
1128 /**
1129 * Set post processed CSS content cache.
1130 *
1131 * @param string $csscontent The post processed CSS content.
1132 * @return bool True if the content was successfully cached.
1133 */
1134 public function set_css_content_cache($csscontent) {
1135
1136 $cache = cache::make('core', 'postprocessedcss');
1137 $key = $this->get_css_cache_key();
1138
1139 return $cache->set($key, $csscontent);
1140 }
1141
0e9911e1
AN
1142 /**
1143 * Return whether the post processed CSS content has been cached.
1144 *
1145 * @return bool Whether the post-processed CSS is available in the cache.
1146 */
1147 public function has_css_cached_content() {
1148
1149 $key = $this->get_css_cache_key();
1150 $cache = cache::make('core', 'postprocessedcss');
1151
1152 return $cache->has($key);
1153 }
1154
4cc2f33b
SL
1155 /**
1156 * Return cached post processed CSS content.
1157 *
1158 * @return bool|string The cached css content or false if not found.
1159 */
1160 public function get_css_cached_content() {
1161
1162 $key = $this->get_css_cache_key();
1163 $cache = cache::make('core', 'postprocessedcss');
1164
1165 return $cache->get($key);
1166 }
1167
1168 /**
1169 * Generate the css content cache key.
1170 *
1171 * @return string The post processed css cache key.
1172 */
1173 public function get_css_cache_key() {
1174 $nosvg = (!$this->use_svg_icons()) ? 'nosvg_' : '';
1175 $rtlmode = ($this->rtlmode == true) ? 'rtl' : 'ltr';
1176
1177 return $nosvg . $this->name . '_' . $rtlmode;
1178 }
98245a84
PS
1179
1180 /**
1181 * Get the theme designer css markup,
1182 * the parameters are coming from css_urls().
1183 *
31f28b6a
1184 * NOTE: this method is not expected to be used from any addons.
1185 *
98245a84
PS
1186 * @param string $type
1187 * @param string $subtype
1188 * @param string $sheet
1189 * @return string CSS markup
ebebf55c 1190 */
98245a84 1191 public function get_css_content_debug($type, $subtype, $sheet) {
98245a84 1192
65b8336e
FM
1193 if ($type === 'scss') {
1194 // The SCSS file of the theme is requested.
1195 $csscontent = $this->get_css_content_from_scss(true);
1196 if ($csscontent !== false) {
1d987cae 1197 return $this->post_process($csscontent);
65b8336e
FM
1198 }
1199 return '';
1200 } else if ($type === 'less') {
1201 // The LESS file of the theme is requested.
08823e5f
FM
1202 $csscontent = $this->get_css_content_from_less(true);
1203 if ($csscontent !== false) {
1d987cae 1204 return $this->post_process($csscontent);
08823e5f
FM
1205 }
1206 return '';
1207 }
1208
98245a84
PS
1209 $cssfiles = array();
1210 $css = $this->get_css_files(true);
1211
1212 if ($type === 'ie') {
1213 // IE is a sloppy browser with weird limits, sorry.
1214 if ($subtype === 'plugins') {
1215 $cssfiles = $css['plugins'];
1216
1217 } else if ($subtype === 'parents') {
1218 if (empty($sheet)) {
1219 // Do not bother with the empty parent here.
1220 } else {
1221 // Build up the CSS for that parent so we can serve it as one file.
1222 foreach ($css[$subtype][$sheet] as $parent => $css) {
1223 $cssfiles[] = $css;
1224 }
1225 }
1226 } else if ($subtype === 'theme') {
1227 $cssfiles = $css['theme'];
da283760 1228 foreach ($cssfiles as $key => $value) {
41b973bc 1229 if (in_array($key, [$this->lessfile, self::SCSS_KEY])) {
65b8336e
FM
1230 // Remove the LESS/SCSS file from the theme CSS files.
1231 // The LESS/SCSS files use the type 'less' or 'scss', not 'ie'.
da283760
FM
1232 unset($cssfiles[$key]);
1233 }
1234 }
98245a84
PS
1235 }
1236
1237 } else if ($type === 'plugin') {
1238 if (isset($css['plugins'][$subtype])) {
1239 $cssfiles[] = $css['plugins'][$subtype];
1240 }
1241
1242 } else if ($type === 'parent') {
1243 if (isset($css['parents'][$subtype][$sheet])) {
1244 $cssfiles[] = $css['parents'][$subtype][$sheet];
1245 }
1246
1247 } else if ($type === 'theme') {
1248 if (isset($css['theme'][$sheet])) {
1249 $cssfiles[] = $css['theme'][$sheet];
1250 }
1251 }
1252
1253 $csscontent = '';
1254 foreach ($cssfiles as $file) {
1255 $contents = file_get_contents($file);
1256 $contents = $this->post_process($contents);
1257 $comment = "/** Path: $type $subtype $sheet.' **/\n";
1258 $stats = '';
98245a84
PS
1259 $csscontent .= $comment.$stats.$contents."\n\n";
1260 }
1261
1262 return $csscontent;
1263 }
1264
1265 /**
1266 * Get the whole css stylesheet for editor iframe.
31f28b6a
1267 *
1268 * NOTE: this method is not expected to be used from any addons.
1269 *
98245a84
PS
1270 * @return string CSS markup
1271 */
1272 public function get_css_content_editor() {
1273 // Do not bother to optimise anything here, just very basic stuff.
1274 $cssfiles = $this->editor_css_files();
1275 $css = '';
1276 foreach ($cssfiles as $file) {
1277 $css .= file_get_contents($file)."\n";
1278 }
1279 return $this->post_process($css);
1280 }
1281
1282 /**
1283 * Returns an array of organised CSS files required for this output.
1284 *
1285 * @param bool $themedesigner
1286 * @return array nested array of file paths
1287 */
1288 protected function get_css_files($themedesigner) {
1289 global $CFG;
1290
1291 $cache = null;
08823e5f 1292 $cachekey = 'cssfiles';
98245a84
PS
1293 if ($themedesigner) {
1294 require_once($CFG->dirroot.'/lib/csslib.php');
1295 // We need some kind of caching here because otherwise the page navigation becomes
1296 // way too slow in theme designer mode. Feel free to create full cache definition later...
1297 $cache = cache::make_from_params(cache_store::MODE_APPLICATION, 'core', 'themedesigner', array('theme' => $this->name));
d433cf37 1298 if ($files = $cache->get($cachekey)) {
98245a84
PS
1299 if ($files['created'] > time() - THEME_DESIGNER_CACHE_LIFETIME) {
1300 unset($files['created']);
1301 return $files;
1302 }
1303 }
1304 }
1305
045f492c 1306 $cssfiles = array('plugins'=>array(), 'parents'=>array(), 'theme'=>array());
78946b9b 1307
98245a84 1308 // Get all plugin sheets.
045f492c 1309 $excludes = $this->resolve_excludes('plugins_exclude_sheets');
78946b9b 1310 if ($excludes !== true) {
46f6f7f2 1311 foreach (core_component::get_plugin_types() as $type=>$unused) {
045f492c 1312 if ($type === 'theme' || (!empty($excludes[$type]) and $excludes[$type] === true)) {
78946b9b
PS
1313 continue;
1314 }
bd3b3bba 1315 $plugins = core_component::get_plugin_list($type);
78946b9b
PS
1316 foreach ($plugins as $plugin=>$fulldir) {
1317 if (!empty($excludes[$type]) and is_array($excludes[$type])
22c5c6e6 1318 and in_array($plugin, $excludes[$type])) {
78946b9b
PS
1319 continue;
1320 }
f8bb9666 1321
08823e5f 1322 // Get the CSS from the plugin.
78946b9b
PS
1323 $sheetfile = "$fulldir/styles.css";
1324 if (is_readable($sheetfile)) {
045f492c 1325 $cssfiles['plugins'][$type.'_'.$plugin] = $sheetfile;
f8bb9666 1326 }
22c5c6e6
FM
1327
1328 // Create a list of candidate sheets from parents (direct parent last) and current theme.
1329 $candidates = array();
1330 foreach (array_reverse($this->parent_configs) as $parent_config) {
1331 $candidates[] = $parent_config->name;
f8bb9666 1332 }
22c5c6e6
FM
1333 $candidates[] = $this->name;
1334
1335 // Add the sheets found.
1336 foreach ($candidates as $candidate) {
1337 $sheetthemefile = "$fulldir/styles_{$candidate}.css";
1338 if (is_readable($sheetthemefile)) {
1339 $cssfiles['plugins'][$type.'_'.$plugin.'_'.$candidate] = $sheetthemefile;
1340 }
78946b9b
PS
1341 }
1342 }
1343 }
22c5c6e6 1344 }
34a2777c 1345
98245a84 1346 // Find out wanted parent sheets.
045f492c 1347 $excludes = $this->resolve_excludes('parents_exclude_sheets');
78946b9b 1348 if ($excludes !== true) {
98245a84 1349 foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
78946b9b 1350 $parent = $parent_config->name;
045f492c 1351 if (empty($parent_config->sheets) || (!empty($excludes[$parent]) and $excludes[$parent] === true)) {
78946b9b
PS
1352 continue;
1353 }
1354 foreach ($parent_config->sheets as $sheet) {
d433cf37
FM
1355 if (!empty($excludes[$parent]) && is_array($excludes[$parent])
1356 && in_array($sheet, $excludes[$parent])) {
78946b9b
PS
1357 continue;
1358 }
d433cf37
FM
1359
1360 // We never refer to the parent LESS files.
78946b9b
PS
1361 $sheetfile = "$parent_config->dir/style/$sheet.css";
1362 if (is_readable($sheetfile)) {
045f492c 1363 $cssfiles['parents'][$parent][$sheet] = $sheetfile;
78946b9b
PS
1364 }
1365 }
1366 }
1367 }
34a2777c 1368
41b973bc 1369
d433cf37 1370 // Current theme sheets and less file.
65b8336e 1371 // We first add the SCSS, or LESS file because we want the CSS ones to
41b973bc 1372 // be included after the SCSS/LESS code. However, if both the LESS file
65b8336e 1373 // and a CSS file share the same name, the CSS file is ignored.
41b973bc
FM
1374 if ($this->get_scss_property()) {
1375 $cssfiles['theme'][self::SCSS_KEY] = true;
65b8336e 1376 } else if (!empty($this->lessfile)) {
d433cf37
FM
1377 $sheetfile = "{$this->dir}/less/{$this->lessfile}.less";
1378 if (is_readable($sheetfile)) {
1379 $cssfiles['theme'][$this->lessfile] = $sheetfile;
1380 }
1381 }
78946b9b
PS
1382 if (is_array($this->sheets)) {
1383 foreach ($this->sheets as $sheet) {
1384 $sheetfile = "$this->dir/style/$sheet.css";
d433cf37 1385 if (is_readable($sheetfile) && !isset($cssfiles['theme'][$sheet])) {
045f492c 1386 $cssfiles['theme'][$sheet] = $sheetfile;
78946b9b 1387 }
ebebf55c 1388 }
78946b9b
PS
1389 }
1390
98245a84
PS
1391 if ($cache) {
1392 $files = $cssfiles;
1393 $files['created'] = time();
d433cf37 1394 $cache->set($cachekey, $files);
045f492c 1395 }
98245a84
PS
1396 return $cssfiles;
1397 }
e68c5f36 1398
d433cf37 1399 /**
08823e5f 1400 * Return the CSS content generated from LESS the file.
d433cf37
FM
1401 *
1402 * @param bool $themedesigner True if theme designer is enabled.
1403 * @return bool|string Return false when the compilation failed. Else the compiled string.
1404 */
1405 protected function get_css_content_from_less($themedesigner) {
a75f1dbc 1406 global $CFG;
d433cf37
FM
1407
1408 $lessfile = $this->lessfile;
1409 if (!$lessfile || !is_readable($this->dir . '/less/' . $lessfile . '.less')) {
1410 throw new coding_exception('The theme did not define a LESS file, or it is not readable.');
1411 }
1412
1081de20 1413 // We might need more memory/time to do this, so let's play safe.
d433cf37 1414 raise_memory_limit(MEMORY_EXTRA);
1081de20 1415 core_php_time_limit::raise(300);
d433cf37
FM
1416
1417 // Files list.
08823e5f 1418 $files = $this->get_css_files($themedesigner);
d433cf37 1419
08823e5f
FM
1420 // Get the LESS file path.
1421 $themelessfile = $files['theme'][$lessfile];
d433cf37 1422
5d504395
AN
1423 // Setup compiler options.
1424 $options = array(
d433cf37 1425 // We need to set the import directory to where $lessfile is.
08823e5f 1426 'import_dirs' => array(dirname($themelessfile) => '/'),
d433cf37
FM
1427 // Always disable default caching.
1428 'cache_method' => false,
1429 // Disable the relative URLs, we have post_process() to handle that.
1430 'relativeUrls' => false,
5d504395
AN
1431 );
1432
1433 if ($themedesigner) {
1434 // Add the sourceMap inline to ensure that it is atomically generated.
1435 $options['sourceMap'] = true;
a75f1dbc
DM
1436 $options['sourceMapBasepath'] = $CFG->dirroot;
1437 $options['sourceMapRootpath'] = $CFG->wwwroot;
5d504395
AN
1438 }
1439
1440 // Instantiate the compiler.
1441 $compiler = new core_lessc($options);
d433cf37
FM
1442
1443 try {
08823e5f 1444 $compiler->parse_file_content($themelessfile);
d433cf37
FM
1445
1446 // Get the callbacks.
1447 $compiler->parse($this->get_extra_less_code());
1448 $compiler->ModifyVars($this->get_less_variables());
1449
1450 // Compile the CSS.
1451 $compiled = $compiler->getCss();
1452
d433cf37
FM
1453 } catch (Less_Exception_Parser $e) {
1454 $compiled = false;
1455 debugging('Error while compiling LESS ' . $lessfile . ' file: ' . $e->getMessage(), DEBUG_DEVELOPER);
1456 }
1457
1458 // Try to save memory.
1459 $compiler = null;
1460 unset($compiler);
1461
1462 return $compiled;
1463 }
1464
65b8336e
FM
1465 /**
1466 * Return the CSS content generated from the SCSS file.
1467 *
1468 * @param bool $themedesigner True if theme designer is enabled.
1469 * @return bool|string Return false when the compilation failed. Else the compiled string.
1470 */
1471 protected function get_css_content_from_scss($themedesigner) {
1472 global $CFG;
1473
41b973bc
FM
1474 list($paths, $scss) = $this->get_scss_property();
1475 if (!$scss) {
65b8336e
FM
1476 throw new coding_exception('The theme did not define a SCSS file, or it is not readable.');
1477 }
1478
1081de20 1479 // We might need more memory/time to do this, so let's play safe.
65b8336e 1480 raise_memory_limit(MEMORY_EXTRA);
1081de20 1481 core_php_time_limit::raise(300);
65b8336e 1482
65b8336e
FM
1483 // Set-up the compiler.
1484 $compiler = new core_scss();
258143e3 1485 $compiler->prepend_raw_scss($this->get_pre_scss_code());
41b973bc
FM
1486 if (is_string($scss)) {
1487 $compiler->set_file($scss);
1488 } else {
1489 $compiler->append_raw_scss($scss($this));
1490 $compiler->setImportPaths($paths);
1491 }
65b8336e 1492 $compiler->append_raw_scss($this->get_extra_scss_code());
65b8336e
FM
1493
1494 try {
1495 // Compile!
1496 $compiled = $compiler->to_css();
65b8336e 1497
eadebb24 1498 } catch (\Exception $e) {
65b8336e 1499 $compiled = false;
41b973bc 1500 debugging('Error while compiling SCSS: ' . $e->getMessage(), DEBUG_DEVELOPER);
65b8336e
FM
1501 }
1502
1503 // Try to save memory.
1504 $compiler = null;
1505 unset($compiler);
1506
1507 return $compiled;
1508 }
1509
af9edb2e
BB
1510 /**
1511 * Return the precompiled CSS if the precompiledcsscallback exists.
1512 *
1513 * @return string Return compiled css.
1514 */
1515 public function get_precompiled_css_content() {
1516 $configs = [$this] + $this->parent_configs;
1517 $css = '';
1518
1519 foreach ($configs as $config) {
1520 if (isset($config->precompiledcsscallback)) {
1521 $function = $config->precompiledcsscallback;
1522 if (function_exists($function)) {
1523 $css .= $function($this);
1524 }
1525 }
1526 }
1527 return $css;
1528 }
1529
95b06c13
DW
1530 /**
1531 * Get the icon system to use.
1532 *
1533 * @return string
1534 */
1535 public function get_icon_system() {
1536
1537 // Getting all the candidate functions.
1538 $system = false;
1539 if (isset($this->iconsystem) && \core\output\icon_system::is_valid_system($this->iconsystem)) {
1540 return $this->iconsystem;
1541 }
1542 foreach ($this->parent_configs as $parent_config) {
1543 if (isset($parent_config->iconsystem) && \core\output\icon_system::is_valid_system($parent_config->iconsystem)) {
1544 return $parent_config->iconsystem;
1545 }
1546 }
8857c715 1547 return \core\output\icon_system::STANDARD;
95b06c13
DW
1548 }
1549
d433cf37
FM
1550 /**
1551 * Return extra LESS variables to use when compiling.
1552 *
1553 * @return array Where keys are the variable names (omitting the @), and the values are the value.
1554 */
1555 protected function get_less_variables() {
1556 $variables = array();
1557
1558 // Getting all the candidate functions.
1559 $candidates = array();
1560 foreach ($this->parent_configs as $parent_config) {
1561 if (!isset($parent_config->lessvariablescallback)) {
1562 continue;
1563 }
1564 $candidates[] = $parent_config->lessvariablescallback;
1565 }
1566 $candidates[] = $this->lessvariablescallback;
1567
1568 // Calling the functions.
1569 foreach ($candidates as $function) {
1570 if (function_exists($function)) {
1571 $vars = $function($this);
1572 if (!is_array($vars)) {
1573 debugging('Callback ' . $function . ' did not return an array() as expected', DEBUG_DEVELOPER);
1574 continue;
1575 }
1576 $variables = array_merge($variables, $vars);
1577 }
1578 }
1579
1580 return $variables;
1581 }
1582
65b8336e 1583 /**
258143e3
FM
1584 * Return extra LESS code to add when compiling.
1585 *
1586 * This is intended to be used by themes to inject some LESS code
1587 * before it gets compiled. If you want to inject variables you
1588 * should use {@link self::get_less_variables()}.
65b8336e 1589 *
258143e3 1590 * @return string The LESS code to inject.
65b8336e 1591 */
258143e3
FM
1592 protected function get_extra_less_code() {
1593 $content = '';
65b8336e
FM
1594
1595 // Getting all the candidate functions.
1596 $candidates = array();
1597 foreach ($this->parent_configs as $parent_config) {
258143e3 1598 if (!isset($parent_config->extralesscallback)) {
65b8336e
FM
1599 continue;
1600 }
258143e3 1601 $candidates[] = $parent_config->extralesscallback;
65b8336e 1602 }
258143e3 1603 $candidates[] = $this->extralesscallback;
65b8336e
FM
1604
1605 // Calling the functions.
1606 foreach ($candidates as $function) {
1607 if (function_exists($function)) {
258143e3 1608 $content .= "\n/** Extra LESS from $function **/\n" . $function($this) . "\n";
65b8336e
FM
1609 }
1610 }
1611
258143e3 1612 return $content;
65b8336e
FM
1613 }
1614
d433cf37 1615 /**
258143e3 1616 * Return extra SCSS code to add when compiling.
d433cf37 1617 *
258143e3 1618 * This is intended to be used by themes to inject some SCSS code
d433cf37 1619 * before it gets compiled. If you want to inject variables you
258143e3 1620 * should use {@link self::get_scss_variables()}.
d433cf37 1621 *
258143e3 1622 * @return string The SCSS code to inject.
d433cf37 1623 */
258143e3 1624 protected function get_extra_scss_code() {
d433cf37
FM
1625 $content = '';
1626
1627 // Getting all the candidate functions.
1628 $candidates = array();
1629 foreach ($this->parent_configs as $parent_config) {
258143e3 1630 if (!isset($parent_config->extrascsscallback)) {
d433cf37
FM
1631 continue;
1632 }
258143e3 1633 $candidates[] = $parent_config->extrascsscallback;
d433cf37 1634 }
258143e3 1635 $candidates[] = $this->extrascsscallback;
d433cf37
FM
1636
1637 // Calling the functions.
1638 foreach ($candidates as $function) {
1639 if (function_exists($function)) {
258143e3 1640 $content .= "\n/** Extra SCSS from $function **/\n" . $function($this) . "\n";
d433cf37
FM
1641 }
1642 }
1643
1644 return $content;
1645 }
1646
65b8336e 1647 /**
258143e3 1648 * SCSS code to prepend when compiling.
65b8336e 1649 *
258143e3 1650 * This is intended to be used by themes to inject SCSS code before it gets compiled.
65b8336e
FM
1651 *
1652 * @return string The SCSS code to inject.
1653 */
258143e3 1654 protected function get_pre_scss_code() {
65b8336e
FM
1655 $content = '';
1656
1657 // Getting all the candidate functions.
1658 $candidates = array();
1659 foreach ($this->parent_configs as $parent_config) {
258143e3 1660 if (!isset($parent_config->prescsscallback)) {
65b8336e
FM
1661 continue;
1662 }
258143e3 1663 $candidates[] = $parent_config->prescsscallback;
65b8336e 1664 }
258143e3 1665 $candidates[] = $this->prescsscallback;
65b8336e
FM
1666
1667 // Calling the functions.
1668 foreach ($candidates as $function) {
1669 if (function_exists($function)) {
258143e3 1670 $content .= "\n/** Pre-SCSS from $function **/\n" . $function($this) . "\n";
65b8336e
FM
1671 }
1672 }
1673
1674 return $content;
1675 }
1676
41b973bc
FM
1677 /**
1678 * Get the SCSS property.
1679 *
1680 * This resolves whether a SCSS file (or content) has to be used when generating
1681 * the stylesheet for the theme. It will look at parents themes and check the
1682 * SCSS properties there.
1683 *
1684 * @return False when SCSS is not used.
1685 * An array with the import paths, and the path to the SCSS file or Closure as second.
1686 */
1687 public function get_scss_property() {
1688 if ($this->scsscache === null) {
1689 $configs = [$this] + $this->parent_configs;
1690 $scss = null;
1691
1692 foreach ($configs as $config) {
1693 $path = "{$config->dir}/scss";
1694
1695 // We collect the SCSS property until we've found one.
1696 if (empty($scss) && !empty($config->scss)) {
1697 $candidate = is_string($config->scss) ? "{$path}/{$config->scss}.scss" : $config->scss;
1698 if ($candidate instanceof Closure) {
1699 $scss = $candidate;
1700 } else if (is_string($candidate) && is_readable($candidate)) {
1701 $scss = $candidate;
1702 }
1703 }
1704
1705 // We collect the import paths once we've found a SCSS property.
1706 if ($scss && is_dir($path)) {
1707 $paths[] = $path;
1708 }
1709
1710 }
1711
1712 $this->scsscache = $scss !== null ? [$paths, $scss] : false;
1713 }
1714
1715 return $this->scsscache;
1716 }
1717
e68c5f36 1718 /**
473dd811
SH
1719 * Generate a URL to the file that serves theme JavaScript files.
1720 *
d7656956
ARN
1721 * If we determine that the theme has no relevant files, then we return
1722 * early with a null value.
1723 *
71c03ac1 1724 * @param bool $inhead true means head url, false means footer
d7656956 1725 * @return moodle_url|null
e68c5f36 1726 */
baeb20bb 1727 public function javascript_url($inhead) {
e68c5f36
PS
1728 global $CFG;
1729
1730 $rev = theme_get_revision();
e68c5f36 1731 $params = array('theme'=>$this->name,'rev'=>$rev);
baeb20bb
PS
1732 $params['type'] = $inhead ? 'head' : 'footer';
1733
d7656956
ARN
1734 // Return early if there are no files to serve
1735 if (count($this->javascript_files($params['type'])) === 0) {
1736 return null;
1737 }
1738
ecbad2ad 1739 if (!empty($CFG->slasharguments) and $rev > 0) {
7eb50b32 1740 $url = new moodle_url("/theme/javascript.php");
ecbad2ad
PS
1741 $url->set_slashargument('/'.$this->name.'/'.$rev.'/'.$params['type'], 'noparam', true);
1742 return $url;
1743 } else {
7eb50b32 1744 return new moodle_url('/theme/javascript.php', $params);
ecbad2ad 1745 }
e68c5f36
PS
1746 }
1747
473dd811
SH
1748 /**
1749 * Get the URL's for the JavaScript files used by this theme.
1750 * They won't be served directly, instead they'll be mediated through
1751 * theme/javascript.php.
1752 *
1753 * @param string $type Either javascripts_footer, or javascripts
1754 * @return array
1755 */
045f492c
SH
1756 public function javascript_files($type) {
1757 if ($type === 'footer') {
1758 $type = 'javascripts_footer';
1759 } else {
f856106b 1760 $type = 'javascripts';
045f492c 1761 }
04c01408 1762
358c13cb
PS
1763 $js = array();
1764 // find out wanted parent javascripts
045f492c 1765 $excludes = $this->resolve_excludes('parents_exclude_javascripts');
358c13cb
PS
1766 if ($excludes !== true) {
1767 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
1768 $parent = $parent_config->name;
04c01408 1769 if (empty($parent_config->$type)) {
358c13cb
PS
1770 continue;
1771 }
1772 if (!empty($excludes[$parent]) and $excludes[$parent] === true) {
1773 continue;
1774 }
04c01408 1775 foreach ($parent_config->$type as $javascript) {
358c13cb
PS
1776 if (!empty($excludes[$parent]) and is_array($excludes[$parent])
1777 and in_array($javascript, $excludes[$parent])) {
1778 continue;
1779 }
1780 $javascriptfile = "$parent_config->dir/javascript/$javascript.js";
1781 if (is_readable($javascriptfile)) {
045f492c 1782 $js[] = $javascriptfile;
358c13cb
PS
1783 }
1784 }
1785 }
1786 }
1787
1788 // current theme javascripts
04c01408
PS
1789 if (is_array($this->$type)) {
1790 foreach ($this->$type as $javascript) {
358c13cb
PS
1791 $javascriptfile = "$this->dir/javascript/$javascript.js";
1792 if (is_readable($javascriptfile)) {
045f492c
SH
1793 $js[] = $javascriptfile;
1794 }
1795 }
1796 }
045f492c
SH
1797 return $js;
1798 }
1799
1800 /**
3d3fae72 1801 * Resolves an exclude setting to the themes setting is applicable or the
045f492c
SH
1802 * setting of its closest parent.
1803 *
1804 * @param string $variable The name of the setting the exclude setting to resolve
f8129210 1805 * @param string $default
045f492c
SH
1806 * @return mixed
1807 */
f8129210 1808 protected function resolve_excludes($variable, $default = null) {
045f492c
SH
1809 $setting = $default;
1810 if (is_array($this->{$variable}) or $this->{$variable} === true) {
1811 $setting = $this->{$variable};
1812 } else {
1813 foreach ($this->parent_configs as $parent_config) { // the immediate parent first, base last
1814 if (!isset($parent_config->{$variable})) {
1815 continue;
1816 }
1817 if (is_array($parent_config->{$variable}) or $parent_config->{$variable} === true) {
1818 $setting = $parent_config->{$variable};
1819 break;
358c13cb
PS
1820 }
1821 }
1822 }
045f492c
SH
1823 return $setting;
1824 }
358c13cb 1825
045f492c
SH
1826 /**
1827 * Returns the content of the one huge javascript file merged from all theme javascript files.
473dd811 1828 *
f8129210 1829 * @param bool $type
045f492c
SH
1830 * @return string
1831 */
1832 public function javascript_content($type) {
1833 $jsfiles = $this->javascript_files($type);
1834 $js = '';
1835 foreach ($jsfiles as $jsfile) {
1836 $js .= file_get_contents($jsfile)."\n";
1837 }
1838 return $js;
e68c5f36
PS
1839 }
1840
473dd811
SH
1841 /**
1842 * Post processes CSS.
1843 *
1844 * This method post processes all of the CSS before it is served for this theme.
1845 * This is done so that things such as image URL's can be swapped in and to
1846 * run any specific CSS post process method the theme has requested.
3d3fae72 1847 * This allows themes to use CSS settings.
473dd811
SH
1848 *
1849 * @param string $css The CSS to process.
1850 * @return string The processed CSS.
1851 */
045f492c 1852 public function post_process($css) {
78946b9b 1853 // now resolve all image locations
37824e73 1854 if (preg_match_all('/\[\[pix:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
78946b9b
PS
1855 $replaced = array();
1856 foreach ($matches as $match) {
1857 if (isset($replaced[$match[0]])) {
1858 continue;
1859 }
1860 $replaced[$match[0]] = true;
1861 $imagename = $match[2];
1862 $component = rtrim($match[1], '|');
663640f5 1863 $imageurl = $this->image_url($imagename, $component)->out(false);
df06c1c4 1864 // we do not need full url because the image.php is always in the same dir
9d473266 1865 $imageurl = preg_replace('|^http.?://[^/]+|', '', $imageurl);
df06c1c4 1866 $css = str_replace($match[0], $imageurl, $css);
ebebf55c 1867 }
34a2777c 1868 }
17a6649b 1869
9ba6076c 1870 // Now resolve all font locations.
37824e73 1871 if (preg_match_all('/\[\[font:([a-z0-9_]+\|)?([^\]]+)\]\]/', $css, $matches, PREG_SET_ORDER)) {
9ba6076c
PS
1872 $replaced = array();
1873 foreach ($matches as $match) {
1874 if (isset($replaced[$match[0]])) {
1875 continue;
1876 }
1877 $replaced[$match[0]] = true;
1878 $fontname = $match[2];
1879 $component = rtrim($match[1], '|');
1880 $fonturl = $this->font_url($fontname, $component)->out(false);
1881 // We do not need full url because the font.php is always in the same dir.
1882 $fonturl = preg_replace('|^http.?://[^/]+|', '', $fonturl);
1883 $css = str_replace($match[0], $fonturl, $css);
1884 }
1885 }
1886
dc48cc0a
AA
1887 // Now resolve all theme settings or do any other postprocessing.
1888 // This needs to be done before calling core parser, since the parser strips [[settings]] tags.
1889 $csspostprocess = $this->csspostprocess;
1890 if (function_exists($csspostprocess)) {
1891 $css = $csspostprocess($css, $this);
1892 }
1893
1d987cae 1894 // Post processing using an object representation of CSS.
493ef66e
FM
1895 $treeprocessor = $this->get_css_tree_post_processor();
1896 $needsparsing = !empty($treeprocessor) || !empty($this->rtlmode);
1d987cae 1897 if ($needsparsing) {
061a39ac 1898
1081de20 1899 // We might need more memory/time to do this, so let's play safe.
061a39ac 1900 raise_memory_limit(MEMORY_EXTRA);
1081de20 1901 core_php_time_limit::raise(300);
061a39ac 1902
1d987cae
FM
1903 $parser = new core_cssparser($css);
1904 $csstree = $parser->parse();
1905 unset($parser);
1d987cae 1906
d8f90ec6
FM
1907 if ($this->rtlmode) {
1908 $this->rtlize($csstree);
1909 }
1910
493ef66e
FM
1911 if ($treeprocessor) {
1912 $treeprocessor($csstree, $this);
d8f90ec6 1913 }
1d987cae 1914
1d987cae
FM
1915 $css = $csstree->render();
1916 unset($csstree);
1917 }
1918
78946b9b 1919 return $css;
ebebf55c 1920 }
17a6649b 1921
1d987cae
FM
1922 /**
1923 * Flip a stylesheet to RTL.
1924 *
1925 * @param Object $csstree The parsed CSS tree structure to flip.
1926 * @return void
1927 */
1928 protected function rtlize($csstree) {
1929 $rtlcss = new core_rtlcss($csstree);
1930 $rtlcss->flip();
1931 }
1932
ebebf55c 1933 /**
c266d256
DW
1934 * Return the direct URL for an image from the pix folder.
1935 *
1936 * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
78946b9b 1937 *
088598ba 1938 * @deprecated since Moodle 3.3
78946b9b 1939 * @param string $imagename the name of the icon.
f8129210 1940 * @param string $component specification of one plugin like in get_string()
78946b9b 1941 * @return moodle_url
fdeb7fa1 1942 */
c39e5ba2 1943 public function pix_url($imagename, $component) {
088598ba 1944 debugging('pix_url is deprecated. Use image_url for images and pix_icon for icons.', DEBUG_DEVELOPER);
c266d256
DW
1945 return $this->image_url($imagename, $component);
1946 }
1947
1948 /**
1949 * Return the direct URL for an image from the pix folder.
1950 *
1951 * Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
1952 *
1953 * @param string $imagename the name of the icon.
1954 * @param string $component specification of one plugin like in get_string()
1955 * @return moodle_url
1956 */
1957 public function image_url($imagename, $component) {
fdeb7fa1 1958 global $CFG;
78946b9b 1959
9d473266 1960 $params = array('theme'=>$this->name);
436dbeec 1961 $svg = $this->use_svg_icons();
9d473266
PS
1962
1963 if (empty($component) or $component === 'moodle' or $component === 'core') {
1964 $params['component'] = 'core';
1965 } else {
1966 $params['component'] = $component;
1967 }
78946b9b
PS
1968
1969 $rev = theme_get_revision();
1970 if ($rev != -1) {
1971 $params['rev'] = $rev;
1972 }
9d473266
PS
1973
1974 $params['image'] = $imagename;
1975
7eb50b32 1976 $url = new moodle_url("/theme/image.php");
9d473266 1977 if (!empty($CFG->slasharguments) and $rev > 0) {
436dbeec
SH
1978 $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['image'];
1979 if (!$svg) {
1980 // We add a simple /_s to the start of the path.
1981 // The underscore is used to ensure that it isn't a valid theme name.
1982 $path = '/_s'.$path;
1983 }
1984 $url->set_slashargument($path, 'noparam', true);
9d473266 1985 } else {
436dbeec
SH
1986 if (!$svg) {
1987 // We add an SVG param so that we know not to serve SVG images.
1988 // We do this because all modern browsers support SVG and this param will one day be removed.
1989 $params['svg'] = '0';
1990 }
1991 $url->params($params);
fdeb7fa1 1992 }
78946b9b 1993
9d473266 1994 return $url;
fdeb7fa1 1995 }
1996
9ba6076c
PS
1997 /**
1998 * Return the URL for a font
1999 *
2000 * @param string $font the name of the font (including extension).
2001 * @param string $component specification of one plugin like in get_string()
2002 * @return moodle_url
2003 */
2004 public function font_url($font, $component) {
2005 global $CFG;
2006
2007 $params = array('theme'=>$this->name);
2008
2009 if (empty($component) or $component === 'moodle' or $component === 'core') {
2010 $params['component'] = 'core';
2011 } else {
2012 $params['component'] = $component;
2013 }
2014
2015 $rev = theme_get_revision();
2016 if ($rev != -1) {
2017 $params['rev'] = $rev;
2018 }
2019
2020 $params['font'] = $font;
2021
7eb50b32 2022 $url = new moodle_url("/theme/font.php");
9ba6076c
PS
2023 if (!empty($CFG->slasharguments) and $rev > 0) {
2024 $path = '/'.$params['theme'].'/'.$params['component'].'/'.$params['rev'].'/'.$params['font'];
2025 $url->set_slashargument($path, 'noparam', true);
2026 } else {
2027 $url->params($params);
2028 }
2029
2030 return $url;
2031 }
2032
fe7b75f8
PS
2033 /**
2034 * Returns URL to the stored file via pluginfile.php.
2035 *
2036 * Note the theme must also implement pluginfile.php handler,
2037 * theme revision is used instead of the itemid.
2038 *
2039 * @param string $setting
2040 * @param string $filearea
2041 * @return string protocol relative URL or null if not present
2042 */
2043 public function setting_file_url($setting, $filearea) {
2044 global $CFG;
2045
2046 if (empty($this->settings->$setting)) {
2047 return null;
2048 }
2049
2050 $component = 'theme_'.$this->name;
2051 $itemid = theme_get_revision();
2052 $filepath = $this->settings->$setting;
2053 $syscontext = context_system::instance();
2054
2055 $url = moodle_url::make_file_url("$CFG->wwwroot/pluginfile.php", "/$syscontext->id/$component/$filearea/$itemid".$filepath);
2056
2057 // Now this is tricky because the we can not hardcode http or https here, lets use the relative link.
2058 // Note: unfortunately moodle_url does not support //urls yet.
2059
2060 $url = preg_replace('|^https?://|i', '//', $url->out(false));
2061
2062 return $url;
2063 }
2064
2065 /**
2066 * Serve the theme setting file.
2067 *
2068 * @param string $filearea
2069 * @param array $args
2070 * @param bool $forcedownload
2071 * @param array $options
2072 * @return bool may terminate if file not found or donotdie not specified
2073 */
2074 public function setting_file_serve($filearea, $args, $forcedownload, $options) {
2075 global $CFG;
2076 require_once("$CFG->libdir/filelib.php");
2077
2078 $syscontext = context_system::instance();
2079 $component = 'theme_'.$this->name;
2080
2081 $revision = array_shift($args);
2082 if ($revision < 0) {
2083 $lifetime = 0;
2084 } else {
2085 $lifetime = 60*60*24*60;
bb8ed60a
MS
2086 // By default, theme files must be cache-able by both browsers and proxies.
2087 if (!array_key_exists('cacheability', $options)) {
2088 $options['cacheability'] = 'public';
2089 }
fe7b75f8
PS
2090 }
2091
2092 $fs = get_file_storage();
2093 $relativepath = implode('/', $args);
2094
2095 $fullpath = "/{$syscontext->id}/{$component}/{$filearea}/0/{$relativepath}";
2096 $fullpath = rtrim($fullpath, '/');
2097 if ($file = $fs->get_file_by_hash(sha1($fullpath))) {
2098 send_stored_file($file, $lifetime, 0, $forcedownload, $options);
2099 return true;
2100 } else {
2101 send_file_not_found();
2102 }
2103 }
2104
fdeb7fa1 2105 /**
78946b9b 2106 * Resolves the real image location.
436dbeec
SH
2107 *
2108 * $svg was introduced as an arg in 2.4. It is important because not all supported browsers support the use of SVG
2109 * and we need a way in which to turn it off.
2110 * By default SVG won't be used unless asked for. This is done for two reasons:
2111 * 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
2112 * browser supports SVG.
2113 * 2. We only serve SVG images from locations we trust. This must NOT include any areas where the image may have been uploaded
2114 * by the user due to security concerns.
2115 *
78946b9b
PS
2116 * @param string $image name of image, may contain relative path
2117 * @param string $component
62306cdf
JD
2118 * @param bool $svg|null Should SVG images also be looked for? If null, resorts to $CFG->svgicons if that is set; falls back to
2119 * auto-detection of browser support otherwise
78946b9b 2120 * @return string full file path
fdeb7fa1 2121 */
436dbeec 2122 public function resolve_image_location($image, $component, $svg = false) {
78946b9b
PS
2123 global $CFG;
2124
436dbeec
SH
2125 if (!is_bool($svg)) {
2126 // If $svg isn't a bool then we need to decide for ourselves.
2127 $svg = $this->use_svg_icons();
2128 }
2129
78946b9b 2130 if ($component === 'moodle' or $component === 'core' or empty($component)) {
436dbeec 2131 if ($imagefile = $this->image_exists("$this->dir/pix_core/$image", $svg)) {
78946b9b
PS
2132 return $imagefile;
2133 }
2134 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
436dbeec 2135 if ($imagefile = $this->image_exists("$parent_config->dir/pix_core/$image", $svg)) {
78946b9b
PS
2136 return $imagefile;
2137 }
2138 }
436dbeec 2139 if ($imagefile = $this->image_exists("$CFG->dataroot/pix/$image", $svg)) {
f930cf6b
EM
2140 return $imagefile;
2141 }
436dbeec 2142 if ($imagefile = $this->image_exists("$CFG->dirroot/pix/$image", $svg)) {
78946b9b
PS
2143 return $imagefile;
2144 }
2145 return null;
2146
2147 } else if ($component === 'theme') { //exception
2148 if ($image === 'favicon') {
2149 return "$this->dir/pix/favicon.ico";
2150 }
436dbeec 2151 if ($imagefile = $this->image_exists("$this->dir/pix/$image", $svg)) {
78946b9b
PS
2152 return $imagefile;
2153 }
2154 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
436dbeec 2155 if ($imagefile = $this->image_exists("$parent_config->dir/pix/$image", $svg)) {
78946b9b
PS
2156 return $imagefile;
2157 }
2158 }
2159 return null;
2160
78946b9b
PS
2161 } else {
2162 if (strpos($component, '_') === false) {
2163 $component = 'mod_'.$component;
2164 }
2165 list($type, $plugin) = explode('_', $component, 2);
2166
436dbeec 2167 if ($imagefile = $this->image_exists("$this->dir/pix_plugins/$type/$plugin/$image", $svg)) {
78946b9b
PS
2168 return $imagefile;
2169 }
2170 foreach (array_reverse($this->parent_configs) as $parent_config) { // base first, the immediate parent last
436dbeec 2171 if ($imagefile = $this->image_exists("$parent_config->dir/pix_plugins/$type/$plugin/$image", $svg)) {
78946b9b
PS
2172 return $imagefile;
2173 }
2174 }
436dbeec 2175 if ($imagefile = $this->image_exists("$CFG->dataroot/pix_plugins/$type/$plugin/$image", $svg)) {
f930cf6b
EM
2176 return $imagefile;
2177 }
1c74b260 2178 $dir = core_component::get_plugin_directory($type, $plugin);
436dbeec 2179 if ($imagefile = $this->image_exists("$dir/pix/$image", $svg)) {
78946b9b
PS
2180 return $imagefile;
2181 }
2182 return null;
fdeb7fa1 2183 }
fdeb7fa1 2184 }
2185
9ba6076c
PS
2186 /**
2187 * Resolves the real font location.
2188 *
2189 * @param string $font name of font file
2190 * @param string $component
2191 * @return string full file path
2192 */
2193 public function resolve_font_location($font, $component) {
2194 global $CFG;
2195
2196 if ($component === 'moodle' or $component === 'core' or empty($component)) {
2197 if (file_exists("$this->dir/fonts_core/$font")) {
2198 return "$this->dir/fonts_core/$font";
2199 }
2200 foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
2201 if (file_exists("$parent_config->dir/fonts_core/$font")) {
2202 return "$parent_config->dir/fonts_core/$font";
2203 }
2204 }
2205 if (file_exists("$CFG->dataroot/fonts/$font")) {
2206 return "$CFG->dataroot/fonts/$font";
2207 }
2208 if (file_exists("$CFG->dirroot/lib/fonts/$font")) {
2209 return "$CFG->dirroot/lib/fonts/$font";
2210 }
2211 return null;
2212
2213 } else if ($component === 'theme') { // Exception.
2214 if (file_exists("$this->dir/fonts/$font")) {
2215 return "$this->dir/fonts/$font";
2216 }
2217 foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
2218 if (file_exists("$parent_config->dir/fonts/$font")) {
2219 return "$parent_config->dir/fonts/$font";
2220 }
2221 }
2222 return null;
2223
2224 } else {
2225 if (strpos($component, '_') === false) {
2226 $component = 'mod_'.$component;
2227 }
2228 list($type, $plugin) = explode('_', $component, 2);
2229
2230 if (file_exists("$this->dir/fonts_plugins/$type/$plugin/$font")) {
2231 return "$this->dir/fonts_plugins/$type/$plugin/$font";
2232 }
2233 foreach (array_reverse($this->parent_configs) as $parent_config) { // Base first, the immediate parent last.
2234 if (file_exists("$parent_config->dir/fonts_plugins/$type/$plugin/$font")) {
2235 return "$parent_config->dir/fonts_plugins/$type/$plugin/$font";
2236 }
2237 }
2238 if (file_exists("$CFG->dataroot/fonts_plugins/$type/$plugin/$font")) {
2239 return "$CFG->dataroot/fonts_plugins/$type/$plugin/$font";
2240 }
2241 $dir = core_component::get_plugin_directory($type, $plugin);
2242 if (file_exists("$dir/fonts/$font")) {
2243 return "$dir/fonts/$font";
2244 }
2245 return null;
2246 }
2247 }
2248
436dbeec
SH
2249 /**
2250 * Return true if we should look for SVG images as well.
2251 *
436dbeec
SH
2252 * @return bool
2253 */
2254 public function use_svg_icons() {
2255 global $CFG;
2256 if ($this->usesvg === null) {
c3d2fbf9 2257
ba2ad431 2258 if (!isset($CFG->svgicons)) {
c3d2fbf9 2259 $this->usesvg = core_useragent::supports_svg();
436dbeec
SH
2260 } else {
2261 // Force them on/off depending upon the setting.
ba2ad431 2262 $this->usesvg = (bool)$CFG->svgicons;
436dbeec
SH
2263 }
2264 }
2265 return $this->usesvg;
2266 }
2267
f7d6a556
SH
2268 /**
2269 * Forces the usesvg setting to either true or false, avoiding any decision making.
2270 *
2271 * This function should only ever be used when absolutely required, and before any generation of image URL's has occurred.
383b89a1 2272 * DO NOT ABUSE THIS FUNCTION... not that you'd want to right ;)
f7d6a556
SH
2273 *
2274 * @param bool $setting True to force the use of svg when available, null otherwise.
2275 */
383b89a1 2276 public function force_svg_use($setting) {
f7d6a556
SH
2277 $this->usesvg = (bool)$setting;
2278 }
2279
1d987cae
FM
2280 /**
2281 * Set to be in RTL mode.
2282 *
2283 * This will likely be used when post processing the CSS before serving it.
2284 *
2285 * @param bool $inrtl True when in RTL mode.
2286 */
2287 public function set_rtl_mode($inrtl = true) {
2288 $this->rtlmode = $inrtl;
2289 }
2290
0e9911e1
AN
2291 /**
2292 * Whether the theme is being served in RTL mode.
2293 *
2294 * @return bool True when in RTL mode.
2295 */
2296 public function get_rtl_mode() {
2297 return $this->rtlmode;
2298 }
2299
d4a03c00 2300 /**
78946b9b 2301 * Checks if file with any image extension exists.
473dd811 2302 *
436dbeec
SH
2303 * The order to these images was adjusted prior to the release of 2.4
2304 * At that point the were the following image counts in Moodle core:
2305 *
2306 * - png = 667 in pix dirs (1499 total)
2307 * - gif = 385 in pix dirs (606 total)
2308 * - jpg = 62 in pix dirs (74 total)
2309 * - jpeg = 0 in pix dirs (1 total)
2310 *
2311 * There is work in progress to move towards SVG presently hence that has been prioritiesed.
2312 *
78946b9b 2313 * @param string $filepath
436dbeec 2314 * @param bool $svg If set to true SVG images will also be looked for.
78946b9b 2315 * @return string image name with extension
d4a03c00 2316 */
436dbeec
SH
2317 private static function image_exists($filepath, $svg = false) {
2318 if ($svg && file_exists("$filepath.svg")) {
2319 return "$filepath.svg";
78946b9b
PS
2320 } else if (file_exists("$filepath.png")) {
2321 return "$filepath.png";
436dbeec
SH
2322 } else if (file_exists("$filepath.gif")) {
2323 return "$filepath.gif";
78946b9b
PS
2324 } else if (file_exists("$filepath.jpg")) {
2325 return "$filepath.jpg";
2326 } else if (file_exists("$filepath.jpeg")) {
2327 return "$filepath.jpeg";
d4a03c00 2328 } else {
78946b9b 2329 return false;
d4a03c00 2330 }
2331 }
2332
fdeb7fa1 2333 /**
78946b9b 2334 * Loads the theme config from config.php file.
473dd811 2335 *
78946b9b 2336 * @param string $themename
473dd811 2337 * @param stdClass $settings from config_plugins table
b0ec47fb 2338 * @param boolean $parentscheck true to also check the parents. .
473dd811 2339 * @return stdClass The theme configuration
fdeb7fa1 2340 */
b0ec47fb 2341 private static function find_theme_config($themename, $settings, $parentscheck = true) {
78946b9b
PS
2342 // We have to use the variable name $THEME (upper case) because that
2343 // is what is used in theme config.php files.
fdeb7fa1 2344
78946b9b
PS
2345 if (!$dir = theme_config::find_theme_location($themename)) {
2346 return null;
fdeb7fa1 2347 }
2f67a9b3 2348
365a5941 2349 $THEME = new stdClass();
78946b9b
PS
2350 $THEME->name = $themename;
2351 $THEME->dir = $dir;
2352 $THEME->settings = $settings;
2353
2354 global $CFG; // just in case somebody tries to use $CFG in theme config
2355 include("$THEME->dir/config.php");
2356
2357 // verify the theme configuration is OK
2358 if (!is_array($THEME->parents)) {
2359 // parents option is mandatory now
2360 return null;
b0ec47fb
JM
2361 } else {
2362 // We use $parentscheck to only check the direct parents (avoid infinite loop).
2363 if ($parentscheck) {
2364 // Find all parent theme configs.
2365 foreach ($THEME->parents as $parent) {
2366 $parentconfig = theme_config::find_theme_config($parent, $settings, false);
2367 if (empty($parentconfig)) {
2368 return null;
2369 }
2370 }
2371 }
fdeb7fa1 2372 }
2373
78946b9b 2374 return $THEME;
fdeb7fa1 2375 }
2376
d4a03c00 2377 /**
78946b9b
PS
2378 * Finds the theme location and verifies the theme has all needed files
2379 * and is not obsoleted.
473dd811 2380 *
78946b9b
PS
2381 * @param string $themename
2382 * @return string full dir path or null if not found
d4a03c00 2383 */
78946b9b
PS
2384 private static function find_theme_location($themename) {
2385 global $CFG;
2386
2387 if (file_exists("$CFG->dirroot/theme/$themename/config.php")) {
2388 $dir = "$CFG->dirroot/theme/$themename";
d4a03c00 2389
3dd1d7e7
DM
2390 } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$themename/config.php")) {
2391 $dir = "$CFG->themedir/$themename";
2392
7d875874 2393 } else {
78946b9b 2394 return null;
d4a03c00 2395 }
78946b9b
PS
2396
2397 if (file_exists("$dir/styles.php")) {
2398 //legacy theme - needs to be upgraded - upgrade info is displayed on the admin settings page
2399 return null;
2400 }
2f67a9b3 2401
78946b9b 2402 return $dir;
d4a03c00 2403 }
2404
1d13c75c 2405 /**
78946b9b 2406 * Get the renderer for a part of Moodle for this theme.
473dd811 2407 *
78946b9b 2408 * @param moodle_page $page the page we are rendering
f8129210 2409 * @param string $component the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
78946b9b 2410 * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
c927e35c 2411 * @param string $target one of rendering target constants
78946b9b 2412 * @return renderer_base the requested renderer.
1d13c75c 2413 */
c927e35c 2414 public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
78946b9b 2415 if (is_null($this->rf)) {
c927e35c 2416 $classname = $this->rendererfactory;
78946b9b 2417 $this->rf = new $classname($this);
1d13c75c 2418 }
78946b9b 2419
c927e35c 2420 return $this->rf->get_renderer($page, $component, $subtype, $target);
1d13c75c 2421 }
2422
fdeb7fa1 2423 /**
78946b9b 2424 * Get the information from {@link $layouts} for this type of page.
473dd811 2425 *
78946b9b
PS
2426 * @param string $pagelayout the the page layout name.
2427 * @return array the appropriate part of {@link $layouts}.
fdeb7fa1 2428 */
78946b9b
PS
2429 protected function layout_info_for_page($pagelayout) {
2430 if (array_key_exists($pagelayout, $this->layouts)) {
2431 return $this->layouts[$pagelayout];
2432 } else {
191b267b
PS
2433 debugging('Invalid page layout specified: ' . $pagelayout);
2434 return $this->layouts['standard'];
fdeb7fa1 2435 }
2436 }
2437
2438 /**
78946b9b
PS
2439 * Given the settings of this theme, and the page pagelayout, return the
2440 * full path of the page layout file to use.
2441 *
2442 * Used by {@link core_renderer::header()}.
2443 *
2444 * @param string $pagelayout the the page layout name.
2445 * @return string Full path to the lyout file to use
ebebf55c 2446 */
78946b9b 2447 public function layout_file($pagelayout) {
ebebf55c 2448 global $CFG;
fdeb7fa1 2449
78946b9b
PS
2450 $layoutinfo = $this->layout_info_for_page($pagelayout);
2451 $layoutfile = $layoutinfo['file'];
fdeb7fa1 2452
84db3ea2
SH
2453 if (array_key_exists('theme', $layoutinfo)) {
2454 $themes = array($layoutinfo['theme']);
2455 } else {
2456 $themes = array_merge(array($this->name),$this->parents);
2457 }
4399b9d5 2458
84db3ea2
SH
2459 foreach ($themes as $theme) {
2460 if ($dir = $this->find_theme_location($theme)) {
2461 $path = "$dir/layout/$layoutfile";
2462
2463 // Check the template exists, return general base theme template if not.
2464 if (is_readable($path)) {
2465 return $path;
2466 }
78946b9b 2467 }
34a2777c 2468 }
2469
191b267b 2470 debugging('Can not find layout file for: ' . $pagelayout);
78946b9b
PS
2471 // fallback to standard normal layout
2472 return "$CFG->dirroot/theme/base/layout/general.php";
2473 }
ebebf55c 2474
78946b9b
PS
2475 /**
2476 * Returns auxiliary page layout options specified in layout configuration array.
473dd811 2477 *
78946b9b
PS
2478 * @param string $pagelayout
2479 * @return array
2480 */
2481 public function pagelayout_options($pagelayout) {
2482 $info = $this->layout_info_for_page($pagelayout);
2483 if (!empty($info['options'])) {
2484 return $info['options'];
34a2777c 2485 }
78946b9b
PS
2486 return array();
2487 }
34a2777c 2488
78946b9b
PS
2489 /**
2490 * Inform a block_manager about the block regions this theme wants on this
2491 * page layout.
473dd811 2492 *
78946b9b
PS
2493 * @param string $pagelayout the general type of the page.
2494 * @param block_manager $blockmanager the block_manger to set up.
78946b9b
PS
2495 */
2496 public function setup_blocks($pagelayout, $blockmanager) {
2497 $layoutinfo = $this->layout_info_for_page($pagelayout);
2498 if (!empty($layoutinfo['regions'])) {
292dcf04 2499 $blockmanager->add_regions($layoutinfo['regions'], false);
78946b9b 2500 $blockmanager->set_default_region($layoutinfo['defaultregion']);
ebebf55c 2501 }
34a2777c 2502 }
2503
473dd811
SH
2504 /**
2505 * Gets the visible name for the requested block region.
2506 *
2507 * @param string $region The region name to get
2508 * @param string $theme The theme the region belongs to (may come from the parent theme)
2509 * @return string
2510 */
cadc0d28
TH
2511 protected function get_region_name($region, $theme) {
2512 $regionstring = get_string('region-' . $region, 'theme_' . $theme);
2513 // A name exists in this theme, so use it
2514 if (substr($regionstring, 0, 1) != '[') {
2515 return $regionstring;
2516 }
2517
2518 // Otherwise, try to find one elsewhere
2519 // Check parents, if any
2520 foreach ($this->parents as $parentthemename) {
2521 $regionstring = get_string('region-' . $region, 'theme_' . $parentthemename);
2522 if (substr($regionstring, 0, 1) != '[') {
2523 return $regionstring;
2524 }
2525 }
2526
644fcbb6
DW
2527 // Last resort, try the bootstrapbase theme for names
2528 return get_string('region-' . $region, 'theme_bootstrapbase');
cadc0d28
TH
2529 }
2530
ebebf55c 2531 /**
78946b9b 2532 * Get the list of all block regions known to this theme in all templates.
473dd811 2533 *
78946b9b 2534 * @return array internal region name => human readable name.
ebebf55c 2535 */
78946b9b
PS
2536 public function get_all_block_regions() {
2537 $regions = array();
78946b9b
PS
2538 foreach ($this->layouts as $layoutinfo) {
2539 foreach ($layoutinfo['regions'] as $region) {
a9535f79 2540 $regions[$region] = $this->get_region_name($region, $this->name);
ebebf55c 2541 }
34a2777c 2542 }
78946b9b 2543 return $regions;
34a2777c 2544 }
d609d962
SH
2545
2546 /**
2547 * Returns the human readable name of the theme
2548 *
2549 * @return string
2550 */
2551 public function get_theme_name() {
2552 return get_string('pluginname', 'theme_'.$this->name);
2553 }
225c418f
SH
2554
2555 /**
2556 * Returns the block render method.
2557 *
2558 * It is set by the theme via:
2559 * $THEME->blockrendermethod = '...';
2560 *
2561 * It can be one of two values, blocks or blocks_for_region.
2562 * It should be set to the method being used by the theme layouts.
2563 *
2564 * @return string
2565 */
2566 public function get_block_render_method() {
2567 if ($this->blockrendermethod) {
2568 // Return the specified block render method.
2569 return $this->blockrendermethod;
2570 }
2571 // Its not explicitly set, check the parent theme configs.
2572 foreach ($this->parent_configs as $config) {
2573 if (isset($config->blockrendermethod)) {
2574 return $config->blockrendermethod;
2575 }
2576 }
2577 // Default it to blocks.
2578 return 'blocks';
2579 }
493ef66e
FM
2580
2581 /**
2582 * Get the callable for CSS tree post processing.
2583 *
2584 * @return string|null
2585 */
2586 public function get_css_tree_post_processor() {
2587 $configs = [$this] + $this->parent_configs;
2588 foreach ($configs as $config) {
755b013f 2589 if (!empty($config->csstreepostprocessor) && is_callable($config->csstreepostprocessor)) {
493ef66e
FM
2590 return $config->csstreepostprocessor;
2591 }
2592 }
2593 return null;
2594 }
a26ce248 2595
ebebf55c 2596}
34a2777c 2597
ebebf55c 2598/**
d9c8f425 2599 * This class keeps track of which HTML tags are currently open.
2600 *
2601 * This makes it much easier to always generate well formed XHTML output, even
2602 * if execution terminates abruptly. Any time you output some opening HTML
2603 * without the matching closing HTML, you should push the necessary close tags
2604 * onto the stack.
ebebf55c 2605 *
2606 * @copyright 2009 Tim Hunt
473dd811
SH
2607 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2608 * @since Moodle 2.0
f8129210 2609 * @package core
76be40cc 2610 * @category output
ebebf55c 2611 */
d9c8f425 2612class xhtml_container_stack {
473dd811
SH
2613
2614 /**
76be40cc 2615 * @var array Stores the list of open containers.
473dd811 2616 */
d9c8f425 2617 protected $opencontainers = array();
473dd811 2618
fa1afe32 2619 /**
76be40cc 2620 * @var array In developer debug mode, stores a stack trace of all opens and
d9c8f425 2621 * closes, so we can output helpful error messages when there is a mismatch.
fa1afe32 2622 */
d9c8f425 2623 protected $log = array();
473dd811 2624
fa1afe32 2625 /**
76be40cc
SH
2626 * @var boolean Store whether we are developer debug mode. We need this in
2627 * several places including in the destructor where we may not have access to $CFG.
fa1afe32 2628 */
d9c8f425 2629 protected $isdebugging;
34a2777c 2630
473dd811
SH
2631 /**
2632 * Constructor
2633 */
d9c8f425 2634 public function __construct() {
96f81ea3
PS
2635 global $CFG;
2636 $this->isdebugging = $CFG->debugdeveloper;
ebebf55c 2637 }
34a2777c 2638
fa1afe32 2639 /**
d9c8f425 2640 * Push the close HTML for a recently opened container onto the stack.
473dd811 2641 *
d9c8f425 2642 * @param string $type The type of container. This is checked when {@link pop()}
2643 * is called and must match, otherwise a developer debug warning is output.
2644 * @param string $closehtml The HTML required to close the container.
fa1afe32 2645 */
d9c8f425 2646 public function push($type, $closehtml) {
2647 $container = new stdClass;
2648 $container->type = $type;
2649 $container->closehtml = $closehtml;
2650 if ($this->isdebugging) {
2651 $this->log('Open', $type);
3aaa27f4 2652 }
d9c8f425 2653 array_push($this->opencontainers, $container);
ebebf55c 2654 }
34a2777c 2655
fa1afe32 2656 /**
d9c8f425 2657 * Pop the HTML for the next closing container from the stack. The $type
2658 * must match the type passed when the container was opened, otherwise a
2659 * warning will be output.
473dd811 2660 *
d9c8f425 2661 * @param string $type The type of container.
2662 * @return string the HTML required to close the container.
fa1afe32 2663 */
d9c8f425 2664 public function pop($type) {
2665 if (empty($this->opencontainers)) {
2666 debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
2667 $this->output_log(), DEBUG_DEVELOPER);
2668 return;
3aaa27f4 2669 }
ebebf55c 2670
d9c8f425 2671 $container = array_pop($this->opencontainers);
2672 if ($container->type != $type) {
2673 debugging('<p>The type of container to be closed (' . $container->type .
2674 ') does not match the type of the next open container (' . $type .
2675 '). This suggests there is a nesting problem.</p>' .
2676 $this->output_log(), DEBUG_DEVELOPER);
ebebf55c 2677 }
d9c8f425 2678 if ($this->isdebugging) {
2679 $this->log('Close', $type);
e8775320 2680 }
d9c8f425 2681 return $container->closehtml;
ebebf55c 2682 }
e8775320 2683
fa1afe32 2684 /**
d9c8f425 2685 * Close all but the last open container. This is useful in places like error
2686 * handling, where you want to close all the open containers (apart from <body>)
2687 * before outputting the error message.
473dd811 2688 *
d9c8f425 2689 * @param bool $shouldbenone assert that the stack should be empty now - causes a
2690 * developer debug warning if it isn't.
2691 * @return string the HTML required to close any open containers inside <body>.
fa1afe32 2692 */
d9c8f425 2693 public function pop_all_but_last($shouldbenone = false) {
2694 if ($shouldbenone && count($this->opencontainers) != 1) {
2695 debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
2696 $this->output_log(), DEBUG_DEVELOPER);
2697 }
2698 $output = '';
2699 while (count($this->opencontainers) > 1) {
2700 $container = array_pop($this->opencontainers);
2701 $output .= $container->closehtml;
e8775320 2702 }
d9c8f425 2703 return $output;
e8775320 2704 }
34a2777c 2705
ebebf55c 2706 /**
d9c8f425 2707 * You can call this function if you want to throw away an instance of this
2708 * class without properly emptying the stack (for example, in a unit test).
2709 * Calling this method stops the destruct method from outputting a developer
2710 * debug warning. After calling this method, the instance can no longer be used.
ebebf55c 2711 */
d9c8f425 2712 public function discard() {
2713 $this->opencontainers = null;
ebebf55c 2714 }
d9c8f425 2715
fa1afe32 2716 /**
d9c8f425 2717 * Adds an entry to the log.
473dd811 2718 *
d9c8f425 2719 * @param string $action The name of the action
2720 * @param string $type The type of action
fa1afe32 2721 */
d9c8f425 2722 protected function log($action, $type) {
2723 $this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
2724 format_backtrace(debug_backtrace()) . '</li>';
ebebf55c 2725 }
34a2777c 2726
fa1afe32 2727 /**
d9c8f425 2728 * Outputs the log's contents as a HTML list.
473dd811 2729 *
d9c8f425 2730 * @return string HTML list of the log
fa1afe32 2731 */
d9c8f425 2732 protected function output_log() {
2733 return '<ul>' . implode("\n", $this->log) . '</ul>';
34a2777c 2734 }
6fc267a0 2735}